public class BasicAuthScheme extends AuthScheme
| Modifier and Type | Field and Description |
|---|---|
static java.lang.String |
AUTH_HEADER |
AUTHENTICATE_RESPONSE_HEADER, authenticateResponseHeader, DEFAULT_UNAUTHORIZED_MESSAGE, realm, scheme| Constructor and Description |
|---|
BasicAuthScheme()
Create a scheme with no realm.
|
BasicAuthScheme(java.lang.String realm)
Create a scheme with a realm.
|
| Modifier and Type | Method and Description |
|---|---|
Request |
addAuth(Request request,
java.lang.String id,
java.lang.String secret)
Adds authentication credentials to a request.
|
Response |
authenticate(Request request,
java.lang.String userId,
java.lang.String secret)
Authenticates the request.
|
static java.lang.String |
buildAuthHeaderValue(java.lang.String username,
java.lang.String password)
Builds an auth header.
|
java.lang.String |
getUserId(Request request)
Gets the user id from the request, if possible.
|
boolean |
hasCredentials(Request request)
Determines if the request has any (invalid or valid) credentials for this scheme.
|
equals, getAuthenticateResponseHeader, getRealm, getScheme, getUnauthorizedResponse, hashCodepublic static final java.lang.String AUTH_HEADER
public BasicAuthScheme()
public BasicAuthScheme(java.lang.String realm)
realm - The realm.public Request addAuth(Request request, java.lang.String id, java.lang.String secret) throws java.security.GeneralSecurityException
AuthSchemeaddAuth in class AuthSchemerequest - The request to which credentials are added.id - An id that uniquely identifies the user (e.g. 'username').secret - The authentication secret for the username.java.security.GeneralSecurityExceptionpublic boolean hasCredentials(Request request)
AuthSchemehasCredentials in class AuthSchemerequest - The request.public java.lang.String getUserId(Request request) throws java.security.GeneralSecurityException
AuthSchemegetUserId in class AuthSchemerequest - The request.null if none.java.security.GeneralSecurityExceptionpublic Response authenticate(Request request, java.lang.String userId, java.lang.String secret) throws java.security.GeneralSecurityException
AuthSchemeauthenticate in class AuthSchemerequest - The request.userId - The user id for the secret.secret - The secret data.null.java.security.GeneralSecurityExceptionpublic static final java.lang.String buildAuthHeaderValue(java.lang.String username,
java.lang.String password)
username - The username.password - The password.