Package de.xima.fc.api.entity

Class UserTokenAPI

java.lang.Object

de.xima.fc.api.ASubAPI

de.xima.fc.api.entity.UserTokenAPI

public class UserTokenAPI
extends ASubAPI

API class for reading and writing UserRefreshToken entities.

Since:

8.0.0

Author:

XIMA Media GmbH

Method Summary

Modifier and Type	Method	Description
UserRefreshToken	createRefreshToken(UserContext uc, @NotBlank String userProfileId, String issuer, @NotBlank IClientDescriptor clientDescriptor)
static UserTokenAPI	getInstance()
TokenConfiguration	getTokenConfiguration(UserContext uc)
List<UserRefreshToken>	getUserRefreshTokens(UserContext uc, IUser user)
boolean	removeRefreshToken(UserContext uc, UserRefreshToken token)
boolean	removeRefreshToken(UserContext uc, String refreshToken, IClientDescriptor clientDescriptor)
UserRefreshToken	updateRefreshToken(UserContext uc, @NotBlank String refreshToken, @NotBlank IClientDescriptor clientDescriptor)

Methods inherited from class de.xima.fc.api.ASubAPI

getHandlerProvider

Methods inherited from class java.lang.Object

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

Method Detail

getTokenConfiguration

public TokenConfiguration getTokenConfiguration(UserContext uc)

updateRefreshToken

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

Throws:

InvalidTokenException

UnknownTokenException

createRefreshToken

public UserRefreshToken createRefreshToken(UserContext uc,
                                           @NotBlank
                                           @NotBlank String userProfileId,
                                           String issuer,
                                           @NotBlank
                                           @NotBlank IClientDescriptor clientDescriptor)
                                    throws TokenCreateException

Throws:

TokenCreateException

removeRefreshToken

public boolean removeRefreshToken(UserContext uc,
                                  String refreshToken,
                                  IClientDescriptor clientDescriptor)

removeRefreshToken

public boolean removeRefreshToken(UserContext uc,
                                  UserRefreshToken token)

getInstance

public static UserTokenAPI getInstance()

getUserRefreshTokens

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