org.keycloak.authentication.actiontoken.ActionTokenHandler< T extends JsonWebToken > インタフェーステンプレート

org.keycloak.authentication.actiontoken.ActionTokenHandler< T extends JsonWebToken > の継承関係図

org.keycloak.authentication.actiontoken.ActionTokenHandler< T extends JsonWebToken > 連携図

公開メンバ関数
Response	handleToken (T token, ActionTokenContext< T > tokenContext)
Class< T >	getTokenClass ()
default Predicate<? super T > []	getVerifiers (ActionTokenContext< T > tokenContext)
String	getAuthenticationSessionIdFromToken (T token, ActionTokenContext< T > tokenContext, AuthenticationSessionModel currentAuthSession)
EventType	eventType ()
String	getDefaultEventError ()
String	getDefaultErrorMessage ()
AuthenticationSessionModel	startFreshAuthenticationSession (T token, ActionTokenContext< T > tokenContext) throws VerificationException
boolean	canUseTokenRepeatedly (T token, ActionTokenContext< T > tokenContext)

詳解

Handler of the action token.

引数

<T>	Class implementing the action token

著者

hmlnarik

関数詳解

canUseTokenRepeatedly()

boolean org.keycloak.authentication.actiontoken.ActionTokenHandler< T extends JsonWebToken >.canUseTokenRepeatedly	(	T	token,
		ActionTokenContext< T >	tokenContext
	)

Returns

true 

when the token can be used repeatedly to invoke the action,

false 

when the token is intended to be for single use only.

戻り値

see above

eventType()

EventType org.keycloak.authentication.actiontoken.ActionTokenHandler< T extends JsonWebToken >.eventType

(

)

Returns a event type logged with EventBuilder class.

戻り値

getAuthenticationSessionIdFromToken()

String org.keycloak.authentication.actiontoken.ActionTokenHandler< T extends JsonWebToken >.getAuthenticationSessionIdFromToken	(	T	token,
		ActionTokenContext< T >	tokenContext,
		AuthenticationSessionModel	currentAuthSession
	)

Returns a compound authentication session ID requested from within the given token that the handler should attempt to join.

引数

token	Token. Can be null
tokenContext
currentAuthSession	Authentication session that is currently in progress, null if no authentication session is not set

参照

AuthenticationSessionCompoundId

戻り値

Authentication session ID (can be

null 

if the token does not contain authentication session ID)

getDefaultErrorMessage()

String org.keycloak.authentication.actiontoken.ActionTokenHandler< T extends JsonWebToken >.getDefaultErrorMessage

(

)

Returns an error to be shown in the response when token handling fails and no more specific error message is provided.

戻り値

getDefaultEventError()

String org.keycloak.authentication.actiontoken.ActionTokenHandler< T extends JsonWebToken >.getDefaultEventError

(

)

Returns an error to be shown in the EventBuilder detail when token handling fails and no more specific error is provided.

戻り値

getTokenClass()

Class<T> org.keycloak.authentication.actiontoken.ActionTokenHandler< T extends JsonWebToken >.getTokenClass

(

)

Returns the Java token class for use with deserialization.

戻り値

getVerifiers()

default Predicate<? super T> [] org.keycloak.authentication.actiontoken.ActionTokenHandler< T extends JsonWebToken >.getVerifiers ( ActionTokenContext< T >  tokenContext )

inline

Returns an array of verifiers that are tested prior to handling the token. All verifiers have to pass successfully for token to be handled. The returned array must not be

null 

.

引数

tokenContext

戻り値

Verifiers or an empty array. The returned array must not be

null 

.

                                                                                    {
        return new Predicate[] {};
    }

handleToken()

Response org.keycloak.authentication.actiontoken.ActionTokenHandler< T extends JsonWebToken >.handleToken	(	T	token,
		ActionTokenContext< T >	tokenContext
	)

Performs the action as per the token details. This method is only called if all verifiers returned in handleToken succeed.

引数

token
tokenContext

戻り値

startFreshAuthenticationSession()

AuthenticationSessionModel org.keycloak.authentication.actiontoken.ActionTokenHandler< T extends JsonWebToken >.startFreshAuthenticationSession	(	T	token,
		ActionTokenContext< T >	tokenContext
	)		throws VerificationException

Creates a fresh authentication session according to the information from the token. The default implementation creates a new authentication session that requests termination after required actions.

引数

token
tokenContext

戻り値

---

このインタフェース詳解は次のファイルから抽出されました:

• D:/AppData/doxygen/keycloak/rest-service/src/services/src/main/java/org/keycloak/authentication/actiontoken/ActionTokenHandler.java