Package jetbrains.buildServer.serverSide.auth.impl

Class TokenAuthenticationModelImpl

java.lang.Object

jetbrains.buildServer.serverSide.auth.impl.TokenAuthenticationModelImpl

All Implemented Interfaces:

TokenAuthenticationModel

public class TokenAuthenticationModelImpl
extends Object
implements TokenAuthenticationModel

Author:

Dmitrii Bogdanov

Nested Class Summary

Nested classes/interfaces inherited from interface jetbrains.buildServer.serverSide.auth.TokenAuthenticationModel

TokenAuthenticationModel.CheckCredentialsResult

Field Summary

Fields

Modifier and Type	Field	Description
static String	LOG_EXPIRED_TOKENS_PROPERTY

Constructor Summary

Constructors

Constructor	Description
TokenAuthenticationModelImpl(UserModelEx userModelEx, AuthenticationTokenCreator authenticationTokenCreator, AuthenticationTokenStorage authenticationTokenStorage, MultiNodesEvents multiNodesEvents, ServerResponsibility responsibility, ScheduledExecutorService executorService, TimeService timeService, AuditLogFactory auditLogFactory, EventDispatcher<BuildServerListener> dispatcher)

Method Summary

Modifier and Type	Method	Description
TokenAuthenticationModel.CheckCredentialsResult	checkCredentials(SimpleCredentials credentials)	Checks whether the password provided in credentials matches existing token for user with provided username
int	countUserTokens(long userId)	Count user tokens
AuthenticationToken	createToken(long userId, String tokenName, Date expirationTime)	Generate token with tokenName for userId.
AuthenticationToken	createToken(long userId, String tokenName, Date expirationTime, AuthenticationToken.PermissionsRestriction permissionsRestriction)	Generate token with tokenName for userId.
void	deleteAllTokens()	Delete all tokens
void	deleteAllUserTokens(long userId)	Delete all user tokens
void	deleteToken(long userId, String tokenName)	Delete token by user id and token name
AuthenticationToken	find(String id)
List<AuthenticationToken>	getUserTokens(long userId)	List all user tokens
boolean	isMyToken(String tokenValue)	Check whether the token was generated by this module
BearerTokenCredentials	parseToken(String token)	Parse token from raw string
void	updateLastAccessInfo(SimpleCredentials credentials, String remoteAddress)	Update information about last usage of a token.
boolean	userHasReachedMaxAllowedNumberOfTokens(long userId)	Check whether user has already reached max number of allowed tokens
void	validateName(String name)	Validate the token name

Methods inherited from class java.lang.Object

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

Field Detail

LOG_EXPIRED_TOKENS_PROPERTY

@NotNull
public static final String LOG_EXPIRED_TOKENS_PROPERTY

See Also:

Constant Field Values

Constructor Detail

TokenAuthenticationModelImpl

public TokenAuthenticationModelImpl(@NotNull
                                    UserModelEx userModelEx,
                                    @NotNull
                                    AuthenticationTokenCreator authenticationTokenCreator,
                                    @NotNull
                                    AuthenticationTokenStorage authenticationTokenStorage,
                                    @NotNull
                                    MultiNodesEvents multiNodesEvents,
                                    @NotNull
                                    ServerResponsibility responsibility,
                                    @NotNull
                                    ScheduledExecutorService executorService,
                                    @NotNull
                                    TimeService timeService,
                                    @NotNull
                                    AuditLogFactory auditLogFactory,
                                    @NotNull
                                    EventDispatcher<BuildServerListener> dispatcher)

Method Detail

createToken

@NotNull
public AuthenticationToken createToken(long userId,
                                       @NotNull
                                       String tokenName,
                                       @NotNull
                                       Date expirationTime)
                                throws AuthenticationTokenStorage.CreationException

Description copied from interface: TokenAuthenticationModel

Generate token with tokenName for userId. Subsequent invocation of TokenAuthenticationModel.parseToken(java.lang.String) on the string returned by this method should result in correct instance of BearerTokenCredentials

Specified by:

createToken in interface TokenAuthenticationModel

Returns:

generated token

Throws:

