wt.fc.cache
Class StandardObjReferenceCacheService

java.lang.Object
  extended bywt.services.StandardManager
      extended bywt.fc.cache.StandardObjReferenceCacheService
All Implemented Interfaces:
Manager, NetFactor, ObjectReferenceCache, Serializable

public class StandardObjReferenceCacheService
extends StandardManager
implements ObjectReferenceCache, Serializable

Standard Object Reference Cache Service class

Use the newStandardObjReferenceCacheService static factory method(s), not the StandardObjReferenceCacheService constructor, to construct instances of this class. Instances must be constructed using the static factory(s), in order to ensure proper initialization of the instance.



Supported API: false

Extendable: false

See Also:
Serialized Form

Field Summary
private static String CLASSNAME
           
private static boolean DEBUG
           
private static DebugWriter LOG
           
private static String RESOURCE
           
 
Fields inherited from class wt.services.StandardManager
 
Fields inherited from interface wt.services.Manager
MANAGER_SERVICE, STARTUP_AUTOMATIC, STARTUP_MANUAL, STATUS_EMERGENCY_SHUTDOWN, STATUS_EMERGENCY_SHUTTING_DOWN, STATUS_SHUTDOWN, STATUS_SHUTDOWN_ERRORS, STATUS_SHUTDOWN_FAILURE, STATUS_SHUTTING_DOWN, STATUS_STARTED, STATUS_STARTED_ERRORS, STATUS_STARTING_UP, STATUS_STARTUP_FAILURE
 
Constructor Summary
StandardObjReferenceCacheService()
           
 
Method Summary
 String getConceptualClassname()
          Deprecated.  
 Persistable getObject(CachedObjectReference objRef)
          getObject will return a clone of the cached object from the Cache Service after checking access control.
 Persistable getReadOnlyObject(CachedObjectReference objRef)
          when Invoked on the server side getReadOnlyObject will return a reference to tha actual cached object.
 CachedObjectReference inflate(CachedObjectReference objRef)
          method used to inflate Cached Object References for client side attribute display and access.
static StandardObjReferenceCacheService newStandardObjReferenceCacheService()
          Default factory for the class.
protected  void performStartupProcess()
          Dummy method to be overridden by subclasses.
 void showCacheState()
          method called by the ShowCacheState class, used primarily for debugging purposes, show the current caches contents.
 
Methods inherited from class wt.services.StandardManager
emergencyShutdown, emergencyShutdownComplete, emergencyShuttingDown, getClassInfo, getManagerService, getManagerStatus, getName, getStartupType, init, initialize, initialize, isStarted, newStandardManager, newStandardManager, performEmergencyShutdownProcess, performShutdownProcess, registerEvents, setManagerService, shutdown, shutdownFailure, shutdownSuccess, shuttingDown, started, startedErrors, startingUp, startup, startupFailure, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

RESOURCE

private static final String RESOURCE
See Also:
Constant Field Values

CLASSNAME

private static final String CLASSNAME

DEBUG

private static final boolean DEBUG

LOG

private static final DebugWriter LOG
Constructor Detail

StandardObjReferenceCacheService

public StandardObjReferenceCacheService()
Method Detail

getConceptualClassname

public String getConceptualClassname()
Deprecated.  

Returns the conceptual (modeled) name for the class.

Supported API: false

Specified by:
getConceptualClassname in interface NetFactor
Overrides:
getConceptualClassname in class StandardManager
Returns:
String

performStartupProcess

protected void performStartupProcess()
                              throws ManagerException
Dummy method to be overridden by subclasses. Subclasses should override this method and provide startup processing.

Supported API: false

Overrides:
performStartupProcess in class StandardManager
Throws:
ManagerException

newStandardObjReferenceCacheService

public static StandardObjReferenceCacheService newStandardObjReferenceCacheService()
                                                                            throws WTException
Default factory for the class.

Supported API: false

Returns:
StandardObjReferenceCacheService
Throws:
WTException

getObject

public Persistable getObject(CachedObjectReference objRef)
                      throws WTException
getObject will return a clone of the cached object from the Cache Service after checking access control.

Supported API: false

Specified by:
getObject in interface ObjectReferenceCache
Parameters:
objRef -
Returns:
Persistable
Throws:
WTException

getReadOnlyObject

public Persistable getReadOnlyObject(CachedObjectReference objRef)
                              throws WTException
when Invoked on the server side getReadOnlyObject will return a reference to tha actual cached object. I should NOT be modified as it will contaminate the cache. this method also enforce access contorl.

Supported API: false

Specified by:
getReadOnlyObject in interface ObjectReferenceCache
Parameters:
objRef -
Returns:
Persistable
Throws:
WTException

inflate

public CachedObjectReference inflate(CachedObjectReference objRef)
                              throws WTException
method used to inflate Cached Object References for client side attribute display and access.

Supported API: false

Specified by:
inflate in interface ObjectReferenceCache
Parameters:
objRef -
Returns:
CachedObjectReference
Throws:
WTException

showCacheState

public void showCacheState()
                    throws WTException
method called by the ShowCacheState class, used primarily for debugging purposes, show the current caches contents.

Supported API: false

Specified by:
showCacheState in interface ObjectReferenceCache
Throws:
WTException