Package org.eclipse.persistence.sessions.coordination

Class Command

java.lang.Object
org.eclipse.persistence.sessions.coordination.Command
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
MergeChangeSetCommand
public abstract class Command extends Object implements Serializable

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

See Also:
Author:
Steven Vo

  • Constructor Summary

    Constructors
    Constructor
    Description
    Command()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    abstract void
    executeWithSession(org.eclipse.persistence.internal.sessions.AbstractSession session)
    INTERNAL: If the CommandProcessor is a EclipseLink session then this method will get executed.
    ServiceId
    getServiceId()
    PUBLIC: Return the service identifier of the service where the command originated
    boolean
    isInternalCommand()
    INTERNAL: Determine whether this command is public or internal to EclipseLink.
    void
    setServiceId(ServiceId newServiceId)
    ADVANCED: Set the service identifier of the service where the command originated

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • Command

      public Command()

  • Method Details

    • executeWithSession

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

    • getServiceId

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

    • setServiceId

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

    • isInternalCommand

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