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)
default ProviderType	create (KeycloakSession session)
default void	onCreate (KeycloakSession session, RealmModel realm, ComponentModel model)
default void	onUpdate (KeycloakSession session, RealmModel realm, ComponentModel oldModel, ComponentModel newModel)
default void	preRemove (KeycloakSession session, RealmModel realm, ComponentModel model)
default List< ProviderConfigProperty >	getCommonProviderConfigProperties ()
default Map< String, Object >	getTypeMetadata ()
default int	order ()

静的公開変数類
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

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

                        {
    }

create() [1/2]

default ProviderType org.keycloak.component.ComponentFactory< CreatedType, ProviderType extends Provider >.create ( KeycloakSession  session )

inlineinherited

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

                                                         {
        return null;
    }

create() [2/2]

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

inline

org.keycloak.component.ComponentFactory< CreatedType, ProviderType extends Provider >を実装しています。

                                                                                          {
        return new TrustedHostClientRegistrationPolicy(session, model);
    }

getCommonProviderConfigProperties()

default List<ProviderConfigProperty> org.keycloak.component.ComponentFactory< CreatedType, ProviderType extends Provider >.getCommonProviderConfigProperties ( )

inlineinherited

These are config properties that are common across all implementation of this component type

戻り値

org.keycloak.storage.UserStorageProviderFactory< T extends UserStorageProvider >, org.keycloak.storage.client.ClientStorageProviderFactory< T extends ClientStorageProvider >で実装されています。

                                                                     {
        return Collections.EMPTY_LIST;
    }

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

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

                                                              {
        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

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

                                {
        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

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

                          {
        return PROVIDER_ID;
    }

getTypeMetadata()

default Map<String, Object> org.keycloak.component.ComponentFactory< CreatedType, ProviderType extends Provider >.getTypeMetadata ( )

inlineinherited

This is metadata about this component type. Its really configuration information about the component type and not an individual instance

戻り値

org.keycloak.storage.UserStorageProviderFactory< T extends UserStorageProvider >, org.keycloak.storage.client.ClientStorageProviderFactory< T extends ClientStorageProvider >で実装されています。

                                          {
        return Collections.EMPTY_MAP;

    }

init()

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

inlineinherited

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

                                          {
    }

onCreate()

default void org.keycloak.component.ComponentFactory< CreatedType, ProviderType extends Provider >.onCreate ( KeycloakSession  session, RealmModel  realm, ComponentModel  model  )

inlineinherited

Called after a component is created

引数

session
realm
model

org.keycloak.storage.ldap.LDAPStorageProviderFactory, org.keycloak.federation.kerberos.KerberosFederationProviderFactory, org.keycloak.storage.UserStorageProviderFactory< T extends UserStorageProvider >, org.keycloak.storage.client.ClientStorageProviderFactory< T extends ClientStorageProvider >で実装されています。

                                                                                   {

    }

onUpdate()

default void org.keycloak.component.ComponentFactory< CreatedType, ProviderType extends Provider >.onUpdate ( KeycloakSession  session, RealmModel  realm, ComponentModel  oldModel, ComponentModel  newModel  )

inlineinherited

Called after the component is updated.

引数

session
realm
oldModel	old saved model
newModel	new configuration

org.keycloak.storage.ldap.LDAPStorageProviderFactory, org.keycloak.federation.kerberos.KerberosFederationProviderFactoryで実装されています。

                                                                                                               {

    }

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.services.clientregistration.policy.AbstractClientRegistrationPolicyFactory.postInit ( KeycloakSessionFactory  factory )

inlineinherited

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

                                                         {
        this.sessionFactory = factory;
    }

preRemove()

default void org.keycloak.component.ComponentFactory< CreatedType, ProviderType extends Provider >.preRemove ( KeycloakSession  session, RealmModel  realm, ComponentModel  model  )

inlineinherited

Called before the component is removed.

引数

session
realm
model	model of the component, which is going to be removed

org.keycloak.storage.ldap.LDAPStorageProviderFactory, org.keycloak.federation.kerberos.KerberosFederationProviderFactoryで実装されています。

                                                                                    {

    }

validateConfiguration()

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

inline

org.keycloak.component.ComponentFactory< CreatedType, ProviderType extends Provider >を実装しています。

                                                                                                                                            {
        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/src/keycloak/src/main/java/org/keycloak/services/clientregistration/policy/impl/TrustedHostClientRegistrationPolicyFactory.java