org.gluu.credmanager.service.LdapService クラス

org.gluu.credmanager.service.LdapService の継承関係図

org.gluu.credmanager.service.LdapService 連携図

公開メンバ関数
boolean	isInService ()
String	getOIDCEndpoint ()
String	getIssuerUrl ()
int	getDynamicClientExpirationTime ()
String	getEncryptedString (String str) throws StringEncrypter.EncryptionException
String	getDecryptedString (String str) throws StringEncrypter.EncryptionException
boolean	setup (LdapSettings ldapSettings) throws Exception
Map< String, String >	getCustScriptConfigProperties (String displayName)
String	getPersonDn (String id)
String	getPeopleDn ()
String	getGroupsDn ()
String	getClientsDn ()
String	getScopesDn ()
String	getCustomScriptsDn ()
String	getOrganizationInum ()
gluuOrganization	getOrganization ()
boolean	isAdmin (String userId)
boolean	isBackendLdapEnabled ()
boolean	authenticate (String uid, String pass) throws Exception
void	prepareFidoBranch (String userInum)

関数
public< T > T	get (Class< T > clazz, String dn)
public< T > List< T >	find (Class< T > clazz, String parentDn, String filter)
public< T > List< T >	find (T object, Class< T > clazz, String parentDn)
public< T > boolean	add (T object, Class< T > clazz, String parentDn)
public< T > boolean	modify (T object, Class< T > clazz)
public< T > boolean	delete (T object, Class< T > clazz)
private< T > List< T >	fromPersistedObjects (PersistedObjects< T > objects) throws LDAPPersistException

非公開メンバ関数
void	inited ()
boolean	loadApplianceSettings (Properties properties)
void	loadOxAuthSettings (String dn) throws Exception
void	loadOxTrustSettings (String dn) throws Exception

非公開変数類
Logger	logger
MainSettings	settings
boolean	inService
OperationsFacade	ldapOperationService
LdapEntryManager	ldapEntryManager
String	orgInum
JsonNode	oxAuthConfDynamic
JsonNode	oxAuthConfStatic
JsonNode	oxTrustConfApplication
JsonNode	oxTrustConfCacheRefresh
ObjectMapper	mapper
StringEncrypter	stringEncrypter

詳解

著者

jgomer

関数詳解

add()

public<T> boolean org.gluu.credmanager.service.LdapService.add ( T  object, Class< T >  clazz, String  parentDn  )

inlinepackage

org.gluu.credmanager.service.ILdapServiceを実装しています。

                                                                      {

        boolean success = false;
        try {
            LDAPPersister<T> persister = LDAPPersister.getInstance(clazz);
            LDAPResult ldapResult = persister.add(object, ldapOperationService.getConnection(), parentDn);
            success = ldapResult.getResultCode().equals(ResultCode.SUCCESS);
            logger.trace("add. Operation result was '{}'", ldapResult.getResultCode().getName());
        } catch (Exception e) {
            logger.error(e.getMessage(), e);
        }
        return success;

    }

authenticate()

boolean org.gluu.credmanager.service.LdapService.authenticate ( String  uid, String  pass  ) throws Exception

inline

                                                                          {
        if (oxTrustConfApplication != null) {
            return ldapOperationService.authenticate(uid, pass, oxTrustConfApplication.get("baseDN").asText());
        }
        throw new UnsupportedOperationException("LDAP authentication is not supported with current settings");
    }

delete()

public<T> boolean org.gluu.credmanager.service.LdapService.delete ( T  object, Class< T >  clazz  )

inlinepackage

org.gluu.credmanager.service.ILdapServiceを実装しています。

                                                        {

        boolean success = false;
        try {
            LDAPPersister<T> persister = LDAPPersister.getInstance(clazz);
            LDAPResult ldapResult = persister.delete(object, ldapOperationService.getConnection());
            success = ldapResult.getResultCode().equals(ResultCode.SUCCESS);
            logger.trace("delete. Operation result was '{}'", ldapResult.getResultCode().getName());
        } catch (Exception e) {
            logger.error(e.getMessage(), e);
        }
        return success;

    }

find() [1/2]

public<T> List<T> org.gluu.credmanager.service.LdapService.find ( Class< T >  clazz, String  parentDn, String  filter  )

inlinepackage

