public interface TokenProvider
Modifier and Type | Field and Description |
---|---|
static String |
PARAM_TOKEN_EXPIRATION
Optional configuration parameter to set the token expiration time in ms.
|
static String |
PARAM_TOKEN_LENGTH
Optional configuration parameter to define the length of the key.
|
static String |
PARAM_TOKEN_REFRESH
Optional configuration parameter to define if a given token should be
refreshed or not.
|
Modifier and Type | Method and Description |
---|---|
@Nullable TokenInfo |
createToken(@NotNull Credentials credentials)
Issues a new login token for the user with the specified credentials
and returns the associated
TokenInfo . |
@Nullable TokenInfo |
createToken(@NotNull String userId,
@NotNull Map<String,?> attributes)
Issues a new login token for the user with the given
userId
and the specified attributes. |
boolean |
doCreateToken(@NotNull Credentials credentials)
Returns
true if the given credentials indicate that a new token
needs to be issued. |
@Nullable TokenInfo |
getTokenInfo(@NotNull String token)
Retrieves the
TokenInfo associated with the specified login token
or null . |
static final String PARAM_TOKEN_EXPIRATION
static final String PARAM_TOKEN_LENGTH
static final String PARAM_TOKEN_REFRESH
boolean doCreateToken(@NotNull @NotNull Credentials credentials)
true
if the given credentials indicate that a new token
needs to be issued.credentials
- The current credentials.true
if a new login token needs to be created, false
otherwise.@Nullable @Nullable TokenInfo createToken(@NotNull @NotNull Credentials credentials)
TokenInfo
.credentials
- The current credentials.TokenInfo
associated with the new login token or
null
if no token has been created.@Nullable @Nullable TokenInfo createToken(@NotNull @NotNull String userId, @NotNull @NotNull Map<String,?> attributes)
userId
and the specified attributes.userId
- The identifier of the user for which a new token should
be created.attributes
- The attributes associated with the new token.TokenInfo
associated with the new login token or
null
if no token has been created.Copyright © 2010 - 2020 Adobe. All Rights Reserved