Package com.atlassian.bamboo.accesstoken

Interface AccessTokenService

All Known Implementing Classes:

DefaultAccessTokenService

public interface AccessTokenService

Service for managing AccessTokens and authenticating them.

Since:

6.10

Method Summary

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

Method Detail

create

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

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

Parameters:

createAccessTokenRequest -

Returns:

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

Throws:

TokenLimitExceededException - when user already has maximum number of tokens

CreateTokenFailedException - when can not generate unique token id

UnauthorisedException - when try create token for other user than current logged in

TokenWithNameExistsException - when user already has token with name

getAccessTokensByUserName

@NotNull
@NotNull List<AccessToken> getAccessTokensByUserName(@NotNull
                                                     @NotNull String userName)
                                              throws UnauthorisedException

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

Parameters:

userName -

Returns:

list of all user's access tokens

Throws:

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

deleteByTokenId

void deleteByTokenId(@NotNull
                     @NotNull String tokenId)
              throws UnauthorisedException

Delete one token with tokenId.

Parameters:

tokenId -

Throws:

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

deleteByTokenIdBecauseOfExpiry

void deleteByTokenIdBecauseOfExpiry(@NotNull
                                    @NotNull String tokenId,
                                    @NotNull
                                    @NotNull Date expirationDate)

Delete one token with tokenId because of expiry.

Parameters:

tokenId - token id

expirationDate - expiration date

deleteByUserName

void deleteByUserName(@NotNull
                      @NotNull String userName)
               throws UnauthorisedException

Delete all tokens for given user name

Parameters:

userName -

Throws:

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

authenticate

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

Authenticate by raw token

Parameters:

rawToken - created by create(CreateAccessTokenRequest) method

Returns:

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