com.crystaldecisions.sdk.occa.security
Interface ISecCacheControllerAdmin

All Superinterfaces:

IBatch

public interface ISecCacheControllerAdmin
extends IBatch

The interface for controlling cache loading of rights admin info. Extends IBatch to allow load requests to be batched together. Note that for all these admin queries, sdk would not check in local cache for information already recorded. All these requests, whether batched or not, will always be committed to the backend to retrieve the most up-to-date result.

Method Summary

void	cacheExplicitLimits(int objectID) Request a load of the explicit limits associated with the object
void	cacheExplicitPrincipals(int objectID) Request a load of the principals that have explicit rights on the object
void	cacheExplicitRights(int objectID) Request a load of the explicit boolean rights associated with the object
void	cacheExplicitRoles(int objectID) Request a load of the explicit roles associated with the object
void	cacheKnownRightsByPlugin(int objectID) Request a load of the known security info applicable to the given object grouped by plugin types
void	cacheKnownSecurityInfo(int objectID) Request a load of the known security info applicable to the given object
void	cacheLimit(int rightID, java.lang.Object rightKind, int principalID, int objectID) Request a load of the limits of a principal on a given object
void	cachePrincipals(int objectID) Request a load of the principals that have effective rights on the object
void	cacheRight(int rightID, java.lang.Object rightKind, int principalID, int objectID) Deprecated. since 12.0 SP1. Use cacheRight(RightDescriptor right, int principalID, int objectID) instead
void	cacheRight(RightDescriptor right, int principalID, int objectID) Request a load of the boolean rights of a principal on a given object
void	cacheSecurityInfo(int objectID) Request a load of the security info (all the effective principals, rights and roles) associated with the object
void	cacheSecurityInfo(int objectID, int principalID) Request a load of the security info (all the effective principals, rights and roles) associated with the object for a given principal

Methods inherited from interface com.crystaldecisions.sdk.occa.security.IBatch

batch, batch, batch, commit, rollback

Method Detail

cacheRight

void cacheRight(int rightID,
                java.lang.Object rightKind,
                int principalID,
                int objectID)
                throws SDKException

Deprecated. since 12.0 SP1. Use cacheRight(RightDescriptor right, int principalID, int objectID) instead

Request a load of the boolean rights of a principal on a given object

Parameters:

rightID - ID of the right being accessed

rightKind - Plugin kind the right is specified for. Can be the integer object type or the object kind string.

principalID - ID of the principal the right applies to

objectID - Object the right applies to

Throws:

SDKException

cacheRight

void cacheRight(RightDescriptor right,
                int principalID,
                int objectID)
                throws SDKException

Request a load of the boolean rights of a principal on a given object

Parameters:

right - right being accessed

principalID - ID of the principal the right applies to

objectID - Object the right applies to

Throws:

SDKException

cacheLimit

void cacheLimit(int rightID,
                java.lang.Object rightKind,
                int principalID,
                int objectID)
                throws SDKException

Request a load of the limits of a principal on a given object

Parameters:

rightID - ID of the right being accessed

rightKind - Plugin kind the right is specified for. Can be the integer object type or the object kind string.

principalID - ID of the principal the right applies to

objectID - Object the right applies to

Throws:

SDKException

cacheExplicitRoles

void cacheExplicitRoles(int objectID)
                        throws SDKException

Request a load of the explicit roles associated with the object

Parameters:

objectID - Object the role applies to

Throws:

SDKException

cacheExplicitRights

void cacheExplicitRights(int objectID)
                         throws SDKException

Request a load of the explicit boolean rights associated with the object

Parameters:

objectID - Object the right applies to

Throws:

SDKException

cacheExplicitLimits

void cacheExplicitLimits(int objectID)
                         throws SDKException

Request a load of the explicit limits associated with the object

Parameters:

objectID - Object the right applies to

Throws:

SDKException

cacheSecurityInfo

void cacheSecurityInfo(int objectID)
                       throws SDKException

Request a load of the security info (all the effective principals, rights and roles) associated with the object

Parameters:

objectID - Object the security info applies to

Throws:

SDKException

cacheSecurityInfo

void cacheSecurityInfo(int objectID,
                       int principalID)
                       throws SDKException

Request a load of the security info (all the effective principals, rights and roles) associated with the object for a given principal

Parameters:

objectID - Object the security info applies to

principalID - Principal the security info applies to

Throws:

SDKException

cachePrincipals

void cachePrincipals(int objectID)
                     throws SDKException

Request a load of the principals that have effective rights on the object

Parameters:

objectID - Object the security info applies to

Throws:

SDKException

cacheExplicitPrincipals

void cacheExplicitPrincipals(int objectID)
                             throws SDKException

Request a load of the principals that have explicit rights on the object

Parameters:

objectID - Object the security info applies to

Throws:

SDKException

cacheKnownSecurityInfo

void cacheKnownSecurityInfo(int objectID)
                            throws SDKException

Request a load of the known security info applicable to the given object

Parameters:

objectID - Object ID

Throws:

SDKException

cacheKnownRightsByPlugin

void cacheKnownRightsByPlugin(int objectID)
                              throws SDKException

Request a load of the known security info applicable to the given object grouped by plugin types

Parameters:

objectID - Object ID

Throws:

SDKException