Interface IUserTokenHandler

All Superinterfaces:

IAPIHandler, IGenericHandler, Serializable

All Known Implementing Classes:

UserTokenHandler

public interface IUserTokenHandler
extends IGenericHandler

Handler for UserRefreshToken entities

Since:

8.0.0

Author:

XIMA Media GmbH

Method Summary

Modifier and Type	Method	Description
UserRefreshToken	createRefreshToken(UserContext uc, RefreshTokenUserDataDTO refreshTokenUserDataDTO, String issuer, IClientDescriptor clientDescriptor)
RefreshTokenUserDataDTO	getRefreshTokenUserData(UserContext uc, @NotNull String refreshToken)
RefreshTokenUserDataDTO	getRefreshTokenUserData(UserContext uc, @NotNull UUID refreshTokenId)
TokenConfiguration	getTokenConfiguration(UserContext uc)
List<UserRefreshToken>	getUserRefreshTokens(UserContext uc, IUser user)
boolean	isValidRefreshToken(UserContext uc, UUID refreshTokenId)
boolean	removeRefreshToken(UserContext uc, UserRefreshToken token)
boolean	removeRefreshToken(UserContext uc, String refreshToken)
UserRefreshToken	updateRefreshToken(UserContext uc, String refreshToken, IClientDescriptor clientDescriptor)

Methods inherited from interface IAPIHandler

getName

Methods inherited from interface IGenericHandler

create, create, delete, delete, deleteBy, deleteById, deleteById, getAll, getAllBy, getAttributes, getAttributes, getBy, getById, getById, getById, getEntityRefs, getSingleAttributes, getSingleAttributes, resultTotalCount, update, update

Method Details

getTokenConfiguration

TokenConfiguration getTokenConfiguration(UserContext uc)

updateRefreshToken

UserRefreshToken updateRefreshToken(UserContext uc,
 String refreshToken,
 IClientDescriptor clientDescriptor)
                             throws InvalidTokenException,
UnknownTokenException

Throws:

InvalidTokenException

UnknownTokenException

createRefreshToken

UserRefreshToken createRefreshToken(UserContext uc,
 RefreshTokenUserDataDTO refreshTokenUserDataDTO,
 String issuer,
 IClientDescriptor clientDescriptor)
                             throws TokenCreateException

Throws:

TokenCreateException

removeRefreshToken

boolean removeRefreshToken(UserContext uc,
 String refreshToken)

removeRefreshToken

boolean removeRefreshToken(UserContext uc,
 UserRefreshToken token)

getUserRefreshTokens

List<UserRefreshToken> getUserRefreshTokens(UserContext uc,
 IUser user)

isValidRefreshToken

boolean isValidRefreshToken(UserContext uc,
 UUID refreshTokenId)

getRefreshTokenUserData

RefreshTokenUserDataDTO getRefreshTokenUserData(UserContext uc,
 @NotNull
 @NotNull UUID refreshTokenId)
                                         throws InvalidTokenException

Throws:

InvalidTokenException

getRefreshTokenUserData

RefreshTokenUserDataDTO getRefreshTokenUserData(UserContext uc,
 @NotNull
 @NotNull String refreshToken)
                                         throws InvalidTokenException

Throws:

InvalidTokenException