Package com.opencloud.slee.resources.sis.script.in.interceptors

Class OperationInvoke

java.lang.Object

com.opencloud.slee.resources.sis.script.in.interceptors.Operation

com.opencloud.slee.resources.sis.script.in.interceptors.OperationInvoke

public final class OperationInvoke
extends Operation

An operation invoke request sent or received by an interceptor extension component.

Nested Class Summary

Nested classes/interfaces inherited from class com.opencloud.slee.resources.sis.script.in.interceptors.Operation

Operation.Type

Constructor Summary

Constructors

Constructor	Description
OperationInvoke(OperationInvokeEvent replacing, TcapOperation op, Object arg)	Create a new operation representing an invoke request that replaces an existing invoke request.
OperationInvoke(OperationInvokeEvent replacing, TcapOperation op, Object arg, long timeout)	Create a new operation representing an invoke request that replaces an existing invoke request.
OperationInvoke(OperationInvokeEvent replacing, Object arg)	Create a new operation representing an invoke request that replaces an existing invoke request of the same type.
OperationInvoke(OperationInvokeEvent replacing, Object arg, long timeout)	Create a new operation representing an invoke request that replaces an existing invoke request of the same type.
OperationInvoke(TcapOperation op, boolean hasInvokeID, int invokeID, Object arg, boolean hasLinkedID, int linkedID)	Create a new operation representing an invoke request.
OperationInvoke(TcapOperation op, boolean hasInvokeID, int invokeID, Object arg, boolean hasLinkedID, int linkedID, long timeout)	Create a new operation representing an invoke request.
OperationInvoke(OperationInvoke replacing, TcapOperation op, Object arg)	Create a new operation representing an invoke request that replaces an existing invoke request.
OperationInvoke(OperationInvoke replacing, Object arg)	Create a new operation representing an invoke request that replaces an existing invoke request of the same type.

Method Summary

Modifier and Type	Method	Description
Object	getArgument()	Get the operation argument.
long	getInvokeTimeout()	Get the invoke timeout, if available.
int	getLinkedID()	Get the linked ID.
String	getName()	Get a descriptive name for this operation.
Operation.Type	getType()	Get the type of operation.
boolean	hasInvokeID()	Determine if the operation has an invoke ID.
boolean	hasLinkedID()	Determine if the operation has a linked ID.
String	toString()

Methods inherited from class com.opencloud.slee.resources.sis.script.in.interceptors.Operation

getInvokeID, getOperation

Methods inherited from class java.lang.Object

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

Constructor Detail

OperationInvoke

public OperationInvoke(TcapOperation op,
                       boolean hasInvokeID,
                       int invokeID,
                       Object arg,
                       boolean hasLinkedID,
                       int linkedID)

Create a new operation representing an invoke request.

Parameters:

op - operation metadata object that identifies the operation.

hasInvokeID - boolean flag indicating if an invoke ID is present. Invoke IDs are always present for operations sent to the interceptor extension components. An interceptor extension component that generates operations as output can choose whether or not to specify an invoke ID. If an invoke ID is not specified, the SIS will choose one.

invokeID - the invoke ID for the operation.

arg - the operation argument, or null if there is no argument.

hasLinkedID - boolean flag indicating if a linked ID is present.

linkedID - the linked ID, ignored unless hasLinkedID is true.

OperationInvoke

public OperationInvoke(TcapOperation op,
                       boolean hasInvokeID,
                       int invokeID,
                       Object arg,
                       boolean hasLinkedID,
                       int linkedID,
                       long timeout)

Create a new operation representing an invoke request.

Parameters:

op - operation metadata object that identifies the operation.

hasInvokeID - boolean flag indicating if an invoke ID is present. Invoke IDs are always present for operations sent to the interceptor extension components. An interceptor extension component that generates operations as output can choose whether or not to specify an invoke ID. If an invoke ID is not specified, the SIS will choose one.

invokeID - the invoke ID for the operation.

arg - the operation argument, or null if there is no argument.

hasLinkedID - boolean flag indicating if a linked ID is present.

