org.keycloak.authentication.actiontoken.AbstractActionTokenHander< T extends JsonWebToken > クラステンプレート

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

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

公開メンバ関数
	AbstractActionTokenHander (String id, Class< T > tokenClass, String defaultErrorMessage, EventType defaultEventType, String defaultEventError)
ActionTokenHandler< T >	create (KeycloakSession session)
void	init (Scope config)
void	postInit (KeycloakSessionFactory factory)
String	getId ()
void	close ()
Class< T >	getTokenClass ()
EventType	eventType ()
String	getDefaultErrorMessage ()
String	getDefaultEventError ()
String	getAuthenticationSessionIdFromToken (T token, ActionTokenContext< T > tokenContext, AuthenticationSessionModel currentAuthSession)
AuthenticationSessionModel	startFreshAuthenticationSession (T token, ActionTokenContext< T > tokenContext)
boolean	canUseTokenRepeatedly (T token, ActionTokenContext< T > tokenContext)
Response	handleToken (T token, ActionTokenContext< T > tokenContext)
default Predicate<? super T > []	getVerifiers (ActionTokenContext< T > tokenContext)

非公開変数類
final String	id
final Class< T >	tokenClass
final String	defaultErrorMessage
final EventType	defaultEventType
final String	defaultEventError

詳解

著者

hmlnarik

構築子と解体子

AbstractActionTokenHander()

org.keycloak.authentication.actiontoken.AbstractActionTokenHander< T extends JsonWebToken >.AbstractActionTokenHander ( String  id, Class< T >  tokenClass, String  defaultErrorMessage, EventType  defaultEventType, String  defaultEventError  )

inline

                                                                                                                                                       {
        this.id = id;
        this.tokenClass = tokenClass;
        this.defaultErrorMessage = defaultErrorMessage;
        this.defaultEventType = defaultEventType;
        this.defaultEventError = defaultEventError;
    }

関数詳解

canUseTokenRepeatedly()

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

inline

                                                                                      {
        return true;
    }

close()

void org.keycloak.authentication.actiontoken.AbstractActionTokenHander< T extends JsonWebToken >.close ( )

inline

                        {
    }

create()

ActionTokenHandler<T> org.keycloak.authentication.actiontoken.AbstractActionTokenHander< T extends JsonWebToken >.create ( KeycloakSession  session )

inline

                                                                 {
        return this;
    }

eventType()

EventType org.keycloak.authentication.actiontoken.AbstractActionTokenHander< T extends JsonWebToken >.eventType ( )

inline

                                 {
        return this.defaultEventType;
    }

getAuthenticationSessionIdFromToken()

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

inline

                                                                                                                                                  {
        return token instanceof DefaultActionToken ? ((DefaultActionToken) token).getCompoundAuthenticationSessionId() : null;
    }

getDefaultErrorMessage()

String org.keycloak.authentication.actiontoken.AbstractActionTokenHander< T extends JsonWebToken >.getDefaultErrorMessage ( )

inline

                                           {
        return this.defaultErrorMessage;
    }

getDefaultEventError()

String org.keycloak.authentication.actiontoken.AbstractActionTokenHander< T extends JsonWebToken >.getDefaultEventError ( )

inline

                                         {
        return this.defaultEventError;
    }

getId()

String org.keycloak.authentication.actiontoken.AbstractActionTokenHander< T extends JsonWebToken >.getId ( )

inline

                          {
        return this.id;
    }

getTokenClass()

Class<T> org.keycloak.authentication.actiontoken.AbstractActionTokenHander< T extends JsonWebToken >.getTokenClass ( )

inline

                                    {
        return this.tokenClass;
    }

getVerifiers()

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

inlineinherited

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  )

inherited

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

引数

token
tokenContext

戻り値

init()

void org.keycloak.authentication.actiontoken.AbstractActionTokenHander< T extends JsonWebToken >.init ( Scope  config )

inline

                                   {
    }

postInit()

void org.keycloak.authentication.actiontoken.AbstractActionTokenHander< T extends JsonWebToken >.postInit ( KeycloakSessionFactory  factory )

inline

                                                         {
    }

startFreshAuthenticationSession()

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

inline

                                                                                                                   {
        AuthenticationSessionModel authSession = tokenContext.createAuthenticationSessionForClient(token.getIssuedFor());
        authSession.setAuthNote(AuthenticationManager.END_AFTER_REQUIRED_ACTIONS, "true");
        return authSession;
    }

メンバ詳解

defaultErrorMessage

final String org.keycloak.authentication.actiontoken.AbstractActionTokenHander< T extends JsonWebToken >.defaultErrorMessage

private

defaultEventError

final String org.keycloak.authentication.actiontoken.AbstractActionTokenHander< T extends JsonWebToken >.defaultEventError

private

defaultEventType

final EventType org.keycloak.authentication.actiontoken.AbstractActionTokenHander< T extends JsonWebToken >.defaultEventType

private

id

final String org.keycloak.authentication.actiontoken.AbstractActionTokenHander< T extends JsonWebToken >.id

private

tokenClass

final Class<T> org.keycloak.authentication.actiontoken.AbstractActionTokenHander< T extends JsonWebToken >.tokenClass

private

---

このクラス詳解は次のファイルから抽出されました:

• D:/AppData/doxygen/keycloak/src/keycloak/src/main/java/org/keycloak/authentication/actiontoken/AbstractActionTokenHander.java