public interface TokenAuthenticationManager
Modifier and Type | Method and Description |
---|---|
Token |
authenticateApplication(ApplicationAuthenticationContext authenticationContext)
Authenticates an application and generates an authentication token.
|
Token |
authenticateUser(UserAuthenticationContext authenticateContext)
Deprecated.
This method exists to maintain the API for old clients. It creates a token with the
default lifetime.
|
Token |
authenticateUser(UserAuthenticationContext authenticateContext,
TokenLifetime tokenLifetime)
Authenticates a user and and generates an authentication token.
|
Token |
authenticateUserWithoutValidatingPassword(UserAuthenticationContext authenticateContext)
Feigns the authentication process for a user and creates a token for the authentication without validating the password.
|
List<Application> |
findAuthorisedApplications(User user,
String applicationName)
Returns a list of applications a user
is authorised to authenticate with.
|
User |
findUserByToken(String tokenKey,
String applicationName)
Will find a user via the passed in token key.
|
Token |
findUserTokenByKey(String tokenKey,
String applicationName)
Returns the token matching a given key
|
Date |
getTokenExpiryTime(Token token)
Returns the expiry time of a token.
|
void |
invalidateToken(String token)
Attempts to invalidate a Token based on the passed in Token key (random hash).
|
void |
invalidateTokensForUser(String username,
String exclusionToken,
String applicationName)
Invalidates all sessions for a user, possibly excluding a specific one.
|
void |
removeExpiredTokens()
Removes all tokens that have exceeded their expiry time.
|
List<Token> |
searchTokens(EntityQuery<Token> query)
Returns a list of tokens matching the given query.
|
Token |
validateApplicationToken(String tokenKey,
ValidationFactor[] validationFactors)
Validates an application token key given validation factors.
|
Token |
validateUserToken(String userTokenKey,
ValidationFactor[] validationFactors,
String application)
Validates a user token key given validation factors and checks that the user is allowed to authenticate
with the specified application
|
Token authenticateApplication(ApplicationAuthenticationContext authenticationContext) throws InvalidAuthenticationException
authenticationContext
- application authentication credentials.InvalidAuthenticationException
- authentication was not successful because either the application does not exist, the password is incorrect, the application is inactive or there was a problem generating the authentication token.Token authenticateUser(UserAuthenticationContext authenticateContext, TokenLifetime tokenLifetime) throws InvalidAuthenticationException, OperationFailedException, InactiveAccountException, ApplicationAccessDeniedException, ExpiredCredentialException, ApplicationNotFoundException
RemoteDirectory.authenticate(String, com.atlassian.crowd.embedded.api.PasswordCredential)
method is
iteratively called for each assigned directory. If the user does not exist in one directory, the directory is skipped and the next one is examined. If the user does
not exist in any of the assigned directories then an InvalidAuthenticationException
is thrown.authenticateContext
- The authentication details for the user.tokenLifetime
- Requested lifetime of the tokenInvalidAuthenticationException
- The authentication was not successful.OperationFailedException
- error thrown by directory implementation when attempting to find or authenticate the user.InactiveAccountException
- user account is inactive.ApplicationAccessDeniedException
- user does not have access to authenticate with application.ExpiredCredentialException
- the user's credentials have expired. The user must change their credentials in order to successfully authenticate.ApplicationNotFoundException
- if the application could not be found@Deprecated Token authenticateUser(UserAuthenticationContext authenticateContext) throws InvalidAuthenticationException, OperationFailedException, InactiveAccountException, ApplicationAccessDeniedException, ExpiredCredentialException, ApplicationNotFoundException
Token authenticateUserWithoutValidatingPassword(UserAuthenticationContext authenticateContext) throws InvalidAuthenticationException, OperationFailedException, InactiveAccountException, ApplicationAccessDeniedException, ApplicationNotFoundException
authenticateUser(com.atlassian.crowd.model.authentication.UserAuthenticationContext, TokenLifetime)
method.authenticateContext
- The authentication details for the user.InvalidAuthenticationException
- if the authentication was not successful.OperationFailedException
- if the error thrown by directory implementation when attempting to find or authenticate the user.InactiveAccountException
- if the user account is inactive.ApplicationAccessDeniedException
- if the user does not have access to authenticate with application.ApplicationNotFoundException
- if the application could not be foundToken validateApplicationToken(String tokenKey, ValidationFactor[] validationFactors) throws InvalidTokenException
tokenKey
- returns a valid token corresponding to the tokenKey.validationFactors
- validation factors for generating the token hash.InvalidTokenException
- if the tokenKey or corresponding client validation factors do not represent a valid application token.Token validateUserToken(String userTokenKey, ValidationFactor[] validationFactors, String application) throws InvalidTokenException, ApplicationAccessDeniedException, OperationFailedException
userTokenKey
- returns a valid token corresponding to the tokenKey.validationFactors
- validation factors for generating the token hash.application
- name of application to authenticate with.InvalidTokenException
- if the userTokenKey or corresponding validationFactors do not represent a valid SSO token.OperationFailedException
- there was an error communicating with an underlying directory when determining if a user is allowed to authenticate with the application (eg. if a user has the appropriate group memberships).ApplicationAccessDeniedException
- the user is not allowed to authenticate with the application.void invalidateToken(String token)
token
- the token key (random hash) to invalidate.List<Token> searchTokens(EntityQuery<Token> query)
query
- entity query for Entity.TOKEN
.Token
matching the search criteria.void removeExpiredTokens()
User findUserByToken(String tokenKey, String applicationName) throws InvalidTokenException, OperationFailedException, ApplicationNotFoundException, ApplicationAccessDeniedException
tokenKey
- the token keyapplicationName
- name of the current applicationInvalidTokenException
- if the User or Directory cannot be found that relates to the given token,
or the token is associated to an Application and not a UserOperationFailedException
- if there was an issue accessing the user from the underlying directoryApplicationNotFoundException
- if the application could not be foundApplicationAccessDeniedException
- the user is not allowed to authenticate with the application.Token findUserTokenByKey(String tokenKey, String applicationName) throws InvalidTokenException, ApplicationAccessDeniedException, OperationFailedException, ApplicationNotFoundException
tokenKey
- the token keyapplicationName
- name of the current applicationInvalidTokenException
- if the token cannot be found by the give key,
or the token is associated to an Application and not a UserOperationFailedException
- if there was an issue accessing the user from the underlying directoryApplicationNotFoundException
- if the application could not be foundApplicationAccessDeniedException
- the user is not allowed to authenticate with the application.List<Application> findAuthorisedApplications(User user, String applicationName) throws OperationFailedException, DirectoryNotFoundException, ApplicationNotFoundException
user
- user to search for.applicationName
- name of the current applicationOperationFailedException
- if there was an error querying directory.DirectoryNotFoundException
- if the directory could not be found.ApplicationNotFoundException
- if the application could not be foundvoid invalidateTokensForUser(String username, String exclusionToken, String applicationName) throws UserNotFoundException, ApplicationNotFoundException
applicationName
- name of the current applicationusername
- exclusionToken
- the random hash of a token to leave validUserNotFoundException
ApplicationNotFoundException
Copyright © 2013 Atlassian. All Rights Reserved.