com.adaptris.core

Class AdaptrisMessageImp

java.lang.Object

com.adaptris.core.AdaptrisMessageImp

All Implemented Interfaces:

AdaptrisMessage, InterlokMessage, java.lang.Cloneable

Direct Known Subclasses:

DefaultAdaptrisMessageImp, MultiPayloadAdaptrisMessageImp

public abstract class AdaptrisMessageImp
extends java.lang.Object
implements AdaptrisMessage, java.lang.Cloneable

Standard implementation of AdaptrisMessage interface.

When referring to metadata items by key you can use a form of indirection by specifying a prefix to your key ("$$").
Using this prefix on any metadata key will not perform an action (retrieve, add etc) to that metadata item but instead will look up the value of that metadata key and use the value as the metadata item key to be performed on.
Example:
Calling addMetadata("myKey", "myValue");
Will create a new metadata item with the key "myKey" and the value "myValue".
However calling addMetadata("$$myKey", "myValue") will lookup the value of the metadata key named "myKey" and use that value as the key for the addMetadata() method.

See Also:

DefaultMessageFactory, AdaptrisMessageFactory, AdaptrisMessage

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AdaptrisMessageImp(IdGenerator guid, AdaptrisMessageFactory fac) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
void	addEvent(MessageEventGenerator meg, boolean wasSuccessful) Adds an event to this AdaptrisMessage's MessageLifecycleEvent.
void	addMessageHeader(java.lang.String key, java.lang.String value)
void	addMetadata(MetadataElement e) Puts the passed MetadataElement into the metadata.
void	addMetadata(java.lang.String key, java.lang.String value) Puts the passed value into the metadata against the passed key.
void	addObjectHeader(java.lang.Object key, java.lang.Object object) Adds an Object to this message as metadata.
void	clearMetadata() Clears the current metadata.
java.lang.Object	clone() Returns a deep clone of this object.
static void	copyPayload(AdaptrisMessage src, AdaptrisMessage dest) Deprecated. since 3.11.0 use MessageHelper#copyPayload(AdaptrisMessage, AdaptrisMessage) instead.
byte[]	encode(AdaptrisMessageEncoder encoder) Uses the passed AdaptrisMessageEncoder to create an encoded version of this AdaptrisMessage.
java.lang.String	getContentEncoding()
AdaptrisMessageFactory	getFactory() Return the factory that created this message.
java.util.Map<java.lang.String,java.lang.String>	getMessageHeaders()
MessageLifecycleEvent	getMessageLifecycleEvent() Returns this object's MessageLifecycleEvent.
java.util.Set<MetadataElement>	getMetadata() Returns a shallow clone of this message's metadata.
MetadataElement	getMetadata(java.lang.String key) Returns the MetadataElement containing the passed key or null if the key does not exist.
java.lang.String	getMetadataValue(java.lang.String key) Returns the String value associated with the passed key or null if the key does not exist.
java.lang.String	getMetadataValueIgnoreKeyCase(java.lang.String key) First looks for a metadata value stored against the passed key taking account of the passed key's case.
java.lang.String	getNextServiceId() Returns the unique ID of the next Service to apply to the message.
java.util.Map<java.lang.Object,java.lang.Object>	getObjectHeaders()
java.io.Reader	getReader()
java.lang.String	getUniqueId()
java.io.Writer	getWriter()
java.io.Writer	getWriter(java.lang.String encoding)
boolean	headersContainsKey(java.lang.String key)
void	removeMessageHeader(java.lang.String key)
void	removeMetadata(MetadataElement element) Removes the passed MetadataElement from the metadata if it is present.
java.lang.String	resolve(java.lang.String s, boolean dotAll)
void	setContentEncoding(java.lang.String charEnc)
void	setMessageHeaders(java.util.Map<java.lang.String,java.lang.String> metadata)
void	setMetadata(java.util.Set<MetadataElement> set) Adds all the passed metadata to this message's metadata.
void	setNextServiceId(java.lang.String s) Sets the unique ID of the next Service to apply to the message.
void	setUniqueId(java.lang.String s)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.adaptris.core.AdaptrisMessage

addObjectMetadata, containsKey, equivalentForTracking, getCharEncoding, getObjectMetadata, getPayload, getPayloadForLogging, getSize, getStringPayload, setCharEncoding, setPayload, setStringPayload, setStringPayload

Methods inherited from interface com.adaptris.interlok.types.InterlokMessage

getContent, getInputStream, getOutputStream, resolve, setContent, wrap

Constructor Detail

AdaptrisMessageImp

protected AdaptrisMessageImp(IdGenerator guid,
                             AdaptrisMessageFactory fac)

Creates a new instance.

Parameters:

guid - a GuidGenerator that will be used to create unique-ids.

Method Detail

getFactory

public AdaptrisMessageFactory getFactory()

Description copied from interface: AdaptrisMessage

Return the factory that created this message.

Specified by:

getFactory in interface AdaptrisMessage

Returns:

the factory.

setContentEncoding

public void setContentEncoding(java.lang.String charEnc)

Specified by:

setContentEncoding in interface InterlokMessage

See Also:

InterlokMessage.setContentEncoding(String)

getContentEncoding

public java.lang.String getContentEncoding()

Specified by:

getContentEncoding in interface InterlokMessage

See Also:

InterlokMessage.getContentEncoding()

headersContainsKey

public boolean headersContainsKey(java.lang.String key)

Specified by:

headersContainsKey in interface InterlokMessage

See Also:

InterlokMessage.headersContainsKey(String)

addMetadata

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

Description copied from interface: AdaptrisMessage

Puts the passed value into the metadata against the passed key. If a value has previously been set against this key it will be overwritten.

Specified by:

addMetadata in interface AdaptrisMessage

Parameters:

key - the key

value - the value

addMessageHeader

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

Specified by:

addMessageHeader in interface InterlokMessage

addMetadata

public void addMetadata(MetadataElement e)

Description copied from interface: AdaptrisMessage

Puts the passed MetadataElement into the metadata. If a value has previously been set with the same key it will be overwritten and a message to that effect should be logged.

Specified by:

addMetadata in interface AdaptrisMessage

Parameters:

e - the MetadataElement to add

See Also:

AdaptrisMessage.addMetadata(MetadataElement)

removeMetadata

public void removeMetadata(MetadataElement element)

Description copied from interface: AdaptrisMessage

Removes the passed MetadataElement from the metadata if it is present.

Specified by:

removeMetadata in interface AdaptrisMessage

Parameters:

element - the MetadataElement to remove

See Also:

AdaptrisMessage.removeMetadata(MetadataElement)

removeMessageHeader

public void removeMessageHeader(java.lang.String key)

Specified by:

removeMessageHeader in interface InterlokMessage

See Also:

InterlokMessage.removeMessageHeader(String)

setMetadata

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

Description copied from interface: AdaptrisMessage

Adds all the passed metadata to this message's metadata.

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

Specified by:

setMetadata in interface AdaptrisMessage

Parameters:

set - the metadata to add

setMessageHeaders

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

Specified by:

setMessageHeaders in interface InterlokMessage

clearMetadata

public void clearMetadata()

Description copied from interface: AdaptrisMessage

Clears the current metadata.

Specified by:

clearMetadata in interface AdaptrisMessage

See Also:

AdaptrisMessage.clearMetadata()

getMetadataValue

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

Description copied from interface: AdaptrisMessage

Returns the String value associated with the passed key or null if the key does not exist. NB may also return null if null was explicitly set as the value of the key. Use containsKey to differentiate these cases.

Specified by:

getMetadataValue in interface AdaptrisMessage

Parameters:

key - the key to look for

Returns:

the value associated with the key

See Also:

AdaptrisMessage.getMetadataValue(String)

getMetadata

public MetadataElement getMetadata(java.lang.String key)

Description copied from interface: AdaptrisMessage

Returns the MetadataElement containing the passed key or null if the key does not exist. NB may also return null if null was explicitly set as the value of the key. Use containsKey to differentiate these cases.

Specified by:

getMetadata in interface AdaptrisMessage

Parameters:

key - the key to look for

Returns:

the MetadataElement containing the key

See Also:

AdaptrisMessage.getMetadata(String)

getMessageHeaders

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

Specified by:

getMessageHeaders in interface InterlokMessage

getMetadata

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

Description copied from interface: AdaptrisMessage

Returns a shallow clone of this message's metadata.

Specified by:

getMetadata in interface AdaptrisMessage

Returns:

a Set of all MetadataElementss

getUniqueId

public java.lang.String getUniqueId()

Specified by:

getUniqueId in interface InterlokMessage

setUniqueId

public void setUniqueId(java.lang.String s)

Specified by:

setUniqueId in interface InterlokMessage

getReader

public java.io.Reader getReader()
                         throws java.io.IOException

Specified by:

getReader in interface InterlokMessage

Throws:

java.io.IOException

getWriter

public java.io.Writer getWriter()
                         throws java.io.IOException

Specified by:

getWriter in interface InterlokMessage

Throws:

java.io.IOException

getWriter

public java.io.Writer getWriter(java.lang.String encoding)
                         throws java.io.IOException

Specified by:

getWriter in interface InterlokMessage

Throws:

java.io.IOException

addEvent

public void addEvent(MessageEventGenerator meg,
                     boolean wasSuccessful)

Description copied from interface: AdaptrisMessage

Adds an event to this AdaptrisMessage's MessageLifecycleEvent.

Specified by:

addEvent in interface AdaptrisMessage

Parameters:

meg - the MessageEventGenerator

wasSuccessful - the status of the event

getMessageLifecycleEvent

public MessageLifecycleEvent getMessageLifecycleEvent()

Description copied from interface: AdaptrisMessage

Returns this object's MessageLifecycleEvent.

Specified by:

getMessageLifecycleEvent in interface AdaptrisMessage

Returns:

this object's MessageLifecycleEvent

See Also:

AdaptrisMessage.getMessageLifecycleEvent()

encode

public byte[] encode(AdaptrisMessageEncoder encoder)
              throws CoreException

Description copied from interface: AdaptrisMessage

Uses the passed AdaptrisMessageEncoder to create an encoded version of this AdaptrisMessage. If null is passed this method returns this.getPayload().

Specified by:

encode in interface AdaptrisMessage

Parameters:

encoder - the AdaptrisMessageEncoder to use

Returns:

a byte[] representation of this message

Throws:

CoreException - wrapping any underlying Exceptions that may occur

See Also:

AdaptrisMessage.encode(AdaptrisMessageEncoder)

addObjectHeader

public void addObjectHeader(java.lang.Object key,
                            java.lang.Object object)

Adds an Object to this message as metadata. Object metadata is intended to be used within a single Workflow only and will not be encoded or otherwise transported between Workflows.

Specified by:

addObjectHeader in interface InterlokMessage

Parameters:

object - the Object to set as metadata

key - the key to store this object against.

getObjectHeaders

public java.util.Map<java.lang.Object,java.lang.Object> getObjectHeaders()

Specified by:

getObjectHeaders in interface InterlokMessage

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()

getNextServiceId

public java.lang.String getNextServiceId()

Description copied from interface: AdaptrisMessage

Returns the unique ID of the next Service to apply to the message. Optional, used by BranchingServiceCollection and possibly others later.

Specified by:

getNextServiceId in interface AdaptrisMessage

Returns:

the unique ID of the next Service to apply

See Also:

AdaptrisMessage.getNextServiceId()

setNextServiceId

public void setNextServiceId(java.lang.String s)

Description copied from interface: AdaptrisMessage

Sets the unique ID of the next Service to apply to the message.

Specified by:

setNextServiceId in interface AdaptrisMessage

Parameters:

s - the unique ID of the next Service to apply to the message

resolve

public java.lang.String resolve(java.lang.String s,
                                boolean dotAll)

Specified by:

resolve in interface InterlokMessage

getMetadataValueIgnoreKeyCase

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

Description copied from interface: AdaptrisMessage

First looks for a metadata value stored against the passed key taking account of the passed key's case. If a value is found it is returned. Next looks for a metadata value stored against the passed key ignoring. The valued stored against the first key which matches the passed key ignoring case is returned. As the underlying store is unordered, which key will match first is undefined. If no key matches the passed key ignoring case, null is returned.

E.g. where a message has the metdadata values "1" and "2" set against keys "AAA" and "aaa" respectively, calling getMetadataValueIgnoreKeyCase("AAA") will return "1', calling getMetadataValueIgnoreKeyCase("aaa") will return "2', and calling getMetadataValueIgnoreKeyCase("aAA") will return either "1' or "2".

Specified by:

getMetadataValueIgnoreKeyCase in interface AdaptrisMessage

Parameters:

key - the key to look for

Returns:

the value associated with the key or null

See Also:

#getMetadataValueIgnoreKeyCase(java.lang.String)

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Description copied from interface: AdaptrisMessage

Returns a deep clone of this object.

Specified by:

clone in interface AdaptrisMessage

Overrides:

clone in class java.lang.Object

Returns:

a deep clone of this object

Throws:

java.lang.CloneNotSupportedException - if the implementation does not support cloning

See Also:

Object.clone()

copyPayload

@Deprecated
public static void copyPayload(AdaptrisMessage src,
                                           AdaptrisMessage dest)
                                    throws java.io.IOException

Deprecated. since 3.11.0 use MessageHelper#copyPayload(AdaptrisMessage, AdaptrisMessage) instead.

Copy the payload from one AdaptrisMessage to another.

Throws:

java.io.IOException