org.xdi.oxauth.uma.service.UmaResourceService クラス

org.xdi.oxauth.uma.service.UmaResourceService 連携図

公開メンバ関数
void	addBranch ()
void	addResource (UmaResource resource)
void	validate (UmaResource resource)
void	updateResource (UmaResource resource)
void	remove (UmaResource resource)
void	remove (String rsid)
void	remove (List< UmaResource > resources)
List< UmaResource >	getResourcesByAssociatedClient (String associatedClientDn)
boolean	containsResource (UmaResource resource)
Set< UmaResource >	getResources (Set< String > ids)
UmaResource	getResourceById (String id)
UmaResource	getResourceByDn (String dn)
String	getDnForResource (String oxId)
String	getBaseDnForResource ()
boolean	removeFromCache (UmaResource resource)
void	cleanup (Date now)

非公開メンバ関数
List< UmaResource >	findResources (UmaResource resource)
void	prepareBranch ()
void	putInCache (UmaResource resource)
UmaResource	fromCache (String dn)

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

静的非公開変数類
static final int	RESOURCE_CACHE_EXPIRATION_IN_SECONDS = 120

詳解

Provides operations with resource set descriptions

著者

Yuriy Movchan

Yuriy Zabrovarnyy Date: 10.05.2012

関数詳解

addBranch()

void org.xdi.oxauth.uma.service.UmaResourceService.addBranch ( )

inline

                            {
        SimpleBranch branch = new SimpleBranch();
        branch.setOrganizationalUnitName("resources");
        branch.setDn(getDnForResource(null));

        ldapEntryManager.persist(branch);
    }

addResource()

void org.xdi.oxauth.uma.service.UmaResourceService.addResource ( UmaResource  resource )

inline

Add new resource description entry

引数

resource

resource

                                                  {
        validate(resource);
        ldapEntryManager.persist(resource);
        putInCache(resource);
    }

cleanup()

void org.xdi.oxauth.uma.service.UmaResourceService.cleanup ( Date  now )

inline

                                  {
        prepareBranch();

        BatchOperation<UmaResource> batchService = new ProcessBatchOperation<UmaResource>() {
            @Override
            public void performAction(List<UmaResource> entries) {
                for (UmaResource p : entries) {
                    try {
                        remove(p);
                    } catch (Exception e) {
                        log.error("Failed to remove entry", e);
                    }
                }
            }

        };
        ldapEntryManager.findEntries(getBaseDnForResource(), UmaResource.class, Filter.createLessOrEqualFilter("oxAuthExpiration", ldapEntryManager.encodeTime(now)), SearchScope.SUB, new String[]{""}, batchService, 0, 0, CleanerTimer.BATCH_SIZE);
    }

containsResource()

boolean org.xdi.oxauth.uma.service.UmaResourceService.containsResource ( UmaResource  resource )

inline

Check if LDAP server contains resource description with specified attributes

戻り値

True if resource description with specified attributes exist

                                                          {
        return ldapEntryManager.contains(resource);
    }

findResources()

List<UmaResource> org.xdi.oxauth.uma.service.UmaResourceService.findResources ( UmaResource  resource )

inlineprivate

Get resource descriptions by example.

Do not expose it outside because we want to involve cache where possible.

引数

resource

Resource

戻り値

Resource which conform example

                                                                  {
        return ldapEntryManager.findEntries(resource);
    }

fromCache()

UmaResource org.xdi.oxauth.uma.service.UmaResourceService.fromCache ( String  dn )

inlineprivate

                                             {
        try {
            return (UmaResource) cacheService.get(null, dn);
        } catch (Exception e) {
            log.error("Failed to fetch client from cache, dn: " + dn, e);
            return null;
        }
    }

getBaseDnForResource()

String org.xdi.oxauth.uma.service.UmaResourceService.getBaseDnForResource ( )

inline

                                         {
        final String umaBaseDn = staticConfiguration.getBaseDn().getUmaBase(); // "ou=uma,o=@!1111,o=gluu"
        return String.format("ou=resources,%s", umaBaseDn);
    }

getDnForResource()

String org.xdi.oxauth.uma.service.UmaResourceService.getDnForResource ( String  oxId )

inline

Build DN string for resource description

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

getResourceByDn()

UmaResource org.xdi.oxauth.uma.service.UmaResourceService.getResourceByDn ( String  dn )

inline

Get resource description by DN

引数

dn	Resource description DN

戻り値

Resource description

                                                  {
        UmaResource fromCache = fromCache(dn);
        if (fromCache != null) {
            return fromCache;
        }
        return ldapEntryManager.find(UmaResource.class, dn);
    }

getResourceById()

UmaResource org.xdi.oxauth.uma.service.UmaResourceService.getResourceById ( String  id )