org.gluu.credmanager.service.ILdapServiceを実装しています。

                                                                            {

        List<T> results = new ArrayList<>();
        try {
            LDAPPersister<T> persister = LDAPPersister.getInstance(clazz);
            results = fromPersistedObjects(persister.search(ldapOperationService.getConnection(), parentDn, SearchScope.SUB,
                    DereferencePolicy.NEVER, 0, 0, Filter.create(filter), null));
        } catch (Exception e) {
            logger.error(e.getMessage(), e);
        }
        return results;

    }

find() [2/2]

public<T> List<T> org.gluu.credmanager.service.LdapService.find ( T  object, Class< T >  clazz, String  parentDn  )

inlinepackage

org.gluu.credmanager.service.ILdapServiceを実装しています。

                                                                       {

        List<T> results = new ArrayList<>();
        try {
            LDAPPersister<T> persister = LDAPPersister.getInstance(clazz);
            results = fromPersistedObjects(persister.search(object, ldapOperationService.getConnection(), parentDn, SearchScope.SUB));
        } catch (Exception e) {
            logger.error(e.getMessage(), e);
        }
        return results;

    }

fromPersistedObjects()

private<T> List<T> org.gluu.credmanager.service.LdapService.fromPersistedObjects ( PersistedObjects< T >  objects ) throws LDAPPersistException

inlinepackage

                                                                                                      {

        List<T> results = new ArrayList<>();
        for (T obj = objects.next(); obj != null; obj = objects.next()) {
            results.add(obj);
        }
        return results;

    }

get()

public<T> T org.gluu.credmanager.service.LdapService.get ( Class< T >  clazz, String  dn  )

inlinepackage

org.gluu.credmanager.service.ILdapServiceを実装しています。

                                                {

        T object = null;
        try {
            LDAPPersister<T> persister = LDAPPersister.getInstance(clazz);
            object = persister.get(dn, ldapOperationService.getConnection());
        } catch (Exception e) {
            logger.error(e.getMessage(), e);
        }
        return object;

    }

getClientsDn()

String org.gluu.credmanager.service.LdapService.getClientsDn ( )

inline

org.gluu.credmanager.service.ILdapServiceを実装しています。

                                 {
        return oxAuthConfStatic.get("baseDn").get("clients").asText();
    }

getCustomScriptsDn()

String org.gluu.credmanager.service.LdapService.getCustomScriptsDn ( )

inline

org.gluu.credmanager.service.ILdapServiceを実装しています。

                                       {
        return oxAuthConfStatic.get("baseDn").get("scripts").asText();
    }

getCustScriptConfigProperties()

Map<String, String> org.gluu.credmanager.service.LdapService.getCustScriptConfigProperties ( String  displayName )

inline

org.gluu.credmanager.service.ILdapServiceを実装しています。

                                                                                 {

        Map<String, String> properties = null;
        try {
            oxCustomScript script = new oxCustomScript();
            script.setDisplayName(displayName);

            List<oxCustomScript> scripts = find(script, oxCustomScript.class, getCustomScriptsDn());
            if (scripts.size() > 0) {
                String[] props = scripts.get(0).getConfigurationProperties();

                properties = new HashMap<>();
                if (Utils.isNotEmpty(props)) {
                    for (String prop : props) {
                        try {
                            JsonNode node = mapper.readTree(prop);
                            String key = node.get("value1").asText();
                            String value = node.get("value2").asText();
                            properties.put(key, value);
                        } catch (Exception e) {
                            logger.error("Error reading a custom script configuration property ({})", e.getMessage());
                        }
                    }
                }
            }
        } catch (Exception e) {
            logger.error(e.getMessage(), e);
        }
        return properties;

    }

getDecryptedString()

String org.gluu.credmanager.service.LdapService.getDecryptedString ( String  str ) throws StringEncrypter.EncryptionException

inline

                                                                                             {
        return stringEncrypter == null ? str :  stringEncrypter.decrypt(str);
    }

getDynamicClientExpirationTime()

int org.gluu.credmanager.service.LdapService.getDynamicClientExpirationTime ( )

inline

                                                {
        boolean dynRegEnabled = oxAuthConfDynamic.get("dynamicRegistrationEnabled").asBoolean();
        return dynRegEnabled ? oxAuthConfDynamic.get("dynamicRegistrationExpirationTime").asInt() : -1;
    }

getEncryptedString()

String org.gluu.credmanager.service.LdapService.getEncryptedString ( String  str ) throws StringEncrypter.EncryptionException

inline

                                                                                            {
        return stringEncrypter == null ? str : stringEncrypter.encrypt(str);
    }

getGroupsDn()

String org.gluu.credmanager.service.LdapService.getGroupsDn ( )

inline

