|
||||||||||
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 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. |
Exception |
getError()
Retrieves the Exception describing the exchanges error status. |
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. |
QName |
getInterfaceName()
Retrieves the interface name used by this exchange. |
NormalizedMessage |
getMessage(String name)
Retrieves a normalized message based on the specified message reference. |
QName |
getOperation()
Retrieves the operation used by this exchange. |
URI |
getPattern()
Returns the URI of the pattern for this exchange. |
Object |
getProperty(String name)
Retrieves the specified property from the exchange. |
Set |
getPropertyNames()
Returns the name of all properties for this exchange. |
MessageExchange.Role |
getRole()
Queries the role that the caller plays in the exchange. |
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(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(QName interfaceName)
Specifies the interface name used by this exchange. |
void |
setMessage(NormalizedMessage msg,
String name)
Sets a normalized message with the specified message reference. |
void |
setOperation(QName name)
Specifies the operation used by this exchange. |
void |
setProperty(String name,
Object obj)
Specifies a property for the exchange. |
void |
setService(QName service)
Specifies the service used by this exchange. |
void |
setStatus(ExchangeStatus status)
Sets the processing status of the exchange. |
Field Detail |
---|
static final String JTA_TRANSACTION_PROPERTY_NAME
Method Detail |
---|
URI getPattern()
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(Exception error)
ExchangeStatus.ERROR
.
error
- error causeException 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(String name)
name
- message reference
void setMessage(NormalizedMessage msg, String name) throws MessagingException
msg
- normalized messagename
- message reference
MessagingException
- operation not permitted in the current exchange stateObject getProperty(String name)
name
- property name
void setProperty(String name, Object obj)
name
- property nameobj
- property valuevoid setEndpoint(ServiceEndpoint endpoint)
endpoint
- endpoint addressvoid setService(QName service)
service
- service addressvoid setInterfaceName(QName interfaceName)
interfaceName
- interface namevoid setOperation(QName name)
name
- operation nameServiceEndpoint getEndpoint()
QName getInterfaceName()
QName getService()
QName getOperation()
boolean isTransacted()
MessageExchange.Role getRole()
Set getPropertyNames()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |