org.keycloak.storage.ldap.mappers.msad.MSADUserAccountControlStorageMapperFactory クラス

org.keycloak.storage.ldap.mappers.msad.MSADUserAccountControlStorageMapperFactory の継承関係図

org.keycloak.storage.ldap.mappers.msad.MSADUserAccountControlStorageMapperFactory 連携図

公開メンバ関数
String	getHelpText ()
List< ProviderConfigProperty >	getConfigProperties ()
List< ProviderConfigProperty >	getConfigProperties (RealmModel realm, ComponentModel parent)
String	getId ()
void	init (Config.Scope config)
LDAPStorageMapper	create (KeycloakSession session, ComponentModel model)
void	postInit (KeycloakSessionFactory factory)
Map< String, Object >	getTypeMetadata ()
void	close ()
default void	validateConfiguration (KeycloakSession session, RealmModel realm, ComponentModel config) throws ComponentValidationException
default void	onParentUpdate (RealmModel realm, UserStorageProviderModel oldParent, UserStorageProviderModel newParent, ComponentModel mapperModel)
default void	onCreate (KeycloakSession session, RealmModel realm, ComponentModel model)

静的公開メンバ関数
static ProviderConfigProperty	createConfigProperty (String name, String label, String helpText, String type, List< String > options)

静的公開変数類
static final String	PROVIDER_ID = LDAPConstants.MSAD_USER_ACCOUNT_CONTROL_MAPPER

限定公開メンバ関数
AbstractLDAPStorageMapper	createMapper (ComponentModel mapperModel, LDAPStorageProvider federationProvider)
void	checkMandatoryConfigAttribute (String name, String displayName, ComponentModel mapperModel) throws ComponentValidationException

静的限定公開変数類
static final List< ProviderConfigProperty >	configProperties

静的関数
	[static initializer]

静的非公開メンバ関数
static List< ProviderConfigProperty >	getConfigProps (ComponentModel parent)

詳解

著者

Marek Posolda

関数詳解

[static initializer]()

org.keycloak.storage.ldap.mappers.msad.MSADUserAccountControlStorageMapperFactory.[static initializer] ( )

inlinestaticpackage

checkMandatoryConfigAttribute()

void org.keycloak.storage.ldap.mappers.AbstractLDAPStorageMapperFactory.checkMandatoryConfigAttribute ( String  name, String  displayName, ComponentModel  mapperModel  ) throws ComponentValidationException

inlineprotectedinherited

                                                                                                                                                  {
        String attrConfigValue = mapperModel.getConfig().getFirst(name);
        if (attrConfigValue == null || attrConfigValue.trim().isEmpty()) {
            throw new ComponentValidationException("Missing configuration for '" + displayName + "'");
        }
    }

close()

void org.keycloak.storage.ldap.mappers.AbstractLDAPStorageMapperFactory.close ( )

inlineinherited

                        {
    }

create()

LDAPStorageMapper org.keycloak.storage.ldap.mappers.AbstractLDAPStorageMapperFactory.create ( KeycloakSession  session, ComponentModel  model  )

inlineinherited

                                                                                   {
        // LDAPStorageProvider is in the session already as mappers are always called from it
        String ldapProviderModelId = model.getParentId();
        LDAPStorageProvider ldapProvider = (LDAPStorageProvider) session.getAttribute(ldapProviderModelId);

        return createMapper(model, ldapProvider);
    }

createConfigProperty()

static ProviderConfigProperty org.keycloak.storage.ldap.mappers.AbstractLDAPStorageMapperFactory.createConfigProperty ( String  name, String  label, String  helpText, String  type, List< String >  options  )

inlinestaticinherited

                                                                                                                                             {
        ProviderConfigProperty configProperty = new ProviderConfigProperty();
        configProperty.setName(name);
        configProperty.setLabel(label);
        configProperty.setHelpText(helpText);
        configProperty.setType(type);
        configProperty.setOptions(options);
        return configProperty;
    }

createMapper()

AbstractLDAPStorageMapper org.keycloak.storage.ldap.mappers.msad.MSADUserAccountControlStorageMapperFactory.createMapper ( ComponentModel  mapperModel, LDAPStorageProvider  federationProvider  )

inlineprotected

                                                                                                                         {
        return new MSADUserAccountControlStorageMapper(mapperModel, federationProvider);
    }

getConfigProperties() [1/2]

List<ProviderConfigProperty> org.keycloak.storage.ldap.mappers.msad.MSADUserAccountControlStorageMapperFactory.getConfigProperties ( )

inline

                                                              {
        return configProperties;
    }

getConfigProperties() [2/2]

List<ProviderConfigProperty> org.keycloak.storage.ldap.mappers.msad.MSADUserAccountControlStorageMapperFactory.getConfigProperties ( RealmModel  realm, ComponentModel  parent  )

inline

                                                                                                     {
        return getConfigProps(parent);
    }

getConfigProps()

static List<ProviderConfigProperty> org.keycloak.storage.ldap.mappers.msad.MSADUserAccountControlStorageMapperFactory.getConfigProps ( ComponentModel  parent )

inlinestaticprivate

                                                                                      {
        return ProviderConfigurationBuilder.create()
                .property().name(MSADUserAccountControlStorageMapper.LDAP_PASSWORD_POLICY_HINTS_ENABLED)
                .label("Password Policy Hints Enabled")
                .helpText("Applicable just for writable MSAD. If on, then updating password of MSAD user will use LDAP_SERVER_POLICY_HINTS_OID " +
                        "extension, which means that advanced MSAD password policies like 'password history' or 'minimal password age' will be applied. This extension works just for MSAD 2008 R2 or newer.")
                .type(ProviderConfigProperty.BOOLEAN_TYPE)
                .defaultValue("false")
                .add()
                .build();

    }

getHelpText()

String org.keycloak.storage.ldap.mappers.msad.MSADUserAccountControlStorageMapperFactory.getHelpText ( )

inline

                                {
        return "Mapper specific to MSAD. It's able to integrate the MSAD user account state into Keycloak account state (account enabled, password is expired etc). It's using userAccountControl and pwdLastSet MSAD attributes for that. " +
                "For example if pwdLastSet is 0, the Keycloak user is required to update password, if userAccountControl is 514 (disabled account) the Keycloak user is disabled as well etc. Mapper is also able to handle exception code from LDAP user authentication.";
    }

getId()

String org.keycloak.storage.ldap.mappers.msad.MSADUserAccountControlStorageMapperFactory.getId ( )

inline

                          {
        return PROVIDER_ID;
    }

getTypeMetadata()

Map<String, Object> org.keycloak.storage.ldap.mappers.AbstractLDAPStorageMapperFactory.getTypeMetadata ( )

inlineinherited

                                                 {
        Map<String, Object> metadata = new HashMap<>();
        metadata.put("fedToKeycloakSyncSupported", false);
        metadata.put("keycloakToFedSyncSupported", false);

        return metadata;
    }

init()

void org.keycloak.storage.ldap.mappers.AbstractLDAPStorageMapperFactory.init ( Config.Scope  config )

inlineinherited

                                          {
    }

onCreate()

default void org.keycloak.storage.ldap.mappers.LDAPStorageMapperFactory< T extends LDAPStorageMapper >.onCreate ( KeycloakSession  session, RealmModel  realm, ComponentModel  model  )

inlineinherited

Called when UserStorageProviderModel is created. This allows you to do initialization of any additional configuration you need to add. For example, you may be introspecting a database or ldap schema to automatically create mappings.

引数

session
realm
model

                                                                                           {

    }

onParentUpdate()

default void org.keycloak.storage.ldap.mappers.LDAPStorageMapperFactory< T extends LDAPStorageMapper >.onParentUpdate ( RealmModel  realm, UserStorageProviderModel  oldParent, UserStorageProviderModel  newParent, ComponentModel  mapperModel  )

inlineinherited

                                                                                                                                                      {

    }

postInit()

void org.keycloak.storage.ldap.mappers.AbstractLDAPStorageMapperFactory.postInit ( KeycloakSessionFactory  factory )

inlineinherited

                                                         {
    }

validateConfiguration()

default void org.keycloak.storage.ldap.mappers.LDAPStorageMapperFactory< T extends LDAPStorageMapper >.validateConfiguration ( KeycloakSession  session, RealmModel  realm, ComponentModel  config  ) throws ComponentValidationException

inlineinherited

                                                                                                                                             {

    }

メンバ詳解

configProperties

final List<ProviderConfigProperty> org.keycloak.storage.ldap.mappers.msad.MSADUserAccountControlStorageMapperFactory.configProperties

staticprotected

PROVIDER_ID

final String org.keycloak.storage.ldap.mappers.msad.MSADUserAccountControlStorageMapperFactory.PROVIDER_ID = LDAPConstants.MSAD_USER_ACCOUNT_CONTROL_MAPPER

static

---

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

• D:/AppData/doxygen/keycloak/federation/src/federation/ldap/src/main/java/org/keycloak/storage/ldap/mappers/msad/MSADUserAccountControlStorageMapperFactory.java