org.jitterbit.connector.sdk

Interface Payload

All Known Implementing Classes:

Payload.StringPayload

public interface Payload

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Payload.StringBufferOutputStream A default implementation of an output stream, as a string buffer combined with an output stream.
static class	Payload.StringPayload A default implementation of a payload.

Method Summary

Modifier and Type	Method and Description
void	close() Closes all open streams, both input and output.
String	getContent() Returns the content as a string.
InputStream	getInputStream() Returns a reference to the InputStream associated with this payload.
OutputStream	getOutputStream() Returns a reference to the OutputStream associated with this payload.
void	setContent(String content) Sets the content of the payload.

Method Detail

getContent

String getContent()

Returns the content as a string.

Returns:

the content as a string

setContent

void setContent(String content)

Sets the content of the payload.

Parameters:

content - the payload content

getInputStream

InputStream getInputStream()

Returns a reference to the InputStream associated with this payload. This input stream can be read from. Once data has been read (consumed), it can not be read again.

Returns:

the input stream

getOutputStream

OutputStream getOutputStream()

Returns a reference to the OutputStream associated with this payload. This can be used to write data to the payload. It is the responsibility of the caller to call close() or flush() on the output stream.

Returns:

the output stream

close

void close()
    throws IOException

Closes all open streams, both input and output.

Throws:

IOException - if there is an error while closing the streams