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

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

公開メンバ関数
List< org.xdi.oxauth.model.common.Scope >	getAllScopesList ()
List< String >	getDefaultScopesDn ()
List< String >	getScopesDn (List< String > scopeNames)
org.xdi.oxauth.model.common.Scope	getScopeByDn (String dn)
org.xdi.oxauth.model.common.Scope	getScopeByDnSilently (String dn)
org.xdi.oxauth.model.common.Scope	getScopeByDisplayName (String displayName)
List< org.xdi.oxauth.model.common.Scope >	getScopeByClaim (String claimDn)
List< org.xdi.oxauth.model.common.Scope >	getScopesByClaim (List< org.xdi.oxauth.model.common.Scope > scopes, String claimDn)

非公開メンバ関数
void	putInCache (org.xdi.oxauth.model.common.Scope scope)
void	putInCache (String claimDn, List< org.xdi.oxauth.model.common.Scope > scopes)
org.xdi.oxauth.model.common.Scope	fromCacheByDn (String dn)
org.xdi.oxauth.model.common.Scope	fromCacheByName (String name)
List< org.xdi.oxauth.model.common.Scope >	fromCacheByClaimDn (String claimDn)

静的非公開メンバ関数
static String	getClaimDnCacheKey (String claimDn)
static String	getScopeNameCacheKey (String name)
static String	getScopeDnCacheKey (String dn)

非公開変数類
Logger	log
CacheService	cacheService
PersistenceEntryManager	ldapEntryManager
StaticConfiguration	staticConfiguration

静的非公開変数類
static final String	CACHE_SCOPE_NAME = "ScopeCache"

詳解

著者

Javier Rojas Blum Date: 07.05.2012

Yuriy Movchan Date: 2016/04/26

関数詳解

fromCacheByClaimDn()

List<org.xdi.oxauth.model.common.Scope> org.xdi.oxauth.service.ScopeService.fromCacheByClaimDn ( String  claimDn )

inlineprivate

                                                                                       {
        try {
                String key = getClaimDnCacheKey(claimDn);
            return (List<org.xdi.oxauth.model.common.Scope>) cacheService.get(CACHE_SCOPE_NAME, key);
        } catch (Exception ex) {
            log.error("Failed to get scopes from cache, claimDn: '{}'", claimDn, ex);
            return null;
        }
    }

fromCacheByDn()

org.xdi.oxauth.model.common.Scope org.xdi.oxauth.service.ScopeService.fromCacheByDn ( String  dn )

inlineprivate

                                                                       {
        try {
            String key = getScopeDnCacheKey(dn);
            return (org.xdi.oxauth.model.common.Scope) cacheService.get(CACHE_SCOPE_NAME, key);
        } catch (Exception ex) {
            log.error("Failed to get scope from cache, scopeDn: '{}'", dn, ex);
            return null;
        }
    }

fromCacheByName()

org.xdi.oxauth.model.common.Scope org.xdi.oxauth.service.ScopeService.fromCacheByName ( String  name )

inlineprivate

                                                                           {
        try {
            String key = getScopeNameCacheKey(name);
            return (org.xdi.oxauth.model.common.Scope) cacheService.get(CACHE_SCOPE_NAME, key);
        } catch (Exception ex) {
            log.error("Failed to get scope from cache, name: '{}'", name, ex);
            return null;
        }
    }

getAllScopesList()

List<org.xdi.oxauth.model.common.Scope> org.xdi.oxauth.service.ScopeService.getAllScopesList ( )

inline

returns a list of all scopes

戻り値

list of scopes

                                                                      {
        String scopesBaseDN = staticConfiguration.getBaseDn().getScopes();

        return ldapEntryManager.findEntries(scopesBaseDN,
                org.xdi.oxauth.model.common.Scope.class,
                Filter.createPresenceFilter("inum"));
    }

getClaimDnCacheKey()

static String org.xdi.oxauth.service.ScopeService.getClaimDnCacheKey ( String  claimDn )

inlinestaticprivate

                                                             {
        return "claim_dn" + StringHelper.toLowerCase(claimDn);
    }

getDefaultScopesDn()

List<String> org.xdi.oxauth.service.ScopeService.getDefaultScopesDn ( )

inline

                                             {
        List<String> defaultScopes = new ArrayList<String>();

        for (org.xdi.oxauth.model.common.Scope scope : getAllScopesList()) {
            if (scope.getIsDefault()) {
                defaultScopes.add(scope.getDn());
            }
        }

        return defaultScopes;
    }

getScopeByClaim()

List<org.xdi.oxauth.model.common.Scope> org.xdi.oxauth.service.ScopeService.getScopeByClaim ( String  claimDn )

inline

Get scope by oxAuthClaims

引数

oxAuthClaim

戻り値

List of scope

                                                                                   {
        List<org.xdi.oxauth.model.common.Scope> scopes = fromCacheByClaimDn(claimDn);
        if (scopes == null) {
                Filter filter = Filter.createEqualityFilter("oxAuthClaim", claimDn);
                
                String scopesBaseDN = staticConfiguration.getBaseDn().getScopes();
                scopes = ldapEntryManager.findEntries(scopesBaseDN, org.xdi.oxauth.model.common.Scope.class, filter);  
        
                putInCache(claimDn, scopes);
        }

        return scopes;
    }

getScopeByDisplayName()

