atg.xml.service

Class DocumentCache

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.service.cache.AbstractCache

atg.service.cache.Cache

atg.xml.service.DocumentCache

All Implemented Interfaces:

atg.core.logging.Logging, atg.core.logging.TraceLogging, atg.naming.AbsoluteNameable, NameContextBindingListener, NameContextElement, atg.naming.NameContextParentable, NameResolver, AdminableService, atg.nucleus.Configured, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, java.io.Serializable, java.util.EventListener

public class DocumentCache
extends Cache

A DocumentCache can be used to store W3C Document Object Model objects. Access to these documents are keyed by a DocumentCacheKey.

See Also:

DocumentCacheKey, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION

Fields inherited from class atg.nucleus.GenericService

SERVICE_INFO_KEY

Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging

DEFAULT_LOG_TRACE_STATUS

Fields inherited from interface atg.nucleus.logging.ApplicationLogging

DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS

Constructor Summary

Constructors

Constructor and Description
DocumentCache()

Method Summary

Modifier and Type	Method and Description
java.lang.Object	get(DocumentCacheKey pKey) Get a document from the cache, note this will parse the document if it does not already exist in the cache.
void	put(DocumentCacheKey pKey, DocumentCacheValue pValue) Put a document in the cache
void	remove(DocumentCacheKey pKey) Remove a document from the cache

Methods inherited from class atg.service.cache.Cache

contains, contains, dump, dump, flush, get, get, get, getAccessCount, getAllElements, getAllKeys, getAllKeysOrdered, getCacheEntryTime, getHitCount, getHitRatio, getNumCacheEntries, getSubKeysInvalidationTargetCounts, getTimeoutCount, getUsedCapacity, getUsedMemory, getValidKeysOrdered, hasExpiredValue, hasOtherwiseExpired, isExpiredValueStillGood, main, put, remove, remove, removeByPartialKey, setWaiterAndGetValue

Methods inherited from class atg.service.cache.AbstractCache

getCacheAdapter, getCacheRemovalListener, getEnablePartialKeyInvalidation, getKeyPartsForInvalidation, getMaximumCacheEntries, getMaximumCacheSize, getMaximumEntryLifetime, getMaximumEntrySize, getNumKeyParts, getSize, getUsedMemoryCapacity, isCaching, setCacheAdapter, setCacheRemovalListener, setEnablePartialKeyInvalidation, setKeyPartsForInvalidation, setMaximumCacheEntries, setMaximumCacheSize, setMaximumEntryLifetime, setMaximumEntrySize, setNumKeyParts

Methods inherited from class atg.nucleus.GenericService

addLogListener, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, reResolveThis, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setAdminServletOutputStreamEncoding, setAdminServletUseServletOutputStream, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService, toString

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Constructor Detail

DocumentCache

public DocumentCache()

Method Detail

get

public java.lang.Object get(DocumentCacheKey pKey)
                     throws java.lang.Exception

Get a document from the cache, note this will parse the document if it does not already exist in the cache.

Parameters:

pKey - A DocumentCacheKey.

Throws:

java.lang.Exception

put

public void put(DocumentCacheKey pKey,
                DocumentCacheValue pValue)

Put a document in the cache

Parameters:

pKey - A DocumentCacheKey.

pValue - A DocumentCacheValue.

remove

public void remove(DocumentCacheKey pKey)

Remove a document from the cache

Parameters:

pKey - A DocumentCacheKey.