com.adaptris.core.common

Class MultiPayloadByteArrayOutputParameter

java.lang.Object

com.adaptris.core.common.ByteArrayPayloadDataOutputParameter

com.adaptris.core.common.MultiPayloadByteArrayOutputParameter

All Implemented Interfaces:

DataOutputParameter<byte[]>

public class MultiPayloadByteArrayOutputParameter
extends ByteArrayPayloadDataOutputParameter
implements DataOutputParameter<byte[]>

This MultiPayloadDataOutputParameter is used when you want to insert data into the MultiPayloadAdaptrisMessage payload.

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

Constructor Summary

Constructors

Constructor and Description
MultiPayloadByteArrayOutputParameter()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getPayloadId() Get the ID of the payload to extract.
void	insert(byte[] data, InterlokMessage m) .
void	insert(byte[] data, java.lang.String id, MultiPayloadAdaptrisMessage m) Insert the data into the multi-payload message for the given payload ID.
void	setPayloadId(java.lang.String payloadId) Set the ID of the payload to extract.

Methods inherited from class java.lang.Object

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

Constructor Detail

MultiPayloadByteArrayOutputParameter

public MultiPayloadByteArrayOutputParameter()

Method Detail

getPayloadId

public java.lang.String getPayloadId()

Get the ID of the payload to extract.

Returns:

The payload ID.

setPayloadId

public void setPayloadId(java.lang.String payloadId)

Set the ID of the payload to extract.

Parameters:

payloadId - The payload ID.

insert

public void insert(byte[] data,
                   InterlokMessage m)
            throws InterlokException

.

Specified by:

insert in interface DataOutputParameter<byte[]>

Overrides:

insert in class ByteArrayPayloadDataOutputParameter

Throws:

InterlokException

insert

public void insert(byte[] data,
                   java.lang.String id,
                   MultiPayloadAdaptrisMessage m)

Insert the data into the multi-payload message for the given payload ID.

Parameters:

data - The data to insert.

id - The payload ID.

m - The multi-payload message.