xdi2.messaging.container.interceptor.impl

Class ExecuteCommandInterceptor

java.lang.Object

xdi2.messaging.container.impl.AbstractExtension<CONTAINER>

xdi2.messaging.container.interceptor.impl.AbstractInterceptor<MessagingContainer>

xdi2.messaging.container.interceptor.impl.ExecuteCommandInterceptor

All Implemented Interfaces:

Cloneable, Extension<MessagingContainer>, Interceptor<MessagingContainer>, MessageEnvelopeInterceptor, MessageInterceptor, OperationInterceptor, Prototype<ExecuteCommandInterceptor>

public class ExecuteCommandInterceptor
extends AbstractInterceptor<MessagingContainer>
implements MessageEnvelopeInterceptor, MessageInterceptor, OperationInterceptor, Prototype<ExecuteCommandInterceptor>

This interceptor will execute a command line on an incoming message envelope, message, or operation.

Nested Class Summary

Nested classes/interfaces inherited from interface xdi2.messaging.container.Extension

Extension.InitPriorityComparator, Extension.ShutdownPriorityComparator

Nested classes/interfaces inherited from interface xdi2.messaging.container.Prototype

Prototype.PrototypingContext

Field Summary

Fields inherited from class xdi2.messaging.container.impl.AbstractExtension

DEFAULT_INIT_PRIORITY, DEFAULT_SHUTDOWN_PRIORITY

Constructor Summary

Constructors

Constructor and Description
ExecuteCommandInterceptor()

Method Summary

Modifier and Type	Method and Description
InterceptorResult	after(MessageEnvelope messageEnvelope, ExecutionContext executionContext, ExecutionResult executionResult) Run after a message envelope is executed.
InterceptorResult	after(Message message, ExecutionContext executionContext, ExecutionResult executionResult) Run after a message is executed.
InterceptorResult	after(Operation operation, Graph operationResultGraph, ExecutionContext executionContext) Run after an operation is executed.
InterceptorResult	before(MessageEnvelope messageEnvelope, ExecutionContext executionContext, ExecutionResult executionResult) Run before a message envelope is executed.
InterceptorResult	before(Message message, ExecutionContext executionContext, ExecutionResult executionResult) Run before a message is executed.
InterceptorResult	before(Operation operation, Graph operationResultGraph, ExecutionContext executionContext) Run before an operation is executed.
void	exception(MessageEnvelope messageEnvelope, ExecutionContext executionContext, ExecutionResult executionResult, Exception ex) Run if an exception occurs while a message envelope is executed.
String	getCommandLine()
ExecuteCommandInterceptor	instanceFor(Prototype.PrototypingContext prototypingContext)
boolean	isEnableMessage()
boolean	isEnableMessageEnvelope()
boolean	isEnableOperation()
boolean	isWaitFor()
void	setCommandLine(String commandLine)
void	setEnableMessage(boolean enableMessage)
void	setEnableMessageEnvelope(boolean enableMessageEnvelope)
void	setEnableOperation(boolean enableOperation)
void	setWaitFor(boolean waitFor)

Methods inherited from class xdi2.messaging.container.impl.AbstractExtension

clearDisabled, clearDisabledForMessage, clearDisabledForMessageEnvelope, clearDisabledForOperation, getInitPriority, getShutdownPriority, init, setDisabled, setDisabledForMessage, setDisabledForMessageEnvelope, setDisabledForOperation, shutdown, skip

Methods inherited from class java.lang.Object

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

Methods inherited from interface xdi2.messaging.container.Extension

clearDisabled, clearDisabledForMessage, clearDisabledForMessageEnvelope, clearDisabledForOperation, getInitPriority, getShutdownPriority, init, setDisabled, setDisabledForMessage, setDisabledForMessageEnvelope, setDisabledForOperation, shutdown, skip

Constructor Detail

ExecuteCommandInterceptor

public ExecuteCommandInterceptor()

Method Detail

instanceFor

public ExecuteCommandInterceptor instanceFor(Prototype.PrototypingContext prototypingContext)
                                      throws Xdi2MessagingException

Specified by:

instanceFor in interface Prototype<ExecuteCommandInterceptor>

Throws:

Xdi2MessagingException

before

public InterceptorResult before(MessageEnvelope messageEnvelope,
                                ExecutionContext executionContext,
                                ExecutionResult executionResult)
                         throws Xdi2MessagingException

Description copied from interface: MessageEnvelopeInterceptor

Run before a message envelope is executed.

Specified by:

before in interface MessageEnvelopeInterceptor

Parameters:

messageEnvelope - The message envelope to process.

executionContext - The current execution context.

executionResult - The executionResult.

Returns:

Interceptor result that specifies how the operation should be further processed.

Throws:

Xdi2MessagingException

after

public InterceptorResult after(MessageEnvelope messageEnvelope,
                               ExecutionContext executionContext,
                               ExecutionResult executionResult)
                        throws Xdi2MessagingException

Description copied from interface: MessageEnvelopeInterceptor

Run after a message envelope is executed.

Specified by:

after in interface MessageEnvelopeInterceptor

Parameters:

messageEnvelope - The message envelope to process.

executionContext - The current execution context.

executionResult - The executionResult.

Returns:

Interceptor result that specifies how the operation should be further processed.

Throws:

Xdi2MessagingException

exception

public void exception(MessageEnvelope messageEnvelope,
                      ExecutionContext executionContext,
                      ExecutionResult executionResult,
                      Exception ex)

Description copied from interface: MessageEnvelopeInterceptor

Run if an exception occurs while a message envelope is executed.

Specified by:

exception in interface MessageEnvelopeInterceptor

executionContext - The current execution context.

executionResult - The executionResult.

ex - The exception that occurred.

before

public InterceptorResult before(Message message,
                                ExecutionContext executionContext,
                                ExecutionResult executionResult)
                         throws Xdi2MessagingException

Description copied from interface: MessageInterceptor

Run before a message is executed.

Specified by:

before in interface MessageInterceptor

Parameters:

message - The message to process.

executionContext - The current execution context.

executionResult - The execution result.

Returns:

Interceptor result that specifies how the operation should be further processed.

Throws:

Xdi2MessagingException

after

public InterceptorResult after(Message message,
                               ExecutionContext executionContext,
                               ExecutionResult executionResult)
                        throws Xdi2MessagingException

Description copied from interface: MessageInterceptor

Run after a message is executed.

Specified by:

after in interface MessageInterceptor

Parameters:

message - The message to process.

executionContext - The current execution context.

executionResult - The execution result.

Returns:

Interceptor result that specifies how the operation should be further processed.

Throws:

Xdi2MessagingException

before

public InterceptorResult before(Operation operation,
                                Graph operationResultGraph,
                                ExecutionContext executionContext)
                         throws Xdi2MessagingException

Description copied from interface: OperationInterceptor

Run before an operation is executed.

Specified by:

before in interface OperationInterceptor

Parameters:

operation - The operation to process.

operationResultGraph - The operation's message result.

executionContext - The current execution context.

Returns:

Interceptor result that specifies how the operation should be further processed.

Throws:

Xdi2MessagingException

after

public InterceptorResult after(Operation operation,
                               Graph operationResultGraph,
                               ExecutionContext executionContext)
                        throws Xdi2MessagingException

Description copied from interface: OperationInterceptor

Run after an operation is executed.

Specified by:

after in interface OperationInterceptor

Parameters:

operation - The operation to process.

operationResultGraph - The operation's message result.

executionContext - The current execution context.

Returns:

Interceptor result that specifies how the operation should be further processed.

Throws:

Xdi2MessagingException

getCommandLine

public String getCommandLine()

setCommandLine

public void setCommandLine(String commandLine)

isEnableMessageEnvelope

public boolean isEnableMessageEnvelope()

setEnableMessageEnvelope

public void setEnableMessageEnvelope(boolean enableMessageEnvelope)

isEnableMessage

public boolean isEnableMessage()

setEnableMessage

public void setEnableMessage(boolean enableMessage)

isEnableOperation

public boolean isEnableOperation()

setEnableOperation

public void setEnableOperation(boolean enableOperation)

isWaitFor

public boolean isWaitFor()

setWaitFor

public void setWaitFor(boolean waitFor)