linkedID - the linked ID, ignored unless hasLinkedID is true.

timeout - the invoke timeout specified for the operation.

OperationInvoke

public OperationInvoke(OperationInvokeEvent replacing,
                       TcapOperation op,
                       Object arg)

Create a new operation representing an invoke request that replaces an existing invoke request. The new operation will inherit the invoke ID and linked ID parameters of the invoke it is replacing.

Parameters:

replacing - the operation invoke event that the new invoke is to replace.

op - operation metadata object that identifies the invoke operation.

arg - the new invoke argument, or null if there is no argument.

OperationInvoke

public OperationInvoke(OperationInvokeEvent replacing,
                       TcapOperation op,
                       Object arg,
                       long timeout)

Create a new operation representing an invoke request that replaces an existing invoke request. The new operation will inherit the invoke ID and linked ID parameters of the invoke it is replacing.

Parameters:

replacing - the operation invoke event that the new invoke is to replace.

op - operation metadata object that identifies the invoke operation.

arg - the new invoke argument, or null if there is no argument.

timeout - the invoke timeout specified for the operation.

OperationInvoke

public OperationInvoke(OperationInvokeEvent replacing,
                       Object arg)

Create a new operation representing an invoke request that replaces an existing invoke request of the same type. This method effectively just replaces the existing operation's argument. The new operation will inherit the operation type, invoke ID, and linked ID parameters of the invoke it is replacing.

Parameters:

replacing - the operation invoke event that the new invoke is to replace.

arg - the new invoke argument, or null if there is no argument.

OperationInvoke

public OperationInvoke(OperationInvokeEvent replacing,
                       Object arg,
                       long timeout)

Create a new operation representing an invoke request that replaces an existing invoke request of the same type. This method effectively just replaces the existing operation's argument. The new operation will inherit the operation type, invoke ID, and linked ID parameters of the invoke it is replacing.

Parameters:

replacing - the operation invoke event that the new invoke is to replace.

arg - the new invoke argument, or null if there is no argument.

timeout - the invoke timeout specified for the operation.

OperationInvoke

public OperationInvoke(OperationInvoke replacing,
                       TcapOperation op,
                       Object arg)

Create a new operation representing an invoke request that replaces an existing invoke request. The new operation will inherit the invoke ID, linked ID, and invoke timeout parameters of the invoke it is replacing.

Parameters:

replacing - the operation invoke that the new invoke is to replace.

op - operation metadata object that identifies the invoke operation.

arg - the new invoke argument, or null if there is no argument.

OperationInvoke

public OperationInvoke(OperationInvoke replacing,
                       Object arg)

Create a new operation representing an invoke request that replaces an existing invoke request of the same type. This method effectively just replaces the existing operation's argument. The new operation will inherit the operation type, invoke ID, linked ID, and invoke timeout parameters of the invoke it is replacing.

Parameters:

replacing - the operation invoke that the new invoke is to replace.

arg - the new invoke argument, or null if there is no argument.

Method Detail

getType

public Operation.Type getType()

Description copied from class: Operation

Get the type of operation.

Specified by:

getType in class Operation

Returns:

the type of operation.

getArgument

public Object getArgument()

Get the operation argument.

Returns:

the operation argument, or null if there is no argument.

hasInvokeID

public boolean hasInvokeID()

Determine if the operation has an invoke ID.

Returns:

true if an invoke ID is present, false otherwise.

hasLinkedID

public boolean hasLinkedID()

Determine if the operation has a linked ID.

Returns:

true if a linked ID is present, false otherwise.

getLinkedID

public int getLinkedID()

Get the linked ID.

Returns:

the linked ID. Only valid if hasLinkedID returns true.

getInvokeTimeout

public long getInvokeTimeout()

Get the invoke timeout, if available. The invoke timeout is only present when running an output interceptor.

Returns:

the invoke timeout, measured in milliseconds.

getName

public String getName()

Description copied from class: Operation

Get a descriptive name for this operation.

Specified by:

getName in class Operation

Returns:

a name.

toString

public String toString()

Overrides:

toString in class Object