org.keycloak.authentication.actiontoken.verifyemail.VerifyEmailActionToken クラス

org.keycloak.authentication.actiontoken.verifyemail.VerifyEmailActionToken の継承関係図

org.keycloak.authentication.actiontoken.verifyemail.VerifyEmailActionToken 連携図

公開メンバ関数
	VerifyEmailActionToken (String userId, int absoluteExpirationInSecs, String compoundAuthenticationSessionId, String email, String clientId)
String	getEmail ()
void	setEmail (String email)
String	getCompoundOriginalAuthenticationSessionId ()
void	setCompoundOriginalAuthenticationSessionId (String originalAuthenticationSessionId)
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 ()
int	getExpiration ()
default String	serializeKey ()

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

静的公開変数類
static final String	TOKEN_TYPE = "verify-email"
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"

非公開メンバ関数
	VerifyEmailActionToken ()

非公開変数類
String	email
String	originalAuthenticationSessionId

静的非公開変数類
static final String	JSON_FIELD_EMAIL = "eml"
static final String	JSON_FIELD_ORIGINAL_AUTHENTICATION_SESSION_ID = "oasid"

詳解

Representation of a token that represents a time-limited verify e-mail action.

著者

hmlnarik

構築子と解体子

VerifyEmailActionToken() [1/2]

org.keycloak.authentication.actiontoken.verifyemail.VerifyEmailActionToken.VerifyEmailActionToken ( String  userId, int  absoluteExpirationInSecs, String  compoundAuthenticationSessionId, String  email, String  clientId  )

inline

                                                                                                                                                      {
        super(userId, TOKEN_TYPE, absoluteExpirationInSecs, null, compoundAuthenticationSessionId);
        this.email = email;
        this.issuedFor = clientId;
    }

VerifyEmailActionToken() [2/2]

org.keycloak.authentication.actiontoken.verifyemail.VerifyEmailActionToken.VerifyEmailActionToken ( )

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

org.keycloak.models.ActionTokenKeyModelを実装しています。

                                {
        return getType();
    }

getActionVerificationNonce()

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

inlineinherited

org.keycloak.models.ActionTokenKeyModelを実装しています。

                                             {
        return actionVerificationNonce;
    }

getCompoundAuthenticationSessionId()

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

inlineinherited

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

getCompoundOriginalAuthenticationSessionId()

String org.keycloak.authentication.actiontoken.verifyemail.VerifyEmailActionToken.getCompoundOriginalAuthenticationSessionId ( )

inline

                                                               {
        return originalAuthenticationSessionId;
    }

getEmail()

String org.keycloak.authentication.actiontoken.verifyemail.VerifyEmailActionToken.getEmail ( )

inline

                             {
        return email;
    }

getExpiration()

int org.keycloak.models.ActionTokenKeyModel.getExpiration ( )

inherited

Returns absolute number of seconds since the epoch in UTC timezone when the token expires.

getNote()

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

inlineinherited

org.keycloak.models.ActionTokenValueModelを実装しています。

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

getNotes()

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

inlineinherited

org.keycloak.models.ActionTokenValueModelを実装しています。

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

getUserId()

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

inlineinherited

org.keycloak.models.ActionTokenKeyModelを実装しています。

                              {
        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);
    }

serializeKey()

default String org.keycloak.models.ActionTokenKeyModel.serializeKey ( )

inlineinherited

                                  {
        String userId = getUserId();
        String encodedUserId = userId == null ? "" : Base64.encodeBytes(userId.getBytes(StandardCharsets.UTF_8));
        return String.format("%s.%d.%s.%s", encodedUserId, getExpiration(), getActionVerificationNonce(), getActionId());
    }

setCompoundAuthenticationSessionId()

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

inlineinherited

                                                                                         {
        setOtherClaims(JSON_FIELD_AUTHENTICATION_SESSION_ID, authenticationSessionId);
    }

setCompoundOriginalAuthenticationSessionId()

void org.keycloak.authentication.actiontoken.verifyemail.VerifyEmailActionToken.setCompoundOriginalAuthenticationSessionId ( String  originalAuthenticationSessionId )

inline

                                                                                                   {
        this.originalAuthenticationSessionId = originalAuthenticationSessionId;
    }

setEmail()

void org.keycloak.authentication.actiontoken.verifyemail.VerifyEmailActionToken.setEmail ( String  email )

inline

                                       {
        this.email = email;
    }

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;
    }

メンバ詳解

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

email

String org.keycloak.authentication.actiontoken.verifyemail.VerifyEmailActionToken.email

private

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_EMAIL

final String org.keycloak.authentication.actiontoken.verifyemail.VerifyEmailActionToken.JSON_FIELD_EMAIL = "eml"

staticprivate

JSON_FIELD_ORIGINAL_AUTHENTICATION_SESSION_ID

final String org.keycloak.authentication.actiontoken.verifyemail.VerifyEmailActionToken.JSON_FIELD_ORIGINAL_AUTHENTICATION_SESSION_ID = "oasid"

staticprivate

originalAuthenticationSessionId

String org.keycloak.authentication.actiontoken.verifyemail.VerifyEmailActionToken.originalAuthenticationSessionId

private

TOKEN_TYPE

final String org.keycloak.authentication.actiontoken.verifyemail.VerifyEmailActionToken.TOKEN_TYPE = "verify-email"

static

---

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

• D:/AppData/doxygen/keycloak/oidc-service/src/main/java/org/keycloak/authentication/actiontoken/verifyemail/VerifyEmailActionToken.java