com.atlassian.bamboo.accesstoken

Class DefaultAccessTokenService

java.lang.Object

com.atlassian.bamboo.accesstoken.DefaultAccessTokenService

All Implemented Interfaces:

AccessTokenService

public class DefaultAccessTokenService
extends Object
implements AccessTokenService

Constructor Summary

Constructors

Constructor and Description
DefaultAccessTokenService(AccessTokenDao accessTokenDao, AccessTokenGenerator accessTokenGenerator, BambooAuthenticationContext bambooAuthenticationContext, BambooPermissionManager bambooPermissionManager, com.atlassian.event.api.EventPublisher eventPublisher, BambooUserManager bambooUserManager, AuditLogService auditLogService)

Method Summary

Modifier and Type	Method and Description
Optional<AccessToken>	authenticate(String rawToken) Authenticate by raw token
RawAccessToken	create(CreateAccessTokenRequest createAccessTokenRequest) Create new access token for user.
void	deleteByTokenId(String tokenId) Delete one token with tokenId.
void	deleteByUserName(String userName) Delete all tokens for given user name
List<AccessToken>	getAccessTokensByUserName(String userName) Get All tokens for given user name.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultAccessTokenService

public DefaultAccessTokenService(AccessTokenDao accessTokenDao,
                                 AccessTokenGenerator accessTokenGenerator,
                                 BambooAuthenticationContext bambooAuthenticationContext,
                                 BambooPermissionManager bambooPermissionManager,
                                 com.atlassian.event.api.EventPublisher eventPublisher,
                                 BambooUserManager bambooUserManager,
                                 AuditLogService auditLogService)

Method Detail

authenticate

public Optional<AccessToken> authenticate(@NotNull
                                          String rawToken)

Description copied from interface: AccessTokenService

Authenticate by raw token

Specified by:

authenticate in interface AccessTokenService

Parameters:

rawToken - created by AccessTokenService.create(CreateAccessTokenRequest) method

Returns:

Optional with AccessToken When user exists & is enabled and token is valid, otherwise Optional.empty()

create

@NotNull
public RawAccessToken create(@NotNull
                                      CreateAccessTokenRequest createAccessTokenRequest)
                               throws TokenLimitExceededException,
                                      CreateTokenFailedException,
                                      TokenWithNameExistsException

Description copied from interface: AccessTokenService

Create new access token for user. User can create token only for himself.

Specified by:

create in interface AccessTokenService

Returns:

RawAccessToken, RawAccessToken.getRawToken() can be used in AccessTokenService.authenticate(String)

Throws:

TokenLimitExceededException - when user already has maximum number of tokens

CreateTokenFailedException - when can not generate unique token id

TokenWithNameExistsException - when user already has token with name

getAccessTokensByUserName

@NotNull
public List<AccessToken> getAccessTokensByUserName(@NotNull
                                                            String userName)

Description copied from interface: AccessTokenService

Get All tokens for given user name. Not admin can only get own tokens. Admins and restricted admins can get all users' tokens.

Specified by:

getAccessTokensByUserName in interface AccessTokenService

Returns:

list of all user's access tokens

deleteByTokenId

public void deleteByTokenId(@NotNull
                            String tokenId)

Description copied from interface: AccessTokenService

Delete one token with tokenId.

Specified by:

deleteByTokenId in interface AccessTokenService

deleteByUserName

public void deleteByUserName(@NotNull
                             String userName)
                      throws UnauthorisedException

Description copied from interface: AccessTokenService

Delete all tokens for given user name

Specified by:

deleteByUserName in interface AccessTokenService

Throws:

UnauthorisedException - on non-admin tries to delete other user tokens