org.keycloak.authentication.requiredactions.TermsAndConditions クラス

org.keycloak.authentication.requiredactions.TermsAndConditions の継承関係図

org.keycloak.authentication.requiredactions.TermsAndConditions 連携図

公開メンバ関数
RequiredActionProvider	create (KeycloakSession session)
RequiredActionProvider	createDisplay (KeycloakSession session, String displayType)
void	init (Config.Scope config)
void	postInit (KeycloakSessionFactory factory)
String	getId ()
void	evaluateTriggers (RequiredActionContext context)
void	requiredActionChallenge (RequiredActionContext context)
void	processAction (RequiredActionContext context)
String	getDisplayText ()
void	close ()
default boolean	isOneTimeAction ()
default int	order ()

静的公開変数類
static final String	PROVIDER_ID = "terms_and_conditions"
static final String	USER_ATTRIBUTE = PROVIDER_ID

詳解

著者

Bill Burke

バージョン

Revision

1

関数詳解

close()

void org.keycloak.authentication.requiredactions.TermsAndConditions.close ( )

inline

org.keycloak.provider.Providerを実装しています。

                        {

    }

create()

RequiredActionProvider org.keycloak.authentication.requiredactions.TermsAndConditions.create ( KeycloakSession  session )

inline

org.keycloak.provider.ProviderFactory< T extends Provider >を実装しています。

                                                                  {
        return this;
    }

createDisplay()

RequiredActionProvider org.keycloak.authentication.requiredactions.TermsAndConditions.createDisplay ( KeycloakSession  session, String  displayType  )

inline

org.keycloak.authentication.DisplayTypeRequiredActionFactoryを実装しています。

                                                                                             {
        if (displayType == null) return this;
        if (!OAuth2Constants.DISPLAY_CONSOLE.equalsIgnoreCase(displayType)) return null;
        return ConsoleTermsAndConditions.SINGLETON;
    }

evaluateTriggers()

void org.keycloak.authentication.requiredactions.TermsAndConditions.evaluateTriggers ( RequiredActionContext  context )

inline

org.keycloak.authentication.RequiredActionProviderを実装しています。

                                                                {

    }

getDisplayText()

String org.keycloak.authentication.requiredactions.TermsAndConditions.getDisplayText ( )

inline

org.keycloak.authentication.RequiredActionFactoryを実装しています。

                                   {
        return "Terms and Conditions";
    }

getId()

String org.keycloak.authentication.requiredactions.TermsAndConditions.getId ( )

inline

org.keycloak.provider.ProviderFactory< T extends Provider >を実装しています。

                          {
        return PROVIDER_ID;
    }

init()

void org.keycloak.authentication.requiredactions.TermsAndConditions.init ( Config.Scope  config )

inline

org.keycloak.provider.ProviderFactory< T extends Provider >を実装しています。

                                          {

    }

isOneTimeAction()

default boolean org.keycloak.authentication.RequiredActionFactory.isOneTimeAction ( )

inlineinherited

Flag indicating whether the execution of the required action by the same circumstances (e.g. by one and the same action token) should only be permitted once.

戻り値

org.keycloak.authentication.requiredactions.UpdatePassword, org.keycloak.authentication.requiredactions.UpdateTotpで実装されています。

                                      {
        return false;
    }

order()

default int org.keycloak.provider.ProviderFactory< T extends Provider >.order ( )

inlineinherited

org.keycloak.protocol.docker.DockerAuthV2ProtocolFactory, org.keycloak.urls.HostnameProviderFactory, org.keycloak.protocol.oidc.ext.OIDCExtProviderFactoryで実装されています。

                        {
        return 0;
    }

postInit()

void org.keycloak.authentication.requiredactions.TermsAndConditions.postInit ( KeycloakSessionFactory  factory )

inline

org.keycloak.provider.ProviderFactory< T extends Provider >を実装しています。

                                                         {

    }

processAction()

void org.keycloak.authentication.requiredactions.TermsAndConditions.processAction ( RequiredActionContext  context )

inline

org.keycloak.authentication.RequiredActionProviderを実装しています。

                                                             {
        if (context.getHttpRequest().getDecodedFormParameters().containsKey("cancel")) {
            context.getUser().removeAttribute(USER_ATTRIBUTE);
            context.failure();
            return;
        }

        context.getUser().setAttribute(USER_ATTRIBUTE, Arrays.asList(Integer.toString(Time.currentTime())));

        context.success();
    }

requiredActionChallenge()

void org.keycloak.authentication.requiredactions.TermsAndConditions.requiredActionChallenge ( RequiredActionContext  context )

inline

org.keycloak.authentication.RequiredActionProviderを実装しています。

                                                                       {
        Response challenge = context.form().createForm("terms.ftl");
        context.challenge(challenge);
    }

メンバ詳解

PROVIDER_ID

final String org.keycloak.authentication.requiredactions.TermsAndConditions.PROVIDER_ID = "terms_and_conditions"

static

USER_ATTRIBUTE

final String org.keycloak.authentication.requiredactions.TermsAndConditions.USER_ATTRIBUTE = PROVIDER_ID

static

---

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

• D:/AppData/doxygen/keycloak/src/keycloak/src/main/java/org/keycloak/authentication/requiredactions/TermsAndConditions.java