AuthenticationTokenStorage.CreationException - if the user already has the token with specified name

createToken

@NotNull
public AuthenticationToken createToken(long userId,
                                       @NotNull
                                       String tokenName,
                                       @NotNull
                                       Date expirationTime,
                                       @NotNull
                                       AuthenticationToken.PermissionsRestriction permissionsRestriction)
                                throws AuthenticationTokenStorage.CreationException

Description copied from interface: TokenAuthenticationModel

Generate token with tokenName for userId. Subsequent invocation of TokenAuthenticationModel.parseToken(java.lang.String) on the string returned by this method should result in correct instance of BearerTokenCredentials

Specified by:

createToken in interface TokenAuthenticationModel

Returns:

generated token

Throws:

AuthenticationTokenStorage.CreationException - if the user already has the token with specified name

getUserTokens

@NotNull
public List<AuthenticationToken> getUserTokens(long userId)

Description copied from interface: TokenAuthenticationModel

List all user tokens

Specified by:

getUserTokens in interface TokenAuthenticationModel

Returns:

empty collection if user doesn't have tokens or list of tokens without values

countUserTokens

public int countUserTokens(long userId)

Description copied from interface: TokenAuthenticationModel

Count user tokens

Specified by:

countUserTokens in interface TokenAuthenticationModel

Returns:

number of user tokens

updateLastAccessInfo

public void updateLastAccessInfo(@NotNull
                                 SimpleCredentials credentials,
                                 @Nullable
                                 String remoteAddress)

Description copied from interface: TokenAuthenticationModel

Update information about last usage of a token.

Specified by:

updateLastAccessInfo in interface TokenAuthenticationModel

deleteToken

public void deleteToken(long userId,
                        @NotNull
                        String tokenName)

Description copied from interface: TokenAuthenticationModel

Delete token by user id and token name

Specified by:

deleteToken in interface TokenAuthenticationModel

deleteAllUserTokens

public void deleteAllUserTokens(long userId)

Description copied from interface: TokenAuthenticationModel

Delete all user tokens

Specified by:

deleteAllUserTokens in interface TokenAuthenticationModel

deleteAllTokens

public void deleteAllTokens()

Description copied from interface: TokenAuthenticationModel

Delete all tokens

Specified by:

deleteAllTokens in interface TokenAuthenticationModel

parseToken

@NotNull
public BearerTokenCredentials parseToken(@NotNull
                                         String token)

Description copied from interface: TokenAuthenticationModel

Parse token from raw string

Specified by:

parseToken in interface TokenAuthenticationModel

Returns:

BearerTokenCredentials containing name and token value

userHasReachedMaxAllowedNumberOfTokens

public boolean userHasReachedMaxAllowedNumberOfTokens(long userId)

Description copied from interface: TokenAuthenticationModel

Check whether user has already reached max number of allowed tokens

Specified by:

userHasReachedMaxAllowedNumberOfTokens in interface TokenAuthenticationModel

Returns:

true if user already has max number of tokens

checkCredentials

public TokenAuthenticationModel.CheckCredentialsResult checkCredentials(@NotNull
                                                                        SimpleCredentials credentials)

Description copied from interface: TokenAuthenticationModel

Checks whether the password provided in credentials matches existing token for user with provided username

Specified by:

checkCredentials in interface TokenAuthenticationModel

Returns:

isMyToken

public boolean isMyToken(@NotNull
                         String tokenValue)

Description copied from interface: TokenAuthenticationModel

Check whether the token was generated by this module

Specified by:

isMyToken in interface TokenAuthenticationModel

Parameters:

tokenValue - token

Returns:

true if token created by this module

validateName

public void validateName(@NotNull
                         String name)
                  throws AuthenticationTokenStorage.InvalidTokenName

Description copied from interface: TokenAuthenticationModel

Validate the token name

Specified by:

validateName in interface TokenAuthenticationModel

Parameters:

name - token name

Throws:

AuthenticationTokenStorage.InvalidTokenName - when the name is not valid

find

public AuthenticationToken find(@NotNull
                                String id)

Specified by:

find in interface TokenAuthenticationModel