com.gigaspaces.internal.client.cache

Class AbstractSpaceCacheContainer

java.lang.Object

com.gigaspaces.internal.client.spaceproxy.AbstractSpaceProxy

com.gigaspaces.internal.client.cache.AbstractSpaceCacheContainer

All Implemented Interfaces:

IPojoSpace, ISpaceCache, ISpaceProxy, SecuredService, IDotnetProxyAssociated, ActionMaker, IJSpace, JavaSpace

Direct Known Subclasses:

LocalCacheContainer, LocalViewContainer

public abstract class AbstractSpaceCacheContainer
extends AbstractSpaceProxy
implements ISpaceCache

Since:

8.0.5

Author:

Niv Ingberg

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	AbstractSpaceCacheContainer.StateMonitor

Field Summary

Fields

Modifier and Type	Field and Description
protected String	_cacheID
protected org.slf4j.Logger	_logger

Fields inherited from interface com.j_spaces.core.IJSpace

NO_WAIT

Fields inherited from interface net.jini.space.JavaSpace

NO_WAIT

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractSpaceCacheContainer(IDirectSpaceProxy remoteProxy, SpaceCacheConfig config)

Method Summary

Modifier and Type	Method and Description
AbstractSpaceCache	assertCacheConnected()
void	close() Closes space cache (the local cache).
OperationID	createNewOperationID() Generate a unique operation ID
protected abstract AbstractSpaceCache	createSpaceCache()
protected void	finalize()
Object	getAdmin() Returns the admin object to the remote part of this space.
abstract SpaceCacheConfig	getCacheConfig()
String	getCacheId()
SpaceCacheState	getCacheState()
Transaction.Created	getContextTransaction() Returns the transaction associated with the current context, if any.
IDirectSpaceProxy	getDirectProxy() returns itself in case of a direct proxy or the real proxy in case of a local cache or a view.
SpaceURL	getFinderURL() Returns the SpaceURL object which was used as the argument for SpaceFinder.find(SpaceURL) while looking for the space.
IDirectSpaceProxy	getLocalSpace() Returns a direct proxy to the local space.
String	getName() Returns the name of this space.
Object	getPrivilegedAdmin()
int	getReadModifiers() Gets the proxy ReadModifiers.
Uuid	getReferentUuid() Returns the unique Uuid of this space instance.
IDirectSpaceProxy	getRemoteSpace() Returns a direct proxy to the remote space.
int	getUpdateModifiers() Gets the proxyUpdateModifiers.
SpaceURL	getURL() Returns the SpaceURL instance which was used to initialize the space.
void	initialize()
protected abstract org.slf4j.Logger	initLogger()
int	initWriteModifiers(int modifiers)
boolean	isCacheContainer()
boolean	isClustered() returns true if the proxy is Clustered
boolean	isEmbedded() Checks whether proxy is connected to embedded or remote space.
boolean	isFifo() Returns true if this proxy FIFO enabled, otherwise false.
boolean	isOptimisticLockingEnabled() Returns status of Optimistic Lock protocol.
boolean	isSecured() Returns an indication : is this space secured.
boolean	isServiceSecured() If a security model is defined will return true.
boolean	isStartedWithinGSC() Returns true if the space started within a GSC.
Class<?>	loadRemoteClass(String className) Loads a remote class from the space, the class will be loaded locally into a corresponding LRMIClassLoader
SecurityContext	login(CredentialsProvider credentialsProvider) Login to a secured service using the provided credentialsProvider.
protected void	notifyLocalSpaceOnInternalStateChange(SpaceCacheState state)
void	onCacheFailure(AbstractSpaceCache failedCache)
Object	readById(ReadTakeProxyActionInfo actionInfo)
Object	readById(String className, Object id, Object routing, Transaction txn, long timeout, int modifiers, boolean ifExists, QueryResultTypeInternal resultType, String[] projections)
Transaction.Created	replaceContextTransaction(Transaction.Created transaction)
Transaction.Created	replaceContextTransaction(Transaction.Created transaction, ActionListener actionListener, boolean delegatedXa)
void	setActionListener(ActionListener actionListener) Sets a new ActionListener to receive events.
void	setFifo(boolean enabled) Sets FIFO mode for proxy.
void	setOptimisticLocking(boolean enabled) Enable/Disable Optimistic Lock protocol.
int	setReadModifiers(int modifiers) Sets the read mode modifiers for proxy level.
int	setUpdateModifiers(int modifiers) Sets the update mode modifiers for proxy level.
String	toString()
void	verifyProjectionsAreSupported(AbstractProjectionTemplate projectionTemplate)

Methods inherited from class com.gigaspaces.internal.client.spaceproxy.AbstractSpaceProxy

aggregate, applyNotifyInfoDefaults, asyncAddIndexes, asyncChange, asyncRead, asyncTake, change, checkIfConnected, clear, clear, count, count, createActionManager, dropClass, execute, getAppDomainId, getContainerName, getDotnetProxyHandleId, getSpaceHealthStatus, getTypeDescriptor, hasAssociatedAppDomain, isLocalCacheCacheContainer, isLocalViewContainer, isTargetOfADotnetProxy, notify, ping, read, read, read, read, readByIds, readByIds, readByIds, readByUid, readEntriesUids, readIfExists, readIfExists, readIfExists, readMultiple, readMultiple, readMultiple, readMultiple, registerTypeDescriptor, registerTypeDescriptor, setAppDomainId, setDotnetProxyHandleId, snapshot, snapshot, take, take, take, take, takeById, takeById, takeByIds, takeByIds, takeByIds, takeByUid, takeIfExists, takeIfExists, takeIfExists, takeMultiple, takeMultiple, takeMultiple, takeMultiple, unregisterTypeDescriptor, update, update, updateMultiple, updateMultiple, write, write, write, writeMultiple, writeMultiple, writeMultiple, writeMultiple, writeMultiple

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.gigaspaces.internal.client.spaceproxy.ISpaceProxy

getNotificationsDirectProxy

Methods inherited from interface com.j_spaces.core.IJSpace

getCacheTypeName

Field Detail

_logger

protected final org.slf4j.Logger _logger

_cacheID

protected final String _cacheID

Constructor Detail

AbstractSpaceCacheContainer

protected AbstractSpaceCacheContainer(IDirectSpaceProxy remoteProxy,
                                      SpaceCacheConfig config)

Method Detail

initLogger

protected abstract org.slf4j.Logger initLogger()

verifyProjectionsAreSupported

public void verifyProjectionsAreSupported(AbstractProjectionTemplate projectionTemplate)

getCacheId

public String getCacheId()

getCacheState

public SpaceCacheState getCacheState()

getCacheConfig

public abstract SpaceCacheConfig getCacheConfig()

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable

toString

public String toString()

Overrides:

toString in class Object

close

public void close()

Description copied from interface: ISpaceCache

Closes space cache (the local cache). Note, any operations performed on the space cache after it has been closed will result in an error. For example, and event session built on top of the space cache should be closed before the space cache is closed.

Specified by:

close in interface ISpaceCache

Specified by:

close in interface ISpaceProxy

assertCacheConnected

public AbstractSpaceCache assertCacheConnected()
                                        throws SpaceCacheException

Throws:

SpaceCacheException

getLocalSpace

public IDirectSpaceProxy getLocalSpace()

Description copied from interface: ISpaceCache

Returns a direct proxy to the local space.

Specified by:

getLocalSpace in interface ISpaceCache

Overrides:

getLocalSpace in class AbstractSpaceProxy

getRemoteSpace

public IDirectSpaceProxy getRemoteSpace()

Description copied from interface: ISpaceCache

Returns a direct proxy to the remote space.

Specified by:

getRemoteSpace in interface ISpaceCache

Overrides:

getRemoteSpace in class AbstractSpaceProxy

initialize

public void initialize()
                throws SpaceCacheInitializationException

Throws:

SpaceCacheInitializationException

onCacheFailure

public void onCacheFailure(AbstractSpaceCache failedCache)

createSpaceCache

protected abstract AbstractSpaceCache createSpaceCache()
                                                throws SpaceCacheInitializationException

Throws:

SpaceCacheInitializationException

isEmbedded

public boolean isEmbedded()

Description copied from interface: IJSpace

Checks whether proxy is connected to embedded or remote space.

Specified by:

isEmbedded in interface IJSpace

isClustered

public boolean isClustered()

Description copied from interface: ISpaceProxy

returns true if the proxy is Clustered

Specified by:

isClustered in interface ISpaceProxy

Returns:

true when the proxy is Clustered

isSecured

public boolean isSecured()

Description copied from interface: IJSpace

Returns an indication : is this space secured. If for this space defined Security Filter, the space will be secured.

Specified by:

isSecured in interface IJSpace

Returns:

boolean true if this space secured, otherwise false.

isServiceSecured

public boolean isServiceSecured()
                         throws RemoteException

Description copied from interface: SecuredService

If a security model is defined will return true.

Specified by:

isServiceSecured in interface SecuredService

Returns:

true if secured; false otherwise.

Throws:

RemoteException - communication-related exceptions that may occur during the execution of a remote method call.

isStartedWithinGSC

public boolean isStartedWithinGSC()
                           throws RemoteException

Description copied from interface: IJSpace

Returns true if the space started within a GSC.

Specified by:

isStartedWithinGSC in interface IJSpace

Throws:

RemoteException

getName

public String getName()

Description copied from interface: IJSpace

Returns the name of this space.

Specified by:

getName in interface IJSpace

getFinderURL

public SpaceURL getFinderURL()

Description copied from interface: IJSpace

Returns the SpaceURL object which was used as the argument for SpaceFinder.find(SpaceURL) while looking for the space. If a client uses this SpaceURL when it calls to SpaceFinder.find(SpaceURL) it should be able to find that space. Notice: The SpaceURL returned when calling getURL() is different since in that case it returns the SpaceURL used to initialize the space (a java:// protocol to start an embedded space).

Specified by:

getFinderURL in interface IJSpace

Returns:

SpaceURL object which can be used to find the space proxy while calling SpaceFinder.find(SpaceURL)

getURL

public SpaceURL getURL()

Description copied from interface: IJSpace

Returns the SpaceURL instance which was used to initialize the space.

Specified by:

getURL in interface IJSpace

getReferentUuid

public Uuid getReferentUuid()

Description copied from interface: IJSpace

Returns the unique Uuid of this space instance.

Specified by:

getReferentUuid in interface IJSpace

getAdmin

public Object getAdmin()
                throws RemoteException

Description copied from interface: IJSpace

Returns the admin object to the remote part of this space.

 // get a list of classes and the number of entries of each class
 IRemoteJSpaceAdmin remoteAdmin =
 (IRemoteJSpaceAdmin)serverAdmin.getAdmin();
 Object classList[] = remoteAdmin.getRuntimeInfo().m_ClassNames.toArray();
 List numOFEntries = remoteAdmin.getRuntimeInfo().m_NumOFEntries;
 

Specified by:

getAdmin in interface IJSpace

Returns:

the remoteAdmin object to the remote part of this space.

Throws:

RemoteException - if a communication error occurs

getDirectProxy

public IDirectSpaceProxy getDirectProxy()

Description copied from interface: IJSpace

returns itself in case of a direct proxy or the real proxy in case of a local cache or a view.

Specified by:

getDirectProxy in interface IJSpace

Returns:

IDirectSpaceProxy

getPrivilegedAdmin

public Object getPrivilegedAdmin()
                          throws RemoteException

Specified by:

getPrivilegedAdmin in interface ISpaceProxy

Throws:

RemoteException

See Also:

IJSpace.getAdmin()

isFifo

public boolean isFifo()

Description copied from interface: IJSpace

Returns true if this proxy FIFO enabled, otherwise false.

Specified by:

isFifo in interface IJSpace

setFifo

public void setFifo(boolean enabled)

Description copied from interface: IJSpace

Sets FIFO mode for proxy.

Specified by:

setFifo in interface IJSpace

isOptimisticLockingEnabled

public boolean isOptimisticLockingEnabled()

Description copied from interface: IJSpace

Returns status of Optimistic Lock protocol.

Specified by:

isOptimisticLockingEnabled in interface IJSpace

setOptimisticLocking

public void setOptimisticLocking(boolean enabled)

Description copied from interface: IJSpace

Enable/Disable Optimistic Lock protocol.

Specified by:

setOptimisticLocking in interface IJSpace

initWriteModifiers

public int initWriteModifiers(int modifiers)

Specified by:

initWriteModifiers in interface ISpaceProxy

getContextTransaction

public Transaction.Created getContextTransaction()

Description copied from interface: ISpaceProxy

Returns the transaction associated with the current context, if any.

Specified by:

getContextTransaction in interface ISpaceProxy

replaceContextTransaction

public Transaction.Created replaceContextTransaction(Transaction.Created transaction)

Specified by:

replaceContextTransaction in interface ISpaceProxy

replaceContextTransaction

public Transaction.Created replaceContextTransaction(Transaction.Created transaction,
                                                     ActionListener actionListener,
                                                     boolean delegatedXa)

Specified by:

replaceContextTransaction in interface ISpaceProxy

setActionListener

public void setActionListener(ActionListener actionListener)

Description copied from interface: ActionMaker

Sets a new ActionListener to receive events. Replaces any former ActionListener if exists.

Specified by:

setActionListener in interface ActionMaker

getReadModifiers

public int getReadModifiers()

Description copied from interface: IJSpace

Gets the proxy ReadModifiers.

Specified by:

getReadModifiers in interface IJSpace

setReadModifiers

public int setReadModifiers(int modifiers)

Description copied from interface: IJSpace

Sets the read mode modifiers for proxy level.

Specified by:

setReadModifiers in interface IJSpace

getUpdateModifiers

public int getUpdateModifiers()

Description copied from interface: IJSpace

Gets the proxyUpdateModifiers.

Specified by:

getUpdateModifiers in interface IJSpace

setUpdateModifiers

public int setUpdateModifiers(int modifiers)

Description copied from interface: IJSpace

Sets the update mode modifiers for proxy level.

Specified by:

setUpdateModifiers in interface IJSpace

login

public SecurityContext login(CredentialsProvider credentialsProvider)
                      throws RemoteException

Description copied from interface: SecuredService

Login to a secured service using the provided credentialsProvider.

Specified by:

login in interface SecuredService

Parameters:

credentialsProvider - provides credentials to be used for authentication.

Throws:

RemoteException - communication-related exceptions that may occur during the execution of a remote method call.

loadRemoteClass

public Class<?> loadRemoteClass(String className)
                         throws ClassNotFoundException

Description copied from interface: ISpaceProxy

Loads a remote class from the space, the class will be loaded locally into a corresponding LRMIClassLoader

Specified by:

loadRemoteClass in interface ISpaceProxy

Throws:

ClassNotFoundException

createNewOperationID

public OperationID createNewOperationID()

Description copied from interface: ISpaceProxy

Generate a unique operation ID

Specified by:

createNewOperationID in interface ISpaceProxy

Returns:

Unique operation ID

readById

public Object readById(ReadTakeProxyActionInfo actionInfo)
                throws RemoteException,
                       UnusableEntryException,
                       TransactionException,
                       InterruptedException

Specified by:

readById in interface ISpaceProxy

Overrides:

readById in class AbstractSpaceProxy

Throws:

RemoteException

UnusableEntryException

TransactionException

InterruptedException

readById

public Object readById(String className,
                       Object id,
                       Object routing,
                       Transaction txn,
                       long timeout,
                       int modifiers,
                       boolean ifExists,
                       QueryResultTypeInternal resultType,
                       String[] projections)
                throws RemoteException,
                       UnusableEntryException,
                       TransactionException,
                       InterruptedException

Specified by:

readById in interface ISpaceProxy

Overrides:

readById in class AbstractSpaceProxy

Throws:

RemoteException

UnusableEntryException

TransactionException

InterruptedException

isCacheContainer

public boolean isCacheContainer()

Overrides:

isCacheContainer in class AbstractSpaceProxy

notifyLocalSpaceOnInternalStateChange

protected void notifyLocalSpaceOnInternalStateChange(SpaceCacheState state)