Skip navigation links

com.stellent.cis.client.api.common.administrative.scs.cache
Interface ICISAdministrativeSCSCacheAPI

All Superinterfaces:

ICommandAPI

public interface ICISAdministrativeSCSCacheAPI

extends ICommandAPI

The command API implementation of the administrative.scs.cache commands. This implementation can be accessed directly via the ICommandFacade class, using the API name administrative.scs.cache, with the following syntax:

 ICISAdministrativeSCSCacheAPI commandAPI =
       (ICISAdministrativeSCSCacheAPI)m_commandFacade.getCommandAPI ("administrative.scs.cache", m_commandFacade.getCommandTypeForName ("common"));
 

Field Summary

static java.lang.String

API_CATEGORY Category for this Command API

Method Summary

void	clearCache(java.lang.String adapterName) Clear the cache on the given adapter.
void	clearCache(java.lang.String adapterName, java.lang.String user) Clear the cache on the given adapter.
void	clearFileCache(java.lang.String adapterName) Clear the File cache on the given adapter.
ISCSFileCachePolicy	getDefaultFileCachePolicy(java.lang.String adapterName, java.lang.String service) Retrieve a default cache policy for the given command name and type.
ISCSServiceCachePolicy	getDefaultServiceCachePolicy(java.lang.String adapterName, java.lang.String service) Retrieve a default cache policy for the given command name and type.
ISCSEventPollerInfo	getEventPoller(java.lang.String adapterName) Retrieve the bean that represents the event polling system in the CIS layer.
ISCSFileCacheInfo	getFileCacheInfoCommand(java.lang.String adapterName) Get the File cache location on the given adapter.
java.lang.String	getFileCacheLocation(java.lang.String adapterName) Get the File cache location on the given adapter.
java.util.Collection	getFileCachePolicies(java.lang.String adapterName) Retrieve all the cache policies for a given adapter.
java.util.Collection	getFileCachePolicies(java.lang.String adapterName, boolean filterDefault) Retrieve all the cache policies for a given adapter.
ISCSFileCachePolicy	getFileCachePolicy(java.lang.String adapterName, java.lang.String service) Retrieve the cache policy for a given command.
java.lang.Integer	getFileCacheSize(java.lang.String adapterName) Get the File cache size on the given adapter.
ISCSServiceCacheInfo	getServiceCacheInfo(java.lang.String adapterName) Get the File cache location on the given adapter.
java.util.Collection	getServiceCachePolicies(java.lang.String adapterName) Retrieve all the cache policies for a given adapter.
java.util.Collection	getServiceCachePolicies(java.lang.String adapterName, boolean filterDefault) Retrieve all the cache policies for a given adapter.
ISCSServiceCachePolicy	getServiceCachePolicy(java.lang.String adapterName, java.lang.String service) Retrieve the cache policy for a given command.
void	removeCachePolicy(java.lang.String adapterName, java.lang.String service) Remove a cache policy associated with the given command.
void	removeCachePolicy(java.lang.String adapterName, java.lang.String service, boolean persistConfig) Remove a cache policy associated with the given command.
void	removeFileCachePolicy(java.lang.String adapterName, java.lang.String service) Remove a file cache policy associated with the given command.
void	removeFileCachePolicy(java.lang.String adapterName, java.lang.String service, boolean persistConfig) Remove a file cache policy associated with the given command.
void	updateCommandCachePolicy(java.lang.String adapterName, ISCSServiceCachePolicy cachePolicy) Update a cache policy for an active command.
void	updateCommandCachePolicy(java.lang.String adapterName, ISCSServiceCachePolicy cachePolicy, boolean persistConfig) Update a cache policy for an active command.
void	updateEventPoller(java.lang.String adapterName, ISCSEventPollerInfo eventPoller) Update the event polling mechanism for the given adapter.
void	updateEventPoller(java.lang.String adapterName, ISCSEventPollerInfo eventPoller, boolean persist) Update the event polling mechanism for the given adapter.
void	updateFileCachePolicy(java.lang.String adapterName, ISCSFileCachePolicy cachePolicy) Update a cache policy for an active command.
void	updateFileCachePolicy(java.lang.String adapterName, ISCSFileCachePolicy cachePolicy, boolean persistConfig) Update a cache policy for an active command.

