Class RFC2617Scheme
java.lang.Object
edu.internet2.middleware.grouperClientExt.org.apache.commons.httpclient.auth.RFC2617Scheme
- All Implemented Interfaces:
AuthScheme
- Direct Known Subclasses:
BasicScheme
,DigestScheme
Abstract authentication scheme class that lays foundation for all RFC 2617 compliant authetication schemes and provides capabilities common to all authentication schemes defined in RFC 2617.
-
Constructor Summary
ConstructorDescriptionDefault constructor for RFC2617 compliant authetication schemes.RFC2617Scheme
(String challenge) Deprecated. -
Method Summary
Modifier and TypeMethodDescriptiongetID()
Deprecated.no longer usedgetParameter
(String name) Returns authentication parameter with the given name, if available.protected Map
Returns authentication parameters map.getRealm()
Returns authentication realm.void
processChallenge
(String challenge) Processes the given challenge token.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface edu.internet2.middleware.grouperClientExt.org.apache.commons.httpclient.auth.AuthScheme
authenticate, authenticate, getSchemeName, isComplete, isConnectionBased
-
Constructor Details
-
RFC2617Scheme
public RFC2617Scheme()Default constructor for RFC2617 compliant authetication schemes.- Since:
- 3.0
-
RFC2617Scheme
Deprecated.Use parameterless constructor andAuthScheme.processChallenge(String)
methodDefault constructor for RFC2617 compliant authetication schemes.- Parameters:
challenge
- authentication challenge- Throws:
MalformedChallengeException
- is thrown if the authentication challenge is malformed
-
-
Method Details
-
processChallenge
Processes the given challenge token. Some authentication schemes may involve multiple challenge-response exchanges. Such schemes must be able to maintain the state information when dealing with sequential challenges- Specified by:
processChallenge
in interfaceAuthScheme
- Parameters:
challenge
- the challenge string- Throws:
MalformedChallengeException
- is thrown if the authentication challenge is malformed- Since:
- 3.0
-
getParameters
Returns authentication parameters map. Keys in the map are lower-cased.- Returns:
- the map of authentication parameters
-
getParameter
Returns authentication parameter with the given name, if available.- Specified by:
getParameter
in interfaceAuthScheme
- Parameters:
name
- The name of the parameter to be returned- Returns:
- the parameter with the given name
-
getRealm
Returns authentication realm. The realm may not be null.- Specified by:
getRealm
in interfaceAuthScheme
- Returns:
- the authentication realm
-
getID
Deprecated.no longer usedReturns a String identifying the authentication challenge. This is used, in combination with the host and port to determine if authorization has already been attempted or not. Schemes which require multiple requests to complete the authentication should return a different value for each stage in the request.Additionally, the ID should take into account any changes to the authentication challenge and return a different value when appropriate. For example when the realm changes in basic authentication it should be considered a different authentication attempt and a different value should be returned.
This method simply returns the realm for the challenge.
- Specified by:
getID
in interfaceAuthScheme
- Returns:
- String a String identifying the authentication challenge. The returned value may be null.
-
AuthScheme.processChallenge(String)
method