Package io.jans.as.server.model.common

Class AbstractAuthorizationGrant

java.lang.Object

io.jans.as.server.model.common.AbstractAuthorizationGrant

All Implemented Interfaces:

IAuthorizationGrant

Direct Known Subclasses:

AuthorizationGrant

public abstract class AbstractAuthorizationGrant
extends java.lang.Object
implements IAuthorizationGrant

Version:

September 30, 2021

Author:

Yuriy Zabrovarnyy, Javier Rojas Blum, Yuriy Movchan

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.concurrent.ConcurrentMap<java.lang.String,AccessToken>	accessTokens
protected io.jans.as.model.configuration.AppConfiguration	appConfiguration
protected java.util.concurrent.ConcurrentMap<java.lang.String,RefreshToken>	refreshTokens
protected ScopeChecker	scopeChecker

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractAuthorizationGrant()
protected	AbstractAuthorizationGrant(io.jans.as.common.model.common.User user, AuthorizationGrantType authorizationGrantType, io.jans.as.common.model.registration.Client client, java.util.Date authenticationTime)

Method Summary

Modifier and Type	Method	Description
java.lang.String	checkScopesPolicy(java.lang.String requestedScopes)	Checks the scopes policy configured according to the type of the authorization grant to limit the issued token scopes.
AccessToken	createAccessToken(ExecutionContext executionContext)
RefreshToken	createRefreshToken(ExecutionContext context)
RefreshToken	createRefreshToken(ExecutionContext context, int lifetime)
AbstractToken	getAccessToken(java.lang.String tokenCode)	Gets the access token instance from the id token list or the access token list given its code.
java.util.List<AccessToken>	getAccessTokens()	Returns a list with all the issued access tokens.
java.util.Set<java.lang.String>	getAccessTokensCodes()	Returns a list with all the issued access tokens codes.
java.lang.String	getAcrValues()
java.util.Date	getAuthenticationTime()
AuthorizationCode	getAuthorizationCode()	Returns the AuthorizationCode.
AuthorizationGrantType	getAuthorizationGrantType()	Returns the AuthorizationGrantType.
java.lang.String	getClaims()
io.jans.as.common.model.registration.Client	getClient()	Returns the Client.
java.lang.String	getClientDn()
java.lang.String	getClientId()
java.lang.String	getCodeChallenge()
java.lang.String	getCodeChallengeMethod()
java.lang.String	getGrantId()
IdToken	getIdToken()
JwtAuthorizationRequest	getJwtAuthorizationRequest()
AccessToken	getLongLivedAccessToken()
java.lang.String	getNonce()
RefreshToken	getRefreshToken(java.lang.String refreshTokenCode)	Gets the refresh token instance from the refresh token list given its code.
java.util.List<RefreshToken>	getRefreshTokens()	Returns a list with all the issued refresh tokens.
java.util.Set<java.lang.String>	getRefreshTokensCodes()	Returns a list with all the issued refresh tokens codes.
java.util.Set<java.lang.String>	getScopes()	Returns a list of the scopes granted to the client.
java.lang.String	getSessionDn()
java.lang.String	getTokenBindingHash()
TokenEntity	getTokenEntity()
io.jans.as.common.model.common.User	getUser()	Returns the resource owner's.
java.lang.String	getUserDn()
java.lang.String	getUserId()
java.lang.String	getX5cs256()
protected void	init(io.jans.as.common.model.common.User user, AuthorizationGrantType authorizationGrantType, io.jans.as.common.model.registration.Client client, java.util.Date authenticationTime)
void	setAccessTokens(java.util.List<AccessToken> accessTokens)
void	setAcrValues(java.lang.String acrValues)
void	setAuthenticationTime(java.util.Date authenticationTime)
void	setAuthorizationCode(AuthorizationCode authorizationCode)	Sets the AuthorizationCode.
void	setClaims(java.lang.String claims)
void	setCodeChallenge(java.lang.String codeChallenge)
void	setCodeChallengeMethod(java.lang.String codeChallengeMethod)
void	setGrantId(java.lang.String grantId)
void	setIdToken(IdToken idToken)
void	setJwtAuthorizationRequest(JwtAuthorizationRequest jwtAuthorizationRequest)
void	setLongLivedAccessToken(AccessToken longLivedAccessToken)
void	setNonce(java.lang.String nonce)
void	setRefreshTokens(java.util.List<RefreshToken> refreshTokens)
void	setScopes(java.util.Collection<java.lang.String> scopes)
void	setSessionDn(java.lang.String sessionDn)
void	setTokenBindingHash(java.lang.String tokenBindingHash)
void	setTokenEntity(TokenEntity tokenEntity)
void	setX5cs256(java.lang.String x5cs256)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.jans.as.server.model.common.IAuthorizationGrant

