com.sun.jbi.messaging

Class MessageExchangeProxy

java.lang.Object

com.sun.jbi.messaging.MessageExchangeProxy

All Implemented Interfaces:

MessageExchange

Direct Known Subclasses:

InOnlyImpl, InOptionalOutImpl, InOutImpl, Observer, RobustInOnlyImpl

public abstract class MessageExchangeProxy
extends Object
implements MessageExchange

This abstract class is used as the base for a MessageExchange reference given to a Binding or Engine. The binding and engine are given different instances, because the states naviagated during execution are different. Each instance also tracks its twin. It's mostly just a proxy to the underlying MessageExchangeImpl. The proxy tracks the status of the reference to determine which operations are legal at any point in time. Legal operations are forwarded to the underlying MessageExchangeImpl. Each subclass is expected to specify a state machine that will be used by this proxy to sequence the actions. The state machine is very simple. There are only 4 actions: SEND, ACCEPT, SET_STATUS, SET_FAULT. Along with each state there is a set (implemented as a bit-mask) of operations that are legal in the current state. The structure is represented as a simple [][]. The first dimension is the array of states, the second dimension contains the valid set, followed by the next array index for each action. An index of -1 means an illegal request (the code in here should only request legal transisions.) Each subclass implements 2 state machines, one for the SOURCE side and one for the TARGET side of a message exchange.

Author:

Sun Microsystems, Inc.

Nested Class Summary

Nested classes/interfaces inherited from interface javax.jbi.messaging.MessageExchange

MessageExchange.Role

Field Summary

Fields

Modifier and Type	Field and Description
static int	ACTION_ACCEPT Column 3: Action ACCEPT
static int	ACTION_FAULT Column 5: Action FAULT
static int	ACTION_MASK Column 1: Legal operation MASK.
static int	ACTION_SEND Column 2: Action SEND
static int	ACTION_STATUS Column 4: Action STATUS
static int	ADDRESS Category of actions used to address a message exchange: SET_SERVICE, SET_OPERATION, SET_ENDPOINT, SET_INTERFACE
static int	CHECK_STATUS_OR_FAULT Hint check STATUS or FAULT
static int	COMPLETE Hint COMPLETE
static int	CREATE_FAULT Allowed to create fault.
static int	DO_ACCEPT Allowed to ACCEPT
static int	DO_SEND Allowed to SEND
static int	DO_SENDSYNCH Allowed to SENDSYNCH.
static int	MARK_ACTIVE Hint ACTIVE
static int	MARK_DONE Hint DONE
static int	REQUEST Hint is a REQUEST.
static int	RESUME_TX Hint RESUME_TX
static int	SET_DONE Allowed to set done status.
static int	SET_ERROR Allowed to set error status.
static int	SET_FAULT Allowed to set fault.
static int	SET_IN Allowed to set IN message
static int	SET_OUT Allowed to set OUT message
static int	SET_PROPERTY Allowed to set property.
static int	SET_TRANSACTION Allowed to set transaction.
static int	STATUS Hint is a STATUS.
static int	SUSPEND_TX Hint SUSPEND_TX

Fields inherited from interface javax.jbi.messaging.MessageExchange

JTA_TRANSACTION_PROPERTY_NAME

Method Summary

Methods

Modifier and Type	Method and Description
boolean	checkTimeout()
Fault	createFault() Create a Fault.
NormalizedMessage	createMessage() Create a Message.
ServiceEndpoint	getActualEndpoint()
Set	getDeltaProperties()
ServiceEndpoint	getEndpoint() Get the Endpoint for this exchange.
Exception	getError() Get Exception describing the exchanges error status.
String	getExchangeId() Get ExchangeId associated with this MessageExchange.
Fault	getFault() Get the Fault message for this exchange.
QName	getInterfaceName()
NormalizedMessage	getMessage(String name) Get a NormalizedMEssage by reference.
QName	getOperation() Get the Service for this exchange.
int	getPhase()
int	getPhaseMask()
Object	getProperty(String name) Get a property.
Set	getPropertyNames()
MessageExchange.Role	getRole() Return the role to take in this exchange.
QName	getService() Get the Service for this exchange.
String	getSourceComponent()
ExchangeStatus	getStatus() Get status of this MessageExchange.
String	getTargetComponent()
boolean	isRemoteInvocation()
boolean	isTransacted() Check existence of a transaction.
void	mergeProperties()
void	setEndpoint(ServiceEndpoint endPoint) Set Endpoint for this exchange.
void	setError(Exception error) Set Exception describing reason for error status.
void	setFault(Fault fault) Set Fault message for this exchange.
void	setInterfaceName(QName interfaceName)
void	setMessage(NormalizedMessage message, String name) Set a NormalizedMessage by reference.
void	setOperation(QName operation) Set Operation for this exchange.
void	setProperty(String name, Object object) Set a property.
void	setService(QName service) Set Service for this exchange.
void	setStatus(ExchangeStatus status) Set status of this MessageExchange.
boolean	terminate() Force exchange into DONE state.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.jbi.messaging.MessageExchange

getPattern

Field Detail

SET_TRANSACTION

public static final int SET_TRANSACTION

Allowed to set transaction.

See Also:

Constant Field Values

ADDRESS

public static final int ADDRESS

Category of actions used to address a message exchange: SET_SERVICE, SET_OPERATION, SET_ENDPOINT, SET_INTERFACE

See Also:

Constant Field Values

SET_PROPERTY

public static final int SET_PROPERTY

Allowed to set property.

See Also:

Constant Field Values

SET_FAULT

public static final int SET_FAULT

Allowed to set fault.

See Also:

Constant Field Values

SET_DONE

public static final int SET_DONE

Allowed to set done status.

See Also:

Constant Field Values

SET_ERROR

public static final int SET_ERROR

Allowed to set error status.

See Also:

Constant Field Values

SET_IN

public static final int SET_IN

Allowed to set IN message

See Also:

Constant Field Values

SET_OUT

public static final int SET_OUT

Allowed to set OUT message

See Also:

Constant Field Values

CREATE_FAULT

public static final int CREATE_FAULT

Allowed to create fault.

See Also:

Constant Field Values

DO_SENDSYNCH

public static final int DO_SENDSYNCH

Allowed to SENDSYNCH.

See Also:

Constant Field Values

DO_SEND

public static final int DO_SEND

Allowed to SEND

See Also:

Constant Field Values

DO_ACCEPT

public static final int DO_ACCEPT

Allowed to ACCEPT

See Also:

Constant Field Values

SUSPEND_TX

public static final int SUSPEND_TX

Hint SUSPEND_TX

See Also:

Constant Field Values

RESUME_TX

public static final int RESUME_TX

Hint RESUME_TX

See Also:

Constant Field Values

MARK_DONE

public static final int MARK_DONE

Hint DONE

See Also:

Constant Field Values

MARK_ACTIVE

public static final int MARK_ACTIVE

Hint ACTIVE

See Also:

Constant Field Values

COMPLETE

public static final int COMPLETE

Hint COMPLETE

See Also:

Constant Field Values

CHECK_STATUS_OR_FAULT

public static final int CHECK_STATUS_OR_FAULT

Hint check STATUS or FAULT

See Also:

Constant Field Values

REQUEST

public static final int REQUEST

Hint is a REQUEST.

See Also:

Constant Field Values

STATUS

public static final int STATUS

Hint is a STATUS.

See Also:

Constant Field Values

ACTION_MASK

public static final int ACTION_MASK

Column 1: Legal operation MASK.

See Also:

Constant Field Values

ACTION_SEND

public static final int ACTION_SEND

Column 2: Action SEND

See Also:

Constant Field Values

ACTION_ACCEPT

public static final int ACTION_ACCEPT

Column 3: Action ACCEPT

See Also:

Constant Field Values

ACTION_STATUS

public static final int ACTION_STATUS

Column 4: Action STATUS

See Also:

Constant Field Values

ACTION_FAULT

public static final int ACTION_FAULT

Column 5: Action FAULT

See Also:

Constant Field Values

Method Detail

getExchangeId

