oracle.stellent.ridc.convenience.usersecurity.impl

Class UserSecurityGroupsCache

java.lang.Object

oracle.stellent.ridc.convenience.usersecurity.impl.UserSecurityGroupsCache

All Implemented Interfaces:

IUserSecurityCache

Direct Known Subclasses:

UserSGAccountsCache

public class UserSecurityGroupsCache
extends Object
implements IUserSecurityCache

Implementation of Content Security will check Security Groups

Nested Class Summary

Nested classes/interfaces inherited from interface oracle.stellent.ridc.convenience.usersecurity.IUserSecurityCache

IUserSecurityCache.AdminType

Field Summary

Fields

Modifier and Type	Field and Description
protected List<IAccessResolver>	m_accessResolvers
protected CSEnvCache	m_csEnvCache
protected IdcClient	m_idcClient
protected ILog	m_log
protected IAccessResolver	m_securityGroupsResolver
protected IServiceCallUtils	m_serviceCallUtils
protected ExpiringCache<String,CachedDataBinder>	m_userPermissionsCache

Constructor Summary

Constructors

Constructor and Description
UserSecurityGroupsCache(IdcClient idcClient, int cacheMaxSize, long timeToLive) Deprecated.
UserSecurityGroupsCache(IdcClient idcClient, int cacheMaxSize, long timeToLive, IServiceCallUtils serviceCallUtils) Deprecated.
UserSecurityGroupsCache(IdcClient idcClient, int cacheMaxSize, long userTimeToLive, long serverTimeToLive, IdcContext superuser) Create a security implementation that checks Security Groups
UserSecurityGroupsCache(IdcClient idcClient, int cacheMaxSize, long userTimeToLive, long serverTimeToLive, IdcContext superuser, IServiceCallUtils serviceCallUtils) Create a security implementation that checks Security Groups

Method Summary

Modifier and Type	Method and Description
void	addAccessResolver(IAccessResolver accessResolver) Adds an access handler to the chain
void	clearCache() Clear the cache completely
void	clearCache(ITrace trace) 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.
IdcClient	getIdcClient() Get the IdcClient used for this cache
int	getInUseCount() Get number of active entries in cache
DataBinder	getPermissions(CacheId id, ITrace trace) Get the permissions for a user
IServiceCallUtils	getServiceCallUtils()
IUserSecurityFlags	getUserSecurityFlags(CacheId id, ITrace trace) Returns the UserSecurityFlags object.
void	initializeCache(int maxSize, long timeToLive) Initialize the user permissions 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.
boolean	isAuthorDelete(CacheId id, DataObject docInfo, int access, ITrace trace)
protected void	putPermissions(CacheId id, CachedDataBinder permissions) Remember user's permissions
DataBinder	removeCacheId(CacheId id) Drop the permissions for this user from the cache
protected CachedDataBinder	removePermissions(CacheId id) Remove user's permissions
void	removeStaleEntries() Remove entries from cache that are too old
void	setIdcClient(IdcClient idcClient) For this Cache, set the communication information
void	setServiceCallUtils(IServiceCallUtils serviceCallUtils)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

m_log

protected ILog m_log

m_idcClient

protected IdcClient m_idcClient

m_serviceCallUtils

protected IServiceCallUtils m_serviceCallUtils

m_securityGroupsResolver

protected IAccessResolver m_securityGroupsResolver

m_accessResolvers

protected List<IAccessResolver> m_accessResolvers

m_userPermissionsCache

protected ExpiringCache<String,CachedDataBinder> m_userPermissionsCache

m_csEnvCache

protected CSEnvCache m_csEnvCache

Constructor Detail

UserSecurityGroupsCache

public UserSecurityGroupsCache(IdcClient idcClient,
                               int cacheMaxSize,
                               long userTimeToLive,
                               long serverTimeToLive,
                               IdcContext superuser)

Create a security implementation that checks Security Groups

Parameters:

idcClient - RIDC connection information

cacheMaxSize - Number of entries (userids) to keep in LRU cache

userTimeToLive - Number of milliseconds before an entry is too old

serverTimeToLive - Number of milliseconds to keep server's Environment information

superuser - Admin-level user to fetch environment information

See Also:

UserSecurityGroupsCache

UserSecurityGroupsCache

public UserSecurityGroupsCache(IdcClient idcClient,
                               int cacheMaxSize,
                               long userTimeToLive,
                               long serverTimeToLive,
                               IdcContext superuser,
                               IServiceCallUtils serviceCallUtils)

Create a security implementation that checks Security Groups

Parameters:

idcClient - RIDC connection information

cacheMaxSize - Number of entries (userids) to keep in LRU cache

userTimeToLive - Number of milliseconds before an entry is too old

serverTimeToLive - Number of milliseconds to keep server's Environment information

superuser - Admin-level user to fetch environment information

serviceCallUtils - util class perhaps a mock object for testing

See Also:

UserSecurityGroupsCache

UserSecurityGroupsCache

@Deprecated
public UserSecurityGroupsCache(IdcClient idcClient,
                                           int cacheMaxSize,
                                           long timeToLive)

Deprecated.

Create a security implementation that checks Security Groups This constructor will use the anonymous user to fetch environment information. You should consider using another constructor and the superuser as some environment information is restricted. Since this is a potentially dangerous configuration (you will silently not get all the information you think you should be getting) it is marked as deprecated.

