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 Object
implements IAuthorizationGrant

Version:

September 30, 2021

Author:

Yuriy Zabrovarnyy, Javier Rojas Blum, Yuriy Movchan

Field Summary

Fields

Modifier and Type	Field	Description
protected final ConcurrentMap<String,AccessToken>	accessTokens
protected io.jans.as.model.configuration.AppConfiguration	appConfiguration
protected final ConcurrentMap<String,LogoutStatusJwt>	logoutStatusJwts
protected final ConcurrentMap<String,RefreshToken>	refreshTokens
protected ScopeChecker	scopeChecker
protected final ConcurrentMap<String,TxToken>	txTokens

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, Date authenticationTime)

Method Summary

Modifier and Type	Method	Description
String	checkScopesPolicy(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(String tokenCode)	Gets the access token instance from the id token list or the access token list given its code.
int	getAccessTokenLifetimeInSeconds(ExecutionContext executionContext)
List<AccessToken>	getAccessTokens()	Returns a list with all the issued access tokens.
Set<String>	getAccessTokensCodes()	Returns a list with all the issued access tokens codes.
String	getAcrValues()
Date	getAuthenticationTime()
AuthorizationCode	getAuthorizationCode()	Returns the AuthorizationCode.
AuthorizationGrantType	getAuthorizationGrantType()	Returns the AuthorizationGrantType.
io.jans.as.model.authzdetails.AuthzDetails	getAuthzDetails()
String	getAuthzDetailsAsString()
String	getClaims()
io.jans.as.common.model.registration.Client	getClient()	Returns the Client.
String	getClientDn()
String	getClientId()
String	getCodeChallenge()
String	getCodeChallengeMethod()
String	getDpopJkt()
String	getGrantId()
IdToken	getIdToken()
JwtAuthorizationRequest	getJwtAuthorizationRequest()
LogoutStatusJwt	getLogoutStatusJwt(String logoutStatusJwtCode)	Gets the logout out jwt instance from the logout status jwt list given its code.
List<LogoutStatusJwt>	getLogoutStatusJwts()	Returns a list with all the issued logout status jwts.
Set<String>	getLogoutStatusJwtsCodes()	Returns a list with all the issued logout status jwts.
AccessToken	getLongLivedAccessToken()
String	getNonce()
String	getReferenceId()
RefreshToken	getRefreshToken(String refreshTokenCode)	Gets the refresh token instance from the refresh token list given its code.
List<RefreshToken>	getRefreshTokens()	Returns a list with all the issued refresh tokens.
Set<String>	getRefreshTokensCodes()	Returns a list with all the issued refresh tokens codes.
Set<String>	getScopes()	Returns a list of the scopes granted to the client.
String	getSessionDn()
Integer	getStatusListIndex()
String	getTokenBindingHash()
io.jans.model.token.TokenEntity	getTokenEntity()
TxToken	getTxToken(String txTokenCode)
List<TxToken>	getTxTokens()
io.jans.as.common.model.common.User	getUser()	Returns the resource owner's.
String	getUserDn()
String	getUserId()
String	getX5ts256()
protected void	init(io.jans.as.common.model.common.User user, AuthorizationGrantType authorizationGrantType, io.jans.as.common.model.registration.Client client, Date authenticationTime)
boolean	isAuthorizationChallenge()
void	setAccessTokens(List<AccessToken> accessTokens)
void	setAcrValues(String acrValues)
void	setAuthenticationTime(Date authenticationTime)
AbstractAuthorizationGrant	setAuthorizationChallenge(boolean authorizationChallenge)
void	setAuthorizationCode(AuthorizationCode authorizationCode)	Sets the AuthorizationCode.
void	setAuthzDetails(io.jans.as.model.authzdetails.AuthzDetails authzDetails)
void	setClaims(String claims)
void	setCodeChallenge(String codeChallenge)
void	setCodeChallengeMethod(String codeChallengeMethod)
void	setDpopJkt(String dpopJkt)
void	setGrantId(String grantId)
void	setIdToken(IdToken idToken)
void	setJwtAuthorizationRequest(JwtAuthorizationRequest jwtAuthorizationRequest)
void	setLogoutStatusJwts(List<LogoutStatusJwt> tokens)
void	setLongLivedAccessToken(AccessToken longLivedAccessToken)
void	setNonce(String nonce)
void	setReferenceId(String referenceId)
void	setRefreshTokens(List<RefreshToken> refreshTokens)
void	setScopes(Collection<String> scopes)
void	setSessionDn(String sessionDn)
void	setStatusListIndex(Integer statusListIndex)
void	setTokenBindingHash(String tokenBindingHash)
void	setTokenEntity(io.jans.model.token.TokenEntity tokenEntity)
void	setTxTokens(List<TxToken> txTokens)
void	setX5ts256(String x5ts256)
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, createLogoutStatusJwt, getGrantType, getSub, revokeAllTokens, save

Field Details

appConfiguration

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

scopeChecker

@Inject
protected ScopeChecker scopeChecker

txTokens

protected final ConcurrentMap<String,TxToken> txTokens

accessTokens

protected final ConcurrentMap<String,AccessToken> accessTokens

refreshTokens

protected final ConcurrentMap<String,RefreshToken> refreshTokens

logoutStatusJwts

protected final ConcurrentMap<String,LogoutStatusJwt> logoutStatusJwts

Constructor Details

AbstractAuthorizationGrant

protected AbstractAuthorizationGrant()

AbstractAuthorizationGrant

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

Method Details

init

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

getReferenceId

public String getReferenceId()

setReferenceId

public void setReferenceId(String referenceId)

isAuthorizationChallenge

public boolean isAuthorizationChallenge()

setAuthorizationChallenge

public AbstractAuthorizationGrant setAuthorizationChallenge(boolean authorizationChallenge)

getStatusListIndex

public Integer getStatusListIndex()

setStatusListIndex

public void setStatusListIndex(Integer statusListIndex)

getDpopJkt

public String getDpopJkt()

setDpopJkt

public void setDpopJkt(String dpopJkt)

getGrantId

public String getGrantId()

Specified by:

getGrantId in interface IAuthorizationGrant

setGrantId

public void setGrantId(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 String getTokenBindingHash()

setTokenBindingHash

public void setTokenBindingHash(String tokenBindingHash)

getX5ts256

public String getX5ts256()

setX5ts256

public void setX5ts256(String x5ts256)

getNonce

public String getNonce()

Specified by:

getNonce in interface IAuthorizationGrant

setNonce

public void setNonce(String nonce)

Specified by:

setNonce in interface IAuthorizationGrant

getCodeChallenge

public String getCodeChallenge()

setCodeChallenge

public void setCodeChallenge(String codeChallenge)

getCodeChallengeMethod

public String getCodeChallengeMethod()

setCodeChallengeMethod

public void setCodeChallengeMethod(String codeChallengeMethod)

getClaims

public String getClaims()

setClaims

public void setClaims(String claims)

getRefreshTokensCodes

public Set<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.

getLogoutStatusJwtsCodes

public Set<String> getLogoutStatusJwtsCodes()

Returns a list with all the issued logout status jwts.

Specified by:

getLogoutStatusJwtsCodes in interface IAuthorizationGrant

Returns:

List with all the issued logout status jwts.

getAccessTokensCodes

public Set<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 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.

getTxTokens

public List<TxToken> getTxTokens()

getTxToken

public TxToken getTxToken(String txTokenCode)

setScopes

public void setScopes(Collection<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 io.jans.model.token.TokenEntity getTokenEntity()

Specified by:

getTokenEntity in interface IAuthorizationGrant

setTokenEntity

public void setTokenEntity(io.jans.model.token.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 String getAcrValues()

Specified by:

getAcrValues in interface IAuthorizationGrant

setAcrValues

public void setAcrValues(String acrValues)

Specified by:

setAcrValues in interface IAuthorizationGrant

getSessionDn

public String getSessionDn()

Specified by:

getSessionDn in interface IAuthorizationGrant

setSessionDn

public void setSessionDn(String sessionDn)

Specified by:

setSessionDn in interface IAuthorizationGrant

checkScopesPolicy

public String checkScopesPolicy(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

getAccessTokenLifetimeInSeconds

public int getAccessTokenLifetimeInSeconds(ExecutionContext executionContext)

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 String getUserId()

Specified by:

getUserId in interface IAuthorizationGrant

getUserDn

public 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 String getClientId()

Specified by:

getClientId in interface IAuthorizationGrant

getClientDn

public String getClientDn()

Specified by:

getClientDn in interface IAuthorizationGrant

getAuthenticationTime

public Date getAuthenticationTime()

Specified by:

getAuthenticationTime in interface IAuthorizationGrant

setAuthenticationTime

public void setAuthenticationTime(Date authenticationTime)

getScopes

public Set<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.

getAuthzDetailsAsString

public String getAuthzDetailsAsString()

getAuthzDetails

public io.jans.as.model.authzdetails.AuthzDetails getAuthzDetails()

setAuthzDetails

public void setAuthzDetails(io.jans.as.model.authzdetails.AuthzDetails authzDetails)

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(List<AccessToken> accessTokens)

Specified by:

setAccessTokens in interface IAuthorizationGrant

setTxTokens

public void setTxTokens(List<TxToken> txTokens)

Specified by:

setTxTokens in interface IAuthorizationGrant

getLogoutStatusJwts

public List<LogoutStatusJwt> getLogoutStatusJwts()

Returns a list with all the issued logout status jwts.

Specified by:

getLogoutStatusJwts in interface IAuthorizationGrant

Returns:

List with all the issued logout status jwts.

setLogoutStatusJwts

public void setLogoutStatusJwts(List<LogoutStatusJwt> tokens)

Specified by:

setLogoutStatusJwts in interface IAuthorizationGrant

getLogoutStatusJwt

public LogoutStatusJwt getLogoutStatusJwt(String logoutStatusJwtCode)

Gets the logout out jwt instance from the logout status jwt list given its code.

Specified by:

getLogoutStatusJwt in interface IAuthorizationGrant

Parameters:

logoutStatusJwtCode - The code of the logout status jwt.

Returns:

The logout status jwt instance or null if not found.

getRefreshTokens

public 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(List<RefreshToken> refreshTokens)

Specified by:

setRefreshTokens in interface IAuthorizationGrant

getRefreshToken

public RefreshToken getRefreshToken(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(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 String toString()

Overrides:

toString in class Object