org.ws4d.java.message

Class Message

java.lang.Object

org.ws4d.java.types.UnknownDataContainer

org.ws4d.java.message.Message

Direct Known Subclasses:

EventingResponseMessage, FaultMessage, GetMessage, GetMetadataMessage, GetMetadataResponseMessage, GetResponseMessage, GetStatusMessage, InvokeMessage, RenewMessage, SignableMessage, SubscribeMessage, SubscriptionEndMessage, UnsubscribeMessage, UnsubscribeResponseMessage

public abstract class Message
extends UnknownDataContainer

This class implements an abstract MessageObject.

Field Summary

Fields

Modifier and Type	Field and Description
protected SOAPHeader	header
protected boolean	inbound If true, then this is a message received over a remote communication channel; if false, the message is being sent from this stack instance.
static int	MULTICAST_ROUTING_SCHEME
static int	UNICAST_ROUTING_SCHEME
static int	UNKNOWN_ROUTING_SCHEME

Fields inherited from class org.ws4d.java.types.UnknownDataContainer

unknownAttributes, unknownElements_QN_2_List

Constructor Summary

Constructors

Constructor and Description
Message(SOAPHeader header) Constructor.

Method Summary

Modifier and Type	Method and Description
AppSequence	getAppSequence()
SOAPHeader	getHeader() Returns the SOAP header of the message.
AttributedURI	getMessageId() Returns the message id.
AttributedURI	getRelatesTo()
EndpointReference	getReplyTo()
int	getRoutingScheme() Gets the outgoing routing scheme for this message.
AttributedURI	getTo()
abstract int	getType() Type of message.
boolean	isInbound() Returns true if this message was received over a remote communication channel.
void	setInbound(boolean inbound)
void	setResponseTo(Message request) Sets the [relationship], [to] and [parameters] properties of this message to the values of the [message ID] and [reply to] properties of the passed in message.
void	setResponseTo(SOAPHeader requestHeader) Sets the [relationship], [to] and [parameters] properties of this message to the values of the [message ID] and [reply to] properties of the passed in SOAP header.
void	setRoutingScheme(int routingScheme)
protected void	setSOAPHeader(SOAPHeader header)
java.lang.String	toString() (non-Javadoc)

Methods inherited from class org.ws4d.java.types.UnknownDataContainer

addUnknownAttribute, addUnknownElement, getUnknownAttribute, getUnknownAttributes, getUnknownElement, getUnknownElements, getUnknownElements, setUnknownAttributes, setUnknownElements

Methods inherited from class java.lang.Object

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

Field Detail

UNKNOWN_ROUTING_SCHEME

public static final int UNKNOWN_ROUTING_SCHEME

See Also:

Constant Field Values

UNICAST_ROUTING_SCHEME

public static final int UNICAST_ROUTING_SCHEME

See Also:

Constant Field Values

MULTICAST_ROUTING_SCHEME

public static final int MULTICAST_ROUTING_SCHEME

See Also:

Constant Field Values

header

protected SOAPHeader header

inbound

protected boolean inbound

If true, then this is a message received over a remote communication channel; if false, the message is being sent from this stack instance.

Constructor Detail

Message

public Message(SOAPHeader header)

Constructor.

Parameters:

header -

Method Detail

toString

public java.lang.String toString()

(non-Javadoc)

Overrides:

toString in class UnknownDataContainer

See Also:

Object.toString()

setResponseTo

public void setResponseTo(Message request)

Sets the [relationship], [to] and [parameters] properties of this message to the values of the [message ID] and [reply to] properties of the passed in message.

Parameters:

request - the message from which to extract the source properties

setResponseTo

public void setResponseTo(SOAPHeader requestHeader)

Sets the [relationship], [to] and [parameters] properties of this message to the values of the [message ID] and [reply to] properties of the passed in SOAP header.

Parameters:

requestHeader - the SOAP header from which to extract the source properties

getType

public abstract int getType()

Type of message.

Returns:

type.

getHeader

public SOAPHeader getHeader()

Returns the SOAP header of the message.

Returns:

header.

getMessageId

public AttributedURI getMessageId()

Returns the message id.

Returns:

the message id.

getRelatesTo

public AttributedURI getRelatesTo()

getTo

public AttributedURI getTo()

getReplyTo

public EndpointReference getReplyTo()

getAppSequence

public AppSequence getAppSequence()

isInbound

public boolean isInbound()

Returns true if this message was received over a remote communication channel. Returns false if the message is being sent from this stack instance.

Returns:

whether this is an inbound or an outbound message

setInbound

public void setInbound(boolean inbound)

Parameters:

inbound - the inbound to set

getRoutingScheme

public int getRoutingScheme()

Gets the outgoing routing scheme for this message. It can be unknown (0x0), unicast (0x1), multicast (0x2). http://en.wikipedia.org/wiki/Routing

Returns:

the outgoing routing scheme for this message.

setRoutingScheme

public void setRoutingScheme(int routingScheme)

setSOAPHeader

protected void setSOAPHeader(SOAPHeader header)