org.backsource.amsterdam.service
Class ServiceMessage

java.lang.Object
  org.backsource.amsterdam.service.ServiceMessage

public class ServiceMessage

extends java.lang.Object

Is the message sent through the system, should be constructed by the ProtocolHandler. The content of a ServiceMessage may be manipulated on the way down the invoker chain (eg from SGML to XML), but the message object in itself may not be changed to a new one. FIXME - shoild not an url be part of this?

Version:

$Revision: 1.1.1.1 $

Author:

Peter Antman

Constructor Summary

ServiceMessage(ContentMapEntry entry, java.lang.String url, java.lang.String mime, java.io.InputStream is)

ServiceMessage(ContentMapEntry entry, java.lang.String url, java.lang.String mime, java.lang.String message)

ServiceMessage(java.lang.Object message)

ServiceMessage(java.lang.String url, java.lang.String mime, java.io.InputStream is)

ServiceMessage(java.lang.String url, java.lang.String mime, java.lang.String message)

Method Summary

ContentMapEntry	getContentMapEntry()
java.lang.String	getMessage() Get the message.
java.lang.String	getMime() Get mime type
java.lang.String	getName()
java.lang.Object	getObjectMessage()
java.lang.String	getResponse() Get any response message
java.io.InputStream	getStream() Get a stream to the underlying message.
java.lang.String	getUrl()
boolean	hasObjectMessage()
boolean	hasStream() Check if message body is carried inside a stream If it is use getStream() else use getMessage()
protected void	hasStream(boolean hasStream)
boolean	isBinary() Check if message body is binary
protected void	isBinary(boolean isBinary)
void	setContentMapEntry(ContentMapEntry entry)
void	setInputStream(java.io.InputStream is) Set an InputStream, overwriting the previus one, if you do this, see to it that the original one was closed first.
void	setMessage(java.lang.String message) Set a message, overwrite the prevous one.
void	setMime(java.lang.String mime)
void	setName(java.lang.String name)
void	setObjectMessage(java.lang.Object message)
void	setResponse(java.lang.String response) A publisher (or some other party in the chain) may fill in a response note (in xml).
void	setUrl(java.lang.String url)

Methods inherited from class java.lang.Object

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

Constructor Detail

ServiceMessage

public ServiceMessage(ContentMapEntry entry,
                      java.lang.String url,
                      java.lang.String mime,
                      java.lang.String message)

ServiceMessage

public ServiceMessage(java.lang.String url,
                      java.lang.String mime,
                      java.lang.String message)

ServiceMessage

public ServiceMessage(java.lang.String url,
                      java.lang.String mime,
                      java.io.InputStream is)

ServiceMessage

public ServiceMessage(ContentMapEntry entry,
                      java.lang.String url,
                      java.lang.String mime,
                      java.io.InputStream is)

ServiceMessage

public ServiceMessage(java.lang.Object message)

Method Detail

getContentMapEntry

public ContentMapEntry getContentMapEntry()

setContentMapEntry

public void setContentMapEntry(ContentMapEntry entry)

getUrl

public java.lang.String getUrl()

setUrl

public void setUrl(java.lang.String url)

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

hasStream

public boolean hasStream()

Check if message body is carried inside a stream If it is use getStream() else use getMessage()

hasStream

protected void hasStream(boolean hasStream)

isBinary

public boolean isBinary()

Check if message body is binary

isBinary

protected void isBinary(boolean isBinary)

getMime

public java.lang.String getMime()

Get mime type

setMime

public void setMime(java.lang.String mime)

getStream

public java.io.InputStream getStream()

Get a stream to the underlying message. The creator of the stream may not count on that the message has reached the final destination when it is closed.

setInputStream

public void setInputStream(java.io.InputStream is)

Set an InputStream, overwriting the previus one, if you do this, see to it that the original one was closed first. May be set to null, hasStream will then be set to false

getMessage

public java.lang.String getMessage()

Get the message. Only if its text, and currently only if it was set

setMessage

public void setMessage(java.lang.String message)

Set a message, overwrite the prevous one.

setObjectMessage

public void setObjectMessage(java.lang.Object message)

getObjectMessage

public java.lang.Object getObjectMessage()

hasObjectMessage

public boolean hasObjectMessage()

getResponse

public java.lang.String getResponse()

Get any response message

setResponse

public void setResponse(java.lang.String response)

A publisher (or some other party in the chain) may fill in a response note (in xml). It is up to the application assembler to see to it that the parts agree on a format if this feature is used.