org.gluu.oxtrust.ldap.service.uma.ScopeDescriptionService クラス

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

org.gluu.oxtrust.ldap.service.uma.ScopeDescriptionService 連携図

公開メンバ関数
void	addBranch ()
boolean	containsBranch ()
void	prepareScopeDescriptionBranch ()
UmaScopeDescription	getScopeDescriptionByDn (String dn)
void	addScopeDescription (UmaScopeDescription scopeDescription)
void	updateScopeDescription (UmaScopeDescription scopeDescription)
void	removeScopeDescription (UmaScopeDescription scopeDescription)
boolean	containsScopeDescription (UmaScopeDescription scopeDescription)
List< UmaScopeDescription >	getAllScopeDescriptions (String... ldapReturnAttributes)
List< UmaScopeDescription >	findScopeDescriptions (String pattern, int sizeLimit)
List< UmaScopeDescription >	getAllScopeDescriptions (int sizeLimit)
List< UmaScopeDescription >	findScopeDescriptions (UmaScopeDescription scopeDescription)
List< UmaScopeDescription >	findScopeDescriptionsById (String id)
String	generateInumForNewScopeDescription ()
String	getDnForScopeDescription (String inum)
UmaScopeDescription	getUmaScopeByInum (String inum)

非公開メンバ関数
String	generateInumForNewScopeDescriptionImpl ()

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

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

詳解

Provides operations with scope descriptions

著者

Yuriy Movchan Date: 12/07/2012

関数詳解

addBranch()

void org.gluu.oxtrust.ldap.service.uma.ScopeDescriptionService.addBranch ( )

inline

                                {
                SimpleBranch branch = new SimpleBranch();
                branch.setOrganizationalUnitName("scopes");
                branch.setDn(getDnForScopeDescription(null));

                ldapEntryManager.persist(branch);
        }

addScopeDescription()

void org.gluu.oxtrust.ldap.service.uma.ScopeDescriptionService.addScopeDescription ( UmaScopeDescription  scopeDescription )

inline

Add new scope description entry

引数

scopeDescription

Scope description

                                                                              {
                ldapEntryManager.persist(scopeDescription);
        }

containsBranch()

boolean org.gluu.oxtrust.ldap.service.uma.ScopeDescriptionService.containsBranch ( )

inline

                                        {
                return ldapEntryManager.contains(SimpleBranch.class, getDnForScopeDescription(null));
        }

containsScopeDescription()

boolean org.gluu.oxtrust.ldap.service.uma.ScopeDescriptionService.containsScopeDescription ( UmaScopeDescription  scopeDescription )

inline

Check if LDAP server contains scope description with specified attributes

戻り値

True if scope description with specified attributes exist

                                                                                      {
                return ldapEntryManager.contains(scopeDescription);
        }

findScopeDescriptions() [1/2]

List<UmaScopeDescription> org.gluu.oxtrust.ldap.service.uma.ScopeDescriptionService.findScopeDescriptions ( String  pattern, int  sizeLimit  )

inline

Search scope descriptions by pattern

引数

pattern	Pattern
sizeLimit	Maximum count of results

戻り値

List of scope descriptions

                                                                                              {
                String[] targetArray = new String[] { pattern };
                Filter oxIdFilter = Filter.createSubstringFilter("oxId", null, targetArray, null);
                Filter displayNameFilter = Filter.createSubstringFilter(OxTrustConstants.displayName, null, targetArray, null);
                Filter searchFilter = Filter.createORFilter(oxIdFilter, displayNameFilter);

                List<UmaScopeDescription> result = ldapEntryManager.findEntries(getDnForScopeDescription(null),
                                UmaScopeDescription.class, searchFilter, sizeLimit);

                return result;
        }

findScopeDescriptions() [2/2]

List<UmaScopeDescription> org.gluu.oxtrust.ldap.service.uma.ScopeDescriptionService.findScopeDescriptions ( UmaScopeDescription  scopeDescription )

inline

Get scope descriptions by example

引数

scopeDescription

Scope description

戻り値

List of ScopeDescription which conform example

                                                                                                     {
                return ldapEntryManager.findEntries(scopeDescription);
        }

findScopeDescriptionsById()

List<UmaScopeDescription> org.gluu.oxtrust.ldap.service.uma.ScopeDescriptionService.findScopeDescriptionsById ( String  id )

inline

Get scope descriptions by Id

引数

id

Id

戻り値

