fish.payara.security.openid.domain

Class OpenIdContextImpl

java.lang.Object

fish.payara.security.openid.domain.OpenIdContextImpl

All Implemented Interfaces:

OpenIdContext, Serializable

@SessionScoped
public class OpenIdContextImpl
extends Object
implements OpenIdContext

An injectable interface that provides access to access token, identity token, claims and OpenId Connect provider related information.

Author:

Gaurav Gupta

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
OpenIdContextImpl()

Method Summary

Modifier and Type	Method and Description
AccessToken	getAccessToken() Gets the authorization token that was received from the OpenId Connect provider
Set<String>	getCallerGroups() Gets the groups associated with the caller
String	getCallerName() Gets the caller name of the validated caller
OpenIdClaims	getClaims() Gets the User Claims that was received from the userinfo endpoint
javax.json.JsonObject	getClaimsJson() Gets the User Claims that was received from the userinfo endpoint
Optional<Long>	getExpiresIn() Return the time that the access token is granted for, if it is set to expire
IdentityToken	getIdentityToken() Gets the identity token that was received from the OpenId Connect provider
javax.json.JsonObject	getProviderMetadata() The OpenId Connect Provider's metadata document fetched via provider URI.
Optional<RefreshToken>	getRefreshToken() Returns the refresh token that can be used to get a new access token
String	getSubject() Subject Identifier.
String	getTokenType() Gets the token type value.
void	logout(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Invalidates the RP's active OpenId Connect session and if LogoutDefinition.notifyProvider() set to true then redirect the End-User's User Agent to the end_session_endpoint to notify the OP that the user has logged out of the RP's application and ask the user whether they want to logout from the OP as well.
void	setAccessToken(AccessToken token)
void	setCallerGroups(Set<String> callerGroups)
void	setCallerName(String callerName)
void	setClaims(javax.json.JsonObject claims)
void	setExpiresIn(Long expiresIn)
void	setIdentityToken(IdentityToken identityToken)
void	setOpenIdConfiguration(OpenIdConfiguration configuration)
void	setRefreshToken(RefreshToken refreshToken)
void	setTokenType(String tokenType)

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenIdContextImpl

public OpenIdContextImpl()

Method Detail

getCallerName

public String getCallerName()

Description copied from interface: OpenIdContext

Gets the caller name of the validated caller

Specified by:

getCallerName in interface OpenIdContext

Returns:

setCallerName

public void setCallerName(String callerName)

getCallerGroups

public Set<String> getCallerGroups()

Description copied from interface: OpenIdContext

Gets the groups associated with the caller

Specified by:

getCallerGroups in interface OpenIdContext

Returns:

setCallerGroups

public void setCallerGroups(Set<String> callerGroups)

getSubject

public String getSubject()

Description copied from interface: OpenIdContext

Subject Identifier. A locally unique and never reassigned identifier within the Issuer for the End-User, which is intended to be consumed by the Client

Specified by:

getSubject in interface OpenIdContext

Returns:

getTokenType

public String getTokenType()

Description copied from interface: OpenIdContext

Gets the token type value. The value MUST be Bearer or another token_type value that the Client has negotiated with the Authorization Server.

Specified by:

getTokenType in interface OpenIdContext

Returns:

setTokenType

public void setTokenType(String tokenType)

getAccessToken

public AccessToken getAccessToken()

Description copied from interface: OpenIdContext

Gets the authorization token that was received from the OpenId Connect provider

Specified by:

getAccessToken in interface OpenIdContext

Returns:

setAccessToken

public void setAccessToken(AccessToken token)

getIdentityToken

public IdentityToken getIdentityToken()

Description copied from interface: OpenIdContext

Gets the identity token that was received from the OpenId Connect provider

Specified by:

getIdentityToken in interface OpenIdContext

Returns:

setIdentityToken

public void setIdentityToken(IdentityToken identityToken)

getRefreshToken

public Optional<RefreshToken> getRefreshToken()

Description copied from interface: OpenIdContext

Returns the refresh token that can be used to get a new access token

Specified by:

getRefreshToken in interface OpenIdContext

Returns:

setRefreshToken

public void setRefreshToken(RefreshToken refreshToken)

getExpiresIn

public Optional<Long> getExpiresIn()

Description copied from interface: OpenIdContext

Return the time that the access token is granted for, if it is set to expire

Specified by:

getExpiresIn in interface OpenIdContext

Returns:

setExpiresIn

public void setExpiresIn(Long expiresIn)

getClaimsJson

public javax.json.JsonObject getClaimsJson()

Description copied from interface: OpenIdContext

Gets the User Claims that was received from the userinfo endpoint

Specified by:

getClaimsJson in interface OpenIdContext

Returns:

the claims json

getClaims

public OpenIdClaims getClaims()

Description copied from interface: OpenIdContext

Gets the User Claims that was received from the userinfo endpoint

Specified by:

getClaims in interface OpenIdContext

Returns:

the OpenIdClaims instance

setClaims

public void setClaims(javax.json.JsonObject claims)

getProviderMetadata

public javax.json.JsonObject getProviderMetadata()

Description copied from interface: OpenIdContext

The OpenId Connect Provider's metadata document fetched via provider URI.

Specified by:

getProviderMetadata in interface OpenIdContext

Returns:

setOpenIdConfiguration

public void setOpenIdConfiguration(OpenIdConfiguration configuration)

logout

public void logout(javax.servlet.http.HttpServletRequest request,
                   javax.servlet.http.HttpServletResponse response)

Description copied from interface: OpenIdContext

Invalidates the RP's active OpenId Connect session and if LogoutDefinition.notifyProvider() set to true then redirect the End-User's User Agent to the end_session_endpoint to notify the OP that the user has logged out of the RP's application and ask the user whether they want to logout from the OP as well. After successful logout, the End-User's User Agent redirect back to the RP's post_redirect_uri configured via LogoutDefinition.redirectURI()

Specified by:

logout in interface OpenIdContext