public abstract Class Command

Class Inheritance

extends Object
implements Serializable

java.lang.Object
org.eclipse.persistence.sessions.coordination.Command

All Implemented Interfaces

java.io.Serializable

Known Direct Subclasses

org.eclipse.persistence.sessions.coordination.MergeChangeSetCommand, org.eclipse.persistence.internal.sessions.coordination.MetadataRefreshCommand, org.eclipse.persistence.internal.sessions.coordination.RCMCommand

Imports

org.eclipse.persistence.internal.sessions.AbstractSession

Purpose: Provide an extendable framework class for a Command object that can be remotely executed.

Description: Is the root command class from which all other remotely executable commands must extend. A Command is invoked by calling propagateCommand() on a local CommandManager, and is executed on each remote service by each remote CommandManager invoking processCommand() on its local

Author: Steven Vo
Since: OracleAS TopLink 10g (9.0.4)
See Also: CommandManager, CommandProcessor

Field Summary

Modifier and Type	Field and Description
pack-priv ServiceId	serviceId The unique calling card of the service that initiated the command

Constructor Summary

Access	Constructor and Description
protected	Command() Default constructor.

Method Summary

Modifier and Type	Method and Description
public abstract void	executeWithSession(AbstractSession The session that can be used to execute the command on. session) INTERNAL: If the CommandProcessor is a EclipseLink session then this method will get executed.
public ServiceId	Returns: The unique identifier of the sending RCM service getServiceId() PUBLIC: Return the service identifier of the service where the command originated
public boolean	isInternalCommand() INTERNAL: Determine whether this command is public or internal to EclipseLink.
public void	setServiceId(ServiceId The unique identifier of the sending RCM service newServiceId) ADVANCED: Set the service identifier of the service where the command originated

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

serviceId	back to summary
pack-priv ServiceId serviceId The unique calling card of the service that initiated the command

Constructor Detail

Command	back to summary
protected Command() Default constructor.

Method Detail

executeWithSession	back to summary
public abstract void executeWithSession(AbstractSession session) INTERNAL: If the CommandProcessor is a EclipseLink session then this method will get executed. Parameters session:AbstractSession The session that can be used to execute the command on.

executeWithSession

back to summary

public abstract void executeWithSession(AbstractSession session)

INTERNAL: If the CommandProcessor is a EclipseLink session then this method will get executed.

Parameters

session:AbstractSession: The session that can be used to execute the command on.

getServiceId	back to summary
public ServiceId getServiceId() PUBLIC: Return the service identifier of the service where the command originated Returns:ServiceId The unique identifier of the sending RCM service

getServiceId

back to summary

public ServiceId getServiceId()

PUBLIC: Return the service identifier of the service where the command originated

Returns:ServiceId: The unique identifier of the sending RCM service

isInternalCommand	back to summary
public boolean isInternalCommand() INTERNAL: Determine whether this command is public or internal to EclipseLink. User commands must return false.

setServiceId	back to summary
public void setServiceId(ServiceId newServiceId) ADVANCED: Set the service identifier of the service where the command originated Parameters newServiceId:ServiceId The unique identifier of the sending RCM service

setServiceId

back to summary

public void setServiceId(ServiceId newServiceId)

ADVANCED: Set the service identifier of the service where the command originated

Parameters

newServiceId:ServiceId: The unique identifier of the sending RCM service