org.gluu.credmanager.service.ILdapServiceを実装しています。

                                {
        return oxAuthConfStatic.get("baseDn").get("groups").asText();
    }

getIssuerUrl()

String org.gluu.credmanager.service.LdapService.getIssuerUrl ( )

inline

                                 {
        return oxAuthConfDynamic.get("issuer").asText();
    }

getOIDCEndpoint()

String org.gluu.credmanager.service.LdapService.getOIDCEndpoint ( )

inline

                                    {
        return oxAuthConfDynamic.get("openIdConfigurationEndpoint").asText();
    }

getOrganization()

gluuOrganization org.gluu.credmanager.service.LdapService.getOrganization ( )

inline

org.gluu.credmanager.service.ILdapServiceを実装しています。

                                              {
        return get(gluuOrganization.class, String.format("o=%s,o=gluu", getOrganizationInum()));
    }

getOrganizationInum()

String org.gluu.credmanager.service.LdapService.getOrganizationInum ( )

inline

org.gluu.credmanager.service.ILdapServiceを実装しています。

                                        {
        return oxAuthConfDynamic.get("organizationInum").asText();
    }

getPeopleDn()

String org.gluu.credmanager.service.LdapService.getPeopleDn ( )

inline

org.gluu.credmanager.service.ILdapServiceを実装しています。

                                {
        return oxAuthConfStatic.get("baseDn").get("people").asText();
    }

getPersonDn()

String org.gluu.credmanager.service.LdapService.getPersonDn ( String  id )

inline

org.gluu.credmanager.service.ILdapServiceを実装しています。

                                         {
        return String.format("inum=%s,%s", id, getPeopleDn());
    }

getScopesDn()

String org.gluu.credmanager.service.LdapService.getScopesDn ( )

inline

org.gluu.credmanager.service.ILdapServiceを実装しています。

                                {
        return oxAuthConfStatic.get("baseDn").get("scopes").asText();
    }

inited()

void org.gluu.credmanager.service.LdapService.inited ( )

inlineprivate

                          {

        try {
            mapper = new ObjectMapper();
            inService = setup(settings.getLdapSettings());

            logger.info("LDAPService was{} initialized successfully", inService ? "" : " not");
        } catch (Exception e) {
            logger.error(e.getMessage(), e);
        }

    }

isAdmin()

boolean org.gluu.credmanager.service.LdapService.isAdmin ( String  userId )

inline

                                          {
        gluuOrganization organization = getOrganization();
        DN[] dns = organization.getGluuManagerGroupDNs();

        Person personMember = get(Person.class, getPersonDn(userId));
        return personMember != null
                && personMember.getMemberOfDNs().stream().anyMatch(m -> Stream.of(dns).anyMatch(dn -> dn.equals(m)));

    }

isBackendLdapEnabled()

boolean org.gluu.credmanager.service.LdapService.isBackendLdapEnabled ( )

inline

Tries to determine whether local installation of Gluu is using a backend LDAP. This reads the OxTrust configuration Json and inspects inside property "sourceConfigs"

戻り値

例外

Exception

                                          {

        try {
            if (oxTrustConfCacheRefresh != null) {
                List<Boolean> enabledList = new ArrayList<>();
                oxTrustConfCacheRefresh.get("sourceConfigs").forEach(node -> enabledList.add(node.get("enabled").asBoolean()));
                return enabledList.stream().anyMatch(Boolean::booleanValue);
            }
        } catch (Exception e) {
            logger.error(e.getMessage(), e);
        }
        return false;

    }

isInService()

boolean org.gluu.credmanager.service.LdapService.isInService ( )

inline

                                 {
        return inService;
    }

loadApplianceSettings()

boolean org.gluu.credmanager.service.LdapService.loadApplianceSettings ( Properties  properties )

inlineprivate

                                                                 {

        boolean success = false;
        try {
            loadOxAuthSettings(properties.getProperty("oxauth_ConfigurationEntryDN"));
            success = true;
            String dn = properties.getProperty("oxtrust_ConfigurationEntryDN");
            if (dn != null) {
                loadOxTrustSettings(dn);
            }
        } catch (Exception e) {
            logger.error(e.getMessage(), e);
        }
        return success;

    }

loadOxAuthSettings()

void org.gluu.credmanager.service.LdapService.loadOxAuthSettings ( String  dn ) throws Exception

inlineprivate

                                                                {

        oxAuthConfiguration conf = get(oxAuthConfiguration.class, dn);
        oxAuthConfDynamic = mapper.readTree(conf.getAuthConfDynamic());
        oxAuthConfStatic = mapper.readTree(conf.getAuthConfStatic());


    }

loadOxTrustSettings()

void org.gluu.credmanager.service.LdapService.loadOxTrustSettings ( String  dn ) throws Exception

inlineprivate

                                                                 {
        oxTrustConfiguration confT = get(oxTrustConfiguration.class, dn);
        if (confT != null) {
            oxTrustConfApplication = mapper.readTree(confT.getOxTrustConfApplication());
            oxTrustConfCacheRefresh = mapper.readTree(confT.getOxTrustConfCacheRefresh());
        }
    }

modify()

public<T> boolean org.gluu.credmanager.service.LdapService.modify ( T  object, Class< T >  clazz  )

inlinepackage

org.gluu.credmanager.service.ILdapServiceを実装しています。

                                                        {

        boolean success = false;
        try {
            LDAPPersister<T> persister = LDAPPersister.getInstance(clazz);
            LDAPResult ldapResult = persister.modify(object, ldapOperationService.getConnection(), null, true);
            if (ldapResult == null) {
                logger.trace("modify. No attribute changes took place for this modification");
            } else {
                success = ldapResult.getResultCode().equals(ResultCode.SUCCESS);
                logger.trace("modify. Operation result was '{}'", ldapResult.getResultCode().getName());
            }
        } catch (Exception e) {
            logger.error(e.getMessage(), e);
        }
        return success;

    }

prepareFidoBranch()

void org.gluu.credmanager.service.LdapService.prepareFidoBranch ( String  userInum )

inline

                                                  {

        String dn = String.format("ou=fido,inum=%s,%s", userInum, getPeopleDn());
        organizationalUnit entry = get(organizationalUnit.class, dn);
        if (entry == null) {
            logger.info("Non existing fido branch for {}, creating...", userInum);
            entry = new organizationalUnit();
            entry.setDn(dn);
            entry.setOu("fido");

            if (!modify(entry, organizationalUnit.class)) {
                logger.error("Could not create fido branch");
            }
        }

    }

setup()

boolean org.gluu.credmanager.service.LdapService.setup ( LdapSettings  ldapSettings ) throws Exception

inline

                                                                     {

        Properties ldapProperties = new FileConfiguration(ldapSettings.getOxLdapLocation()).getProperties();
        String saltFile = ldapSettings.getSaltLocation();

        if (Utils.isNotEmpty(saltFile)) {
            String salt = new FileConfiguration(saltFile).getProperties().getProperty("encodeSalt");
            stringEncrypter = StringEncrypter.instance(salt);
            ldapProperties = PropertiesDecrypter.decryptProperties(stringEncrypter, ldapProperties);
        }
        //3.2.0 style
        //ldapOperationService = new LdapEntryManagerFactory().createEntryManager(ldapProperties).getOperationService();
        //ldapEntryManager = ldapOperationService.get...

        //3.1.x style:
        ldapEntryManager = new LdapEntryManager(new OperationsFacade(new LDAPConnectionProvider(ldapProperties)));
        ldapOperationService = ldapEntryManager.getLdapOperationService();

        //Initialize important class members
        return loadApplianceSettings(ldapProperties);

    }

メンバ詳解

inService

boolean org.gluu.credmanager.service.LdapService.inService

private

ldapEntryManager

LdapEntryManager org.gluu.credmanager.service.LdapService.ldapEntryManager

private

ldapOperationService

OperationsFacade org.gluu.credmanager.service.LdapService.ldapOperationService

private

logger

Logger org.gluu.credmanager.service.LdapService.logger

private

mapper

ObjectMapper org.gluu.credmanager.service.LdapService.mapper

private

orgInum

String org.gluu.credmanager.service.LdapService.orgInum

private

oxAuthConfDynamic

JsonNode org.gluu.credmanager.service.LdapService.oxAuthConfDynamic

private

oxAuthConfStatic

JsonNode org.gluu.credmanager.service.LdapService.oxAuthConfStatic

private

oxTrustConfApplication

JsonNode org.gluu.credmanager.service.LdapService.oxTrustConfApplication

private

oxTrustConfCacheRefresh

JsonNode org.gluu.credmanager.service.LdapService.oxTrustConfCacheRefresh

private

settings

MainSettings org.gluu.credmanager.service.LdapService.settings

private

stringEncrypter

StringEncrypter org.gluu.credmanager.service.LdapService.stringEncrypter

private

---

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

• D:/AppData/OpenId/gluu/src/cred-manager/app/src/main/java/org/gluu/credmanager/service/LdapService.java