|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface MessageExchange
MessageExchange represents a container for normalized messages which are described by an exchange pattern. The exchange pattern defines the names, sequence, and cardinality of messages in an exchange.
Nested Class Summary | |
---|---|
static class |
MessageExchange.Role
Typesafe enum containing the roles a component can play in a service. |
Field Summary | |
---|---|
static java.lang.String |
JTA_TRANSACTION_PROPERTY_NAME
JTA transaction context property name. |
Method Summary | |
---|---|
Fault |
createFault()
Generic factory method for Fault objects. |
NormalizedMessage |
createMessage()
Creates a normalized message based on the specified message reference. |
ServiceEndpoint |
getEndpoint()
Retrieves the endpoint used by this exchange. |
java.lang.Exception |
getError()
Retrieves the Exception describing the exchanges error status. |
java.lang.String |
getExchangeId()
Returns the unique identifier assigned by the NMS for this exchange. |
Fault |
getFault()
Retrieves the fault message for this exchange, if one exists. |
javax.xml.namespace.QName |
getInterfaceName()
Retrieves the interface name used by this exchange. |
NormalizedMessage |
getMessage(java.lang.String name)
Retrieves a normalized message based on the specified message reference. |
javax.xml.namespace.QName |
getOperation()
Retrieves the operation used by this exchange. |
java.net.URI |
getPattern()
Returns the URI of the pattern for this exchange. |
java.lang.Object |
getProperty(java.lang.String name)
Retrieves the specified property from the exchange. |
java.util.Set |
getPropertyNames()
Returns the name of all properties for this exchange. |
MessageExchange.Role |
getRole()
Queries the role that the caller plays in the exchange. |
javax.xml.namespace.QName |
getService()
Retrieves the service used by this exchange. |
ExchangeStatus |
getStatus()
Returns the processing status of the exchange. |
boolean |
isTransacted()
Queries the existence of a transaction context. |
void |
setEndpoint(ServiceEndpoint endpoint)
Specifies the endpoint used by this exchange. |
void |
setError(java.lang.Exception error)
Used to specify the source of a failure status. |
void |
setFault(Fault fault)
Specifies the fault message for this exchange, if one exists. |
void |
setInterfaceName(javax.xml.namespace.QName interfaceName)
Specifies the interface name used by this exchange. |
void |
setMessage(NormalizedMessage msg,
java.lang.String name)
Sets a normalized message with the specified message reference. |
void |
setOperation(javax.xml.namespace.QName name)
Specifies the operation used by this exchange. |
void |
setProperty(java.lang.String name,
java.lang.Object obj)
Specifies a property for the exchange. |
void |
setService(javax.xml.namespace.QName service)
Specifies the service used by this exchange. |
void |
setStatus(ExchangeStatus status)
Sets the processing status of the exchange. |
Field Detail |
---|
static final java.lang.String JTA_TRANSACTION_PROPERTY_NAME
Method Detail |
---|
java.net.URI getPattern()
java.lang.String getExchangeId()
ExchangeStatus getStatus()
void setStatus(ExchangeStatus status) throws MessagingException
status
- exchange status
MessagingException
- failed to set status, possibly due to an
invalid state transition.void setError(java.lang.Exception error)
error
- error causejava.lang.Exception getError()
Fault getFault()
void setFault(Fault fault) throws MessagingException
fault
- fault
MessagingException
- operation not permitted in the current exchange stateNormalizedMessage createMessage() throws MessagingException
MessagingException
- failed to create messageFault createFault() throws MessagingException
MessagingException
- failed to create faultNormalizedMessage getMessage(java.lang.String name)
name
- message reference
void setMessage(NormalizedMessage msg, java.lang.String name) throws MessagingException
msg
- normalized messagename
- message reference
MessagingException
- operation not permitted in the current exchange statejava.lang.Object getProperty(java.lang.String name)
name
- property name
void setProperty(java.lang.String name, java.lang.Object obj)
name
- property nameobj
- property valuevoid setEndpoint(ServiceEndpoint endpoint)
endpoint
- endpoint addressvoid setService(javax.xml.namespace.QName service)
service
- service addressvoid setInterfaceName(javax.xml.namespace.QName interfaceName)
interfaceName
- interface namevoid setOperation(javax.xml.namespace.QName name)
name
- operation nameServiceEndpoint getEndpoint()
javax.xml.namespace.QName getInterfaceName()
javax.xml.namespace.QName getService()
javax.xml.namespace.QName getOperation()
boolean isTransacted()
MessageExchange.Role getRole()
java.util.Set getPropertyNames()
|
${build-info} | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |