com.adaptris.core

Class MultiPayloadMessageFactory

java.lang.Object

com.adaptris.core.AdaptrisMessageFactory

com.adaptris.core.MultiPayloadMessageFactory

public class MultiPayloadMessageFactory
extends AdaptrisMessageFactory

The multi-payload message factory which returns an implementations of MultiPayloadAdaptrisMessage.

 <message-factory class="multi-payload-message-factory">
   <default-char-encoding>UTF-8</default-char-encoding>
   <default-payload-id>payload-1</default-payload-id>
 </message-factory>
 

Since:

3.9.x

See Also:

AdaptrisMessageFactory, MultiPayloadAdaptrisMessage

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

Constructor Summary

Constructors

Constructor and Description
MultiPayloadMessageFactory()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDefaultCharEncoding() Return the default character encoding for the message.
java.lang.String	getDefaultPayloadId() Get the default payload ID.
AdaptrisMessage	newMessage() Returns a new AdaptrisMessage.
AdaptrisMessage	newMessage(AdaptrisMessage source, java.util.Collection<java.lang.String> metadataKeysToPreserve) Returns a new AdaptrisMessage with an empty payload but with selected metadata from the source.
AdaptrisMessage	newMessage(byte[] payload) Returns a new AdaptrisMessage with the specified payload and metadata.
AdaptrisMessage	newMessage(byte[] payload, java.util.Set metadata) Returns a new AdaptrisMessage with the specified payload and metadata.
AdaptrisMessage	newMessage(java.lang.String payload) Returns a new AdaptrisMessage with the specified payload and metadata.
AdaptrisMessage	newMessage(@NotNull java.lang.String payloadId, AdaptrisMessage source, java.util.Collection<java.lang.String> metadataKeysToPreserve)
AdaptrisMessage	newMessage(@NotNull java.lang.String payloadId, byte[] payload)
AdaptrisMessage	newMessage(@NotNull java.lang.String payloadId, byte[] payload, java.util.Set metadata) Create a new multi-payload message, with the given ID, payload, and metadata.
AdaptrisMessage	newMessage(java.lang.String payload, java.util.Set metadata) Returns a new AdaptrisMessage with the specified payload and metadata.
AdaptrisMessage	newMessage(java.lang.String payload, java.lang.String charEncoding) Returns a new AdaptrisMessage with the specified payload and metadata.
AdaptrisMessage	newMessage(java.lang.String payload, java.lang.String charEncoding, java.util.Set metadata) Returns a new AdaptrisMessage with the specified payload and metadata.
AdaptrisMessage	newMessage(@NotNull java.lang.String payloadId, java.lang.String content, java.lang.String charEncoding) Create a new multi-payload message, with the given ID, and payload.
AdaptrisMessage	newMessage(@NotNull java.lang.String payloadId, java.lang.String content, java.lang.String charEncoding, java.util.Set metadata) Create a new multi-payload message, with the given ID, payload, and metadata.
void	setDefaultCharEncoding(java.lang.String s) Set the default character encoding to be applied to the message upon creation.
void	setDefaultPayloadId(java.lang.String defaultPayloadId) Set the default payload ID.

Methods inherited from class com.adaptris.core.AdaptrisMessageFactory

defaultIfNull, getDefaultInstance, getUniqueIdGenerator, setUniqueIdGenerator, uniqueIdGenerator

Methods inherited from class java.lang.Object

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

Constructor Detail

MultiPayloadMessageFactory

public MultiPayloadMessageFactory()

Method Detail

newMessage

public AdaptrisMessage newMessage(byte[] payload)

Returns a new AdaptrisMessage with the specified payload and metadata.

.

Specified by:

newMessage in class AdaptrisMessageFactory

Parameters:

payload - the byte[] payload

Returns:

a new AdaptrisMessage

newMessage

public AdaptrisMessage newMessage(@NotNull
                                  @NotNull java.lang.String payloadId,
                                  byte[] payload)

newMessage

public AdaptrisMessage newMessage(byte[] payload,
                                  java.util.Set metadata)

Returns a new AdaptrisMessage with the specified payload and metadata.

.

Specified by:

newMessage in class AdaptrisMessageFactory

Parameters:

payload - the byte[] payload

metadata - a Set of MetadataElements

Returns:

a new AdaptrisMessage

newMessage

public AdaptrisMessage newMessage(@NotNull
                                  @NotNull java.lang.String payloadId,
                                  byte[] payload,
                                  java.util.Set metadata)

Create a new multi-payload message, with the given ID, payload, and metadata.

Parameters:

payloadId - The payload ID to use.

payload - The payload.

metadata - Any metadata.

Returns:

The new multi-payload message.

newMessage

public AdaptrisMessage newMessage(java.lang.String payload)

Returns a new AdaptrisMessage with the specified payload and metadata. Uses default platform character encoding.

.

Specified by:

newMessage in class AdaptrisMessageFactory

Parameters:

payload - the String payload

Returns:

a new AdaptrisMessage

newMessage

public AdaptrisMessage newMessage(java.lang.String payload,
                                  java.lang.String charEncoding)

Returns a new AdaptrisMessage with the specified payload and metadata. Uses default platform character encoding.

.

Specified by:

newMessage in class AdaptrisMessageFactory

Parameters:

payload - the String payload

charEncoding - the String's character encoding

Returns:

a new AdaptrisMessage

newMessage

public AdaptrisMessage newMessage(java.lang.String payload,
                                  java.util.Set metadata)

Returns a new AdaptrisMessage with the specified payload and metadata. Uses default platform character encoding.

.

Specified by:

newMessage in class AdaptrisMessageFactory

Parameters:

payload - the String payload

metadata - a Set of MetadataElements

Returns:

a new AdaptrisMessage

newMessage

public AdaptrisMessage newMessage(java.lang.String payload,
                                  java.lang.String charEncoding,
                                  java.util.Set metadata)

Returns a new AdaptrisMessage with the specified payload and metadata. Uses default platform character encoding.

.

Specified by:

newMessage in class AdaptrisMessageFactory

Parameters:

payload - the String payload

charEncoding - the String's character encoding

metadata - a Set of MetadataElements

Returns:

a new AdaptrisMessage

newMessage

public AdaptrisMessage newMessage(@NotNull
                                  @NotNull java.lang.String payloadId,
                                  java.lang.String content,
                                  java.lang.String charEncoding)

Create a new multi-payload message, with the given ID, and payload.

Parameters:

payloadId - The payload ID to use.

content - The payload content.

charEncoding - The content encoding.

Returns:

The new multi-payload message.

newMessage

public AdaptrisMessage newMessage(@NotNull
                                  @NotNull java.lang.String payloadId,
                                  java.lang.String content,
                                  java.lang.String charEncoding,
                                  java.util.Set metadata)

Create a new multi-payload message, with the given ID, payload, and metadata.

Parameters:

payloadId - The payload ID to use.

content - The payload content.

charEncoding - The content encoding.

metadata - Any metadata.

Returns:

The new multi-payload message.

newMessage

public AdaptrisMessage newMessage(AdaptrisMessage source,
                                  java.util.Collection<java.lang.String> metadataKeysToPreserve)
                           throws java.lang.CloneNotSupportedException

Returns a new AdaptrisMessage with an empty payload but with selected metadata from the source.

The new AdaptrisMessage will have the same message id and MessageLifecycleEvent will be cloned from the original. Object metadata will also be preserved.

.

Specified by:

newMessage in class AdaptrisMessageFactory

Parameters:

source - the original AdaptrisMessage

metadataKeysToPreserve - a list of keys to transfer to the new Message; if null, then all keys.

Returns:

a new AdaptrisMessage

Throws:

java.lang.CloneNotSupportedException - if the MleMarkers could not be cloned.

newMessage

public AdaptrisMessage newMessage(@NotNull
                                  @NotNull java.lang.String payloadId,
                                  AdaptrisMessage source,
                                  java.util.Collection<java.lang.String> metadataKeysToPreserve)
                           throws java.lang.CloneNotSupportedException

Throws:

java.lang.CloneNotSupportedException

newMessage

public AdaptrisMessage newMessage()

Returns a new AdaptrisMessage. Payload and metadata are null.

.

Specified by:

newMessage in class AdaptrisMessageFactory

Returns:

a new AdaptrisMessage with the specified payload and metadata

getDefaultCharEncoding

public java.lang.String getDefaultCharEncoding()

Description copied from class: AdaptrisMessageFactory

Return the default character encoding for the message.

Specified by:

getDefaultCharEncoding in class AdaptrisMessageFactory

Returns:

the defaultCharEncoding

setDefaultCharEncoding

public void setDefaultCharEncoding(java.lang.String s)

Set the default character encoding to be applied to the message upon creation.

If not explicitly configured, then the platform default character encoding will be used.

Specified by:

setDefaultCharEncoding in class AdaptrisMessageFactory

Parameters:

s - the defaultCharEncoding to set

See Also:

AdaptrisMessage.setCharEncoding(String)

getDefaultPayloadId

public java.lang.String getDefaultPayloadId()

Get the default payload ID.

Returns:

The default payload ID.

setDefaultPayloadId

public void setDefaultPayloadId(java.lang.String defaultPayloadId)

Set the default payload ID.

Parameters:

defaultPayloadId - The default payload ID.