org.xdi.oxauth.model.common.Scope org.xdi.oxauth.service.ScopeService.getScopeByDisplayName ( String  displayName )

inline

Get scope by DisplayName

引数

DisplayName

戻り値

scope

                                                                                       {
        org.xdi.oxauth.model.common.Scope scope = fromCacheByName(displayName);
        if (scope == null) {
                String scopesBaseDN = staticConfiguration.getBaseDn().getScopes();
        
                org.xdi.oxauth.model.common.Scope scopeExample = new org.xdi.oxauth.model.common.Scope();
                scopeExample.setDn(scopesBaseDN);
                scopeExample.setDisplayName(displayName);
        
                List<org.xdi.oxauth.model.common.Scope> scopes = ldapEntryManager.findEntries(scopeExample);
                if ((scopes != null) && (scopes.size() > 0)) {
                        scope = scopes.get(0);
                }
                
                putInCache(scope);
        }

        return scope;
    }    

getScopeByDn()

org.xdi.oxauth.model.common.Scope org.xdi.oxauth.service.ScopeService.getScopeByDn ( String  dn )

inline

returns Scope by Dn

戻り値

Scope

                                                                     {
        org.xdi.oxauth.model.common.Scope scope = fromCacheByDn(dn);
        if (scope == null) {
                scope = ldapEntryManager.find(org.xdi.oxauth.model.common.Scope.class, dn);
                putInCache(scope);
        }
        
        return scope;
    }

getScopeByDnSilently()

org.xdi.oxauth.model.common.Scope org.xdi.oxauth.service.ScopeService.getScopeByDnSilently ( String  dn )

inline

returns Scope by Dn

戻り値

Scope

                                                                             {
        try {
            return getScopeByDn(dn);
        } catch (Exception e) {
            log.trace(e.getMessage(), e);
            return null;
        }
    }

getScopeDnCacheKey()

static String org.xdi.oxauth.service.ScopeService.getScopeDnCacheKey ( String  dn )

inlinestaticprivate

                                                        {
        return "scope_dn_" + StringHelper.toLowerCase(dn);
    }

getScopeNameCacheKey()

static String org.xdi.oxauth.service.ScopeService.getScopeNameCacheKey ( String  name )

inlinestaticprivate

                                                            {
        return "scope_name_" + StringHelper.toLowerCase(name);
    }

getScopesByClaim()

List<org.xdi.oxauth.model.common.Scope> org.xdi.oxauth.service.ScopeService.getScopesByClaim ( List< org.xdi.oxauth.model.common.Scope >  scopes, String  claimDn  )

inline

                                                                                                                                        {
                List<org.xdi.oxauth.model.common.Scope> result = new ArrayList<org.xdi.oxauth.model.common.Scope>();
                for (org.xdi.oxauth.model.common.Scope scope : scopes) {
                        List<String> claims = scope.getOxAuthClaims();
                        if ((claims != null) && claims.contains(claimDn)) {
                                result.add(scope);
                        }
                        
                }

                return result;
        }

getScopesDn()

List<String> org.xdi.oxauth.service.ScopeService.getScopesDn ( List< String >  scopeNames )

inline

                                                             {
        List<String> scopes = new ArrayList<String>();

        for (String scopeName : scopeNames) {
            org.xdi.oxauth.model.common.Scope scope = getScopeByDisplayName(scopeName);
            if (scope != null) {
                scopes.add(scope.getDn());
            }
        }

        return scopes;
    }

putInCache() [1/2]

void org.xdi.oxauth.service.ScopeService.putInCache ( org.xdi.oxauth.model.common.Scope  scope )

inlineprivate

                                                                     {
        if (scope == null) {
                return;
        }

        try {
            cacheService.put(CACHE_SCOPE_NAME, getScopeNameCacheKey(scope.getDisplayName()), scope, Constants.SKIP_CACHE_PUT_FOR_NATIVE_PERSISTENCE);
            cacheService.put(CACHE_SCOPE_NAME, getScopeDnCacheKey(scope.getDn()), scope, Constants.SKIP_CACHE_PUT_FOR_NATIVE_PERSISTENCE);
        } catch (Exception ex) {
            log.error("Failed to put scope in cache, scope: '{}'", scope, ex);
        }
    }

putInCache() [2/2]

void org.xdi.oxauth.service.ScopeService.putInCache ( String  claimDn, List< org.xdi.oxauth.model.common.Scope >  scopes  )

inlineprivate

                                                                                            {
        if (scopes == null) {
                return;
        }

        try {
                String key = getClaimDnCacheKey(claimDn);
            cacheService.put(CACHE_SCOPE_NAME, key, scopes);
        } catch (Exception ex) {
            log.error("Failed to put scopes in cache, claimDn: '{}'", claimDn, ex);
        }
    }

メンバ詳解

CACHE_SCOPE_NAME

final String org.xdi.oxauth.service.ScopeService.CACHE_SCOPE_NAME = "ScopeCache"

staticprivate

cacheService

CacheService org.xdi.oxauth.service.ScopeService.cacheService

private

ldapEntryManager

PersistenceEntryManager org.xdi.oxauth.service.ScopeService.ldapEntryManager

private

log

Logger org.xdi.oxauth.service.ScopeService.log

private

staticConfiguration

StaticConfiguration org.xdi.oxauth.service.ScopeService.staticConfiguration

private

---

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

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