com.j_spaces.core.admin

Interface IInternalRemoteJSpaceAdmin

All Superinterfaces:

GridZoneProvider, IRemoteJSpaceAdmin, JVMInfoProvider, NIOInfoProvider, OSInfoProvider, Remote

All Known Implementing Classes:

JSpaceAdminImpl, JSpaceAdminProxy, LRMISpaceImpl, SpaceImpl

public interface IInternalRemoteJSpaceAdmin
extends IRemoteJSpaceAdmin, NIOInfoProvider, OSInfoProvider, JVMInfoProvider, GridZoneProvider

Extends IRemoteJSpaceAdmin to include internal methods.

Author:

Guy Korland

Field Summary

Fields inherited from interface com.j_spaces.core.admin.IRemoteJSpaceAdmin

REPLICATION_STATUS_ACTIVE, REPLICATION_STATUS_DISABLED, REPLICATION_STATUS_DISCONNECTED

Method Summary

Modifier and Type	Method and Description
SpaceMode	addSpaceModeListener(ISpaceModeListener listener) Adds a listener to be called back with ISpaceModeListener mode changes.
SuspendType	addSpaceSuspendTypeListener(SuspendTypeChangedInternalListener listener) Adds a listener to be called back with SuspendTypeChangedInternalListener suspend type changes.
int	countIncomingConnections()
int	countTransactions(int type, int status)
void	disableStub() disable remote.
int	flushRedoLogToStorage() Flush redo-log packets from memory to underlying storage.
void	forceMoveToPrimary() Forcefully make this space to be primary
ITypeDesc	getClassDescriptor(String className) Get the basic class information from the space directory.
ITypeDesc	getClassDescriptor(String className, boolean asVirtualType) Get the basic class information from the space directory.
byte[]	getClusterConfigFile() Returns a byte representation of the cluster configuration file.
List<ITransportConnection>	getConnectionsInfo() Deprecated. Since 10.1 - Use countIncomingConnections instead
Map<String,LocalCacheDetails>	getLocalCacheDetails()
Map<String,LocalViewDetails>	getLocalViewDetails()
List<UnderTxnLockedObject>	getLockedObjects(Transaction txn) getLockedObjects is called by the GUI.
String	getReplicationDump()
RuntimeHolder	getRuntimeHolder()
SpaceMode	getSpaceMode() Get the current SpaceMode which represents the current state of this participant in the election process.
List<TemplateInfo>	getTemplatesInfo(String className) Returns a list of pending templates.
TransactionInfo[]	getTransactionsInfo(int type, int status) Returns all the transactions with the specific parameters.
boolean	isStartedWithinGSC()
void	removeSpaceModeListener(ISpaceModeListener listener) Removes this listener so that it no longer receives call backs of space mode changes.
void	removeSpaceSuspendTypeListener(SuspendTypeChangedInternalListener listener) Removes this listener so that it no longer receives call backs of space suspend type changes.
void	restart() Deprecated. To restart a space, restart the corresponding processing unit instance
void	setClusterConfigFile(byte[] config) set the cluster configuration according to the given byte representation of the configuration file.
SpaceCopyStatus	spaceCopy(IRemoteSpace remoteProxy, String remoteSpaceUrl, String remoteSpaceName, ITemplatePacket template, boolean includeNotifyTemplates, int chunkSize, SpaceContext spaceContext, SpaceContext remoteSpaceContext) Given ISpaceInternal of a remote space, Copy all entries/notify templates from the space.
SpaceCopyStatus	spaceCopy(String remoteUrl, ITemplatePacket template, boolean includeNotifyTemplates, int chunkSize) Given Url of a remote space, Copy all entries/notify templates from the space.
SpaceCopyStatus	spaceCopy(String remoteUrl, ITemplatePacket template, boolean includeNotifyTemplates, int chunkSize, SpaceContext sc) Given Url of a remote space, Copy all entries/notify templates from the space.
void	start() Deprecated. To stop and start a space, restart the corresponding processing unit instance
void	stop() Deprecated. To stop and start a space, restart the corresponding processing unit instance

Methods inherited from interface com.j_spaces.core.admin.IRemoteJSpaceAdmin

dropClass, getClassTypeInfo, getClusterPolicy, getConfig, getName, getReplicationStatus, getRuntimeInfo, getRuntimeInfo, getSpaceInstanceRemoteClassLoaderInfo, getState, ping, spaceCopy, spaceCopy, updateClusterInfo

Methods inherited from interface com.gigaspaces.lrmi.nio.info.NIOInfoProvider

disableLRMIMonitoring, enableLRMIMonitoring, fetchLRMIMonitoringDetails, getNIODetails, getNIOStatistics

Methods inherited from interface com.gigaspaces.internal.os.OSInfoProvider

getCurrentTimestamp, getOSDetails, getOSStatistics

Methods inherited from interface com.gigaspaces.internal.jvm.JVMInfoProvider

getJVMDetails, getJVMStatistics, runGc

Methods inherited from interface com.gigaspaces.grid.zone.GridZoneProvider

getZones

Method Detail

disableStub

void disableStub()
          throws RemoteException

disable remote.

Throws:

RemoteException - if a communication error occurs

getClusterConfigFile

byte[] getClusterConfigFile()
                     throws RemoteException

Returns a byte representation of the cluster configuration file.

Returns:

byte representation of the cluster configuration file

Throws:

RemoteException - if a communication error occurs

setClusterConfigFile

void setClusterConfigFile(byte[] config)
                   throws RemoteException

set the cluster configuration according to the given byte representation of the configuration file.

Parameters:

config - byte representation of the configuration file

Throws:

RemoteException - if a communication error occurs

getRuntimeHolder

RuntimeHolder getRuntimeHolder()
                        throws RemoteException

Throws:

RemoteException

isStartedWithinGSC

boolean isStartedWithinGSC()
                    throws RemoteException

Throws:

RemoteException

spaceCopy

SpaceCopyStatus spaceCopy(String remoteUrl,
                          ITemplatePacket template,
                          boolean includeNotifyTemplates,
                          int chunkSize)
                   throws RemoteException

Given Url of a remote space, Copy all entries/notify templates from the space.

 Usage:
   SpaceCopyStatus copyStatus = spaceAdmin.spaceCopy( sourceSpaceURL, template, false );
   System.out.println("Copy-Status: " + copyStatus );
 

Parameters:

remoteUrl - url of remote space to copy from

template - EntryPacket template or null.

includeNotifyTemplates - - if true ALL notify templates will be copied too

chunkSize - Chunk size (batch) for this copy operation.

Returns:

SpaceCopyStatus Contains the status information of spaceCopy operation.

Throws:

RemoteException - if a communication error occurs

spaceCopy

SpaceCopyStatus spaceCopy(String remoteUrl,
                          ITemplatePacket template,
                          boolean includeNotifyTemplates,
                          int chunkSize,
                          SpaceContext sc)
                   throws RemoteException

Given Url of a remote space, Copy all entries/notify templates from the space.

 Usage:
   SpaceCopyStatus copyStatus = spaceAdmin.spaceCopy( sourceSpaceURL, template, false );
   System.out.println("Copy-Status: " + copyStatus );
 

Parameters:

remoteUrl - url of remote space to copy from

template - EntryPacket template or null.

includeNotifyTemplates - - if true ALL notify templates will be copied too

chunkSize - Chunk size (batch) for this copy operation.

sc - SpaceContext for security check in the server side.

Returns:

SpaceCopyStatus Contains the status information of spaceCopy operation.

Throws:

RemoteException - if a communication error occurs

spaceCopy

SpaceCopyStatus spaceCopy(IRemoteSpace remoteProxy,
                          String remoteSpaceUrl,
                          String remoteSpaceName,
                          ITemplatePacket template,
                          boolean includeNotifyTemplates,
                          int chunkSize,
                          SpaceContext spaceContext,
                          SpaceContext remoteSpaceContext)
                   throws RemoteException

Given ISpaceInternal of a remote space, Copy all entries/notify templates from the space.

 Usage:
   SpaceCopyStatus copyStatus = spaceAdmin.spaceCopy( remoteProxy, remoteURL, remoteName,
 template, false 1000, sc);
   System.out.println("Copy-Status: " + copyStatus );
 

Parameters:

remoteProxy - ISpaceInternal, a proxy to the remote space to copy from

remoteSpaceUrl - the remote space url.

remoteSpaceName - the remote space name.

template - A template for identified entries that should be copied.

includeNotifyTemplates - - if true ALL notify templates will be copied too

chunkSize - Chunk size (batch) for this copy operation.

spaceContext - SpaceContext for security check in the server side.

remoteSpaceContext - remoteSpaceContext for security check in the server side.

Returns:

SpaceCopyStatus Contains the status information of spaceCopy operation.

Throws:

RemoteException - if a communication error occurs

getTransactionsInfo

TransactionInfo[] getTransactionsInfo(int type,
                                      int status)
                               throws RemoteException

Returns all the transactions with the specific parameters.

Parameters:

type - TransactionInfo.Types.LOCAL, TransactionInfo.Types.JINI or TransactionInfo.Types.XA. Use TransactionInfo.Types.All for all types;

status - can be one of the status defined in TransactionConstants

Returns:

all the TransactionInfos of the transactions that matches the given parameters

Throws:

RemoteException - if a communication error occurs

countTransactions

int countTransactions(int type,
                      int status)
               throws RemoteException

Throws:

RemoteException

getTemplatesInfo

List<TemplateInfo> getTemplatesInfo(String className)
                             throws RemoteException

Returns a list of pending templates.

Parameters:

className - name of the class to search

Returns:

list of pending template for the given class

Throws:

RemoteException

getConnectionsInfo

@Deprecated
List<ITransportConnection> getConnectionsInfo()
                                                   throws RemoteException

Deprecated. Since 10.1 - Use countIncomingConnections instead

Returns:

returns all the transport connection information for this Space.

Throws:

RemoteException

countIncomingConnections

int countIncomingConnections()
                      throws RemoteException

Returns:

returns all the transport connection information for this Space.

Throws:

RemoteException

getLockedObjects

List<UnderTxnLockedObject> getLockedObjects(Transaction txn)
                                     throws RemoteException

getLockedObjects is called by the GUI. it returns Info about all the locked Object by the given Transaction.

Parameters:

txn - - the Transaction that locks the Objects.

Returns:

List of UnderTxnLockedObject

Throws:

RemoteException

getSpaceMode

SpaceMode getSpaceMode()
                throws RemoteException

Get the current SpaceMode which represents the current state of this participant in the election process.

In case of a non-clustered participant, where no election process takes place, the return value is always SpaceMode.PRIMARY.

Returns:

the current SpaceMode of the space.

Throws:

RemoteException - if an exception occurred executing this remote method.

Since:

6.6

addSpaceModeListener

SpaceMode addSpaceModeListener(ISpaceModeListener listener)
                        throws RemoteException

Adds a listener to be called back with ISpaceModeListener mode changes. The change ( SpaceMode ) represents the result of an election process of this participant space. The returned value represents the current state of this participant in the election process.

In case of a non-clustered participant, the return value is always SpaceMode.PRIMARY. Hence, no election process will take place and the listener will not be called.

Parameters:

listener - a listener to be called back on space mode changes.

Returns:

the current SpaceMode of the space.

Throws:

RemoteException - if an exception occurred executing this remote method.

Since:

6.0

See Also:

ISpaceModeListener, SpaceMode

removeSpaceModeListener

void removeSpaceModeListener(ISpaceModeListener listener)
                      throws RemoteException

Removes this listener so that it no longer receives call backs of space mode changes. Invocation has no additional effect if the listener was already removed or was not existent in the first place.

Parameters:

listener - a listener to be removed.

Throws:

RemoteException - if an exception occurred executing this remote method.

Since:

6.0

See Also:

addSpaceModeListener(ISpaceModeListener)

getClassDescriptor

ITypeDesc getClassDescriptor(String className)
                      throws RemoteException

Get the basic class information from the space directory.

 Usage:
   com.j_spaces.core.client.BasicTypeInfo classInfo
        = spaceAdmin.getClassTypeInfo( className );

   String[] fieldNames = classInfo.m_FieldsNames;
   String[] fieldTypes = classInfo.m_FieldsTypes;
 

Parameters:

className - - The name of the class to retrieve the information from.

Returns:

BasicTypeInfo - Which provides class information.

Throws:

RemoteException - if a communication error occurs

getClassDescriptor

ITypeDesc getClassDescriptor(String className,
                             boolean asVirtualType)
                      throws RemoteException

Get the basic class information from the space directory.

 Usage:
   com.j_spaces.core.client.BasicTypeInfo classInfo
        = spaceAdmin.getClassTypeInfo( className );

   String[] fieldNames = classInfo.m_FieldsNames;
   String[] fieldTypes = classInfo.m_FieldsTypes;
 

Parameters:

className - - The name of the class to retrieve the information from.

asVirtualType -

Returns:

BasicTypeInfo - Which provides class information.

Throws:

RemoteException - if a communication error occurs

forceMoveToPrimary

void forceMoveToPrimary()
                 throws RemoteException

Forcefully make this space to be primary

Throws:

RemoteException

getReplicationDump

String getReplicationDump()
                   throws RemoteException

Throws:

RemoteException

flushRedoLogToStorage

int flushRedoLogToStorage()
                   throws RemoteException

Flush redo-log packets from memory to underlying storage. Should be called when the space is in quiesce mode.

Returns:

number of flushed packets

Throws:

RemoteException

Since:

16.2

getLocalCacheDetails

Map<String,LocalCacheDetails> getLocalCacheDetails()
                                            throws RemoteException

Throws:

RemoteException

Since:

9.5.0

getLocalViewDetails

Map<String,LocalViewDetails> getLocalViewDetails()
                                          throws RemoteException

Throws:

RemoteException

Since:

9.5.0

start

@Deprecated
void start()
                throws RemoteException,
                       SpaceAlreadyStartedException

Deprecated. To stop and start a space, restart the corresponding processing unit instance

Attempt to start this space.

 Usage:
  spaceAdmin.start();
 

Throws:

RemoteException - - Failed to start space.

SpaceAlreadyStartedException - - The space is already started

stop

@Deprecated
void stop()
               throws RemoteException,
                      SpaceAlreadyStoppedException

Deprecated. To stop and start a space, restart the corresponding processing unit instance

Attempt to stop this space.

 Usage:
  spaceAdmin.stop();
 

Throws:

RemoteException - - Failed to stop space.

SpaceAlreadyStoppedException - - The space is already stopped

restart

@Deprecated
void restart()
                  throws RemoteException

Deprecated. To restart a space, restart the corresponding processing unit instance

Restarts the space.

 Usage:
   try
   {
  spaceAdmin.restart();
   }
   catch( java.rmi.RemoteException ex )
   {
  System.err.println("Failed to restart space: " + ((IJSpace)space).getName());
  System.err.println("Exception: " + ex);
   }
 

Throws:

RemoteException - Failed to restart space.

addSpaceSuspendTypeListener

SuspendType addSpaceSuspendTypeListener(SuspendTypeChangedInternalListener listener)

Adds a listener to be called back with SuspendTypeChangedInternalListener suspend type changes.

Parameters:

listener - - SuspendTypeChangedInternalListener that will receive notification when a space suspend type changes (SuspendType)

removeSpaceSuspendTypeListener

void removeSpaceSuspendTypeListener(SuspendTypeChangedInternalListener listener)

Removes this listener so that it no longer receives call backs of space suspend type changes.

Parameters:

listener - - SuspendTypeChangedInternalListener that will stop receiving notification when a space suspend type changes (SuspendType)