public String getExchangeId()

Get ExchangeId associated with this MessageExchange.

Specified by:

getExchangeId in interface MessageExchange

getStatus

public ExchangeStatus getStatus()

Get status of this MessageExchange.

Specified by:

getStatus in interface MessageExchange

setStatus

public void setStatus(ExchangeStatus status)
               throws MessagingException

Set status of this MessageExchange.

Specified by:

setStatus in interface MessageExchange

Throws:

MessagingException

getError

public Exception getError()

Get Exception describing the exchanges error status.

Specified by:

getError in interface MessageExchange

setError

public void setError(Exception error)

Set Exception describing reason for error status.

Specified by:

setError in interface MessageExchange

getFault

public Fault getFault()

Get the Fault message for this exchange.

Specified by:

getFault in interface MessageExchange

setFault

public void setFault(Fault fault)
              throws MessagingException

Set Fault message for this exchange.

Specified by:

setFault in interface MessageExchange

Throws:

MessagingException

getEndpoint

public ServiceEndpoint getEndpoint()

Get the Endpoint for this exchange. If a service connection was used to address this exchange, that endpoint is returned to the consumer. The provider always sees the 'real' endpoint that it activated. If a service connection was not used, the provider and consumer see the same endpoint.

Specified by:

getEndpoint in interface MessageExchange

setEndpoint

public void setEndpoint(ServiceEndpoint endPoint)

Set Endpoint for this exchange.

Specified by:

setEndpoint in interface MessageExchange

getActualEndpoint

public ServiceEndpoint getActualEndpoint()

getService

public QName getService()

Get the Service for this exchange.

Specified by:

getService in interface MessageExchange

setService

public void setService(QName service)

Set Service for this exchange.

Specified by:

setService in interface MessageExchange

getOperation

public QName getOperation()

Get the Service for this exchange.

Specified by:

getOperation in interface MessageExchange

setOperation

public void setOperation(QName operation)

Set Operation for this exchange.

Specified by:

setOperation in interface MessageExchange

getInterfaceName

public QName getInterfaceName()

Specified by:

getInterfaceName in interface MessageExchange

setInterfaceName

public void setInterfaceName(QName interfaceName)

Specified by:

setInterfaceName in interface MessageExchange

getMessage

public NormalizedMessage getMessage(String name)

Get a NormalizedMEssage by reference.

Specified by:

getMessage in interface MessageExchange

setMessage

public void setMessage(NormalizedMessage message,
              String name)
                throws MessagingException

Set a NormalizedMessage by reference.

Specified by:

setMessage in interface MessageExchange

Throws:

MessagingException

getProperty

public Object getProperty(String name)

Get a property.

Specified by:

getProperty in interface MessageExchange

setProperty

public void setProperty(String name,
               Object object)

Set a property.

Specified by:

setProperty in interface MessageExchange

getPropertyNames

public Set getPropertyNames()

Specified by:

getPropertyNames in interface MessageExchange

getRole

public MessageExchange.Role getRole()

Return the role to take in this exchange.

Specified by:

getRole in interface MessageExchange

getSourceComponent

public String getSourceComponent()

getTargetComponent

public String getTargetComponent()

isTransacted

public boolean isTransacted()

Check existence of a transaction.

Specified by:

isTransacted in interface MessageExchange

createFault

public Fault createFault()
                  throws MessagingException

Create a Fault.

Specified by:

createFault in interface MessageExchange

Throws:

MessagingException

createMessage

public NormalizedMessage createMessage()
                                throws MessagingException

Create a Message.

Specified by:

createMessage in interface MessageExchange

Throws:

MessagingException

getPhase

public int getPhase()

getPhaseMask

public int getPhaseMask()

terminate

public boolean terminate()

Force exchange into DONE state. Typically used after a sendSynch timeout or the closing of the source or target channel.

isRemoteInvocation

public boolean isRemoteInvocation()

checkTimeout

public boolean checkTimeout()

getDeltaProperties

public Set getDeltaProperties()

mergeProperties

public void mergeProperties()

toString

public String toString()

Overrides:

toString in class Object