|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.autonomy.aci.AciCache
The AciCache
controls the client-side caching of ACI requests made with the ACI api.
You should use it to specify which ACI actions are cached and when they are removed from
the cache.
Caching is turned on by default, using the action caching details specified in
com.autonomy.aci.CachingDetails
resource bundle.
It is a singleton class, which gets instantiated internally the first time it is used.
Method Summary | |
AciResponse |
getCachedResult(AciConnection aciServer,
AciAction aciAction)
Tries to find a valid cached result for the given action sent to the given server. |
static AciCache |
getInstance()
Gives access to the singleton AciCache object. |
long |
getMaxCachingTime()
Returns the maximum time for which results are cached. |
void |
setCachingDetailsForAction(ActionCachingDetails actionCachingDetails)
Details specific cause-effect cases for caching. |
void |
setLogfileName(java.lang.String sLogfileName)
Specify the path and name for the caching events logfile. |
void |
setMaxCachingTime(long lCachingTime)
Set the maximum time for which ACI requests are cached. |
void |
turnLoggingOff()
Stop logging caching events. |
void |
turnLoggingOn()
Start logging caching events. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
public static AciCache getInstance()
Gives access to the singleton AciCache
object.
AciCache
singleton reference.public void setCachingDetailsForAction(ActionCachingDetails actionCachingDetails)
Details specific cause-effect cases for caching. See ActionCachingDetails
for an explanation of how to configure the caching details.
actionCachingDetails
- the caching details for an action.public AciResponse getCachedResult(AciConnection aciServer, AciAction aciAction)
aciServer
- the ACI server that the action request is being sent to.aciAction
- the action that is being sent.
public void setMaxCachingTime(long lCachingTime)
lCachingTime
- the time for which requests are cached in milliseconds. 0 turns off the cache.public long getMaxCachingTime()
public void setLogfileName(java.lang.String sLogfileName)
turnLoggingOn
and turnLoggingOff
.
sLogfileName
- the path of the file into which messages should be logged.public void turnLoggingOn()
setLogfileName
before
any logging will occure.
public void turnLoggingOff()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |