com.adaptris.core

Class MultiPayloadAdaptrisMessageImp

java.lang.Object

com.adaptris.core.AdaptrisMessageImp

com.adaptris.core.MultiPayloadAdaptrisMessageImp

All Implemented Interfaces:

AdaptrisMessage, MultiPayloadAdaptrisMessage, InterlokMessage, java.lang.Cloneable

public class MultiPayloadAdaptrisMessageImp
extends AdaptrisMessageImp
implements MultiPayloadAdaptrisMessage

The standard implementation of multi-payload messages; MultiPayloadAdaptrisMessage implementation created by MultiPayloadMessageFactory.

Since:

3.9.x

See Also:

MultiPayloadAdaptrisMessage, MultiPayloadMessageFactory, AdaptrisMessageImp

Field Summary

Fields inherited from interface com.adaptris.core.MultiPayloadAdaptrisMessage

DEFAULT_PAYLOAD_ID

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MultiPayloadAdaptrisMessageImp(@NotNull java.lang.String payloadId, IdGenerator guid, AdaptrisMessageFactory messageFactory)
protected	MultiPayloadAdaptrisMessageImp(@NotNull java.lang.String payloadId, IdGenerator guid, AdaptrisMessageFactory messageFactory, byte[] payload)
protected	MultiPayloadAdaptrisMessageImp(@NotNull java.lang.String payloadId, IdGenerator guid, AdaptrisMessageFactory messageFactory, java.lang.String content, java.nio.charset.Charset encoding)

Method Summary

Modifier and Type	Method and Description
void	addContent(@NotNull java.lang.String payloadId, java.lang.String payloadString) Add a new payload to the message, with the given ID and content.
void	addContent(@NotNull java.lang.String payloadId, java.lang.String payloadString, java.lang.String charEnc) Add a new payload to the message, with the given ID and content and encoding.
void	addPayload(@NotNull java.lang.String payloadId, byte[] bytes) Add a new payload to the message, with the given ID and data.
java.lang.Object	clone() Returns a deep clone of this object.
void	deletePayload(@NotNull java.lang.String payloadId) Delete an existing payload, with the given payload ID.
boolean	equivalentForTracking(AdaptrisMessage o) AdaptrisMessage's are equivalent for tracking if they have the same unique Id, their payloads are equal, their char encodings are equal and their metadata is equal.
java.lang.String	getContent() Get the current payload content.
java.lang.String	getContent(@NotNull java.lang.String payloadId) Get the payload content for the given ID.
java.lang.String	getContentEncoding() .
java.lang.String	getContentEncoding(@NotNull java.lang.String payloadId) Get the content encoding for the given payload ID.
java.lang.String	getCurrentPayloadId() Get the ID of the current payload.
java.io.InputStream	getInputStream()
java.io.InputStream	getInputStream(@NotNull java.lang.String payloadId) Get the input stream for the given payload ID.
java.io.OutputStream	getOutputStream()
java.io.OutputStream	getOutputStream(@NotNull java.lang.String payloadId) Get the output stream for the given payload ID.
byte[]	getPayload() Get the current payload data.
byte[]	getPayload(@NotNull java.lang.String payloadId) Get the payload data for the given ID.
int	getPayloadCount() Return the number of payloads contained within the message.
java.util.Set<java.lang.String>	getPayloadIDs() Get the payload IDs used within this message.
long	getSize() Get the current payload size.
long	getSize(@NotNull java.lang.String payloadId) Get the size of the payload for the given ID.
boolean	hasPayloadId(@NotNull java.lang.String payloadId) Indicates whether the given payload ID exists in the message.
java.lang.String	resolve(java.lang.String s, boolean dotAll) Resolve against this message's payloads or metadata.
void	setContent(java.lang.String payloadString, java.lang.String charEnc) Set the current payload content.
void	setContentEncoding(java.lang.String enc) .
void	setContentEncoding(@NotNull java.lang.String payloadId, java.lang.String enc) Set the payload content encoding for the given payload ID.
void	setCurrentPayloadId(@NotNull java.lang.String payloadId) Update the ID of the current payload.
void	setPayload(byte[] bytes) Set the current payload data.
void	switchPayload(@NotNull java.lang.String payloadId) Switch from one payload to another, given by the ID.

Methods inherited from class com.adaptris.core.AdaptrisMessageImp

addEvent, addMessageHeader, addMetadata, addMetadata, addObjectHeader, areEqual, clearMetadata, copyPayload, encode, getFactory, getMessageHeaders, getMessageLifecycleEvent, getMetadata, getMetadata, getMetadataValue, getMetadataValueIgnoreKeyCase, getNextServiceId, getObjectHeaders, getReader, getUniqueId, getWriter, getWriter, headersContainsKey, removeMessageHeader, removeMetadata, setMessageHeaders, setMetadata, setNextServiceId, setUniqueId, toString, toString, 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

addEvent, addMetadata, addMetadata, addObjectMetadata, clearMetadata, containsKey, encode, getCharEncoding, getFactory, getMessageLifecycleEvent, getMetadata, getMetadata, getMetadataValue, getMetadataValueIgnoreKeyCase, getNextServiceId, getObjectMetadata, getPayloadForLogging, getStringPayload, removeMetadata, setCharEncoding, setMetadata, setNextServiceId, setStringPayload, setStringPayload, toString, toString

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

addMessageHeader, addObjectHeader, getMessageHeaders, getObjectHeaders, getReader, getUniqueId, getWriter, getWriter, headersContainsKey, removeMessageHeader, resolve, setMessageHeaders, setUniqueId, wrap

Constructor Detail

MultiPayloadAdaptrisMessageImp

protected MultiPayloadAdaptrisMessageImp(@NotNull
                                         @NotNull java.lang.String payloadId,
                                         IdGenerator guid,
                                         AdaptrisMessageFactory messageFactory)

MultiPayloadAdaptrisMessageImp

protected MultiPayloadAdaptrisMessageImp(@NotNull
                                         @NotNull java.lang.String payloadId,
                                         IdGenerator guid,
                                         AdaptrisMessageFactory messageFactory,
                                         byte[] payload)

MultiPayloadAdaptrisMessageImp

protected MultiPayloadAdaptrisMessageImp(@NotNull
                                         @NotNull java.lang.String payloadId,
                                         IdGenerator guid,
                                         AdaptrisMessageFactory messageFactory,
                                         java.lang.String content,
                                         java.nio.charset.Charset encoding)

Method Detail

switchPayload

public void switchPayload(@NotNull
                          @NotNull java.lang.String payloadId)

Switch from one payload to another, given by the ID..

Specified by:

switchPayload in interface MultiPayloadAdaptrisMessage

Parameters:

payloadId - The ID of the payload to switch to.

hasPayloadId

public boolean hasPayloadId(@NotNull
                            @NotNull java.lang.String payloadId)

Indicates whether the given payload ID exists in the message..

Specified by:

hasPayloadId in interface MultiPayloadAdaptrisMessage

Parameters:

payloadId - The payload ID to check.

Returns:

True if there's a payload with the given ID, false otherwise.

setCurrentPayloadId

public void setCurrentPayloadId(@NotNull
                                @NotNull java.lang.String payloadId)

Update the ID of the current payload. This does not change the current working payload, rather updates the ID of the current working payload..

Specified by:

setCurrentPayloadId in interface MultiPayloadAdaptrisMessage

Parameters:

payloadId - The new payload ID.

getCurrentPayloadId

public java.lang.String getCurrentPayloadId()

Get the ID of the current payload..

Specified by:

getCurrentPayloadId in interface MultiPayloadAdaptrisMessage

Returns:

The payload ID.

getPayloadIDs

public java.util.Set<java.lang.String> getPayloadIDs()

Get the payload IDs used within this message..

Specified by:

getPayloadIDs in interface MultiPayloadAdaptrisMessage

Returns:

The payload IDs.

equivalentForTracking

public boolean equivalentForTracking(AdaptrisMessage o)

Description copied from interface: AdaptrisMessage

AdaptrisMessage's are equivalent for tracking if they have the same unique Id, their payloads are equal, their char encodings are equal and their metadata is equal. NB equality of metadata is based on key only.

Specified by:

equivalentForTracking in interface AdaptrisMessage

Parameters:

o - the message to compare

Returns:

true if the passed message is equivalent for tracking

See Also:

(com.adaptris.core.AdaptrisMessage).

setPayload

public void setPayload(byte[] bytes)

Set the current payload data.

Specified by:

setPayload in interface AdaptrisMessage

Parameters:

bytes - The payload data.

See Also:

AdaptrisMessage.setPayload(byte[])

addPayload

public void addPayload(@NotNull
                       @NotNull java.lang.String payloadId,
                       byte[] bytes)

Add a new payload to the message, with the given ID and data..

Specified by:

addPayload in interface MultiPayloadAdaptrisMessage

Parameters:

payloadId - The new payload ID.

bytes - The payload data.

deletePayload

public void deletePayload(@NotNull
                          @NotNull java.lang.String payloadId)

Delete an existing payload, with the given payload ID..

Specified by:

deletePayload in interface MultiPayloadAdaptrisMessage

Parameters:

payloadId - The payload ID.

getPayload

public byte[] getPayload()

Get the current payload data.

Specified by:

getPayload in interface AdaptrisMessage

Returns:

The payload data.

See Also:

AdaptrisMessage.getPayload()

getPayload

public byte[] getPayload(@NotNull
                         @NotNull java.lang.String payloadId)

Get the payload data for the given ID..

Specified by:

getPayload in interface MultiPayloadAdaptrisMessage

Parameters:

payloadId - The payload ID.

Returns:

The payload data.

getSize

public long getSize()

Get the current payload size.

Specified by:

getSize in interface AdaptrisMessage

Returns:

The payload size.

See Also:

AdaptrisMessage.getSize()

getPayloadCount

public int getPayloadCount()

Return the number of payloads contained within the message..

Specified by:

getPayloadCount in interface MultiPayloadAdaptrisMessage

Returns:

The number of payloads.

getSize

public long getSize(@NotNull
                    @NotNull java.lang.String payloadId)

Get the size of the payload for the given ID..

Specified by:

getSize in interface MultiPayloadAdaptrisMessage

Parameters:

payloadId - The payload ID.

Returns:

The payload size.

setContent

public void setContent(java.lang.String payloadString,
                       java.lang.String charEnc)

Set the current payload content.

Specified by:

setContent in interface InterlokMessage

Parameters:

payloadString - The payload content.

charEnc - The content encoding.

See Also:

InterlokMessage.setContent(String, String)

addContent

public void addContent(@NotNull
                       @NotNull java.lang.String payloadId,
                       java.lang.String payloadString)

Add a new payload to the message, with the given ID and content..

Specified by:

addContent in interface MultiPayloadAdaptrisMessage

Parameters:

payloadId - The new payload ID.

payloadString - The payload content.

addContent

public void addContent(@NotNull
                       @NotNull java.lang.String payloadId,
                       java.lang.String payloadString,
                       java.lang.String charEnc)

Add a new payload to the message, with the given ID and content and encoding..

Specified by:

addContent in interface MultiPayloadAdaptrisMessage

Parameters:

payloadId - The new payload ID.

payloadString - The payload content.

charEnc - The content encoding.

getContent

public java.lang.String getContent()

Get the current payload content.

Specified by:

getContent in interface InterlokMessage

Returns:

The payload content.

See Also:

InterlokMessage.getContent()

getContent

public java.lang.String getContent(@NotNull
                                   @NotNull java.lang.String payloadId)

Get the payload content for the given ID..

Specified by:

getContent in interface MultiPayloadAdaptrisMessage

Parameters:

payloadId - The payload ID.

Returns:

The payload content.

setContentEncoding

public void setContentEncoding(java.lang.String enc)

.

Specified by:

setContentEncoding in interface InterlokMessage

Overrides:

setContentEncoding in class AdaptrisMessageImp

See Also:

InterlokMessage.setContentEncoding(String)

setContentEncoding

public void setContentEncoding(@NotNull
                               @NotNull java.lang.String payloadId,
                               java.lang.String enc)

Set the payload content encoding for the given payload ID..

Specified by:

setContentEncoding in interface MultiPayloadAdaptrisMessage

Parameters:

payloadId - The payload ID.

enc - The content encoding.

getContentEncoding

public java.lang.String getContentEncoding()

.

Specified by:

getContentEncoding in interface InterlokMessage

Overrides:

getContentEncoding in class AdaptrisMessageImp

See Also:

InterlokMessage.getContentEncoding()

getContentEncoding

public java.lang.String getContentEncoding(@NotNull
                                           @NotNull java.lang.String payloadId)

Get the content encoding for the given payload ID..

Specified by:

getContentEncoding in interface MultiPayloadAdaptrisMessage

Parameters:

payloadId - The payload ID.

Returns:

The content encoding.

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 AdaptrisMessageImp

Returns:

a deep clone of this object

Throws:

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

See Also:

Object.clone()

getInputStream

public java.io.InputStream getInputStream()

Specified by:

getInputStream in interface InterlokMessage

See Also:

InterlokMessage.getInputStream()

getInputStream

public java.io.InputStream getInputStream(@NotNull
                                          @NotNull java.lang.String payloadId)

Get the input stream for the given payload ID..

Specified by:

getInputStream in interface MultiPayloadAdaptrisMessage

Parameters:

payloadId - The payload ID.

Returns:

The payload input stream.

getOutputStream

public java.io.OutputStream getOutputStream()

Specified by:

getOutputStream in interface InterlokMessage

See Also:

InterlokMessage.getOutputStream()

getOutputStream

public java.io.OutputStream getOutputStream(@NotNull
                                            @NotNull java.lang.String payloadId)

Get the output stream for the given payload ID..

Specified by:

getOutputStream in interface MultiPayloadAdaptrisMessage

Parameters:

payloadId - The payload ID.

Returns:

The payload output stream.

resolve

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

Resolve against this message's payloads or metadata.

This is a helper method that allows you to pass in %payload_id{pl1} and get the payload associated with pl1, or %message{key1} and get the metadata associated with key1. Strings that do not match that format will be returned as is. Support for punctuation characters is down to the implementation; the standard implementations only support a limited subset of punctuation characters in addition to standard word characters ([a-zA-Z_0-9]); they are _!"#&'+,-.:=. The magic values %message{%uniqueId} and %message{%size} should return the message unique-id and message size respectively

Specified by:

resolve in interface InterlokMessage

Overrides:

resolve in class AdaptrisMessageImp

Parameters:

s - The string to resolve.

dotAll - Whether to resolve in Pattern.DOTALL mode, allowing you to match against multiple lines.

Returns:

The original string, the matched payload, an item of metadata, or null (if none exists).