|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ICISAdministrativeSCSCacheAPI
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 |
---|
static final java.lang.String API_CATEGORY
Method Detail |
---|
void clearCache(java.lang.String adapterName) throws CommandException
adapterName
- the adapter name
CommandException
void clearCache(java.lang.String adapterName, java.lang.String user) throws CommandException
adapterName
- the adapter nameuser
- the user name
CommandException
void clearFileCache(java.lang.String adapterName) throws CommandException
adapterName
- the adapter name
CommandException
void removeCachePolicy(java.lang.String adapterName, java.lang.String service) throws CommandException
adapterName
- the adapter nameservice
- the command name
CommandException
void removeCachePolicy(java.lang.String adapterName, java.lang.String service, boolean persistConfig) throws CommandException
adapterName
- the adapter nameservice
- the command namepersistConfig
- if true the configuration for the cache will be persisted
CommandException
void removeFileCachePolicy(java.lang.String adapterName, java.lang.String service) throws CommandException
adapterName
- the adapter nameservice
- the command name
CommandException
void removeFileCachePolicy(java.lang.String adapterName, java.lang.String service, boolean persistConfig) throws CommandException
adapterName
- the adapter nameservice
- the command namepersistConfig
- if true the configuration for the cache will be persisted
CommandException
java.util.Collection getServiceCachePolicies(java.lang.String adapterName) throws CommandException
adapterName
- the adapter name
CommandException
java.util.Collection getServiceCachePolicies(java.lang.String adapterName, boolean filterDefault) throws CommandException
adapterName
- the adapter namefilterDefault
- true to filter the default configurations and only return the modified configurations
CommandException
ISCSServiceCachePolicy getServiceCachePolicy(java.lang.String adapterName, java.lang.String service) throws CommandException
adapterName
- the adapter nameservice
- the command name
CommandException
ISCSServiceCacheInfo getServiceCacheInfo(java.lang.String adapterName) throws CommandException
adapterName
- the adapter name
CommandException
ISCSServiceCachePolicy getDefaultServiceCachePolicy(java.lang.String adapterName, java.lang.String service) throws CommandException
adapterName
- the adapter nameservice
- the command name
CommandException
ISCSFileCachePolicy getDefaultFileCachePolicy(java.lang.String adapterName, java.lang.String service) throws CommandException
adapterName
- the adapter nameservice
- the command name
CommandException
ISCSEventPollerInfo getEventPoller(java.lang.String adapterName) throws CommandException
adapterName
- the adapter name
CommandException
ISCSFileCacheInfo getFileCacheInfoCommand(java.lang.String adapterName) throws CommandException
adapterName
- the adapter name
CommandException
java.lang.String getFileCacheLocation(java.lang.String adapterName) throws CommandException
adapterName
- the adapter name
CommandException
java.util.Collection getFileCachePolicies(java.lang.String adapterName) throws CommandException
adapterName
- the adapter name
CommandException
java.util.Collection getFileCachePolicies(java.lang.String adapterName, boolean filterDefault) throws CommandException
adapterName
- the adapter namefilterDefault
- true to filter the default configurations and only return the modified configurations
CommandException
ISCSFileCachePolicy getFileCachePolicy(java.lang.String adapterName, java.lang.String service) throws CommandException
adapterName
- the adapter nameservice
- the command name
CommandException
java.lang.Integer getFileCacheSize(java.lang.String adapterName) throws CommandException
adapterName
- the adapter name
CommandException
void updateCommandCachePolicy(java.lang.String adapterName, ISCSServiceCachePolicy cachePolicy) throws CommandException
adapterName
- the adapter namecachePolicy
- the cache policy to update
CommandException
void updateCommandCachePolicy(java.lang.String adapterName, ISCSServiceCachePolicy cachePolicy, boolean persistConfig) throws CommandException
adapterName
- the adapter namecachePolicy
- the cache policy to updatepersistConfig
- true to persist the configuration
CommandException
void updateEventPoller(java.lang.String adapterName, ISCSEventPollerInfo eventPoller) throws CommandException
adapterName
- the adapter nameeventPoller
- the populated event poller bean
CommandException
void updateEventPoller(java.lang.String adapterName, ISCSEventPollerInfo eventPoller, boolean persist) throws CommandException
adapterName
- the adapter nameeventPoller
- the populated event poller beanpersist
- true to persist the changes to the configuration file, false to make the changes transient
CommandException
void updateFileCachePolicy(java.lang.String adapterName, ISCSFileCachePolicy cachePolicy) throws CommandException
adapterName
- the adapter namecachePolicy
- the cache policy to update
CommandException
void updateFileCachePolicy(java.lang.String adapterName, ISCSFileCachePolicy cachePolicy, boolean persistConfig) throws CommandException
adapterName
- the adapter namecachePolicy
- the cache policy to updatepersistConfig
- true to persist the configuration
CommandException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |