org.keycloak.storage.ldap.LDAPConfig クラス

org.keycloak.storage.ldap.LDAPConfig 連携図

公開メンバ関数
	LDAPConfig (MultivaluedHashMap< String, String > config)
String	getConnectionUrl ()
String	getFactoryName ()
String	getAuthType ()
String	getUseTruststoreSpi ()
String	getUsersDn ()
Collection< String >	getUserObjectClasses ()
String	getBindDN ()
String	getBindCredential ()
String	getVendor ()
boolean	isActiveDirectory ()
boolean	isValidatePasswordPolicy ()
String	getConnectionPooling ()
String	getConnectionPoolingAuthentication ()
String	getConnectionPoolingDebug ()
String	getConnectionPoolingInitSize ()
String	getConnectionPoolingMaxSize ()
String	getConnectionPoolingPrefSize ()
String	getConnectionPoolingProtocol ()
String	getConnectionPoolingTimeout ()
String	getConnectionTimeout ()
String	getReadTimeout ()
Properties	getAdditionalConnectionProperties ()
int	getSearchScope ()
String	getUuidLDAPAttributeName ()
boolean	isObjectGUID ()
boolean	isPagination ()
int	getBatchSizeForSync ()
String	getUsernameLdapAttribute ()
String	getRdnLdapAttribute ()
String	getCustomUserSearchFilter ()
UserStorageProvider.EditMode	getEditMode ()
void	addBinaryAttribute (String attrName)
Set< String >	getBinaryAttributeNames ()
boolean	equals (Object obj)
int	hashCode ()
String	toString ()

非公開変数類
final MultivaluedHashMap< String, String >	config
final Set< String >	binaryAttributeNames = new HashSet<>()

詳解

著者

Marek Posolda

構築子と解体子

LDAPConfig()

org.keycloak.storage.ldap.LDAPConfig.LDAPConfig ( MultivaluedHashMap< String, String >  config )

inline

                                                                 {
        this.config = config;
    }

関数詳解

addBinaryAttribute()

void org.keycloak.storage.ldap.LDAPConfig.addBinaryAttribute ( String  attrName )

inline

                                                    {
        binaryAttributeNames.add(attrName);
    }

equals()

boolean org.keycloak.storage.ldap.LDAPConfig.equals ( Object  obj )

inline

                                      {
        if (obj == this) return true;
        if (!(obj instanceof LDAPConfig)) return false;

        LDAPConfig that = (LDAPConfig) obj;

        if (!config.equals(that.config)) return false;
        if (!binaryAttributeNames.equals(that.binaryAttributeNames)) return false;
        return true;
    }

getAdditionalConnectionProperties()

Properties org.keycloak.storage.ldap.LDAPConfig.getAdditionalConnectionProperties ( )

inline

                                                          {
        // not supported for now
        return null;
    }

getAuthType()

String org.keycloak.storage.ldap.LDAPConfig.getAuthType ( )

inline

                                {
        String value = config.getFirst(LDAPConstants.AUTH_TYPE);
        if (value == null) {
            return LDAPConstants.AUTH_TYPE_SIMPLE;
        } else {
            return value;
        }
    }

getBatchSizeForSync()

int org.keycloak.storage.ldap.LDAPConfig.getBatchSizeForSync ( )

inline

                                     {
        String pageSizeConfig = config.getFirst(LDAPConstants.BATCH_SIZE_FOR_SYNC);
        return pageSizeConfig!=null ? Integer.parseInt(pageSizeConfig) : LDAPConstants.DEFAULT_BATCH_SIZE_FOR_SYNC;
    }

getBinaryAttributeNames()

Set<String> org.keycloak.storage.ldap.LDAPConfig.getBinaryAttributeNames ( )

inline

                                                 {
        return binaryAttributeNames;
    }

getBindCredential()

String org.keycloak.storage.ldap.LDAPConfig.getBindCredential ( )

inline

                                      {
        return config.getFirst(LDAPConstants.BIND_CREDENTIAL);
    }

getBindDN()

String org.keycloak.storage.ldap.LDAPConfig.getBindDN ( )

inline

                              {
        return config.getFirst(LDAPConstants.BIND_DN);
    }

getConnectionPooling()

String org.keycloak.storage.ldap.LDAPConfig.getConnectionPooling ( )

inline

                                         {
        return config.getFirst(LDAPConstants.CONNECTION_POOLING);
    }

getConnectionPoolingAuthentication()

String org.keycloak.storage.ldap.LDAPConfig.getConnectionPoolingAuthentication ( )

inline

                                                       {
        return config.getFirst(LDAPConstants.CONNECTION_POOLING_AUTHENTICATION);
    }

getConnectionPoolingDebug()

String org.keycloak.storage.ldap.LDAPConfig.getConnectionPoolingDebug ( )

inline

                                              {
        return config.getFirst(LDAPConstants.CONNECTION_POOLING_DEBUG);
    }

getConnectionPoolingInitSize()

String org.keycloak.storage.ldap.LDAPConfig.getConnectionPoolingInitSize ( )

inline

                                                 {
        return config.getFirst(LDAPConstants.CONNECTION_POOLING_INITSIZE);
    }

getConnectionPoolingMaxSize()

String org.keycloak.storage.ldap.LDAPConfig.getConnectionPoolingMaxSize ( )

inline

                                                {
        return config.getFirst(LDAPConstants.CONNECTION_POOLING_MAXSIZE);
    }

getConnectionPoolingPrefSize()

String org.keycloak.storage.ldap.LDAPConfig.getConnectionPoolingPrefSize ( )

inline

                                                 {
        return config.getFirst(LDAPConstants.CONNECTION_POOLING_PREFSIZE);
    }

getConnectionPoolingProtocol()

String org.keycloak.storage.ldap.LDAPConfig.getConnectionPoolingProtocol ( )

inline

                                                 {
        return config.getFirst(LDAPConstants.CONNECTION_POOLING_PROTOCOL);
    }

getConnectionPoolingTimeout()

String org.keycloak.storage.ldap.LDAPConfig.getConnectionPoolingTimeout ( )

inline

                                                {
        return config.getFirst(LDAPConstants.CONNECTION_POOLING_TIMEOUT);
    }

getConnectionTimeout()

String org.keycloak.storage.ldap.LDAPConfig.getConnectionTimeout ( )

inline

                                         {
        return config.getFirst(LDAPConstants.CONNECTION_TIMEOUT);
    }

getConnectionUrl()

String org.keycloak.storage.ldap.LDAPConfig.getConnectionUrl ( )

inline

                                     {
        return config.getFirst(LDAPConstants.CONNECTION_URL);
    }

getCustomUserSearchFilter()

String org.keycloak.storage.ldap.LDAPConfig.getCustomUserSearchFilter ( )

inline

                                              {
        String customFilter = config.getFirst(LDAPConstants.CUSTOM_USER_SEARCH_FILTER);
        if (customFilter != null) {
            customFilter = customFilter.trim();
            if (customFilter.length() > 0) {
                return customFilter;
            }
        }
        return null;
    }

getEditMode()

UserStorageProvider.EditMode org.keycloak.storage.ldap.LDAPConfig.getEditMode ( )

inline

                                                      {
        String editModeString = config.getFirst(LDAPConstants.EDIT_MODE);
        if (editModeString == null) {
            return UserStorageProvider.EditMode.READ_ONLY;
        } else {
            return UserStorageProvider.EditMode.valueOf(editModeString);
        }
    }

getFactoryName()

String org.keycloak.storage.ldap.LDAPConfig.getFactoryName ( )

inline

                                   {
        // hardcoded for now
        return "com.sun.jndi.ldap.LdapCtxFactory";
    }

getRdnLdapAttribute()

String org.keycloak.storage.ldap.LDAPConfig.getRdnLdapAttribute ( )

inline

                                        {
        String rdn = config.getFirst(LDAPConstants.RDN_LDAP_ATTRIBUTE);
        if (rdn == null) {
            rdn = getUsernameLdapAttribute();

            if (rdn.equalsIgnoreCase(LDAPConstants.SAM_ACCOUNT_NAME)) {
                // Just for the backwards compatibility 1.2 -> 1.3 . Should be removed later.
                rdn = LDAPConstants.CN;
            }

        }
        return rdn;
    }

getReadTimeout()

String org.keycloak.storage.ldap.LDAPConfig.getReadTimeout ( )

inline

                                   {
        return config.getFirst(LDAPConstants.READ_TIMEOUT);
    }

getSearchScope()

int org.keycloak.storage.ldap.LDAPConfig.getSearchScope ( )

inline

                                {
        String searchScope = config.getFirst(LDAPConstants.SEARCH_SCOPE);
        return searchScope == null ? SearchControls.SUBTREE_SCOPE : Integer.parseInt(searchScope);
    }

getUsernameLdapAttribute()

String org.keycloak.storage.ldap.LDAPConfig.getUsernameLdapAttribute ( )

inline

                                             {
        String username = config.getFirst(LDAPConstants.USERNAME_LDAP_ATTRIBUTE);
        if (username == null) {
            username = isActiveDirectory() ? LDAPConstants.CN : LDAPConstants.UID;
        }
        return username;
    }

getUserObjectClasses()

Collection<String> org.keycloak.storage.ldap.LDAPConfig.getUserObjectClasses ( )

inline

                                                     {
        String objClassesCfg = config.getFirst(LDAPConstants.USER_OBJECT_CLASSES);
        String objClassesStr = (objClassesCfg != null && objClassesCfg.length() > 0) ? objClassesCfg.trim() : "inetOrgPerson,organizationalPerson";

        String[] objectClasses = objClassesStr.split(",");

        // Trim them
        Set<String> userObjClasses = new HashSet<>();
        for (int i=0 ; i<objectClasses.length ; i++) {
            userObjClasses.add(objectClasses[i].trim());
        }
        return userObjClasses;
    }

getUsersDn()

String org.keycloak.storage.ldap.LDAPConfig.getUsersDn ( )

inline

                               {
        String usersDn = config.getFirst(LDAPConstants.USERS_DN);

        if (usersDn == null) {
            // Just for the backwards compatibility 1.2 -> 1.3 . Should be removed later.
            usersDn = config.getFirst("userDnSuffix");
        }

        return usersDn;
    }

getUseTruststoreSpi()

String org.keycloak.storage.ldap.LDAPConfig.getUseTruststoreSpi ( )

inline

                                        {
        return config.getFirst(LDAPConstants.USE_TRUSTSTORE_SPI);
    }

getUuidLDAPAttributeName()

String org.keycloak.storage.ldap.LDAPConfig.getUuidLDAPAttributeName ( )

inline

                                             {
        String uuidAttrName = config.getFirst(LDAPConstants.UUID_LDAP_ATTRIBUTE);
        if (uuidAttrName == null) {
            // Differences of unique attribute among various vendors
            String vendor = getVendor();
            uuidAttrName = LDAPConstants.getUuidAttributeName(vendor);
        }

        return uuidAttrName;
    }

getVendor()

String org.keycloak.storage.ldap.LDAPConfig.getVendor ( )

inline

                              {
        return config.getFirst(LDAPConstants.VENDOR);
    }

hashCode()

int org.keycloak.storage.ldap.LDAPConfig.hashCode ( )

inline

                          {
        return config.hashCode() * 13 + binaryAttributeNames.hashCode();
    }

isActiveDirectory()

boolean org.keycloak.storage.ldap.LDAPConfig.isActiveDirectory ( )

inline

                                       {
        String vendor = getVendor();
        return vendor != null && vendor.equals(LDAPConstants.VENDOR_ACTIVE_DIRECTORY);
    }

isObjectGUID()

boolean org.keycloak.storage.ldap.LDAPConfig.isObjectGUID ( )

inline

                                  {
        return getUuidLDAPAttributeName().equalsIgnoreCase(LDAPConstants.OBJECT_GUID);
    }

isPagination()

boolean org.keycloak.storage.ldap.LDAPConfig.isPagination ( )

inline

                                  {
        String pagination = config.getFirst(LDAPConstants.PAGINATION);
        return Boolean.parseBoolean(pagination);
    }

isValidatePasswordPolicy()

boolean org.keycloak.storage.ldap.LDAPConfig.isValidatePasswordPolicy ( )

inline

                                              {
        String validatePPolicy = config.getFirst(LDAPConstants.VALIDATE_PASSWORD_POLICY);
        return Boolean.parseBoolean(validatePPolicy);
    }

toString()

String org.keycloak.storage.ldap.LDAPConfig.toString ( )

inline

                             {
        MultivaluedHashMap<String, String> copy = new MultivaluedHashMap<String, String>(config);
        copy.remove(LDAPConstants.BIND_CREDENTIAL);
        return new StringBuilder(copy.toString())
                .append(", binaryAttributes: ").append(binaryAttributeNames)
                .toString();
    }

メンバ詳解

binaryAttributeNames

final Set<String> org.keycloak.storage.ldap.LDAPConfig.binaryAttributeNames = new HashSet<>()

private

config

final MultivaluedHashMap<String, String> org.keycloak.storage.ldap.LDAPConfig.config

private

---

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

• D:/AppData/doxygen/keycloak/src/keycloak/src/main/java/org/keycloak/storage/ldap/LDAPConfig.java