List of ScopeDescription which specified id

                                                                              {
                return ldapEntryManager.findEntries(getDnForScopeDescription(null), UmaScopeDescription.class,
                                Filter.createEqualityFilter("oxId", id));
        }

generateInumForNewScopeDescription()

String org.gluu.oxtrust.ldap.service.uma.ScopeDescriptionService.generateInumForNewScopeDescription ( )

inline

Generate new inum for scope description

戻り値

New inum for scope description

                                                           {
                UmaScopeDescription scopeDescription = new UmaScopeDescription();
                String newInum = null;
                do {
                        newInum = generateInumForNewScopeDescriptionImpl();
                        String newDn = getDnForScopeDescription(newInum);
                        scopeDescription.setDn(newDn);
                } while (ldapEntryManager.contains(scopeDescription));

                return newInum;
        }

generateInumForNewScopeDescriptionImpl()

String org.gluu.oxtrust.ldap.service.uma.ScopeDescriptionService.generateInumForNewScopeDescriptionImpl ( )

inlineprivate

Generate new inum for scope description

戻り値

New inum for scope description

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

getAllScopeDescriptions() [1/2]

List<UmaScopeDescription> org.gluu.oxtrust.ldap.service.uma.ScopeDescriptionService.getAllScopeDescriptions ( String...  ldapReturnAttributes )

inline

Get all scope descriptions

戻り値

List of scope descriptions

                                                                                                 {
                return ldapEntryManager.findEntries(getDnForScopeDescription(null), UmaScopeDescription.class, null,
                                ldapReturnAttributes);
        }

getAllScopeDescriptions() [2/2]

List<UmaScopeDescription> org.gluu.oxtrust.ldap.service.uma.ScopeDescriptionService.getAllScopeDescriptions ( int  sizeLimit )

inline

                                                                                {
                return ldapEntryManager.findEntries(getDnForScopeDescription(null), UmaScopeDescription.class, null, sizeLimit);
        }

getDnForScopeDescription()

String org.gluu.oxtrust.ldap.service.uma.ScopeDescriptionService.getDnForScopeDescription ( String  inum )

inline

Build DN string for scope description

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

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

getScopeDescriptionByDn()

UmaScopeDescription org.gluu.oxtrust.ldap.service.uma.ScopeDescriptionService.getScopeDescriptionByDn ( String  dn )

inline

Get scope description by DN

引数

dn	Scope description DN

戻り値

Scope description

                                                                      {
                return ldapEntryManager.find(UmaScopeDescription.class, dn);
        }

getUmaScopeByInum()

UmaScopeDescription org.gluu.oxtrust.ldap.service.uma.ScopeDescriptionService.getUmaScopeByInum ( String  inum )

inline

                                                                  {
                UmaScopeDescription umaScope = null;
                try {
                        umaScope = ldapEntryManager.find(UmaScopeDescription.class, getDnForScopeDescription(inum));
                } catch (Exception e) {
                        log.error("Failed to find scope by Inum " + inum, e);
                }

                return umaScope;
        }

prepareScopeDescriptionBranch()

void org.gluu.oxtrust.ldap.service.uma.ScopeDescriptionService.prepareScopeDescriptionBranch ( )

inline

Create scope description branch if needed

                                                    {
                if (!containsBranch()) {
                        addBranch();
                }
        }

removeScopeDescription()

void org.gluu.oxtrust.ldap.service.uma.ScopeDescriptionService.removeScopeDescription ( UmaScopeDescription  scopeDescription )

inline

Remove scope description entry

引数

scopeDescription

Scope description

                                                                                 {
                ldapEntryManager.remove(scopeDescription);
        }

updateScopeDescription()

void org.gluu.oxtrust.ldap.service.uma.ScopeDescriptionService.updateScopeDescription ( UmaScopeDescription  scopeDescription )

inline

Update scope description entry

引数

scopeDescription

Scope description

                                                                                 {
                ldapEntryManager.merge(scopeDescription);
        }

メンバ詳解

ldapEntryManager

PersistenceEntryManager org.gluu.oxtrust.ldap.service.uma.ScopeDescriptionService.ldapEntryManager

private

log

Logger org.gluu.oxtrust.ldap.service.uma.ScopeDescriptionService.log

private

organizationService

OrganizationService org.gluu.oxtrust.ldap.service.uma.ScopeDescriptionService.organizationService

private

serialVersionUID

final long org.gluu.oxtrust.ldap.service.uma.ScopeDescriptionService.serialVersionUID = -3537567020929600777L

staticprivate

---

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

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