MultiPayloadByteArrayInputParameter (Interlok Core/Base)

java.lang.Object
- com.adaptris.core.common.MultiPayloadByteArrayInputParameter

All Implemented Interfaces:

DataInputParameter<byte[]>
```
public class MultiPayloadByteArrayInputParameter
extends java.lang.Object
implements DataInputParameter<byte[]>
```
This MultiPayloadDataInputParameter is used when you want to source data from the MultiPayloadAdaptrisMessage payload.

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

Constructor Summary

Constructors
Constructor Description

MultiPayloadByteArrayInputParameter()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`byte[]`	`extract(InterlokMessage m)`	.
`byte[]`	`extract(java.lang.String id, MultiPayloadAdaptrisMessage m)`	Extract the payload with the given ID from the multi-payload message.
`java.lang.String`	`getPayloadId()`	Get the ID of the payload to extract.
`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
  - MultiPayloadByteArrayInputParameter
```
public MultiPayloadByteArrayInputParameter()
```
- 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.
  - extract
```
public byte[] extract(InterlokMessage m)
               throws InterlokException
```
    .
    
    Specified by:
    
    extract in interface DataInputParameter<byte[]>
    
    Throws:
    
    InterlokException
  - extract
```
public byte[] extract(java.lang.String id,
                      MultiPayloadAdaptrisMessage m)
```
    Extract the payload with the given ID from the multi-payload message.
    
    Parameters:
    
    id - The payload ID.
    
    m - The multi-payload message.
    
    Returns:
    
    The extracted payload.