checkExpiredTokens, createIdToken, getGrantType, getSub, revokeAllTokens, save

Field Detail

appConfiguration

@Inject
protected io.jans.as.model.configuration.AppConfiguration appConfiguration

scopeChecker

@Inject
protected ScopeChecker scopeChecker

accessTokens

protected final java.util.concurrent.ConcurrentMap<java.lang.String,AccessToken> accessTokens

refreshTokens

protected final java.util.concurrent.ConcurrentMap<java.lang.String,RefreshToken> refreshTokens

Constructor Detail

AbstractAuthorizationGrant

protected AbstractAuthorizationGrant()

AbstractAuthorizationGrant

protected AbstractAuthorizationGrant(io.jans.as.common.model.common.User user,
                                     AuthorizationGrantType authorizationGrantType,
                                     io.jans.as.common.model.registration.Client client,
                                     java.util.Date authenticationTime)

Method Detail

init

protected void init(io.jans.as.common.model.common.User user,
                    AuthorizationGrantType authorizationGrantType,
                    io.jans.as.common.model.registration.Client client,
                    java.util.Date authenticationTime)

getGrantId

public java.lang.String getGrantId()

Specified by:

getGrantId in interface IAuthorizationGrant

setGrantId

public void setGrantId(java.lang.String grantId)

Specified by:

setGrantId in interface IAuthorizationGrant

getAuthorizationCode

public AuthorizationCode getAuthorizationCode()

Returns the AuthorizationCode.

Specified by:

getAuthorizationCode in interface IAuthorizationGrant

Returns:

The authorization code.

setAuthorizationCode

public void setAuthorizationCode(AuthorizationCode authorizationCode)

Sets the AuthorizationCode.

Specified by:

setAuthorizationCode in interface IAuthorizationGrant

Parameters:

authorizationCode - The authorization code.

getTokenBindingHash

public java.lang.String getTokenBindingHash()

setTokenBindingHash

public void setTokenBindingHash(java.lang.String tokenBindingHash)

getX5cs256

public java.lang.String getX5cs256()

setX5cs256

public void setX5cs256(java.lang.String x5cs256)

getNonce

public java.lang.String getNonce()

Specified by:

getNonce in interface IAuthorizationGrant

setNonce

public void setNonce(java.lang.String nonce)

Specified by:

setNonce in interface IAuthorizationGrant

getCodeChallenge

public java.lang.String getCodeChallenge()

setCodeChallenge

public void setCodeChallenge(java.lang.String codeChallenge)

getCodeChallengeMethod

public java.lang.String getCodeChallengeMethod()

setCodeChallengeMethod

public void setCodeChallengeMethod(java.lang.String codeChallengeMethod)

getClaims

public java.lang.String getClaims()

setClaims

public void setClaims(java.lang.String claims)

getRefreshTokensCodes

public java.util.Set<java.lang.String> getRefreshTokensCodes()

Returns a list with all the issued refresh tokens codes.

Specified by:

getRefreshTokensCodes in interface IAuthorizationGrant

Returns:

List with all the issued refresh tokens codes.

getAccessTokensCodes

public java.util.Set<java.lang.String> getAccessTokensCodes()

Returns a list with all the issued access tokens codes.

Specified by:

getAccessTokensCodes in interface IAuthorizationGrant

Returns:

List with all the issued access tokens codes.

getAccessTokens

public java.util.List<AccessToken> getAccessTokens()

Returns a list with all the issued access tokens.

Specified by:

getAccessTokens in interface IAuthorizationGrant

Returns:

List with all the issued access tokens.

setScopes

public void setScopes(java.util.Collection<java.lang.String> scopes)

Specified by:

setScopes in interface IAuthorizationGrant

getLongLivedAccessToken

public AccessToken getLongLivedAccessToken()

Specified by:

getLongLivedAccessToken in interface IAuthorizationGrant

setLongLivedAccessToken

public void setLongLivedAccessToken(AccessToken longLivedAccessToken)

Specified by:

setLongLivedAccessToken in interface IAuthorizationGrant

getIdToken

public IdToken getIdToken()

Specified by:

getIdToken in interface IAuthorizationGrant

setIdToken

public void setIdToken(IdToken idToken)

Specified by:

setIdToken in interface IAuthorizationGrant

getTokenEntity

public TokenEntity getTokenEntity()

Specified by:

getTokenEntity in interface IAuthorizationGrant

setTokenEntity

public void setTokenEntity(TokenEntity tokenEntity)

Specified by:

setTokenEntity in interface IAuthorizationGrant

getUser

public io.jans.as.common.model.common.User getUser()

Returns the resource owner's.

Specified by:

getUser in interface IAuthorizationGrant

Returns:

The resource owner's.

getAcrValues

public java.lang.String getAcrValues()

Specified by:

getAcrValues in interface IAuthorizationGrant

setAcrValues

public void setAcrValues(java.lang.String acrValues)

Specified by:

setAcrValues in interface IAuthorizationGrant

getSessionDn

public java.lang.String getSessionDn()

Specified by:

getSessionDn in interface IAuthorizationGrant

setSessionDn

public void setSessionDn(java.lang.String sessionDn)

Specified by:

setSessionDn in interface IAuthorizationGrant

checkScopesPolicy

public java.lang.String checkScopesPolicy(java.lang.String requestedScopes)

Checks the scopes policy configured according to the type of the authorization grant to limit the issued token scopes.

Specified by:

checkScopesPolicy in interface IAuthorizationGrant

Parameters:

requestedScopes - A space-delimited list of values in which the order of values does not matter.

Returns:

A space-delimited list of scopes

createAccessToken

public AccessToken createAccessToken(ExecutionContext executionContext)

Specified by:

createAccessToken in interface IAuthorizationGrant

createRefreshToken

public RefreshToken createRefreshToken(ExecutionContext context)

Specified by:

createRefreshToken in interface IAuthorizationGrant

createRefreshToken

public RefreshToken createRefreshToken(ExecutionContext context,
                                       int lifetime)

Specified by:

createRefreshToken in interface IAuthorizationGrant

getUserId

public java.lang.String getUserId()

Specified by:

getUserId in interface IAuthorizationGrant

getUserDn

public java.lang.String getUserDn()

Specified by:

getUserDn in interface IAuthorizationGrant

getAuthorizationGrantType

public AuthorizationGrantType getAuthorizationGrantType()

Returns the AuthorizationGrantType.

Specified by:

getAuthorizationGrantType in interface IAuthorizationGrant

Returns:

The authorization grant type.

getClient

public io.jans.as.common.model.registration.Client getClient()

Returns the Client. An application making protected resource requests on behalf of the resource owner and with its authorization.

Specified by:

getClient in interface IAuthorizationGrant

Returns:

The client.

getClientId

public java.lang.String getClientId()

Specified by:

getClientId in interface IAuthorizationGrant

getClientDn

public java.lang.String getClientDn()

Specified by:

getClientDn in interface IAuthorizationGrant

getAuthenticationTime

public java.util.Date getAuthenticationTime()

Specified by:

getAuthenticationTime in interface IAuthorizationGrant

setAuthenticationTime

public void setAuthenticationTime(java.util.Date authenticationTime)

getScopes

public java.util.Set<java.lang.String> getScopes()

Returns a list of the scopes granted to the client.

Specified by:

getScopes in interface IAuthorizationGrant

Returns:

List of the scopes granted to the client.

getJwtAuthorizationRequest

public JwtAuthorizationRequest getJwtAuthorizationRequest()

Specified by:

getJwtAuthorizationRequest in interface IAuthorizationGrant

setJwtAuthorizationRequest

public void setJwtAuthorizationRequest(JwtAuthorizationRequest jwtAuthorizationRequest)

Specified by:

setJwtAuthorizationRequest in interface IAuthorizationGrant

setAccessTokens

public void setAccessTokens(java.util.List<AccessToken> accessTokens)

Specified by:

setAccessTokens in interface IAuthorizationGrant

getRefreshTokens

public java.util.List<RefreshToken> getRefreshTokens()

Returns a list with all the issued refresh tokens.

Specified by:

getRefreshTokens in interface IAuthorizationGrant

Returns:

List with all the issued refresh tokens.

setRefreshTokens

public void setRefreshTokens(java.util.List<RefreshToken> refreshTokens)

Specified by:

setRefreshTokens in interface IAuthorizationGrant

getRefreshToken

public RefreshToken getRefreshToken(java.lang.String refreshTokenCode)

Gets the refresh token instance from the refresh token list given its code.

Specified by:

getRefreshToken in interface IAuthorizationGrant

Parameters:

refreshTokenCode - The code of the refresh token.

Returns:

The refresh token instance or null if not found.

getAccessToken

public AbstractToken getAccessToken(java.lang.String tokenCode)

Gets the access token instance from the id token list or the access token list given its code.

Specified by:

getAccessToken in interface IAuthorizationGrant

Parameters:

tokenCode - The code of the access token.

Returns:

The access token instance or null if not found.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object