CommandExecutor (Coherence Incubator Command Pattern 11.3.3 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.oracle.coherence.patterns.command.internal
Class CommandExecutor

java.lang.Object
  com.oracle.coherence.patterns.command.internal.CommandExecutor

All Implemented Interfaces:: CommandExecutorMBean

public class CommandExecutor
extends Object
implements CommandExecutorMBean
extends Object
implements CommandExecutorMBean

An CommandExecutor is responsible for coordinating and executing Commands (represented as CommandExecutionRequests) for a single Context.

Included in this responsibility is the recovery and potential re-execution of CommandExecutionRequests (in-the-originally-submitted-order). Such recovery may be due to Coherence load-balancing or recovering cache partitions.

Internally CommandExecutors operate as a FiniteStateMachine (see CommandExecutor.State for details on states).

CommandExecutors state transitions are driven by 'events' raised by the ContextBackingMapListener or through requests made by the SubmitCommandExecutionRequestProcessor.

All CommandExecutors are monitorable through JMX. They are automatically registered and de-registered when they created and stopped (respectively).

Copyright (c) 2008-2016. All Rights Reserved. Oracle Corporation.
Oracle is a registered trademark of Oracle Corporation and/or its affiliates.

Author:: Brian Oliver, Simon Bisson
See Also:: CommandExecutionRequest, CommandSubmitter, CommandExecutorMBean, SubmitCommandExecutionRequestProcessor

Nested Class Summary
`static class`	`CommandExecutor.CommandExecutorEvent` The types of events the `CommandExecutor` `FiniteStateMachine` will accept.
`static class`	`CommandExecutor.State` The set of possible `CommandExecutor.State`s for a `CommandExecutor`.

Constructor Summary
`CommandExecutor(Identifier ctxIdentifier, com.tangosol.net.PartitionedService svcPartition, ScheduledExecutorService executorService)` Internal Constructor.

Method Summary
`SubmissionOutcome`	`acceptCommandExecutionRequest(CommandExecutionRequest commandExecutionRequest, com.tangosol.net.BackingMapManagerContext ctxBackingMapManagerContext)` Accepts the specified `CommandExecutionRequest` for execution by this `CommandExecutor`.
`Identifier`	`getContextIdentifier()` Returns the `Identifier` of the `Context` for which this `CommandExecutor` is coordinating `CommandExecutionRequest` execution.
`String`	`getContextIdentity()` Returns the `Context` `Identifier` as a string.
`long`	`getContextVersion()` Returns the version number of the `Context` that the `CommandExecutor` is managing.
`double`	`getLocalAverageCommandExecutionDuration()` Returns the average execution time (in milliseconds) for the `Command`s executed locally by the current owner of the `Context` (ie: local `CommandExecutor`).
`double`	`getLocalCommandExecutionServiceDuration()` Returns the local command execution service duration (in milliseconds).
`long`	`getLocalCommandsExecuted()` Returns the number of `Command`s that have been executed locally by the current owner of the `Context` (ie: local `CommandExecutor`).
`long`	`getLocalCommandsSubmitted()` Returns the number of `Command`s that have been submitted locally to the current owner of the `Context` (ie: local `CommandExecutor`).
`double`	`getLocalLastCommandExecutionDuration()` Returns the execution time (in milliseconds) for the last `Command` executed locally by the current owner of the `Context` (ie: the local `CommandExecutor`)
`double`	`getLocalMaximumCommandExecutionDuration()` Returns the maximum time (in milliseconds) that a `Command` has taken to execute locally by the current owner of the `Context` (ie: the local `CommandExecutor`)
`double`	`getLocalMinimumCommandExecutionDuration()` Returns the minimum time (in milliseconds) that a `Command` has taken to execute locally by the current owner of the `Context` (ie: the local `CommandExecutor`)
`String`	`getMBeanName()` Returns the cluster-wide uniquely generated JMX bean name for the `CommandExecutor`.
`CommandExecutor.State`	`getState()` Obtains the current `CommandExecutor.State` of the `CommandExecutor`.
`String`	`getStatus()` Returns the current `CommandExecutor.State` of the `CommandExecutor`.
`long`	`getTicketIssuerId()` Returns the current id that is being used to issue `Ticket`s.
`long`	`getTotalCommandExecutionDuration()` Returns the total time (in milliseconds) that the `Command`s executed thus far have taken to execute.
`long`	`getTotalCommandExecutionWaitingDuration()` Returns the total time (in milliseconds) that the `Command`s executed thus far have waited to execute (ie: the queuing time).
`long`	`getTotalCommandsExecuted()` Returns the total number of `Command`s for the `Context` that have been executed (regardless of the owner)
`long`	`getTotalCommandsPendingExecution()` Returns the total number of `Command`s that are yet to be executed
`Instruction`	`onDelaying(CommandExecutor.State previousState, CommandExecutor.State newState, Event event, ExecutionContext context)` Handles when the `CommandExecutor` has to delay execution of `CommandExecutionRequest`s due to doubt of context ownership
`Instruction`	`onExecuting(CommandExecutor.State previousState, CommandExecutor.State newState, Event event, ExecutionContext context)` Executes one or more `CommandExecutionRequest`s that are currently waiting to be executed for the command context.
`Instruction`	`onScheduled(CommandExecutor.State previousState, CommandExecutor.State newState, Event event, ExecutionContext context)` Handles when the `CommandExecutor` schedules to execute `CommandExecutionRequest`s.
`Instruction`	`onStarting(CommandExecutor.State previousState, CommandExecutor.State newState, Event event, ExecutionContext context)` Starts ups, initializes, recovers and schedules the `CommandExecutor` to start processing `CommandExecutionRequest`s.
`Instruction`	`onStopping(CommandExecutor.State previousState, CommandExecutor.State newState, Event event, ExecutionContext context)` Handles the shutdown/stopping process, afterwhich no further requests will be processed.
`void`	`start()` Starts up, initializes, recovers and schedules the `CommandExecutor` to start processing `CommandExecutionRequest`s.
`void`	`stop()` Immediately stops the `CommandExecutor` from executing any further `CommandExecutionRequest`s.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

CommandExecutor

public CommandExecutor(Identifier ctxIdentifier,
                       com.tangosol.net.PartitionedService svcPartition,
                       ScheduledExecutorService executorService)

Internal Constructor. NOTE: To construct a CommandExecutor for your application, you should use a ContextsManager.

Parameters:: ctxIdentifier -

Method Detail

getContextIdentifier

public Identifier getContextIdentifier()

Returns the Identifier of the Context for which this CommandExecutor is coordinating CommandExecutionRequest execution. Context Identifiers are unique across a cluster.

getState

public CommandExecutor.State getState()

Obtains the current CommandExecutor.State of the CommandExecutor.

getMBeanName

public String getMBeanName()

Returns the cluster-wide uniquely generated JMX bean name for the CommandExecutor.