oracle.toplink.remotecommand
Class RemoteCommandManager

java.lang.Object
  oracle.toplink.remotecommand.RemoteCommandManager

All Implemented Interfaces:

CommandManager

public class RemoteCommandManager
extends java.lang.Object
implements CommandManager

Purpose: Provide a CommandManager implementation that will be used by both TopLink and non-TopLink applications.

Description: A RemoteCommandManager (or RCM) instance is the primary component of an RCM service instance. It manages the other components of the service, and directs the overall service operation. Its ServiceId uniquely distinguishes it from other service instances in the cluster.

Each RCM has a logical channel to which it subscribes and publishes. This channel determines which other instances in the cluster the service instance sends and receives remote commands to/from. All RCM's on the same channel should have the same discovery manager settings (be communicating on the same multicast) so that the discovery managers may be able to discover one another. RCM's on different channels may operate on the same or on different multicast groups.

An RCM instance knows about other instances in the cluster through its DiscoveryManager. Its TransportManager is repsonsible for setting up the connections to other instances once they are discovered.

An RCM is instructed to "propagate", or execute on all remote service instances in the cluster that subscribe to the same channel, a remote command by its CommandProcessor. Likewise, when an RCM receives a remote command to be executed then it passes the command off to the CommandProcessor for the processing of the command to occur. CommandProcessors pass commands to the RCM as an Object (in a format that may be specific to the application) and the RCM uses its CommandConverter to convert it to a TopLink Command object before sending the Command off to the cluster. Similarly, when a TopLink Command object is received then the RCM invokes its CommandConverter to convert the object into the application format that will be passed to the CommandProcessor to process the command.

Since:

OracleAS TopLink 10g (9.0.4)

See Also:

CommandManager, Command, CommandProcessor, CommandConverter, CommandTransporter, DiscoveryManager

Field Summary

static boolean	DEFAULT_ASYNCHRONOUS_MODE
static java.lang.String	DEFAULT_CHANNEL

Constructor Summary

RemoteCommandManager(CommandProcessor commandProcessor)

RemoteCommandManager(CommandProcessor commandProcessor, TransportManager transportManager)

Method Summary

java.lang.String	getChannel() Return the service channel for this command manager.
CommandConverter	getCommandConverter() Return the converter instance used to convert between TopLink Command objects and an application command format.
CommandProcessor	getCommandProcessor() Return the command processor that processes commands received from the cluster.
DiscoveryManager	getDiscoveryManager() Return the discovery manager that detects the arrival of new cluster members
TransportManager	getTransportManager() Return the transport manager that manages sending and receiving of remote commands.
java.lang.String	getUrl() Return the URL for this command manager.
void	initialize() Initialize the remote command manager.
boolean	isStopped() Indicates whether the RCM has been stopped: either initialize hasn't been called or shutdown has been called.
void	logDebugWithoutLevelCheck(java.lang.String message, java.lang.Object[] args)
void	logError(java.lang.String message, java.lang.Object[] args)
void	logInfo(java.lang.String message, java.lang.Object[] args)
void	logWarning(java.lang.String message, java.lang.Object[] args)
void	logWarningWithoutLevelCheck(java.lang.String message, java.lang.Object[] args)
void	propagateCommand(java.lang.Object command) ADVANCED: Propagate a remote command to all remote RCM services participating in the TopLink cluster.
void	replaceLocalHostIPAddress(java.lang.String ipAddress) ADVANCED: Allow user to replace the $HOST subString of the local host URL with the user user input at runtime.
void	replaceTransportPortNumber(java.lang.String portNumber) ADVANCED: Allow user to replace the $PORT subString of the local host URL with the user user input at runtime.
void	setChannel(java.lang.String channel) ADVANCED: Set the service channel for this command manager.
void	setCommandConverter(CommandConverter newCommandConverter) ADVANCED: Set the converter instance that will be invoked by this CommandProcessor to convert commands from their application command format into TopLink Command objects before being propagated to remote command manager services.
void	setCommandProcessor(CommandProcessor newCommandProcessor) ADVANCED: Set the command processor that will be invoked to process commands.
void	setDiscoveryManager(DiscoveryManager mgr) Deprecated. overwrite TransportManager.createDiscovery() method if special DiscoveryManager is needed.
void	setServerPlatform(ServerPlatform theServerPlatform) The ServerPlatform must be set manually when the RemoteCommandManager'CommandProcessor is not TopLink Session.
void	setShouldPropagateAsynchronously(boolean asyncMode) ADVANCED: Set whether this command manager should propagate commands synchronously or asynchronously.
void	setShouldRemoveConnectionOnError(boolean shouldRemoveConnectionOnError) Deprecated.
void	setTransportManager(TransportManager newTransportManager) ADVANCED: Set a specific transport manager to manage sending and receiving of remote commands.
void	setUrl(java.lang.String url) ADVANCED: Set the URL for this command manager.
boolean	shouldLogDebugMessage()
boolean	shouldLogWarningMessage()
boolean	shouldPropagateAsynchronously() Return whether this command manager should propagate commands synchronously or asynchronously.
boolean	shouldRemoveConnectionOnError() Deprecated.
void	shutdown() Shut down the remote command manager.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CHANNEL

public static final java.lang.String DEFAULT_CHANNEL

See Also:

Constant Field Values

DEFAULT_ASYNCHRONOUS_MODE

public static final boolean DEFAULT_ASYNCHRONOUS_MODE

See Also:

Constant Field Values

Constructor Detail

RemoteCommandManager

public RemoteCommandManager(CommandProcessor commandProcessor)

RemoteCommandManager

public RemoteCommandManager(CommandProcessor commandProcessor,
                            TransportManager transportManager)

Method Detail

initialize

public void initialize()

Initialize the remote command manager. This will also trigger the DiscoveryManager to start establishing the TopLink cluster.

Specified by:

initialize in interface CommandManager

isStopped

public boolean isStopped()

Indicates whether the RCM has been stopped: either initialize hasn't been called or shutdown has been called.

shutdown

public void shutdown()

Shut down the remote command manager. This will also trigger the DiscoveryManager to stop. NOTE: Although this call initiates the shutdown process, no guarantees are made as to when it will actually complete.

Specified by:

shutdown in interface CommandManager

propagateCommand

public void propagateCommand(java.lang.Object command)

ADVANCED: Propagate a remote command to all remote RCM services participating in the TopLink cluster.

Specified by:

propagateCommand in interface CommandManager

Parameters:

command - An object representing a TopLink command

getCommandProcessor

public CommandProcessor getCommandProcessor()

Description copied from interface: oracle.toplink.remotecommand.CommandManager

Return the command processor that processes commands received from the cluster.

Specified by:

getCommandProcessor in interface CommandManager

Returns:

An implementation instance of CommandProcessor

setCommandProcessor

public void setCommandProcessor(CommandProcessor newCommandProcessor)

Description copied from interface: oracle.toplink.remotecommand.CommandManager

ADVANCED: Set the command processor that will be invoked to process commands. Non-TopLink applications can implement this interface in order to receive remote commands from a TopLink cluster.

Specified by:

setCommandProcessor in interface CommandManager

Parameters:

newCommandProcessor - The intended processor of remote commands

getTransportManager

public TransportManager getTransportManager()

Description copied from interface: oracle.toplink.remotecommand.CommandManager

Return the transport manager that manages sending and receiving of remote commands.

Specified by:

getTransportManager in interface CommandManager

Returns:

The TransportManager instance being used by this CommandManager

setTransportManager

public void setTransportManager(TransportManager newTransportManager)

Description copied from interface: oracle.toplink.remotecommand.CommandManager

ADVANCED: Set a specific transport manager to manage sending and receiving of remote commands.

Specified by:

setTransportManager in interface CommandManager

Parameters:

newTransportManager - An instance of the desired transport manager type

getDiscoveryManager

public DiscoveryManager getDiscoveryManager()

Return the discovery manager that detects the arrival of new cluster members

Specified by:

getDiscoveryManager in interface CommandManager

Returns:

The DiscoveryManager instance being used by this CommandManager

setDiscoveryManager

public void setDiscoveryManager(DiscoveryManager mgr)

Deprecated. overwrite TransportManager.createDiscovery() method if special DiscoveryManager is needed.

ADVANCED: Set the discovery manager that detects the arrival of new cluster members. Note: This should only be used in rare cases or special customized systems. Under normal circumstances the discovery manager should not need to be set.

getCommandConverter

public CommandConverter getCommandConverter()

Return the converter instance used to convert between TopLink Command objects and an application command format.

Specified by:

getCommandConverter in interface CommandManager

Returns:

The converter being used by this CommandManager

setCommandConverter

public void setCommandConverter(CommandConverter newCommandConverter)

ADVANCED: Set the converter instance that will be invoked by this CommandProcessor to convert commands from their application command format into TopLink Command objects before being propagated to remote command manager services. The converter will also be invoked to convert TopLink Command objects into application format before being sent to the CommandProcessor for execution.

Specified by:

setCommandConverter in interface CommandManager

Parameters:

newCommandConverter - The converter to be used by this CommandManager

shouldLogDebugMessage

public boolean shouldLogDebugMessage()

shouldLogWarningMessage

public boolean shouldLogWarningMessage()

logDebugWithoutLevelCheck

public void logDebugWithoutLevelCheck(java.lang.String message,
                                      java.lang.Object[] args)

logInfo

public void logInfo(java.lang.String message,
                    java.lang.Object[] args)

logWarning

public void logWarning(java.lang.String message,
                       java.lang.Object[] args)

logWarningWithoutLevelCheck

public void logWarningWithoutLevelCheck(java.lang.String message,
                                        java.lang.Object[] args)

logError

public void logError(java.lang.String message,
                     java.lang.Object[] args)

getChannel

public java.lang.String getChannel()

Return the service channel for this command manager. All command managers with the same service channel will send and receive commands from each other. Commands sent on other service channels will not be exchanged with this command manager.

Specified by:

getChannel in interface CommandManager

Returns:

The service channel String subscribed to by this CommandManager

setChannel

public void setChannel(java.lang.String channel)

ADVANCED: Set the service channel for this command manager. All command managers with the same service channel will send and receive commands from each other. Commands sent on other service channels will not be exchanged with this command manager.

Specified by:

setChannel in interface CommandManager

Parameters:

channel - The service channel subscribed to by this CommandManager

getUrl

public java.lang.String getUrl()

Return the URL for this command manager.

Specified by:

getUrl in interface CommandManager

Returns:

The URL String for this CommandManager

setUrl

public void setUrl(java.lang.String url)

ADVANCED: Set the URL for this command manager.

Specified by:

setUrl in interface CommandManager

Parameters:

url - The URL String for this CommandManager

shouldPropagateAsynchronously

public boolean shouldPropagateAsynchronously()

Return whether this command manager should propagate commands synchronously or asynchronously. If set to synchronous propagation then propagateCommand() will not return to the caller until the command has been executed on all of the services in the cluster. In asynchronous mode the command manager will create a separate thread for each of the remote service executions, and then promptly return to the caller.

Specified by:

shouldPropagateAsynchronously in interface CommandManager

setShouldPropagateAsynchronously

public void setShouldPropagateAsynchronously(boolean asyncMode)

ADVANCED: Set whether this command manager should propagate commands synchronously or asynchronously. If set to synchronous propagation then propagateCommand() will not return to the caller until the command has been executed on all of the services in the cluster. In asynchronous mode the command manager will create a separate thread for each of the remote service executions, and then promptly return to the caller.

Specified by:

setShouldPropagateAsynchronously in interface CommandManager

setShouldRemoveConnectionOnError

public void setShouldRemoveConnectionOnError(boolean shouldRemoveConnectionOnError)

Deprecated.

OBSOLETE: Set whether connections to remote services should be disconnected when an error occurs.

Specified by:

setShouldRemoveConnectionOnError in interface CommandManager

See Also:

#TransportManager.setShouldRemoveConnectionOnError(boolean shouldRemoveConnectionOnError)

shouldRemoveConnectionOnError

public boolean shouldRemoveConnectionOnError()

Deprecated.

OBSOLETE: Return whether connections to remote services should be disconnected when an error occurs.

Specified by:

shouldRemoveConnectionOnError in interface CommandManager

See Also:

#TransportManager.shouldRemoveConnectionOnError()

replaceLocalHostIPAddress

public void replaceLocalHostIPAddress(java.lang.String ipAddress)

ADVANCED: Allow user to replace the $HOST subString of the local host URL with the user user input at runtime. By default, TopLink will try to discovery the local host IP and may fail due to security or network restrictions. In this case, user can call this API to specify the IP address or host name during pre-login session event or before session login. Example: If input is 145.23.127.79, the local host URL of ormi://$HOST:2971:/app_name will become ormi://145.23.127.79:2971:/app_name

replaceTransportPortNumber

public void replaceTransportPortNumber(java.lang.String portNumber)

ADVANCED: Allow user to replace the $PORT subString of the local host URL with the user user input at runtime. In this case, user can call this API to specify the port number for a specific transport during pre-login session event or before session login. Example: If input is 7799, the local host URL of ormi://145.23.127.79:$PORT/app_name will become ormi://145.23.127.79:7799/app_name

setServerPlatform

public void setServerPlatform(ServerPlatform theServerPlatform)

The ServerPlatform must be set manually when the RemoteCommandManager'CommandProcessor is not TopLink Session. When the CommandProcessor is a TopLink Session, the ServerPlatform is automatically gotten from the Session.