co.codewizards.cloudstore.ls.core.invoke

Class ObjectManager

java.lang.Object

co.codewizards.cloudstore.ls.core.invoke.ObjectManager

public class ObjectManager
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected static long	EVICT_UNUSED_OBJECT_MANAGER_PERIOD_MS
protected static long	EVICT_UNUSED_OBJECT_MANAGER_TIMEOUT_MS Timeout after which an unused ObjectManager is evicted.
protected static long	EVICT_ZERO_REFERENCE_OBJECT_REFS_PERIOD_MS
protected static long	EVICT_ZERO_REFERENCE_OBJECT_REFS_TIMEOUT_MS The other side must notify us that an object is actually used (by invoking incRefCount(Object, Uid)) within this timeout.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ObjectManager(Uid clientId)

Method Summary

Modifier and Type	Method and Description
protected void	assertNotClosed()
static void	clearObjectManagers() Deprecated. Only used for tests! Don't use this method productively!
void	close()
protected ObjectRef	createObjectRef(Class<?> clazz)
void	decRefCount(Object object, Uid refId)
ClassManager	getClassManager()
Uid	getClientId() Gets the id of the client using this ObjectManager.
Object	getContextObject(String key)
static ObjectManager	getInstance(Uid clientId)
protected Date	getLastUseDate()
Object	getObject(ObjectRef objectRef)
Object	getObjectOrFail(ObjectRef objectRef)
ObjectRef	getObjectRef(Object object)
ObjectRef	getObjectRefOrCreate(Object object)
ObjectRef	getObjectRefOrFail(Object object)
Object	getObjectRefOrObject(Object object)
ReferenceJanitorRegistry	getReferenceCleanerRegistry()
RemoteObjectProxyManager	getRemoteObjectProxyManager()
void	incRefCount(Object object, Uid refId)
boolean	isClosed()
boolean	isNeverEvict()
static boolean	isObjectRefMappingEnabled(Object object)
void	putContextObject(String key, Object object)
void	setNeverEvict(boolean neverEvict)

Methods inherited from class java.lang.Object

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

Field Detail

EVICT_UNUSED_OBJECT_MANAGER_TIMEOUT_MS

protected static final long EVICT_UNUSED_OBJECT_MANAGER_TIMEOUT_MS

Timeout after which an unused ObjectManager is evicted.

If a client is closed normally (or crashes) we must make sure that the object-references held by this ObjectManager in the server's JVM are released and can be garbage-collected. Therefore, we track the last use timestamp (e.g. update it when getInstance(Uid) is called).

Periodically, all ObjectManagers not being used for a time period longer than this timeout are "forgotten" and thus both the ObjectManagers and all the objects they hold can be garbage-collected.

This timeout must be (significantly) longer than InverseInvoker.POLL_INVERSE_SERVICE_REQUEST_TIMEOUT_MS to make sure, the long-polling of inverse-service-invocation-requests serves additionally as a keep-alive for the server-side ObjectManager.

See Also:

Constant Field Values

EVICT_UNUSED_OBJECT_MANAGER_PERIOD_MS

protected static final long EVICT_UNUSED_OBJECT_MANAGER_PERIOD_MS

See Also:

Constant Field Values

EVICT_ZERO_REFERENCE_OBJECT_REFS_TIMEOUT_MS

protected static final long EVICT_ZERO_REFERENCE_OBJECT_REFS_TIMEOUT_MS

The other side must notify us that an object is actually used (by invoking incRefCount(Object, Uid)) within this timeout.

Thus, this timeout must be longer than the maximum time it ever takes to (1) transmit the entire object graph from here to the other side and (2) notify in the inverse direction (increment reference count).

Note, that the inverse notification is deferred for performance reasons! IncDecRefCountQueue.INC_DEC_REF_COUNT_PERIOD_MS thus must be significantly shorter than this timeout here.

See Also:

Constant Field Values

EVICT_ZERO_REFERENCE_OBJECT_REFS_PERIOD_MS

protected static final long EVICT_ZERO_REFERENCE_OBJECT_REFS_PERIOD_MS

See Also:

Constant Field Values

Constructor Detail

ObjectManager

protected ObjectManager(Uid clientId)

Method Detail

getInstance

public static ObjectManager getInstance(Uid clientId)

clearObjectManagers

@Deprecated
public static void clearObjectManagers()

Deprecated. Only used for tests! Don't use this method productively!

getLastUseDate

protected Date getLastUseDate()

isNeverEvict

public boolean isNeverEvict()

setNeverEvict

public void setNeverEvict(boolean neverEvict)

getClientId

public Uid getClientId()

Gets the id of the client using this ObjectManager. This is either the remote client talking to a server or it is the server (when the remote client holds references e.g. to listeners or other callbacks for the server).

Returns:

the id of the client.

getContextObject

public Object getContextObject(String key)

putContextObject

public void putContextObject(String key,
                             Object object)

createObjectRef

protected ObjectRef createObjectRef(Class<?> clazz)

getObjectRefOrObject

public Object getObjectRefOrObject(Object object)

getObjectRefOrCreate

public ObjectRef getObjectRefOrCreate(Object object)

getObjectRefOrFail

public ObjectRef getObjectRefOrFail(Object object)

getObjectRef

public ObjectRef getObjectRef(Object object)

getObjectOrFail

public Object getObjectOrFail(ObjectRef objectRef)

getObject

public Object getObject(ObjectRef objectRef)

incRefCount

public void incRefCount(Object object,
                        Uid refId)

decRefCount

public void decRefCount(Object object,
                        Uid refId)

getRemoteObjectProxyManager

public RemoteObjectProxyManager getRemoteObjectProxyManager()

getClassManager

public ClassManager getClassManager()

isObjectRefMappingEnabled

public static boolean isObjectRefMappingEnabled(Object object)

getReferenceCleanerRegistry

public ReferenceJanitorRegistry getReferenceCleanerRegistry()

isClosed

public boolean isClosed()

assertNotClosed

protected void assertNotClosed()

close

public void close()