com.adaptris.core

Class SerializableAdaptrisMessage

java.lang.Object

com.adaptris.core.SerializableAdaptrisMessage

All Implemented Interfaces:

SerializableMessage, java.io.Serializable

public class SerializableAdaptrisMessage
extends java.lang.Object
implements SerializableMessage

The SerializableAdaptrisMessage simply represents an AdaptrisMessage that can be serialized.

Many of the AdaptrisMessage's class members have been removed to facilitate serialization, such as object metadata - considering any object may be placed in object metadata, we could never be sure the message would serialize. The semantics of each method will attempt to follow that defined by AdaptrisMessage even though it does not implement that interface.

See Also:

Serialized Form

In the adapter configuration file this class is aliased as serializable-adaptris-message which is the preferred alternative to the fully qualified classname when building your configuration.

Constructor Summary

Constructors

Constructor and Description
SerializableAdaptrisMessage()
SerializableAdaptrisMessage(SerializableMessage orig)
SerializableAdaptrisMessage(java.lang.String uniqueId)
SerializableAdaptrisMessage(java.lang.String uniqueId, java.lang.String payload)

Method Summary

Modifier and Type	Method and Description
void	addMessageHeader(java.lang.String key, java.lang.String value)
void	addMetadata(MetadataElement e) Add a single item of metadata.
void	addMetadata(java.lang.String key, java.lang.String value) Add a single item of metadata.
boolean	containsKey(java.lang.String key)
boolean	equals(java.lang.Object object)
java.lang.String	getContent()
java.lang.String	getContentEncoding()
java.util.Map<java.lang.String,java.lang.String>	getMessageHeaders()
java.util.Set<MetadataElement>	getMetadata()
java.lang.String	getMetadataValue(java.lang.String key)
java.lang.String	getNextServiceId()
java.lang.String	getUniqueId()
int	hashCode()
void	removeMessageHeader(java.lang.String key)
void	removeMetadata(MetadataElement element)
void	setContent(java.lang.String payload)
void	setContentEncoding(java.lang.String payloadEncoding)
void	setMessageHeaders(java.util.Map<java.lang.String,java.lang.String> arg0)
void	setMetadata(KeyValuePairSet metadata) Set the metadata for this message.
void	setMetadata(java.util.Set<MetadataElement> set) Adds all the associated MetadataElement as metadata.
void	setNextServiceId(java.lang.String s)
void	setPayload(java.lang.String payload, java.lang.String payloadEncoding)
void	setUniqueId(java.lang.String uniqueId)

Methods inherited from class java.lang.Object

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

Constructor Detail

SerializableAdaptrisMessage

public SerializableAdaptrisMessage()

SerializableAdaptrisMessage

public SerializableAdaptrisMessage(SerializableMessage orig)

SerializableAdaptrisMessage

public SerializableAdaptrisMessage(java.lang.String uniqueId)

SerializableAdaptrisMessage

public SerializableAdaptrisMessage(java.lang.String uniqueId,
                                   java.lang.String payload)

Method Detail

getUniqueId

public java.lang.String getUniqueId()

Specified by:

getUniqueId in interface SerializableMessage

setUniqueId

public void setUniqueId(java.lang.String uniqueId)

Specified by:

setUniqueId in interface SerializableMessage

getContent

public java.lang.String getContent()

Specified by:

getContent in interface SerializableMessage

setContent

public void setContent(java.lang.String payload)

Specified by:

setContent in interface SerializableMessage

setPayload

public void setPayload(java.lang.String payload,
                       java.lang.String payloadEncoding)

getMetadata

public java.util.Set<MetadataElement> getMetadata()

setMetadata

public void setMetadata(KeyValuePairSet metadata)

Set the metadata for this message.

This overwrites all metadata in the message with the corresponding set; passing in null or an empty KeyValuePairSet will remove all metadata.

Parameters:

metadata - the metadata to set.

setMetadata

public void setMetadata(java.util.Set<MetadataElement> set)

Adds all the associated MetadataElement as metadata.

This will overwrite any pre-existing keys, but will not remove existing metadata

Parameters:

set - the metadata to add.

See Also:

AdaptrisMessage.setMetadata(Set)

addMetadata

public void addMetadata(java.lang.String key,
                        java.lang.String value)

Add a single item of metadata.

Parameters:

key - the key

value - the value

See Also:

AdaptrisMessage.addMetadata(String, String)

addMetadata

public void addMetadata(MetadataElement e)

Add a single item of metadata.

Parameters:

e - the metadata to add.

removeMetadata

public void removeMetadata(MetadataElement element)

containsKey

public boolean containsKey(java.lang.String key)

getMetadataValue

public java.lang.String getMetadataValue(java.lang.String key)

addMessageHeader

public void addMessageHeader(java.lang.String key,
                             java.lang.String value)

Specified by:

addMessageHeader in interface SerializableMessage

removeMessageHeader

public void removeMessageHeader(java.lang.String key)

Specified by:

removeMessageHeader in interface SerializableMessage

getMessageHeaders

public java.util.Map<java.lang.String,java.lang.String> getMessageHeaders()

Specified by:

getMessageHeaders in interface SerializableMessage

setMessageHeaders

public void setMessageHeaders(java.util.Map<java.lang.String,java.lang.String> arg0)

Specified by:

setMessageHeaders in interface SerializableMessage

getContentEncoding

public java.lang.String getContentEncoding()

Specified by:

getContentEncoding in interface SerializableMessage

setContentEncoding

public void setContentEncoding(java.lang.String payloadEncoding)

Specified by:

setContentEncoding in interface SerializableMessage

getNextServiceId

public java.lang.String getNextServiceId()

Specified by:

getNextServiceId in interface SerializableMessage

setNextServiceId

public void setNextServiceId(java.lang.String s)

Specified by:

setNextServiceId in interface SerializableMessage

equals

public boolean equals(java.lang.Object object)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object