Module jakarta.resource

Package jakarta.resource.cci

Interface Streamable

public interface Streamable

Streamable interface enables a resource adapter to extract data from an input Record or set data into an output Record as a stream of bytes.

The Streamable interface provides a resource adapter's view of the data that has been set in a Record instance by a component.

The Streamable interface is not directly used by a component. It is used by a resource adapter implementation. A component uses Record or any derived interfaces to manage records.

Since:

0.8

See Also:

• Record

Method Summary

Modifier and Type	Method	Description
void	read(InputStream istream)	Read data from an InputStream and initialize fields of a Streamable object.
void	write(OutputStream ostream)	Write fields of a Streamable object to an OutputStream

Method Details

read

void read(InputStream istream)
   throws IOException

Read data from an InputStream and initialize fields of a Streamable object.

Parameters:

istream - InputStream that represents a resource adapter specific internal representation of fields of a Streamable object

Throws:

IOException - if there is an error reading from the stream

write

void write(OutputStream ostream)
    throws IOException

Write fields of a Streamable object to an OutputStream

Parameters:

ostream - OutputStream that holds value of a Streamable object

Throws:

IOException - if there is an error writing to the stream