Java Doc for DigestScheme.java in » Net » Apache-common-HttpClient » org » apache » commons » httpclient » auth » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Net » Apache common HttpClient » org.apache.commons.httpclient.auth

Source Cross Reference Class Diagram Java Document (Java Doc)

java.lang .Object

org.apache.commons.httpclient.auth .RFC2617Scheme

org.apache.commons.httpclient.auth .DigestScheme

DigestScheme

public class DigestScheme extends RFC2617Scheme (Code)

Digest authentication scheme as defined in RFC 2617. Both MD5 (default) and MD5-sess are supported. Currently only qop=auth or no qop is supported. qop=auth-int is unsupported. If auth and auth-int are provided, auth is used.

Credential charset is configured via the org.apache.commons.httpclient.params.HttpMethodParams.CREDENTIAL_CHARSET credentialcharset parameter. Since the digest username is included as clear text in the generated Authentication header, the charset of the username must be compatible with the org.apache.commons.httpclient.params.HttpMethodParams.HTTP_ELEMENT_CHARSET http element charset .

TODO: make class more stateful regarding repeated authentication requests
author:
   Remy Maucherat
author:
   Rodney Waldhoff
author:
   Jeff Dever
author:
   Ortwin Gl?ck
author:
   Sean C. Sullivan
author:
   Adrian Sutton
author:
   Mike Bowler
author:
   Oleg Kalnichevski

Constructor Summary
public	DigestScheme() Default constructor for the digest authetication scheme.
public	DigestScheme(String challenge) Constructor for the digest authetication scheme.

Method Summary
public String	authenticate(Credentials credentials, String method, String uri) Produces a digest authorization string for the given set of Credentials , method name and URI. Parameters: credentials - A set of credentials to be used for athentication Parameters: method - the name of the method that requires authorization.
public String	authenticate(Credentials credentials, HttpMethod method) Produces a digest authorization string for the given set of Credentials , method name and URI.
public static String	createCnonce() Creates a random cnonce value based on the current time.
public String	getID() Gets an ID based upon the realm and the nonce value.
public String	getSchemeName() Returns textual designation of the digest authentication scheme.
public boolean	isComplete() Tests if the Digest authentication process has been completed.
public boolean	isConnectionBased() Returns `false`.
public void	processChallenge(String challenge) Processes the Digest challenge.

Constructor Detail

DigestScheme
public DigestScheme()(Code)
	Default constructor for the digest authetication scheme. since: 3.0

DigestScheme
public DigestScheme(String challenge) throws MalformedChallengeException(Code)
	Constructor for the digest authetication scheme. Parameters: challenge - authentication challenge throws: MalformedChallengeException - is thrown if the authentication challengeis malformedAuthScheme.processChallenge(String)

Method Detail

authenticate
public String authenticate(Credentials credentials, String method, String uri) throws AuthenticationException(Code)
	Produces a digest authorization string for the given set of Credentials , method name and URI. Parameters: credentials - A set of credentials to be used for athentication Parameters: method - the name of the method that requires authorization. Parameters: uri - The URI for which authorization is needed. throws: InvalidCredentialsException - if authentication credentialsare not valid or not applicable for this authentication scheme throws: AuthenticationException - if authorization string cannot be generated due to an authentication failure a digest authorization string See Also: org.apache.commons.httpclient.HttpMethod.getName See Also: org.apache.commons.httpclient.HttpMethod.getPathDigestScheme.authenticate(Credentials,HttpMethod)

authenticate
public String authenticate(Credentials credentials, HttpMethod method) throws AuthenticationException(Code)
	Produces a digest authorization string for the given set of Credentials , method name and URI. Parameters: credentials - A set of credentials to be used for athentication Parameters: method - The method being authenticated throws: InvalidCredentialsException - if authentication credentialsare not valid or not applicable for this authentication scheme throws: AuthenticationException - if authorization string cannot be generated due to an authentication failure a digest authorization string since: 3.0

createCnonce
public static String createCnonce()(Code)
	Creates a random cnonce value based on the current time. The cnonce value as String. throws: HttpClientError - if MD5 algorithm is not supported.

getID
public String getID()(Code)
	Gets an ID based upon the realm and the nonce value. This ensures that requests to the same realm with different nonce values will succeed. This differentiation allows servers to request re-authentication using a fresh nonce value.

getSchemeName
public String getSchemeName()(Code)
	Returns textual designation of the digest authentication scheme. `digest`

isComplete
public boolean isComplete()(Code)
	Tests if the Digest authentication process has been completed. `true` if Digest authorization has been processed,`false` otherwise. since: 3.0

isConnectionBased
public boolean isConnectionBased()(Code)
	Returns `false`. Digest authentication scheme is request based. `false`. since: 3.0

processChallenge
public void processChallenge(String challenge) throws MalformedChallengeException(Code)
	Processes the Digest challenge. Parameters: challenge - the challenge string throws: MalformedChallengeException - is thrown if the authentication challengeis malformed since: 3.0

Methods inherited from org.apache.commons.httpclient.auth.RFC2617Scheme

public String getID()(Code)(Java Doc)
public String getParameter(String name)(Code)(Java Doc)
protected Map getParameters()(Code)(Java Doc)
public String getRealm()(Code)(Java Doc)
public void processChallenge(String challenge) throws MalformedChallengeException(Code)(Java Doc)

Methods inherited from java.lang.Object

native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.