Skip navigation links

Oracle® Fusion Middleware Remote Intradoc Client (RIDC) Java API Reference
11g Release 1 (11.1.1)

E17274-01


oracle.stellent.ridc.convenience.usersecurity
Interface IUserSecurityCache

All Known Implementing Classes:
UserSecurityGroupsCache, UserSGAccountsCache, UserSGAcctAclCache

public interface IUserSecurityCache

Implementation of the interface caches security information e.g. access level for users.


Method Summary
 void addAccessResolver(IAccessResolver accessResolver)
          Adds an access resolver to the chain of resolvers that will work together to calculate the access levels for a given document
 void clearCache()
          Clear the cache completely
 int getAccessLevelForDocument(CacheId id, DataObject docInfo)
          Get the user's access level for a document from cached security information
 CacheId getCacheIdForUser(IdcContext userContext)
          Get the CacheId.
 void initializeCache(int maxSize, long timeToLive)
          Initialize the cache with maximum size and length to live
 DataBinder removeCacheId(CacheId id)
          Remove cache

 

Method Detail

initializeCache

void initializeCache(int maxSize,
                     long timeToLive)
Initialize the cache with maximum size and length to live
Parameters:
maxSize - Assuming an LRU cache, the maximum number of entries
timeToLive - Number of milliseconds for each entry to be valid

clearCache

void clearCache()
Clear the cache completely

addAccessResolver

void addAccessResolver(IAccessResolver accessResolver)
Adds an access resolver to the chain of resolvers that will work together to calculate the access levels for a given document
Parameters:
accessResolver - the IAccessResolver to add

getCacheIdForUser

CacheId getCacheIdForUser(IdcContext userContext)
Get the CacheId. A call is made to the content server using the IdcContext.
Parameters:
userContext - the IdcContent
Returns:
a cacheId to be used in future fetches

removeCacheId

DataBinder removeCacheId(CacheId id)
Remove cache
Parameters:
id - CacheID
Returns:
DataBinder permissions removed from cache or null

getAccessLevelForDocument

int getAccessLevelForDocument(CacheId id,
                              DataObject docInfo)
Get the user's access level for a document from cached security information
Parameters:
id - a cacheId previously obtained
docInfo - DataObject containing security information about the document (typically from DOC_INFO)
Returns:
access level in Content Server form (1=Read, 2=Write, 4=Delete, 8=Admin)
Throws:
IdcClientException

Skip navigation links

Oracle® Fusion Middleware Remote Intradoc Client (RIDC) Java API Reference
11g Release 1 (11.1.1)

E17274-01


Copyright © 2008, 2010, Oracle and/or its affiliates. All rights reserved.