com.boomi.connector.api

Class BasePayload

java.lang.Object

com.boomi.connector.api.BasePayload

All Implemented Interfaces:

ExtendedPayload, Payload, Closeable, AutoCloseable

Direct Known Subclasses:

JsonPayloadUtil

public class BasePayload
extends Object
implements ExtendedPayload

Convenience base class for Payload implementations. None of the base methods do anything.

Constructor Summary

Constructors

Constructor and Description
BasePayload()

Method Summary

Modifier and Type	Method and Description
void	close()
PayloadMetadata	getMetadata() Returns a valid PayloadMetadata for this payload, or null if no metadata is provided.
InputStream	readFrom() Returns a valid InputStream for this payload, or null if not supported.
void	writeTo(OutputStream out) Writes the payload data to the given OutputStream.

Methods inherited from class java.lang.Object

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

Constructor Detail

BasePayload

public BasePayload()

Method Detail

readFrom

public InputStream readFrom()
                     throws IOException

Description copied from interface: Payload

Returns a valid InputStream for this payload, or null if not supported. If this method returns a valid InputStream, Payload.writeTo(java.io.OutputStream) will never be called.

Specified by:

readFrom in interface Payload

Throws:

IOException

writeTo

public void writeTo(OutputStream out)
             throws IOException

Description copied from interface: Payload

Writes the payload data to the given OutputStream. If Payload.readFrom() returns null, this method must be implemented.

Specified by:

writeTo in interface Payload

Parameters:

out - non-null output stream to which to write the payload data

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

getMetadata

public PayloadMetadata getMetadata()

Description copied from interface: ExtendedPayload

Returns a valid PayloadMetadata for this payload, or null if no metadata is provided.

Specified by:

getMetadata in interface ExtendedPayload