inline

                                                  {

        UmaResource fromCache = fromCache(getDnForResource(id));
        if (fromCache != null) {
            log.trace("UMA Resource from cache, id: " + id);
            return fromCache;
        }

        prepareBranch();

        UmaResource ldapResource = new UmaResource();
        ldapResource.setDn(getBaseDnForResource());
        ldapResource.setId(id);

        final List<UmaResource> result = findResources(ldapResource);
        if (result.size() == 0) {
            log.error("Failed to find resource set with id: " + id);
            errorResponseFactory.throwUmaNotFoundException();
        } else if (result.size() > 1) {
            log.error("Multiple resource sets found with given id: " + id);
            errorResponseFactory.throwUmaInternalErrorException();
        }
        return result.get(0);
    }

getResources()

Set<UmaResource> org.xdi.oxauth.uma.service.UmaResourceService.getResources ( Set< String >  ids )

inline

                                                          {
        Set<UmaResource> result = new HashSet<UmaResource>();
        if (ids != null) {
            for (String id : ids) {
                UmaResource resource = getResourceById(id);
                if (resource != null) {
                    result.add(resource);
                } else {
                    log.error("Failed to find resource by id: " + id);
                }
            }
        }
        return result;
    }

getResourcesByAssociatedClient()

List<UmaResource> org.xdi.oxauth.uma.service.UmaResourceService.getResourcesByAssociatedClient ( String  associatedClientDn )

inline

Get all resource descriptions

戻り値

List of resource descriptions

                                                                                       {
        try {
            prepareBranch();

            if (StringUtils.isNotBlank(associatedClientDn)) {
                final Filter filter = Filter.create(String.format("&(oxAssociatedClient=%s)", associatedClientDn));
                return ldapEntryManager.findEntries(getBaseDnForResource(), UmaResource.class, filter);
            }
        } catch (Exception e) {
            log.error(e.getMessage(), e);
        }
        return Collections.emptyList();
    }

prepareBranch()

void org.xdi.oxauth.uma.service.UmaResourceService.prepareBranch ( )

inlineprivate

                                 {
        // Create resource description branch if needed
        if (!ldapEntryManager.contains(SimpleBranch.class, getDnForResource(null))) {
            addBranch();
        }
    }

putInCache()

void org.xdi.oxauth.uma.service.UmaResourceService.putInCache ( UmaResource  resource )

inlineprivate

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

        try {
            cacheService.put(Integer.toString(RESOURCE_CACHE_EXPIRATION_IN_SECONDS), resource.getDn(), resource, Constants.SKIP_CACHE_PUT_FOR_NATIVE_PERSISTENCE);
        } catch (Exception e) {
            log.error("Failed to put client in cache, client:" + resource, e);
        }
    }

remove() [1/3]

void org.xdi.oxauth.uma.service.UmaResourceService.remove ( UmaResource  resource )

inline

Remove resource description entry

引数

resource

resource

                                             {
        ldapEntryManager.remove(resource);
    }

remove() [2/3]

void org.xdi.oxauth.uma.service.UmaResourceService.remove ( String  rsid )

inline

Remove resource description entry by ID.

引数

rsid	resource ID

                                    {
        ldapEntryManager.remove(getResourceById(rsid));
    }

remove() [3/3]

void org.xdi.oxauth.uma.service.UmaResourceService.remove ( List< UmaResource >  resources )

inline

                                                    {
        for (UmaResource resource : resources) {
            remove(resource);
        }
    }

removeFromCache()

boolean org.xdi.oxauth.uma.service.UmaResourceService.removeFromCache ( UmaResource  resource )

inline

                                                         {
        try {
            cacheService.remove(null, resource.getDn());
        } catch (Exception e) {
            log.error(e.getMessage(), e);

            return false;
        }
        return true;
    }

updateResource()

void org.xdi.oxauth.uma.service.UmaResourceService.updateResource ( UmaResource  resource )

inline

Update resource description entry

引数

resource

resource

                                                     {
        validate(resource);
        ldapEntryManager.merge(resource);
    }

validate()

void org.xdi.oxauth.uma.service.UmaResourceService.validate ( UmaResource  resource )

inline

                                               {
        Preconditions.checkArgument(StringUtils.isNotBlank(resource.getName()), "Name is required for resource.");
        Preconditions.checkArgument(((resource.getScopes() != null && !resource.getScopes().isEmpty()) || StringUtils.isNotBlank(resource.getScopeExpression())), "Scope must be specified for resource.");
        Preconditions.checkState(!resource.isExpired(), "UMA Resource expired. It must not be expired.");
        prepareBranch();
    }

メンバ詳解

cacheService

CacheService org.xdi.oxauth.uma.service.UmaResourceService.cacheService

private

errorResponseFactory

ErrorResponseFactory org.xdi.oxauth.uma.service.UmaResourceService.errorResponseFactory

private

ldapEntryManager

PersistenceEntryManager org.xdi.oxauth.uma.service.UmaResourceService.ldapEntryManager

private

log

Logger org.xdi.oxauth.uma.service.UmaResourceService.log

private

RESOURCE_CACHE_EXPIRATION_IN_SECONDS

final int org.xdi.oxauth.uma.service.UmaResourceService.RESOURCE_CACHE_EXPIRATION_IN_SECONDS = 120

staticprivate

staticConfiguration

StaticConfiguration org.xdi.oxauth.uma.service.UmaResourceService.staticConfiguration

private

---

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

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