Field Detail

API_CATEGORY

static final java.lang.String API_CATEGORY

Category for this Command API

See Also:

Constant Field Values

Method Detail

clearCache

void clearCache(java.lang.String adapterName)
                throws CommandException

Clear the cache on the given adapter. Optionally just clear for a user if a user name is provided.

Parameters:

adapterName - the adapter name

Throws:

CommandException

clearCache

void clearCache(java.lang.String adapterName,
                java.lang.String user)
                throws CommandException

Clear the cache on the given adapter. Optionally just clear for a user if a user name is provided.

Parameters:

adapterName - the adapter name

user - the user name

Throws:

CommandException

clearFileCache

void clearFileCache(java.lang.String adapterName)
                    throws CommandException

Clear the File cache on the given adapter.

Parameters:

adapterName - the adapter name

Throws:

CommandException

removeCachePolicy

void removeCachePolicy(java.lang.String adapterName,
                       java.lang.String service)
                       throws CommandException

Remove a cache policy associated with the given command. Optionally persist the configuration.

Parameters:

adapterName - the adapter name

service - the command name

Throws:

CommandException

removeCachePolicy

void removeCachePolicy(java.lang.String adapterName,
                       java.lang.String service,
                       boolean persistConfig)
                       throws CommandException

Remove a cache policy associated with the given command. Optionally persist the configuration.

Parameters:

adapterName - the adapter name

service - the command name

persistConfig - if true the configuration for the cache will be persisted

Throws:

CommandException

removeFileCachePolicy

void removeFileCachePolicy(java.lang.String adapterName,
                           java.lang.String service)
                           throws CommandException

Remove a file cache policy associated with the given command. Optionally persist the configuration.

Parameters:

adapterName - the adapter name

service - the command name

Throws:

CommandException

removeFileCachePolicy

void removeFileCachePolicy(java.lang.String adapterName,
                           java.lang.String service,
                           boolean persistConfig)
                           throws CommandException

Remove a file cache policy associated with the given command. Optionally persist the configuration.

Parameters:

adapterName - the adapter name

service - the command name

persistConfig - if true the configuration for the cache will be persisted

Throws:

CommandException

getServiceCachePolicies

java.util.Collection getServiceCachePolicies(java.lang.String adapterName)
                                             throws CommandException

Retrieve all the cache policies for a given adapter.

Parameters:

adapterName - the adapter name

Throws:

CommandException

getServiceCachePolicies

java.util.Collection getServiceCachePolicies(java.lang.String adapterName,
                                             boolean filterDefault)
                                             throws CommandException

Retrieve all the cache policies for a given adapter.

Parameters:

adapterName - the adapter name

filterDefault - true to filter the default configurations and only return the modified configurations

Throws:

CommandException

getServiceCachePolicy

ISCSServiceCachePolicy getServiceCachePolicy(java.lang.String adapterName,
                                             java.lang.String service)
                                             throws CommandException

Retrieve the cache policy for a given command.

Parameters:

adapterName - the adapter name

service - the command name

Throws:

CommandException

getServiceCacheInfo

ISCSServiceCacheInfo getServiceCacheInfo(java.lang.String adapterName)
                                         throws CommandException

Get the File cache location on the given adapter.

Parameters:

adapterName - the adapter name

Throws:

CommandException

getDefaultServiceCachePolicy

ISCSServiceCachePolicy getDefaultServiceCachePolicy(java.lang.String adapterName,
                                                    java.lang.String service)
                                                    throws CommandException

Retrieve a default cache policy for the given command name and type. The default policy is not currently active, but provides a template for how a command policy should be created.

Parameters:

adapterName - the adapter name

service - the command name

Throws:

CommandException

getDefaultFileCachePolicy

ISCSFileCachePolicy getDefaultFileCachePolicy(java.lang.String adapterName,
                                              java.lang.String service)
                                              throws CommandException

Retrieve a default cache policy for the given command name and type. The default policy is not currently active, but provides a template for how a command policy should be created.

Parameters:

adapterName - the adapter name

service - the command name

Throws:

CommandException

getEventPoller

ISCSEventPollerInfo getEventPoller(java.lang.String adapterName)
                                   throws CommandException

Retrieve the bean that represents the event polling system in the CIS layer.

Parameters:

adapterName - the adapter name

Throws:

CommandException

getFileCacheInfoCommand

ISCSFileCacheInfo getFileCacheInfoCommand(java.lang.String adapterName)
                                          throws CommandException

Get the File cache location on the given adapter.

Parameters:

adapterName - the adapter name

Throws:

CommandException

getFileCacheLocation

java.lang.String getFileCacheLocation(java.lang.String adapterName)
                                      throws CommandException

Get the File cache location on the given adapter.

Parameters:

adapterName - the adapter name

Throws:

CommandException

getFileCachePolicies

java.util.Collection getFileCachePolicies(java.lang.String adapterName)
                                          throws CommandException

Retrieve all the cache policies for a given adapter.

Parameters:

adapterName - the adapter name

Throws:

CommandException

getFileCachePolicies

java.util.Collection getFileCachePolicies(java.lang.String adapterName,
                                          boolean filterDefault)
                                          throws CommandException

Retrieve all the cache policies for a given adapter.

Parameters:

adapterName - the adapter name

filterDefault - true to filter the default configurations and only return the modified configurations

Throws:

CommandException

getFileCachePolicy

ISCSFileCachePolicy getFileCachePolicy(java.lang.String adapterName,
                                       java.lang.String service)
                                       throws CommandException

Retrieve the cache policy for a given command.

Parameters:

adapterName - the adapter name

service - the command name

Throws:

CommandException

getFileCacheSize

java.lang.Integer getFileCacheSize(java.lang.String adapterName)
                                   throws CommandException

Get the File cache size on the given adapter.

Parameters:

adapterName - the adapter name

Throws:

CommandException

updateCommandCachePolicy

void updateCommandCachePolicy(java.lang.String adapterName,
                              ISCSServiceCachePolicy cachePolicy)
                              throws CommandException

Update a cache policy for an active command. Note that this will clear the current cache after the update. Will optionally persist the cache configuration information to the adapterconfig.xml file if specified.

Parameters:

adapterName - the adapter name

cachePolicy - the cache policy to update

Throws:

CommandException

updateCommandCachePolicy

void updateCommandCachePolicy(java.lang.String adapterName,
                              ISCSServiceCachePolicy cachePolicy,
                              boolean persistConfig)
                              throws CommandException

Update a cache policy for an active command. Note that this will clear the current cache after the update. Will optionally persist the cache configuration information to the adapterconfig.xml file if specified.

Parameters:

adapterName - the adapter name

cachePolicy - the cache policy to update

persistConfig - true to persist the configuration

Throws:

CommandException

updateEventPoller

void updateEventPoller(java.lang.String adapterName,
                       ISCSEventPollerInfo eventPoller)
                       throws CommandException

Update the event polling mechanism for the given adapter.

Parameters:

adapterName - the adapter name

eventPoller - the populated event poller bean

Throws:

CommandException

updateEventPoller

void updateEventPoller(java.lang.String adapterName,
                       ISCSEventPollerInfo eventPoller,
                       boolean persist)
                       throws CommandException

Update the event polling mechanism for the given adapter.

Parameters:

adapterName - the adapter name

eventPoller - the populated event poller bean

persist - true to persist the changes to the configuration file, false to make the changes transient

Throws:

CommandException

updateFileCachePolicy

void updateFileCachePolicy(java.lang.String adapterName,
                           ISCSFileCachePolicy cachePolicy)
                           throws CommandException

Update a cache policy for an active command. Note that this will clear the current cache after the update. Will optionally persist the cache configuration information to the adapterconfig.xml file if specified.

Parameters:

adapterName - the adapter name

cachePolicy - the cache policy to update

Throws:

CommandException

updateFileCachePolicy

void updateFileCachePolicy(java.lang.String adapterName,
                           ISCSFileCachePolicy cachePolicy,
                           boolean persistConfig)
                           throws CommandException

Update a cache policy for an active command. Note that this will clear the current cache after the update. Will optionally persist the cache configuration information to the adapterconfig.xml file if specified.

Parameters:

adapterName - the adapter name

cachePolicy - the cache policy to update

persistConfig - true to persist the configuration

Throws:

CommandException

Skip navigation links