Class BasicScheme
java.lang.Object
edu.internet2.middleware.grouperClientExt.org.apache.commons.httpclient.auth.RFC2617Scheme
edu.internet2.middleware.grouperClientExt.org.apache.commons.httpclient.auth.BasicScheme
- All Implemented Interfaces:
AuthScheme
Basic authentication scheme as defined in RFC 2617.
-
Constructor Summary
ConstructorDescriptionDefault constructor for the basic authetication scheme.BasicScheme
(String challenge) Deprecated. -
Method Summary
Modifier and TypeMethodDescriptionauthenticate
(Credentials credentials, HttpMethod method) Produces basic authorization string for the given set ofCredentials
.authenticate
(Credentials credentials, String method, String uri) Deprecated.static String
authenticate
(UsernamePasswordCredentials credentials) Deprecated.Useauthenticate(UsernamePasswordCredentials, String)
Returns a basic Authorization header value for the givenUsernamePasswordCredentials
.static String
authenticate
(UsernamePasswordCredentials credentials, String charset) Returns a basic Authorization header value for the givenUsernamePasswordCredentials
and charset.Returns textual designation of the basic authentication scheme.boolean
Tests if the Basic authentication process has been completed.boolean
Returns false.void
processChallenge
(String challenge) Processes the Basic challenge.Methods inherited from class edu.internet2.middleware.grouperClientExt.org.apache.commons.httpclient.auth.RFC2617Scheme
getID, getParameter, getParameters, getRealm
-
Constructor Details
-
BasicScheme
public BasicScheme()Default constructor for the basic authetication scheme.- Since:
- 3.0
-
BasicScheme
Deprecated.Use parameterless constructor andAuthScheme.processChallenge(String)
methodConstructor for the basic authetication scheme.- Parameters:
challenge
- authentication challenge- Throws:
MalformedChallengeException
- is thrown if the authentication challenge is malformed
-
-
Method Details
-
getSchemeName
Returns textual designation of the basic authentication scheme.- Returns:
basic
-
processChallenge
Processes the Basic challenge.- Specified by:
processChallenge
in interfaceAuthScheme
- Overrides:
processChallenge
in classRFC2617Scheme
- Parameters:
challenge
- the challenge string- Throws:
MalformedChallengeException
- is thrown if the authentication challenge is malformed- Since:
- 3.0
-
isComplete
public boolean isComplete()Tests if the Basic authentication process has been completed.- Returns:
- true if Basic authorization has been processed, false otherwise.
- Since:
- 3.0
-
authenticate
public String authenticate(Credentials credentials, String method, String uri) throws AuthenticationException Deprecated.Produces basic authorization string for the given set ofCredentials
.- Parameters:
credentials
- The set of credentials to be used for athenticationmethod
- Method name is ignored by the basic authentication schemeuri
- URI is ignored by the basic authentication scheme- Returns:
- a basic authorization string
- Throws:
InvalidCredentialsException
- if authentication credentials are not valid or not applicable for this authentication schemeAuthenticationException
- if authorization string cannot be generated due to an authentication failure- See Also:
-
isConnectionBased
public boolean isConnectionBased()Returns false. Basic authentication scheme is request based.- Returns:
- false.
- Since:
- 3.0
-
authenticate
public String authenticate(Credentials credentials, HttpMethod method) throws AuthenticationException Produces basic authorization string for the given set ofCredentials
.- Parameters:
credentials
- The set of credentials to be used for athenticationmethod
- The method being authenticated- Returns:
- a basic authorization string
- Throws:
InvalidCredentialsException
- if authentication credentials are not valid or not applicable for this authentication schemeAuthenticationException
- if authorization string cannot be generated due to an authentication failure- Since:
- 3.0
-
authenticate
Deprecated.Useauthenticate(UsernamePasswordCredentials, String)
Returns a basic Authorization header value for the givenUsernamePasswordCredentials
.- Parameters:
credentials
- The credentials to encode.- Returns:
- a basic authorization string
-
authenticate
Returns a basic Authorization header value for the givenUsernamePasswordCredentials
and charset.- Parameters:
credentials
- The credentials to encode.charset
- The charset to use for encoding the credentials- Returns:
- a basic authorization string
- Since:
- 3.0
-
AuthScheme.processChallenge(String)
method