org.ow2.petals.jbi.messaging.exchange
Class MessageExchangeWrapper

java.lang.Object
  org.ow2.petals.jbi.messaging.exchange.MessageExchangeWrapper

All Implemented Interfaces:

javax.jbi.messaging.MessageExchange

public class MessageExchangeWrapper
extends java.lang.Object
implements javax.jbi.messaging.MessageExchange

This class wrappers a real MessageExchange.

Each actor (consumer or provider) owns an instance of this class.
The wrapper checks that the methods which are called by the related component can be used at the current exchange state.

Author:

Adrien LOUIS - EBM WebSourcing

Nested Class Summary

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

javax.jbi.messaging.MessageExchange.Role

Field Summary

protected java.lang.String	exchangeId The unique exchange Id of this wrapper.
protected MessageExchangeImpl	messageExchange The wrapped Message Exchange.

Fields inherited from interface javax.jbi.messaging.MessageExchange

JTA_TRANSACTION_PROPERTY_NAME

Constructor Summary

MessageExchangeWrapper(MessageExchangeImpl me, javax.jbi.messaging.MessageExchange.Role observerRole)
Create a MessageExchangeWrapper.

Method Summary

javax.jbi.messaging.Fault	createFault()
javax.jbi.messaging.NormalizedMessage	createMessage()
javax.jbi.servicedesc.ServiceEndpoint	getConsumerEndpoint()
javax.jbi.servicedesc.ServiceEndpoint	getEndpoint()
java.lang.Exception	getError()
java.lang.String	getExchangeId()
javax.jbi.messaging.Fault	getFault()
javax.jbi.messaging.FlowAttributes	getFlowAttributes()
javax.xml.namespace.QName	getInterfaceName()
javax.jbi.messaging.NormalizedMessage	getMessage(java.lang.String name)
MessageExchangeImpl	getMessageExchange() Return the real implementation of this MessageExchange.
java.util.Map<java.lang.String,javax.jbi.messaging.NormalizedMessage>	getMessages() Get all the normalized messages
javax.jbi.messaging.MessageExchange.Role	getObserverRole() Return the Role that the owner of this object has in the exchange.
javax.xml.namespace.QName	getOperation()
java.net.URI	getPattern()
java.lang.Object	getProperty(java.lang.String name)
java.util.Set<?>	getPropertyNames()
javax.jbi.messaging.MessageExchange.Role	getRole()
javax.xml.namespace.QName	getService()
javax.jbi.messaging.ExchangeStatus	getStatus()
boolean	isMessageExchangeStored()
boolean	isTerminated() Is terminated?
boolean	isTimeout() Is send timeout?
boolean	isTransacted()
void	setEndpoint(javax.jbi.servicedesc.ServiceEndpoint endpoint)
void	setError(java.lang.Exception error)
void	setFault(javax.jbi.messaging.Fault fault)
void	setFlowAttributes(javax.jbi.messaging.FlowAttributes flowAttributes)
void	setInterfaceName(javax.xml.namespace.QName interfaceName)
void	setMessage(javax.jbi.messaging.NormalizedMessage msg, java.lang.String name)
void	setMessageExchange(MessageExchangeImpl messageExchange) Reset a Message Exchange instance to the wrapper
void	setObserverRole(javax.jbi.messaging.MessageExchange.Role role) Set the observer role
void	setOperation(javax.xml.namespace.QName name)
void	setPersisted(boolean persisted) Set the persisted flag.
void	setProperty(java.lang.String name, java.lang.Object obj)
void	setRole(javax.jbi.messaging.MessageExchange.Role role) Set the role.
void	setService(javax.xml.namespace.QName service)
void	setStatus(javax.jbi.messaging.ExchangeStatus status)
void	setTerminated(boolean terminated) Set the terminated flag.
void	setTimeout(boolean timeout) Set the send timeout on the wrapper.
void	setTransacted(boolean transacted) Set the transacted flag.

Methods inherited from class java.lang.Object

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

Field Detail

exchangeId

protected java.lang.String exchangeId

The unique exchange Id of this wrapper.

messageExchange

protected MessageExchangeImpl messageExchange

The wrapped Message Exchange. This instance can change during the life of a wrapper instance.

Constructor Detail

MessageExchangeWrapper

public MessageExchangeWrapper(MessageExchangeImpl me,
                              javax.jbi.messaging.MessageExchange.Role observerRole)

Create a MessageExchangeWrapper.

Method Detail

createFault

public javax.jbi.messaging.Fault createFault()
                                      throws javax.jbi.messaging.MessagingException

Specified by:

createFault in interface javax.jbi.messaging.MessageExchange

Throws:

javax.jbi.messaging.MessagingException

createMessage

public javax.jbi.messaging.NormalizedMessage createMessage()
                                                    throws javax.jbi.messaging.MessagingException

Specified by:

createMessage in interface javax.jbi.messaging.MessageExchange

Throws:

javax.jbi.messaging.MessagingException

getConsumerEndpoint

public javax.jbi.servicedesc.ServiceEndpoint getConsumerEndpoint()

getEndpoint

public javax.jbi.servicedesc.ServiceEndpoint getEndpoint()

Specified by:

getEndpoint in interface javax.jbi.messaging.MessageExchange

getError

public java.lang.Exception getError()

Specified by:

getError in interface javax.jbi.messaging.MessageExchange

getExchangeId

public java.lang.String getExchangeId()

Specified by:

getExchangeId in interface javax.jbi.messaging.MessageExchange

getFlowAttributes

public javax.jbi.messaging.FlowAttributes getFlowAttributes()

Specified by:

getFlowAttributes in interface javax.jbi.messaging.MessageExchange

setFlowAttributes

public void setFlowAttributes(javax.jbi.messaging.FlowAttributes flowAttributes)

Specified by:

setFlowAttributes in interface javax.jbi.messaging.MessageExchange

getFault

public javax.jbi.messaging.Fault getFault()

Specified by:

getFault in interface javax.jbi.messaging.MessageExchange

getInterfaceName

public javax.xml.namespace.QName getInterfaceName()

Specified by:

getInterfaceName in interface javax.jbi.messaging.MessageExchange

getMessage

public javax.jbi.messaging.NormalizedMessage getMessage(java.lang.String name)

Specified by:

getMessage in interface javax.jbi.messaging.MessageExchange

getMessageExchange

public MessageExchangeImpl getMessageExchange()

Return the real implementation of this MessageExchange.

Returns:

MessageExchangeImpl

getMessages

public java.util.Map<java.lang.String,javax.jbi.messaging.NormalizedMessage> getMessages()

Get all the normalized messages

Returns:

getObserverRole

public javax.jbi.messaging.MessageExchange.Role getObserverRole()

Return the Role that the owner of this object has in the exchange.

Returns:

getOperation

public javax.xml.namespace.QName getOperation()

Specified by:

getOperation in interface javax.jbi.messaging.MessageExchange

getPattern

public java.net.URI getPattern()

Specified by:

getPattern in interface javax.jbi.messaging.MessageExchange

getProperty

public java.lang.Object getProperty(java.lang.String name)

Specified by:

getProperty in interface javax.jbi.messaging.MessageExchange

getPropertyNames

public java.util.Set<?> getPropertyNames()

Specified by:

getPropertyNames in interface javax.jbi.messaging.MessageExchange

getRole

public javax.jbi.messaging.MessageExchange.Role getRole()

Specified by:

getRole in interface javax.jbi.messaging.MessageExchange

getService

public javax.xml.namespace.QName getService()

Specified by:

getService in interface javax.jbi.messaging.MessageExchange

getStatus

public javax.jbi.messaging.ExchangeStatus getStatus()

Specified by:

getStatus in interface javax.jbi.messaging.MessageExchange

isMessageExchangeStored

public boolean isMessageExchangeStored()

isTerminated

public boolean isTerminated()

Is terminated?

Returns:

isTimeout

public boolean isTimeout()

Is send timeout?

Returns:

isTransacted

public boolean isTransacted()

Specified by:

isTransacted in interface javax.jbi.messaging.MessageExchange

setEndpoint

public void setEndpoint(javax.jbi.servicedesc.ServiceEndpoint endpoint)

Specified by:

setEndpoint in interface javax.jbi.messaging.MessageExchange

setError

public void setError(java.lang.Exception error)

Specified by:

setError in interface javax.jbi.messaging.MessageExchange

setFault

public void setFault(javax.jbi.messaging.Fault fault)
              throws javax.jbi.messaging.MessagingException

Specified by:

setFault in interface javax.jbi.messaging.MessageExchange

Throws:

javax.jbi.messaging.MessagingException

setInterfaceName

public void setInterfaceName(javax.xml.namespace.QName interfaceName)

Specified by:

setInterfaceName in interface javax.jbi.messaging.MessageExchange

setMessage

public void setMessage(javax.jbi.messaging.NormalizedMessage msg,
                       java.lang.String name)
                throws javax.jbi.messaging.MessagingException

Specified by:

setMessage in interface javax.jbi.messaging.MessageExchange

Throws:

javax.jbi.messaging.MessagingException

setMessageExchange

public void setMessageExchange(MessageExchangeImpl messageExchange)
                        throws javax.jbi.messaging.MessagingException

Reset a Message Exchange instance to the wrapper

Parameters:

messageExchange -

Throws:

javax.jbi.messaging.MessagingException

setObserverRole

public void setObserverRole(javax.jbi.messaging.MessageExchange.Role role)

Set the observer role

setOperation

public void setOperation(javax.xml.namespace.QName name)

Specified by:

setOperation in interface javax.jbi.messaging.MessageExchange

setPersisted

public void setPersisted(boolean persisted)

Set the persisted flag.

Parameters:

role -

setProperty

public void setProperty(java.lang.String name,
                        java.lang.Object obj)

Specified by:

setProperty in interface javax.jbi.messaging.MessageExchange

setRole

public void setRole(javax.jbi.messaging.MessageExchange.Role role)

Set the role.

Parameters:

role -

setService

public void setService(javax.xml.namespace.QName service)

Specified by:

setService in interface javax.jbi.messaging.MessageExchange

setStatus

public void setStatus(javax.jbi.messaging.ExchangeStatus status)
               throws javax.jbi.messaging.MessagingException

Specified by:

setStatus in interface javax.jbi.messaging.MessageExchange

Throws:

javax.jbi.messaging.MessagingException

setTerminated

public void setTerminated(boolean terminated)

Set the terminated flag.

Parameters:

terminated -

setTimeout

public void setTimeout(boolean timeout)

Set the send timeout on the wrapper.

setTransacted

public void setTransacted(boolean transacted)

Set the transacted flag.

Parameters:

terminated -