Parameters:

idcClient - RIDC connection information

cacheMaxSize - Number of entries (userids) to keep in LRU cache

timeToLive - Number of milliseconds before an entry is too old

UserSecurityGroupsCache

@Deprecated
public UserSecurityGroupsCache(IdcClient idcClient,
                                           int cacheMaxSize,
                                           long timeToLive,
                                           IServiceCallUtils serviceCallUtils)

Deprecated.

Create a security implementation that checks Security Groups overriding the default ServiceCallUtils This constructor will use the anonymous user to fetch environment information. You should consider using another constructor and the superuser as some environment information is restricted. Since this is a potentially dangerous configuration (you will silently not get all the information you think you should be getting) it is marked as deprecated.

Parameters:

idcClient - RIDC connection information

cacheMaxSize - Number of entries (userids) to keep in LRU cache

timeToLive - Number of milliseconds before an entry is too old

serviceCallUtils - util class perhaps a mock object for testing

Method Detail

initializeCache

public void initializeCache(int maxSize,
                            long timeToLive)

Initialize the user permissions cache with maximum size and length to live

Specified by:

initializeCache in interface IUserSecurityCache

Parameters:

maxSize - Assuming an LRU cache, the maximum number of entries

timeToLive - positive number of milliseconds for each entry to be valid

clearCache

public void clearCache()

Clear the cache completely

Specified by:

clearCache in interface IUserSecurityCache

clearCache

public void clearCache(ITrace trace)

Clear the cache completely

Specified by:

clearCache in interface IUserSecurityCache

addAccessResolver

public void addAccessResolver(IAccessResolver accessResolver)

Adds an access handler to the chain

Specified by:

addAccessResolver in interface IUserSecurityCache

Parameters:

accessResolver -

getCacheIdForUser

@Deprecated
public CacheId getCacheIdForUser(IdcContext userContext)

Deprecated. this method swallows IdcClientExceptions

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

Specified by:

getCacheIdForUser in interface IUserSecurityCache

Parameters:

userContext - the IdcContent

Returns:

a cacheId to be used in future fetches

getCacheIdForUser

public CacheId getCacheIdForUser(IdcContext userContext,
                                 ITrace trace)
                          throws IdcClientException

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

Specified by:

getCacheIdForUser in interface IUserSecurityCache

Parameters:

userContext - the IdcContent

trace -

Returns:

a cacheId to be used in future fetches

Throws:

IdcClientException

removeCacheId

public DataBinder removeCacheId(CacheId id)

Drop the permissions for this user from the cache

Specified by:

removeCacheId in interface IUserSecurityCache

Parameters:

id - CacheID

Returns:

DataBinder permissions removed from cache or null

getAccessLevelForDocument

@Deprecated
public 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.

Specified by:

getAccessLevelForDocument in interface IUserSecurityCache

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

public 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.

Specified by:

getAccessLevelForDocument in interface IUserSecurityCache

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)

Throws:

IdcClientException

isAuthorDelete

public boolean isAuthorDelete(CacheId id,
                              DataObject docInfo,
                              int access,
                              ITrace trace)
                       throws IdcClientException

Throws:

IdcClientException

isAdmin

@Deprecated
public 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.

Specified by:

isAdmin in interface IUserSecurityCache

Parameters:

id - CacheId

docInfo - document info either from LocalData or from DOC_INFO resultset

adminType -

Returns:

true or false

isAdmin

public 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.

Specified by:

isAdmin in interface IUserSecurityCache

Parameters:

id - CacheId

docInfo - document info either from LocalData or from DOC_INFO resultset

adminType -

trace -

Returns:

true or false

Throws:

IdcClientException

getUserSecurityFlags

public 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.

Specified by:

getUserSecurityFlags in interface IUserSecurityCache

Parameters:

id - CacheId for the user

trace - (can be null to disable tracing)

Returns:

User security flags object

Throws:

IdcClientException

setIdcClient

public void setIdcClient(IdcClient idcClient)

For this Cache, set the communication information

Parameters:

idcClient - Information for the connection to refresh cache

getIdcClient

public IdcClient getIdcClient()

Get the IdcClient used for this cache

Returns:

IdcClient

getServiceCallUtils

public IServiceCallUtils getServiceCallUtils()

setServiceCallUtils

public void setServiceCallUtils(IServiceCallUtils serviceCallUtils)

getInUseCount

public int getInUseCount()

Get number of active entries in cache

Returns:

number of entries used in cache

removeStaleEntries

public void removeStaleEntries()

Remove entries from cache that are too old

getPermissions

public DataBinder getPermissions(CacheId id,
                                 ITrace trace)
                          throws IdcClientException

Get the permissions for a user

Parameters:

id - CacheId

trace -

Returns:

DataBinder containing user information as the result of the Service GET_USER_PERMISSIONS

Throws:

IdcClientException

putPermissions

protected void putPermissions(CacheId id,
                              CachedDataBinder permissions)

Remember user's permissions

Parameters:

id - CacheId

permissions - Databinder from the GET_USER_PERMISSIONS call

removePermissions

protected CachedDataBinder removePermissions(CacheId id)

Remove user's permissions

Parameters:

id - CacheId

Returns: