org.gluu.oxtrust.ldap.service.ScopeService クラス

org.gluu.oxtrust.ldap.service.ScopeService の継承関係図

org.gluu.oxtrust.ldap.service.ScopeService 連携図

公開メンバ関数
void	addScope (OxAuthScope scope) throws Exception
void	removeScope (OxAuthScope scope) throws Exception
OxAuthScope	getScopeByInum (String inum) throws Exception
String	getDnForScope (String inum) throws Exception
void	updateScope (OxAuthScope scope) throws Exception
String	generateInumForNewScope () throws Exception
List< OxAuthScope >	searchScopes (String pattern, int sizeLimit) throws Exception
OxAuthScope	getScopeByDn (String Dn) throws Exception
List< ScopeType >	getScopeTypes ()
OxAuthScope	getScopeByDisplayName (String DisplayName) throws Exception

非公開メンバ関数
String	generateInumForNewScopeImpl () throws Exception

非公開変数類
PersistenceEntryManager	ldapEntryManager
OrganizationService	organizationService
Logger	logger

静的非公開変数類
static final long	serialVersionUID = 65734145678106186L

詳解

Provides operations with Scopes

著者

Reda Zerrad Date: 06.18.2012

関数詳解

addScope()

void org.gluu.oxtrust.ldap.service.ScopeService.addScope ( OxAuthScope  scope ) throws Exception

inline

Add new scope entry

引数

scope

scope

                                                                 {
                ldapEntryManager.persist(scope);
        }

generateInumForNewScope()

String org.gluu.oxtrust.ldap.service.ScopeService.generateInumForNewScope ( ) throws Exception

inline

Generate new inum for scope

戻り値

New inum for scope

                                                                 {
                OxAuthScope scope = new OxAuthScope();
                String newInum = null;
                do {
                        newInum = generateInumForNewScopeImpl();
                        String newDn = getDnForScope(newInum);
                        scope.setDn(newDn);
                } while (ldapEntryManager.contains(scope));

                return newInum;
        }

generateInumForNewScopeImpl()

String org.gluu.oxtrust.ldap.service.ScopeService.generateInumForNewScopeImpl ( ) throws Exception

inlineprivate

Generate new inum for Scope

戻り値

New inum for Scope

例外

Exception

                                                                      {
                String orgInum = organizationService.getInumForOrganization();
                return orgInum + OxTrustConstants.inumDelimiter + "0009" + OxTrustConstants.inumDelimiter
                                + INumGenerator.generate(2);

        }

getDnForScope()

String org.gluu.oxtrust.ldap.service.ScopeService.getDnForScope ( String  inum ) throws Exception

inline

Build DN string for scope

引数

inum	scope Inum

戻り値

DN string for specified scope or DN for scopes branch if inum is null

例外

Exception

                                                                  {
                String orgDn = organizationService.getDnForOrganization();
                if (StringHelper.isEmpty(inum)) {
                        return String.format("ou=scopes,%s", orgDn);
                }

                return String.format("inum=%s,ou=scopes,%s", inum, orgDn);
        }

getScopeByDisplayName()

OxAuthScope org.gluu.oxtrust.ldap.service.ScopeService.getScopeByDisplayName ( String  DisplayName ) throws Exception

inline

Get scope by DisplayName

引数

DisplayName

戻り値

scope

                                                                                      {
                OxAuthScope scope = new OxAuthScope();
                scope.setBaseDn(getDnForScope(null));
                scope.setDisplayName(DisplayName);

                List<OxAuthScope> scopes = ldapEntryManager.findEntries(scope);

                if ((scopes != null) && (scopes.size() > 0)) {
                        return scopes.get(0);
                }

                return null;
        }

getScopeByDn()

OxAuthScope org.gluu.oxtrust.ldap.service.ScopeService.getScopeByDn ( String  Dn ) throws Exception

inline

returns oxAuthScope by Dn

戻り値

oxAuthScope

                                                                    {
                OxAuthScope result = ldapEntryManager.find(OxAuthScope.class, Dn);

                return result;
        }

getScopeByInum()

OxAuthScope org.gluu.oxtrust.ldap.service.ScopeService.getScopeByInum ( String  inum ) throws Exception

inline

Get scope by inum

引数

inum	scope Inum

戻り値

scope

                                                                        {
                OxAuthScope result = null;
                try {
                        result = ldapEntryManager.find(OxAuthScope.class, getDnForScope(inum));
                } catch (Exception e) {
                        logger.debug("", e);
                }
                return result;
        }

getScopeTypes()

List<ScopeType> org.gluu.oxtrust.ldap.service.ScopeService.getScopeTypes ( )

inline

Get all available scope types

戻り値

Array of scope types

                                               {
                List<ScopeType> scopeTypes = new ArrayList<ScopeType>(
                                Arrays.asList(org.xdi.oxauth.model.common.ScopeType.values()));
                return scopeTypes;
        }

removeScope()

void org.gluu.oxtrust.ldap.service.ScopeService.removeScope ( OxAuthScope  scope ) throws Exception

inline

Remove scope entry

引数

scope

scope

                                                                    {

                ldapEntryManager.remove(scope);
        }

searchScopes()

List<OxAuthScope> org.gluu.oxtrust.ldap.service.ScopeService.searchScopes ( String  pattern, int  sizeLimit  ) throws Exception

inline

Search scopes by pattern

引数

pattern	Pattern
sizeLimit	Maximum count of results

戻り値

List of scopes

例外

Exception

                                                                                              {
                Filter searchFilter = null;
                if (StringHelper.isNotEmpty(pattern)) {
                        String[] targetArray = new String[] { pattern };
                        Filter displayNameFilter = Filter.createSubstringFilter(OxTrustConstants.displayName, null, targetArray,
                                        null);
                        Filter descriptionFilter = Filter.createSubstringFilter(OxTrustConstants.description, null, targetArray,
                                        null);
                        Filter inameFilter = Filter.createSubstringFilter(OxTrustConstants.iname, null, targetArray, null);
                        searchFilter = Filter.createORFilter(displayNameFilter, descriptionFilter, inameFilter);
                }
                List<OxAuthScope> result = ldapEntryManager.findEntries(getDnForScope(null), OxAuthScope.class, searchFilter,
                                sizeLimit);

                return result;
        }

updateScope()

void org.gluu.oxtrust.ldap.service.ScopeService.updateScope ( OxAuthScope  scope ) throws Exception

inline

Update scope entry

引数

scope

scope

                                                                    {
                ldapEntryManager.merge(scope);
        }

メンバ詳解

ldapEntryManager

PersistenceEntryManager org.gluu.oxtrust.ldap.service.ScopeService.ldapEntryManager

private

logger

Logger org.gluu.oxtrust.ldap.service.ScopeService.logger

private

organizationService

OrganizationService org.gluu.oxtrust.ldap.service.ScopeService.organizationService

private

serialVersionUID

final long org.gluu.oxtrust.ldap.service.ScopeService.serialVersionUID = 65734145678106186L

staticprivate

---

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

• D:/AppData/OpenId/gluu/src/oxTrust/server/src/main/java/org/gluu/oxtrust/ldap/service/ScopeService.java