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.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IUserSecurityCache.AdminType

Method Summary

Modifier and Type	Method and Description
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) Deprecated. this method swallows IdcClientExceptions
int	getAccessLevelForDocument(CacheId id, DataObject docInfo, ITrace trace) Get the user's access level for a document.
CacheId	getCacheIdForUser(IdcContext userContext) Deprecated. this method swallows IdcClientExceptions
CacheId	getCacheIdForUser(IdcContext userContext, ITrace trace) Get the CacheId.
IUserSecurityFlags	getUserSecurityFlags(CacheId id, ITrace trace) Returns the UserSecurityFlags object.
void	initializeCache(int maxSize, long timeToLive) Initialize the cache with maximum size and length to live
boolean	isAdmin(CacheId id, DataObject docInfo, IUserSecurityCache.AdminType adminType) Deprecated. this method swallows IdcClientExceptions
boolean	isAdmin(CacheId id, DataObject docInfo, IUserSecurityCache.AdminType adminType, ITrace trace) Returns the Admin flag for the specific admin type.
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

@Deprecated
CacheId getCacheIdForUser(IdcContext userContext)

Deprecated. this method swallows IdcClientExceptions

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

getCacheIdForUser

CacheId getCacheIdForUser(IdcContext userContext,
                          ITrace trace)
                   throws IdcClientException

Get the CacheId. A call is made to the content server using the IdcContext.

Parameters:

userContext - the IdcContent

trace -

Returns:

a cacheId to be used in future fetches

Throws:

IdcClientException

removeCacheId

DataBinder removeCacheId(CacheId id)

Remove cache

Parameters:

id - CacheID

Returns:

DataBinder permissions removed from cache or null

getAccessLevelForDocument

@Deprecated
int getAccessLevelForDocument(CacheId id,
                                          DataObject docInfo)

Deprecated. this method swallows IdcClientExceptions

Get the user's access level for a document. Note that Admin rights are undefined on the document and thus never returned. You can only read, write or delete the document.

Parameters:

id - CacheId

docInfo - document info either from LocalData or from DOC_INFO resultset

Returns:

access level in Content Server form (1=Read, 3=Write, 7=Delete)

getAccessLevelForDocument

int getAccessLevelForDocument(CacheId id,
                              DataObject docInfo,
                              ITrace trace)
                       throws IdcClientException

Get the user's access level for a document. Note that Admin rights are undefined on the document and thus never returned. You can only read, write or delete the document.

Parameters:

id - CacheId

docInfo - document info either from LocalData or from DOC_INFO resultset

trace -

Returns:

access level in Content Server form (1=Read, 3=Write, 7=Delete)

Throws:

IdcClientException

isAdmin

@Deprecated
boolean isAdmin(CacheId id,
                            DataObject docInfo,
                            IUserSecurityCache.AdminType adminType)

Deprecated. this method swallows IdcClientExceptions

Returns the Admin flag for the specific admin type. Note that Admin rights are undefined on the document. You can only read, write or delete the document. Any admin rights returned here might or might not be used by the content server when performing the actual service call.

Parameters:

id - CacheId

docInfo - document info either from LocalData or from DOC_INFO resultset

adminType -

Returns:

true or false

isAdmin

boolean isAdmin(CacheId id,
                DataObject docInfo,
                IUserSecurityCache.AdminType adminType,
                ITrace trace)
         throws IdcClientException

Returns the Admin flag for the specific admin type. Note that Admin rights are undefined on the document. You can only read, write or delete the document. Any admin rights returned here might or might not be used by the content server when performing the actual service call.

Parameters:

id - CacheId

docInfo - document info either from LocalData or from DOC_INFO resultset

adminType -

trace -

Returns:

true or false

Throws:

IdcClientException

getUserSecurityFlags

IUserSecurityFlags getUserSecurityFlags(CacheId id,
                                        ITrace trace)
                                 throws IdcClientException

Returns the UserSecurityFlags object. This object is a snapshot copy of what is in the cache. Typically, it would be used to complete a single request and then discarded.

Parameters:

id - CacheId for the user

trace - (can be null to disable tracing)

Returns:

User security flags object

Throws:

IdcClientException