|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface Exchange
The MessageExchange wrapper to handle properly MessageExchange against the CDK.
| Field Summary | |
|---|---|
static javax.xml.namespace.QName |
DEFAULT_FAULT_QNAME
|
static java.lang.String |
FAULT_MESSAGE_NAME
|
static java.lang.String |
IN_MESSAGE_NAME
|
static java.lang.String |
OUT_MESSAGE_NAME
|
static java.lang.String |
PROPERTY_PROVIDER_LINKTYPE
|
| Method Summary | |
|---|---|
void |
addInMessageAttachment(java.lang.String name,
javax.activation.DataHandler dataHandler)
|
void |
addOutMessageAttachment(java.lang.String name,
javax.activation.DataHandler dataHandler)
|
javax.jbi.messaging.Fault |
createFault()
|
javax.jbi.servicedesc.ServiceEndpoint |
getEndpoint()
|
java.lang.String |
getEndpointName()
Get the endpoint name specified in the message exchange |
java.lang.Exception |
getError()
|
java.lang.String |
getExchangeId()
|
java.net.URI |
getExchangePattern()
Get the message exchange Pattern |
javax.jbi.messaging.Fault |
getFault()
Get the exchange fault |
javax.jbi.messaging.FlowAttributes |
getFlowAttributes()
Get the flow attributes of the message exchange |
java.util.Map<javax.xml.namespace.QName,java.lang.String> |
getInAddressing()
Get the addressing data from the IN message. |
javax.jbi.messaging.NormalizedMessage |
getInMessage()
Extract incoming NormalizedMessage from given MessageExchange. |
javax.activation.DataHandler |
getInMessageAttachment(java.lang.String name)
Get the "In" attachment matching the given name |
java.util.Set<java.lang.String> |
getInMessageAttachmentNames()
Get all the "In" attachment names |
java.util.Set<javax.activation.DataHandler> |
getInMessageAttachments()
Get the "In" attachments in a Set |
org.w3c.dom.Document |
getInMessageContentAsDocument()
Get the content of the "in" message as a DOM document. |
org.w3c.dom.Document |
getInMessageContentAsDocument(boolean forkSource)
Get the content of the "in" message as a DOM document. |
javax.xml.transform.Source |
getInMessageContentAsSource()
Get the content of the "in" message as a Source |
java.lang.Object |
getInMessageProperty(java.lang.String name)
|
java.util.Set<java.lang.String> |
getInMessagePropertyNames()
|
javax.security.auth.Subject |
getInSubject()
Get "In" security subject |
javax.xml.namespace.QName |
getInterfaceName()
|
javax.xml.namespace.QName |
getOperation()
|
java.lang.String |
getOperationName()
Get the operation name (local part of the operation QName) |
javax.jbi.messaging.NormalizedMessage |
getOutMessage()
Extract outgoing NormalizedMessage from given MessageExchange. |
javax.activation.DataHandler |
getOutMessageAttachment(java.lang.String name)
Get the "Out" attachment matching the attachment name. |
java.util.Set<java.lang.String> |
getOutMessageAttachmentNames()
Get all the "Out" attachment names. |
java.util.Set<javax.activation.DataHandler> |
getOutMessageAttachments()
Get all the "Out" attachments in a Set. |
org.w3c.dom.Document |
getOutMessageContentAsDocument()
Get the content of the "out" message as a DOM document. |
org.w3c.dom.Document |
getOutMessageContentAsDocument(boolean forkSource)
Get the content of the "out" message as a DOM document. |
javax.xml.transform.Source |
getOutMessageContentAsSource()
Get the content of the "out" message as a Source |
java.lang.Object |
getOutMessageProperty(java.lang.String name)
|
java.util.Set<?> |
getOutMessagePropertyNames()
|
javax.security.auth.Subject |
getOutSubject()
Get "Out" security subject |
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 |
isActiveStatus()
Test if the message status is ACTIVE |
boolean |
isConsumerRole()
Test if the message role is consumer |
boolean |
isDoneStatus()
Test if the message status is DONE |
boolean |
isErrorStatus()
Test if the message status is ERROR |
boolean |
isInMessage()
Test if an In message is set on the MessageExchange |
boolean |
isInOnlyPattern()
|
boolean |
isInOptionalOutPattern()
|
boolean |
isInOutPattern()
|
boolean |
isOutMessage()
Test if an out message is set on the MessageExchange |
boolean |
isProviderRole()
Test if the message role is provider |
boolean |
isRobustInOnlyPattern()
|
boolean |
isTransacted()
|
void |
setActiveStatus()
Set the message exchange status to ACTIVE |
void |
setDoneStatus()
Set the message exchange status to DONE |
void |
setEndpoint(javax.jbi.servicedesc.ServiceEndpoint endpoint)
|
void |
setError(java.lang.Exception error)
Put the given exception as Error part of the message exchange. |
void |
setErrorStatus()
Set the message exchange status to Error |
void |
setFault(javax.jbi.messaging.Fault fault)
|
void |
setFault(java.lang.Throwable e)
Create a Fault with the given Exception and set it in the
MessageExchange |
void |
setInAddressing(java.util.Map<javax.xml.namespace.QName,java.lang.String> map)
Set the addressing information in the IN message. |
void |
setInMessage(javax.jbi.messaging.NormalizedMessage msg)
Set the input message |
void |
setInMessageAttachment(java.lang.String name,
javax.activation.DataHandler attachement)
Put the attachment in the "out" message. |
void |
setInMessageAttachments(java.util.Map<java.lang.String,javax.activation.DataHandler> attachements)
Put a Map of attachments in the out message of the message exchange. |
void |
setInMessageContent(org.w3c.dom.Document inContent)
Put a Source object in the in message of the message exchange. |
void |
setInMessageContent(java.io.InputStream inContent)
Put a String object in the in message of the message exchange. |
void |
setInMessageContent(javax.xml.transform.Source inContent)
Put a Source object in the in message of the message exchange. |
void |
setInMessageProperties(java.util.Map<java.lang.String,java.lang.Object> properties)
|
void |
setInMessageProperty(java.lang.String name,
java.lang.Object value)
|
void |
setInSubject(javax.security.auth.Subject subject)
Set the "In" security subject. |
void |
setInterfaceName(javax.xml.namespace.QName interfaceName)
Set the target interface name to invoke the service |
void |
setOperation(javax.xml.namespace.QName name)
Set the message operation |
void |
setOutMessage(javax.jbi.messaging.NormalizedMessage msg)
Set the output message |
void |
setOutMessageAttachment(java.lang.String name,
javax.activation.DataHandler attachment)
Put the attachment in the "out" message. |
void |
setOutMessageAttachments(java.util.Map<java.lang.String,javax.activation.DataHandler> attachements)
Put a Map of attachments in the "out" message. |
void |
setOutMessageContent(org.w3c.dom.Document outContent)
Put a Source object in the out message of the message exchange. |
void |
setOutMessageContent(java.io.InputStream inContent)
Put a String object in the in message of the message exchange. |
void |
setOutMessageContent(javax.xml.transform.Source outContent)
Put a Source object in the out message of the message exchange. |
void |
setOutMessageProperties(java.util.Map<java.lang.String,java.lang.Object> properties)
|
void |
setOutMessageProperty(java.lang.String name,
java.lang.Object value)
|
void |
setOutSubject(javax.security.auth.Subject subject)
Set the out security subject. |
void |
setProperty(java.lang.String name,
java.lang.Object obj)
|
void |
setService(javax.xml.namespace.QName service)
|
void |
setStatus(javax.jbi.messaging.ExchangeStatus status)
|
| Field Detail |
|---|
static final javax.xml.namespace.QName DEFAULT_FAULT_QNAME
static final java.lang.String FAULT_MESSAGE_NAME
static final java.lang.String IN_MESSAGE_NAME
static final java.lang.String OUT_MESSAGE_NAME
static final java.lang.String PROPERTY_PROVIDER_LINKTYPE
| Method Detail |
|---|
void addInMessageAttachment(java.lang.String name,
javax.activation.DataHandler dataHandler)
throws javax.jbi.messaging.MessagingException
javax.jbi.messaging.MessagingException
void addOutMessageAttachment(java.lang.String name,
javax.activation.DataHandler dataHandler)
throws javax.jbi.messaging.MessagingException
javax.jbi.messaging.MessagingException
javax.jbi.messaging.Fault createFault()
throws javax.jbi.messaging.MessagingException
javax.jbi.messaging.MessagingExceptionjavax.jbi.servicedesc.ServiceEndpoint getEndpoint()
java.lang.String getEndpointName()
throws javax.jbi.messaging.MessagingException
javax.jbi.messaging.MessagingException - if no Endpoint is setjava.lang.Exception getError()
java.lang.String getExchangeId()
java.net.URI getExchangePattern()
throws javax.jbi.messaging.MessagingException
javax.jbi.messaging.MessagingException - if no message exchange pattern is setjavax.jbi.messaging.Fault getFault()
java.util.Map<javax.xml.namespace.QName,java.lang.String> getInAddressing()
Constants.Addressing), value is the URL
as String...
javax.jbi.messaging.NormalizedMessage getInMessage()
javax.activation.DataHandler getInMessageAttachment(java.lang.String name)
throws javax.jbi.messaging.MessagingException
name - an attachment name
javax.jbi.messaging.MessagingException
java.util.Set<java.lang.String> getInMessageAttachmentNames()
throws javax.jbi.messaging.MessagingException
javax.jbi.messaging.MessagingException
java.util.Set<javax.activation.DataHandler> getInMessageAttachments()
throws javax.jbi.messaging.MessagingException
Set
exchange -
Set
javax.jbi.messaging.MessagingException
org.w3c.dom.Document getInMessageContentAsDocument()
throws javax.jbi.messaging.MessagingException
Source is a Stream or Document, a fork is
processed, which makes the Source still available, but can
decreases the performance.
javax.jbi.messaging.MessagingException - if error occurred during conversion of the Source or if "in"
message is null
org.w3c.dom.Document getInMessageContentAsDocument(boolean forkSource)
throws javax.jbi.messaging.MessagingException
Source is a Stream or Document and forkSource is true, a fork is processed, which makes the
Source still available, but can decreases the performance.
javax.jbi.messaging.MessagingException - if error occurred during conversion of the Source or if "in"
message is null
javax.xml.transform.Source getInMessageContentAsSource()
throws javax.jbi.messaging.MessagingException
javax.jbi.messaging.MessagingException - if "in" message is null
java.lang.Object getInMessageProperty(java.lang.String name)
throws javax.jbi.messaging.MessagingException
name -
javax.jbi.messaging.MessagingException
java.util.Set<java.lang.String> getInMessagePropertyNames()
throws javax.jbi.messaging.MessagingException
javax.jbi.messaging.MessagingException
javax.security.auth.Subject getInSubject()
throws javax.jbi.messaging.MessagingException
null if no subject
javax.jbi.messaging.MessagingExceptionjavax.xml.namespace.QName getInterfaceName()
javax.xml.namespace.QName getOperation()
java.lang.String getOperationName()
javax.jbi.messaging.NormalizedMessage getOutMessage()
javax.activation.DataHandler getOutMessageAttachment(java.lang.String name)
throws javax.jbi.messaging.MessagingException
exchange -
javax.jbi.messaging.MessagingException
java.util.Set<java.lang.String> getOutMessageAttachmentNames()
throws javax.jbi.messaging.MessagingException
javax.jbi.messaging.MessagingException
java.util.Set<javax.activation.DataHandler> getOutMessageAttachments()
throws javax.jbi.messaging.MessagingException
Set.
exchange -
javax.jbi.messaging.MessagingException
org.w3c.dom.Document getOutMessageContentAsDocument()
throws javax.jbi.messaging.MessagingException
Source is a Stream or Document, a fork is
processed, which makes the Source still available, but can
decreases the performance.
javax.jbi.messaging.MessagingException - if error occurred during conversion of the Source or if "in"
message is null
org.w3c.dom.Document getOutMessageContentAsDocument(boolean forkSource)
throws javax.jbi.messaging.MessagingException
Source is a Stream or Document and forkSource is true, a fork is processed, which makes the
Source still available, but can decreases the performance.
javax.jbi.messaging.MessagingException - if error occurred during conversion of the Source or if "in"
message is null
javax.xml.transform.Source getOutMessageContentAsSource()
throws javax.jbi.messaging.MessagingException
javax.jbi.messaging.MessagingException - if "out" message is null
java.lang.Object getOutMessageProperty(java.lang.String name)
throws javax.jbi.messaging.MessagingException
javax.jbi.messaging.MessagingException
java.util.Set<?> getOutMessagePropertyNames()
throws javax.jbi.messaging.MessagingException
javax.jbi.messaging.MessagingException
javax.security.auth.Subject getOutSubject()
throws javax.jbi.messaging.MessagingException
null if no subject
javax.jbi.messaging.MessagingExceptionjava.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 isActiveStatus()
boolean isConsumerRole()
boolean isDoneStatus()
boolean isErrorStatus()
boolean isInMessage()
boolean isInOnlyPattern()
boolean isInOptionalOutPattern()
boolean isInOutPattern()
boolean isOutMessage()
boolean isProviderRole()
boolean isRobustInOnlyPattern()
boolean isTransacted()
void setActiveStatus()
throws javax.jbi.messaging.MessagingException
javax.jbi.messaging.MessagingException
void setDoneStatus()
throws javax.jbi.messaging.MessagingException
javax.jbi.messaging.MessagingExceptionvoid setEndpoint(javax.jbi.servicedesc.ServiceEndpoint endpoint)
void setError(java.lang.Exception error)
void setErrorStatus()
throws javax.jbi.messaging.MessagingException
javax.jbi.messaging.MessagingException
void setFault(javax.jbi.messaging.Fault fault)
throws javax.jbi.messaging.MessagingException
javax.jbi.messaging.MessagingException
void setFault(java.lang.Throwable e)
throws javax.jbi.messaging.MessagingException
Fault with the given Exception and set it in the
MessageExchange
e - the Throwable to transform in Fault
javax.jbi.messaging.MessagingExceptionvoid setInAddressing(java.util.Map<javax.xml.namespace.QName,java.lang.String> map)
Constants.Addressing and values are
the URL as String. If the NormalizedMessage already contains the
addressing data, they will be overrided by the input map. If No
addressing data is available in the message, the input map will be the
addressing data.
map -
void setInMessage(javax.jbi.messaging.NormalizedMessage msg)
throws javax.jbi.messaging.MessagingException
msg - the input message
javax.jbi.messaging.MessagingException
void setInMessageAttachment(java.lang.String name,
javax.activation.DataHandler attachement)
throws javax.jbi.messaging.MessagingException
name - the attachment nameattachement - the attachement data handler
javax.jbi.messaging.MessagingException
void setInMessageAttachments(java.util.Map<java.lang.String,javax.activation.DataHandler> attachements)
throws javax.jbi.messaging.MessagingException
attachements - the attachments to put in the out message
javax.jbi.messaging.MessagingException - if error occurred during out message creation
void setInMessageContent(org.w3c.dom.Document inContent)
throws javax.jbi.messaging.MessagingException
inContent - the DOM Document content to put in the in message
javax.jbi.messaging.MessagingException - if error occurred during in message creation
void setInMessageContent(java.io.InputStream inContent)
throws javax.jbi.messaging.MessagingException
inContent - the Source content to put in the in message
javax.jbi.messaging.MessagingException - if error occurred during in message creation
void setInMessageContent(javax.xml.transform.Source inContent)
throws javax.jbi.messaging.MessagingException
inContent - the Source content to put in the in message
javax.jbi.messaging.MessagingException - if error occurred during in message creation
void setInMessageProperties(java.util.Map<java.lang.String,java.lang.Object> properties)
throws javax.jbi.messaging.MessagingException
javax.jbi.messaging.MessagingException
void setInMessageProperty(java.lang.String name,
java.lang.Object value)
throws javax.jbi.messaging.MessagingException
javax.jbi.messaging.MessagingExceptionvoid setInSubject(javax.security.auth.Subject subject)
the - "In" security subject.void setInterfaceName(javax.xml.namespace.QName interfaceName)
interfaceName - void setOperation(javax.xml.namespace.QName name)
name - the operation (QName)
void setOutMessage(javax.jbi.messaging.NormalizedMessage msg)
throws javax.jbi.messaging.MessagingException
msg - the output message
javax.jbi.messaging.MessagingException
void setOutMessageAttachment(java.lang.String name,
javax.activation.DataHandler attachment)
throws javax.jbi.messaging.MessagingException
name - attachment -
javax.jbi.messaging.MessagingException
void setOutMessageAttachments(java.util.Map<java.lang.String,javax.activation.DataHandler> attachements)
throws javax.jbi.messaging.MessagingException
attachements - the attachements to put in the out message
javax.jbi.messaging.MessagingException - if error occured during out message creation
void setOutMessageContent(org.w3c.dom.Document outContent)
throws javax.jbi.messaging.MessagingException
outContent - the DOM document content to put in the out message
javax.jbi.messaging.MessagingException - if error occured during out message creation
void setOutMessageContent(java.io.InputStream inContent)
throws javax.jbi.messaging.MessagingException
inContent - the Source content to put in the in message
javax.jbi.messaging.MessagingException - if error occurred during in message creation
void setOutMessageContent(javax.xml.transform.Source outContent)
throws javax.jbi.messaging.MessagingException
outContent - the Source content to put in the out message
javax.jbi.messaging.MessagingException - if error occured during out message creation
void setOutMessageProperties(java.util.Map<java.lang.String,java.lang.Object> properties)
throws javax.jbi.messaging.MessagingException
javax.jbi.messaging.MessagingException
void setOutMessageProperty(java.lang.String name,
java.lang.Object value)
throws javax.jbi.messaging.MessagingException
javax.jbi.messaging.MessagingExceptionvoid setOutSubject(javax.security.auth.Subject subject)
subject - the out security subject
void setProperty(java.lang.String name,
java.lang.Object obj)
void setService(javax.xml.namespace.QName service)
void setStatus(javax.jbi.messaging.ExchangeStatus status)
throws javax.jbi.messaging.MessagingException
javax.jbi.messaging.MessagingExceptionjavax.jbi.messaging.FlowAttributes getFlowAttributes()
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||