org.keycloak.services.clientregistration.policy.impl.TrustedHostClientRegistrationPolicyFactory クラス

org.keycloak.services.clientregistration.policy.impl.TrustedHostClientRegistrationPolicyFactory の継承関係図

org.keycloak.services.clientregistration.policy.impl.TrustedHostClientRegistrationPolicyFactory 連携図

公開メンバ関数
ClientRegistrationPolicy	create (KeycloakSession session, ComponentModel model)
String	getHelpText ()
List< ProviderConfigProperty >	getConfigProperties ()
String	getId ()
void	validateConfiguration (KeycloakSession session, RealmModel realm, ComponentModel config) throws ComponentValidationException
void	init (Config.Scope config)
void	postInit (KeycloakSessionFactory factory)
void	close ()
List< ProviderConfigProperty >	getConfigProperties (KeycloakSession session)

静的公開変数類
static final String	PROVIDER_ID = "trusted-hosts"
static final String	TRUSTED_HOSTS = "trusted-hosts"
static final String	HOST_SENDING_REGISTRATION_REQUEST_MUST_MATCH = "host-sending-registration-request-must-match"
static final String	CLIENT_URIS_MUST_MATCH = "client-uris-must-match"

限定公開変数類
KeycloakSessionFactory	sessionFactory

静的非公開変数類
static final ProviderConfigProperty	TRUSTED_HOSTS_PROPERTY = new ProviderConfigProperty(TRUSTED_HOSTS, "trusted-hosts.label", "trusted-hosts.tooltip", ProviderConfigProperty.MULTIVALUED_STRING_TYPE, null)
static final ProviderConfigProperty	HOST_SENDING_REGISTRATION_REQUEST_MUST_MATCH_PROPERTY
static final ProviderConfigProperty	CLIENT_URIS_MUST_MATCH_PROPERTY

詳解

著者

Marek Posolda

関数詳解

close()

void org.keycloak.services.clientregistration.policy.AbstractClientRegistrationPolicyFactory.close ( )

inlineinherited

                        {
    }

create()

ClientRegistrationPolicy org.keycloak.services.clientregistration.policy.impl.TrustedHostClientRegistrationPolicyFactory.create ( KeycloakSession  session, ComponentModel  model  )

inline

                                                                                          {
        return new TrustedHostClientRegistrationPolicy(session, model);
    }

getConfigProperties() [1/2]

List<ProviderConfigProperty> org.keycloak.services.clientregistration.policy.AbstractClientRegistrationPolicyFactory.getConfigProperties ( KeycloakSession  session )

inlineinherited

org.keycloak.services.clientregistration.policy.ClientRegistrationPolicyFactoryを実装しています。

                                                                                     {
        return getConfigProperties();
    }

getConfigProperties() [2/2]

List<ProviderConfigProperty> org.keycloak.services.clientregistration.policy.impl.TrustedHostClientRegistrationPolicyFactory.getConfigProperties ( )

inline

                                                              {
        return Arrays.asList(TRUSTED_HOSTS_PROPERTY, HOST_SENDING_REGISTRATION_REQUEST_MUST_MATCH_PROPERTY, CLIENT_URIS_MUST_MATCH_PROPERTY);
    }

getHelpText()

String org.keycloak.services.clientregistration.policy.impl.TrustedHostClientRegistrationPolicyFactory.getHelpText ( )

inline

                                {
        return "Allows to specify from which hosts is user able to register and which redirect URIs can client use in it's configuration";
    }

getId()

String org.keycloak.services.clientregistration.policy.impl.TrustedHostClientRegistrationPolicyFactory.getId ( )

inline

                          {
        return PROVIDER_ID;
    }

init()

void org.keycloak.services.clientregistration.policy.AbstractClientRegistrationPolicyFactory.init ( Config.Scope  config )

inlineinherited

                                          {
    }

postInit()

void org.keycloak.services.clientregistration.policy.AbstractClientRegistrationPolicyFactory.postInit ( KeycloakSessionFactory  factory )

inlineinherited

                                                         {
        this.sessionFactory = factory;
    }

validateConfiguration()

void org.keycloak.services.clientregistration.policy.impl.TrustedHostClientRegistrationPolicyFactory.validateConfiguration ( KeycloakSession  session, RealmModel  realm, ComponentModel  config  ) throws ComponentValidationException

inline

                                                                                                                                            {
        ConfigurationValidationHelper.check(config)
                .checkBoolean(HOST_SENDING_REGISTRATION_REQUEST_MUST_MATCH_PROPERTY, true)
                .checkBoolean(CLIENT_URIS_MUST_MATCH_PROPERTY, true);

        TrustedHostClientRegistrationPolicy policy = new TrustedHostClientRegistrationPolicy(session, config);
        if (!policy.isHostMustMatch() && !policy.isClientUrisMustMatch()) {
            throw new ComponentValidationException("At least one of hosts verification or client URIs validation must be enabled");
        }

    }

メンバ詳解

CLIENT_URIS_MUST_MATCH

final String org.keycloak.services.clientregistration.policy.impl.TrustedHostClientRegistrationPolicyFactory.CLIENT_URIS_MUST_MATCH = "client-uris-must-match"

static

CLIENT_URIS_MUST_MATCH_PROPERTY

final ProviderConfigProperty org.keycloak.services.clientregistration.policy.impl.TrustedHostClientRegistrationPolicyFactory.CLIENT_URIS_MUST_MATCH_PROPERTY

staticprivate

初期値:

= new ProviderConfigProperty(CLIENT_URIS_MUST_MATCH, "client-uris-must-match.label",
            "client-uris-must-match.tooltip", ProviderConfigProperty.BOOLEAN_TYPE, "true")

HOST_SENDING_REGISTRATION_REQUEST_MUST_MATCH

final String org.keycloak.services.clientregistration.policy.impl.TrustedHostClientRegistrationPolicyFactory.HOST_SENDING_REGISTRATION_REQUEST_MUST_MATCH = "host-sending-registration-request-must-match"

static

HOST_SENDING_REGISTRATION_REQUEST_MUST_MATCH_PROPERTY

final ProviderConfigProperty org.keycloak.services.clientregistration.policy.impl.TrustedHostClientRegistrationPolicyFactory.HOST_SENDING_REGISTRATION_REQUEST_MUST_MATCH_PROPERTY

staticprivate

初期値:

= new ProviderConfigProperty(HOST_SENDING_REGISTRATION_REQUEST_MUST_MATCH, "host-sending-registration-request-must-match.label",
            "host-sending-registration-request-must-match.tooltip", ProviderConfigProperty.BOOLEAN_TYPE, "true")

PROVIDER_ID

final String org.keycloak.services.clientregistration.policy.impl.TrustedHostClientRegistrationPolicyFactory.PROVIDER_ID = "trusted-hosts"

static

sessionFactory

KeycloakSessionFactory org.keycloak.services.clientregistration.policy.AbstractClientRegistrationPolicyFactory.sessionFactory

protectedinherited

TRUSTED_HOSTS

final String org.keycloak.services.clientregistration.policy.impl.TrustedHostClientRegistrationPolicyFactory.TRUSTED_HOSTS = "trusted-hosts"

static

TRUSTED_HOSTS_PROPERTY

final ProviderConfigProperty org.keycloak.services.clientregistration.policy.impl.TrustedHostClientRegistrationPolicyFactory.TRUSTED_HOSTS_PROPERTY = new ProviderConfigProperty(TRUSTED_HOSTS, "trusted-hosts.label", "trusted-hosts.tooltip", ProviderConfigProperty.MULTIVALUED_STRING_TYPE, null)

staticprivate

---

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

• D:/AppData/doxygen/keycloak/rest-service/src/services/src/main/java/org/keycloak/services/clientregistration/policy/impl/TrustedHostClientRegistrationPolicyFactory.java