org.keycloak.authentication.actiontoken.execactions.ExecuteActionsActionToken クラス

org.keycloak.authentication.actiontoken.execactions.ExecuteActionsActionToken の継承関係図

org.keycloak.authentication.actiontoken.execactions.ExecuteActionsActionToken 連携図

公開メンバ関数
	ExecuteActionsActionToken (String userId, int absoluteExpirationInSecs, List< String > requiredActions, String redirectUri, String clientId)
List< String >	getRequiredActions ()
final void	setRequiredActions (List< String > requiredActions)
String	getRedirectUri ()
final void	setRedirectUri (String redirectUri)
String	getCompoundAuthenticationSessionId ()
final void	setCompoundAuthenticationSessionId (String authenticationSessionId)
Map< String, String >	getNotes ()
String	getNote (String name)
final String	setNote (String name, String value)
final String	removeNote (String name)
String	serialize (KeycloakSession session, RealmModel realm, UriInfo uri)
String	getUserId ()
String	getActionId ()
UUID	getActionVerificationNonce ()

静的公開メンバ関数
static DefaultActionTokenKey	from (String serializedKey)

静的公開変数類
static final String	TOKEN_TYPE = "execute-actions"
static final String	JSON_FIELD_AUTHENTICATION_SESSION_ID = "asid"
static final Predicate< DefaultActionTokenKey >	ACTION_TOKEN_BASIC_CHECKS
static final String	ACTION_TOKEN_USER_ID = "ACTION_TOKEN_USER"
static final String	JSON_FIELD_ACTION_VERIFICATION_NONCE = "nonce"

非公開メンバ関数
	ExecuteActionsActionToken ()

静的非公開変数類
static final String	JSON_FIELD_REQUIRED_ACTIONS = "rqac"
static final String	JSON_FIELD_REDIRECT_URI = "reduri"

詳解

著者

hmlnarik

構築子と解体子

ExecuteActionsActionToken() [1/2]

org.keycloak.authentication.actiontoken.execactions.ExecuteActionsActionToken.ExecuteActionsActionToken ( String  userId, int  absoluteExpirationInSecs, List< String >  requiredActions, String  redirectUri, String  clientId  )

inline

                                                                                                                                                     {
        super(userId, TOKEN_TYPE, absoluteExpirationInSecs, null);
        setRequiredActions(requiredActions == null ? new LinkedList<>() : new LinkedList<>(requiredActions));
        setRedirectUri(redirectUri);
        this.issuedFor = clientId;
    }

ExecuteActionsActionToken() [2/2]

org.keycloak.authentication.actiontoken.execactions.ExecuteActionsActionToken.ExecuteActionsActionToken ( )

inlineprivate

                                        {
    }

関数詳解

from()

static DefaultActionTokenKey org.keycloak.authentication.actiontoken.DefaultActionTokenKey.from ( String  serializedKey )

inlinestaticinherited

                                                                   {
        if (serializedKey == null) {
            return null;
        }
        String[] parsed = DOT.split(serializedKey, 4);
        if (parsed.length != 4) {
            return null;
        }

        String userId;
        try {
            userId = new String(Base64.decode(parsed[0]), StandardCharsets.UTF_8);
        } catch (IOException ex) {
            userId = parsed[0];
        }
        return new DefaultActionTokenKey(userId, parsed[3], Integer.parseInt(parsed[1]), UUID.fromString(parsed[2]));
    }

getActionId()

String org.keycloak.authentication.actiontoken.DefaultActionTokenKey.getActionId ( )

inlineinherited

                                {
        return getType();
    }

getActionVerificationNonce()

UUID org.keycloak.authentication.actiontoken.DefaultActionTokenKey.getActionVerificationNonce ( )

inlineinherited

                                             {
        return actionVerificationNonce;
    }

getCompoundAuthenticationSessionId()

String org.keycloak.authentication.actiontoken.DefaultActionToken.getCompoundAuthenticationSessionId ( )

inlineinherited

                                                       {
        return (String) getOtherClaims().get(JSON_FIELD_AUTHENTICATION_SESSION_ID);
    }

getNote()

String org.keycloak.authentication.actiontoken.DefaultActionToken.getNote ( String  name )

inlineinherited

                                       {
        Object res = getOtherClaims().get(name);
        return res instanceof String ? (String) res : null;
    }

getNotes()

Map<String, String> org.keycloak.authentication.actiontoken.DefaultActionToken.getNotes ( )

inlineinherited

                                          {
        Map<String, String> res = new HashMap<>();
        if (getCompoundAuthenticationSessionId() != null) {
            res.put(JSON_FIELD_AUTHENTICATION_SESSION_ID, getCompoundAuthenticationSessionId());
        }
        return res;
    }

getRedirectUri()

String org.keycloak.authentication.actiontoken.execactions.ExecuteActionsActionToken.getRedirectUri ( )

inline

                                   {
        return (String) getOtherClaims().get(JSON_FIELD_REDIRECT_URI);
    }

getRequiredActions()

List<String> org.keycloak.authentication.actiontoken.execactions.ExecuteActionsActionToken.getRequiredActions ( )

inline

                                             {
        return (List<String>) getOtherClaims().get(JSON_FIELD_REQUIRED_ACTIONS);
    }

getUserId()

String org.keycloak.authentication.actiontoken.DefaultActionTokenKey.getUserId ( )

inlineinherited

                              {
        return getSubject();
    }

removeNote()

final String org.keycloak.authentication.actiontoken.DefaultActionToken.removeNote ( String  name )

inlineinherited

Removes given note, and returns original value (or

null 

when no value was present)

戻り値

see description

                                                {
        Object res = getOtherClaims().remove(name);
        return res instanceof String ? (String) res : null;
    }

serialize()

String org.keycloak.authentication.actiontoken.DefaultActionToken.serialize ( KeycloakSession  session, RealmModel  realm, UriInfo  uri  )

inlineinherited

Updates the following fields and serializes this token into a signed JWT. The list of updated fields follows:

• id 

  : random nonce

• issuedAt 

  : Current time

• issuer 

  : URI of the given realm

• audience 

  : URI of the given realm (same as issuer)

引数

session
realm
uri

戻り値

                                                                                    {
        String issuerUri = getIssuer(realm, uri);

        this
          .issuedAt(Time.currentTime())
          .id(getActionVerificationNonce().toString())
          .issuer(issuerUri)
          .audience(issuerUri);

        return session.tokens().encode(this);
    }

setCompoundAuthenticationSessionId()

final void org.keycloak.authentication.actiontoken.DefaultActionToken.setCompoundAuthenticationSessionId ( String  authenticationSessionId )

inlineinherited

                                                                                         {
        setOtherClaims(JSON_FIELD_AUTHENTICATION_SESSION_ID, authenticationSessionId);
    }

setNote()

final String org.keycloak.authentication.actiontoken.DefaultActionToken.setNote ( String  name, String  value  )

inlineinherited

Sets value of the given note

戻り値

original value (or

null 

when no value was present)

                                                           {
        Object res = value == null
          ? getOtherClaims().remove(name)
          : getOtherClaims().put(name, value);
        return res instanceof String ? (String) res : null;
    }

setRedirectUri()

final void org.keycloak.authentication.actiontoken.execactions.ExecuteActionsActionToken.setRedirectUri ( String  redirectUri )

inline

                                                         {
        if (redirectUri == null) {
            getOtherClaims().remove(JSON_FIELD_REDIRECT_URI);
        } else {
            setOtherClaims(JSON_FIELD_REDIRECT_URI, redirectUri);
        }
    }

setRequiredActions()

final void org.keycloak.authentication.actiontoken.execactions.ExecuteActionsActionToken.setRequiredActions ( List< String >  requiredActions )

inline

                                                                       {
        if (requiredActions == null) {
            getOtherClaims().remove(JSON_FIELD_REQUIRED_ACTIONS);
        } else {
            setOtherClaims(JSON_FIELD_REQUIRED_ACTIONS, requiredActions);
        }
    }

メンバ詳解

ACTION_TOKEN_BASIC_CHECKS

final Predicate<DefaultActionTokenKey> org.keycloak.authentication.actiontoken.DefaultActionToken.ACTION_TOKEN_BASIC_CHECKS

staticinherited

初期値:

= t -> {
        if (t.getActionVerificationNonce() == null) {
            throw new VerificationException("Nonce not present.");
        }

        return true;
    }

ACTION_TOKEN_USER_ID

final String org.keycloak.authentication.actiontoken.DefaultActionTokenKey.ACTION_TOKEN_USER_ID = "ACTION_TOKEN_USER"

staticinherited

The authenticationSession note with ID of the user authenticated via the action token

JSON_FIELD_ACTION_VERIFICATION_NONCE

final String org.keycloak.authentication.actiontoken.DefaultActionTokenKey.JSON_FIELD_ACTION_VERIFICATION_NONCE = "nonce"

staticinherited

JSON_FIELD_AUTHENTICATION_SESSION_ID

final String org.keycloak.authentication.actiontoken.DefaultActionToken.JSON_FIELD_AUTHENTICATION_SESSION_ID = "asid"

staticinherited

JSON_FIELD_REDIRECT_URI

final String org.keycloak.authentication.actiontoken.execactions.ExecuteActionsActionToken.JSON_FIELD_REDIRECT_URI = "reduri"

staticprivate

JSON_FIELD_REQUIRED_ACTIONS

final String org.keycloak.authentication.actiontoken.execactions.ExecuteActionsActionToken.JSON_FIELD_REQUIRED_ACTIONS = "rqac"

staticprivate

TOKEN_TYPE

final String org.keycloak.authentication.actiontoken.execactions.ExecuteActionsActionToken.TOKEN_TYPE = "execute-actions"

static

---

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

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