com.sun.xml.messaging.soaprp
Class SOAPRPMessageImpl

java.lang.Object
  |
  +--javax.xml.soap.SOAPMessage
        |
        +--com.sun.xml.messaging.soap.MessageImpl
              |
              +--com.sun.xml.messaging.util.ProfileMessage
                    |
                    +--com.sun.xml.messaging.soaprp.SOAPRPMessageImpl

public class SOAPRPMessageImpl

extends com.sun.xml.messaging.util.ProfileMessage

The message implementation for SOAP-RP Messages.

Constructor Summary

SOAPRPMessageImpl()
Constructs a SOAP-RP Message

SOAPRPMessageImpl(javax.xml.soap.MimeHeaders headers, java.io.InputStream in)
Constructs a message from an input stream.

SOAPRPMessageImpl(javax.xml.soap.SOAPMessage message)
Constructs a message from a SOAPMessage.

Method Summary

void	addHeaders()
javax.xml.messaging.Endpoint	getFrom() Returns the Endpoint for the Sender
javax.xml.soap.MessageFactory	getMessageFactory()
java.lang.String	getRelatesTo() Gets the "relatesTo" element of a SOAP-RP Header, indicating that the message is related to another message in some manner.
com.sun.xml.messaging.util.SerializableMessage	getSerializableMessage()
javax.xml.messaging.Endpoint	getSOAPRPAction() Returns the uri of the "action" element of the SOAPRPHeader of the SOAPRPHeader.
java.util.Vector	getSOAPRPFwdMessagePath() Returns the SOAPRPFwdMessagePath represented by the "fwd" element of the SOAPRPHeader.
java.lang.String	getSOAPRPMessageId() Returns the SOAPRPMessageId represented by the "id" element of the SOAPRPHeader.
javax.xml.messaging.Endpoint	getSOAPRPReceiver() Returns the recipient of the SOAPRP message
java.util.Vector	getSOAPRPRevMessagePath() Returns the SOAPRPRevMessagePath represented by the "rev" element of the SOAPRPHeader.
javax.xml.messaging.Endpoint	getSOAPRPSender() Returns the uri of the initial sender, represented by the "from" element of the SOAPRPHeader.
javax.xml.messaging.Endpoint	getTo() Returns the Endpoint object for the receiver
void	newMessageId() Creates a unique Message Id
void	saveChanges()
void	setAction(javax.xml.messaging.Endpoint action) Sets the uri of the "action" element of the SOAPRPHeader of the SOAPRPHeader.
void	setFrom(javax.xml.messaging.Endpoint from) Sets the uri of the ultimate destination, represented by the "to" element of the SOAPRPHeader.
void	setRelatesTo(java.lang.String id) Sets the "relatesTo" element of a SOAP-RP Header, indicating that the message is related to another message in some manner.
void	setTo(javax.xml.messaging.Endpoint to) Sets the uri of the initial sender, represented by the "from" element of the SOAPRPHeader.
void	updateFwdMessagePath(javax.xml.messaging.Endpoint uri, int position) Adds an intermediary at a specified position in the fwd Message Path.
void	updateRevMessagePath(javax.xml.messaging.Endpoint uri) Adds an intermediary at the top of the rev Message Path.

Methods inherited from class com.sun.xml.messaging.soap.MessageImpl

addAttachmentPart, countAttachments, createAttachmentPart, getAttachments, getAttachments, getContentDescription, getMimeHeaders, getSOAPPart, removeAllAttachments, saveRequired, setContentDescription, writeTo

Methods inherited from class javax.xml.soap.SOAPMessage

createAttachmentPart, createAttachmentPart

Methods inherited from class java.lang.Object

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

Constructor Detail

SOAPRPMessageImpl

public SOAPRPMessageImpl()
                  throws javax.xml.soap.SOAPException

Constructs a SOAP-RP Message

SOAPRPMessageImpl

public SOAPRPMessageImpl(javax.xml.soap.MimeHeaders headers,
                         java.io.InputStream in)
                  throws javax.xml.soap.SOAPException,
                         java.io.IOException

Constructs a message from an input stream.

SOAPRPMessageImpl

public SOAPRPMessageImpl(javax.xml.soap.SOAPMessage message)
                  throws javax.xml.soap.SOAPException,
                         java.io.IOException

Constructs a message from a SOAPMessage.

Method Detail

getFrom

public javax.xml.messaging.Endpoint getFrom()

Returns the Endpoint for the Sender

Overrides:

getFrom in class com.sun.xml.messaging.util.ProfileMessage

Returns:

Endpoint - The sender

getTo

public javax.xml.messaging.Endpoint getTo()

Returns the Endpoint object for the receiver

Overrides:

getTo in class com.sun.xml.messaging.util.ProfileMessage

Returns:

Endpoint - The receiver

getSOAPRPReceiver

public javax.xml.messaging.Endpoint getSOAPRPReceiver()

Returns the recipient of the SOAPRP message

Returns:

Endpoint - The recipient

getSOAPRPSender

public javax.xml.messaging.Endpoint getSOAPRPSender()

Returns the uri of the initial sender, represented by the "from" element of the SOAPRPHeader.

Returns:

Endpoint - The sender

getSOAPRPAction

public javax.xml.messaging.Endpoint getSOAPRPAction()

Returns the uri of the "action" element of the SOAPRPHeader of the SOAPRPHeader.

Returns:

Endpoint - The action Endpoint

getSOAPRPFwdMessagePath

public java.util.Vector getSOAPRPFwdMessagePath()

Returns the SOAPRPFwdMessagePath represented by the "fwd" element of the SOAPRPHeader.

Returns:

Vector - The forward path for the message.

getSOAPRPRevMessagePath

public java.util.Vector getSOAPRPRevMessagePath()

Returns the SOAPRPRevMessagePath represented by the "rev" element of the SOAPRPHeader.

Returns:

Vector - The reverse path for the message.

getSOAPRPMessageId

public java.lang.String getSOAPRPMessageId()

Returns the SOAPRPMessageId represented by the "id" element of the SOAPRPHeader.

Returns:

String - The message id.

getRelatesTo

public java.lang.String getRelatesTo()

Gets the "relatesTo" element of a SOAP-RP Header, indicating that the message is related to another message in some manner.

Returns:

String - the relates to value in the SOAP-RP header.

setFrom

public void setFrom(javax.xml.messaging.Endpoint from)

Sets the uri of the ultimate destination, represented by the "to" element of the SOAPRPHeader.

Parameters:

Endpoint - - the sender's endpoint.

setTo

public void setTo(javax.xml.messaging.Endpoint to)

Sets the uri of the initial sender, represented by the "from" element of the SOAPRPHeader.

Parameters:

Endpoint - - the recipients endpoint.

setAction

public void setAction(javax.xml.messaging.Endpoint action)

Sets the uri of the "action" element of the SOAPRPHeader of the SOAPRPHeader.

Parameters:

Endpoint - - the action element of the SOAPRP header.

setRelatesTo

public void setRelatesTo(java.lang.String id)

Sets the "relatesTo" element of a SOAP-RP Header, indicating that the message is related to another message in some manner.

Parameters:

String - - the relates to field of the SOAPRP header

newMessageId

public void newMessageId()

Creates a unique Message Id

updateFwdMessagePath

public void updateFwdMessagePath(javax.xml.messaging.Endpoint uri,
                                 int position)

Adds an intermediary at a specified position in the fwd Message Path.

Parameters:

uri - The uri of the intermediary to be added in the fwd Message Path

position - The position of the intermediary to be added.

updateRevMessagePath

public void updateRevMessagePath(javax.xml.messaging.Endpoint uri)

Adds an intermediary at the top of the rev Message Path.

Parameters:

uri - The uri of the intermediary to be added in the rev Message Path

saveChanges

public void saveChanges()
                 throws javax.xml.soap.SOAPException

Overrides:

saveChanges in class com.sun.xml.messaging.soap.MessageImpl

getMessageFactory

public javax.xml.soap.MessageFactory getMessageFactory()

getSerializableMessage

public com.sun.xml.messaging.util.SerializableMessage getSerializableMessage()

addHeaders

public void addHeaders()
                throws javax.xml.soap.SOAPException