org.xdi.oxauth.service.ClientAuthorizationsService クラス

org.xdi.oxauth.service.ClientAuthorizationsService 連携図

公開メンバ関数
void	addBranch (final String userInum)
boolean	containsBranch (final String userInum)
void	prepareBranch (final String userInum)
ClientAuthorizations	findClientAuthorizations (String userInum, String clientId, boolean persistInLdap)
void	add (String userInum, String clientId, Set< String > scopes, boolean persistInLdap)
String	getBaseDnForClientAuthorizations (String oxId, String userInum)
String	getBaseDnForClientAuthorizations (String userInum)

非公開メンバ関数
String	getCacheKey (String userInum, String clientId)

非公開変数類
Logger	log
PersistenceEntryManager	ldapEntryManager
UserService	userService
CacheService	cacheService

静的非公開変数類
static final String	CACHE_CLIENT_CUTHORIZATION = "ClientAuthorizationCache"

詳解

著者

Javier Rojas Blum

バージョン

January 17, 2018

関数詳解

add()

void org.xdi.oxauth.service.ClientAuthorizationsService.add ( String  userInum, String  clientId, Set< String >  scopes, boolean  persistInLdap  )

inline

                                                                                                 {
        if (persistInLdap) {
            // oxAuth #441 Pre-Authorization + Persist Authorizations... don't write anything
            // If a client has pre-authorization=true, there is no point to create the entry under
            // ou=clientAuthorizations it will negatively impact performance, grow the size of the
            // ldap database, and serve no purpose.
            prepareBranch(userInum);

            ClientAuthorizations clientAuthorizations = findClientAuthorizations(userInum, clientId, persistInLdap);

            if (clientAuthorizations == null) {
                clientAuthorizations = new ClientAuthorizations();
                clientAuthorizations.setId(UUID.randomUUID().toString());
                clientAuthorizations.setClientId(clientId);
                clientAuthorizations.setScopes(scopes.toArray(new String[scopes.size()]));
                clientAuthorizations.setDn(getBaseDnForClientAuthorizations(clientAuthorizations.getId(), userInum));

                ldapEntryManager.persist(clientAuthorizations);
            } else if (clientAuthorizations.getScopes() != null) {
                Set<String> set = new HashSet<String>(scopes);
                set.addAll(Arrays.asList(clientAuthorizations.getScopes()));
                clientAuthorizations.setScopes(set.toArray(new String[set.size()]));

                ldapEntryManager.merge(clientAuthorizations);
            }
        } else {
            // Put client authorization in cache. oxAuth #662.
            ClientAuthorizations clientAuthorizations = findClientAuthorizations(userInum, clientId, persistInLdap);
            String key = getCacheKey(userInum, clientId);

            if (clientAuthorizations == null) {
                clientAuthorizations = new ClientAuthorizations();
                clientAuthorizations.setId(UUID.randomUUID().toString());
                clientAuthorizations.setClientId(clientId);
                clientAuthorizations.setScopes(scopes.toArray(new String[scopes.size()]));
                clientAuthorizations.setDn(getBaseDnForClientAuthorizations(clientAuthorizations.getId(), userInum));

                cacheService.put(CACHE_CLIENT_CUTHORIZATION, key, clientAuthorizations);
            } else if (clientAuthorizations.getScopes() != null) {
                Set<String> set = new HashSet<String>(scopes);
                set.addAll(Arrays.asList(clientAuthorizations.getScopes()));
                clientAuthorizations.setScopes(set.toArray(new String[set.size()]));

                cacheService.put(CACHE_CLIENT_CUTHORIZATION, key, clientAuthorizations);
            }
        }
    }

addBranch()

void org.xdi.oxauth.service.ClientAuthorizationsService.addBranch ( final String  userInum )

inline

                                                 {
        SimpleBranch branch = new SimpleBranch();
        branch.setOrganizationalUnitName("clientAuthorizations");
        branch.setDn(getBaseDnForClientAuthorizations(userInum));

        ldapEntryManager.persist(branch);
    }

containsBranch()

boolean org.xdi.oxauth.service.ClientAuthorizationsService.containsBranch ( final String  userInum )

inline

                                                         {
        return ldapEntryManager.contains(SimpleBranch.class, getBaseDnForClientAuthorizations(userInum));
    }

findClientAuthorizations()

ClientAuthorizations org.xdi.oxauth.service.ClientAuthorizationsService.findClientAuthorizations ( String  userInum, String  clientId, boolean  persistInLdap  )

inline

                                                                                                                  {
        if (persistInLdap) {
            prepareBranch(userInum);

            String baseDn = getBaseDnForClientAuthorizations(userInum);
            Filter filter = Filter.createEqualityFilter("oxAuthClientId", clientId);

            List<ClientAuthorizations> entries = ldapEntryManager.findEntries(baseDn, ClientAuthorizations.class, filter);
            if (entries != null && !entries.isEmpty()) {
                // if more then one entry then it's problem, non-deterministic behavior, id must be unique
                if (entries.size() > 1) {
                    log.error("Found more then one client authorization entry by client Id: {}" + clientId);
                    for (ClientAuthorizations entry : entries) {
                        log.error(entry.toString());
                    }
                }
                return entries.get(0);
            }
        } else {
            String key = getCacheKey(userInum, clientId);
            Object cacheOjb = cacheService.get(CACHE_CLIENT_CUTHORIZATION, key);
            if (cacheOjb != null && cacheOjb instanceof ClientAuthorizations) {
                return (ClientAuthorizations) cacheOjb;
            }
        }

        return null;
    }

getBaseDnForClientAuthorizations() [1/2]

String org.xdi.oxauth.service.ClientAuthorizationsService.getBaseDnForClientAuthorizations ( String  oxId, String  userInum  )

inline

                                                                                 {
        String baseDn = getBaseDnForClientAuthorizations(userInum);
        if (StringHelper.isEmpty(oxId)) {
            return baseDn;
        }
        return String.format("oxId=%s,%s", oxId, baseDn);
    }

getBaseDnForClientAuthorizations() [2/2]

String org.xdi.oxauth.service.ClientAuthorizationsService.getBaseDnForClientAuthorizations ( String  userInum )

inline

                                                                    {
        final String userBaseDn = userService.getDnForUser(userInum); // inum=1234,ou=people,o=@!1111,o=gluu"
        return String.format("ou=clientAuthorizations,%s", userBaseDn); // "ou=clientAuthorizations,inum=1234,ou=people,o=@!1111,o=gluu"
    }

getCacheKey()

String org.xdi.oxauth.service.ClientAuthorizationsService.getCacheKey ( String  userInum, String  clientId  )

inlineprivate

                                                                 {
        return userInum + "_" + clientId;
    }

prepareBranch()

void org.xdi.oxauth.service.ClientAuthorizationsService.prepareBranch ( final String  userInum )

inline

                                                     {
        // Create client authorizations branch if needed
        if (!containsBranch(userInum)) {
            addBranch(userInum);
        }
    }

メンバ詳解

CACHE_CLIENT_CUTHORIZATION

final String org.xdi.oxauth.service.ClientAuthorizationsService.CACHE_CLIENT_CUTHORIZATION = "ClientAuthorizationCache"

staticprivate

cacheService

CacheService org.xdi.oxauth.service.ClientAuthorizationsService.cacheService

private

ldapEntryManager

PersistenceEntryManager org.xdi.oxauth.service.ClientAuthorizationsService.ldapEntryManager

private

log

Logger org.xdi.oxauth.service.ClientAuthorizationsService.log

private

userService

UserService org.xdi.oxauth.service.ClientAuthorizationsService.userService

private

---

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

• D:/AppData/OpenId/gluu/src/oxAuth/Server/src/main/java/org/xdi/oxauth/service/ClientAuthorizationsService.java