org.osid.transport

Interface OutboundStreamSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface OutboundStreamSession
extends OsidSession

The outbound stream session is used to send and receive arbitrary data to and from a remote end point. The methods accept and return a data stream. Some protocols may send or receive all data within a single stream while others may use the streams as channels or frames of data.

A stream may be available for reading before all the data as arrived and as such multiple streams may be processed simultaneously.

Method Summary

Methods

Modifier and Type	Method and Description
Endpoint	getEndpoint() Gets the Endpoint associated with this session.
Id	getEndpointId() Gets the Endpoint Id associated with this session.
boolean	hasDataAvailable() Tests to see if an input stream is available for retrieval.
DataInputStream	receiveData() Receives data from the remote transport endpoint.
DataOutputStream	sendData() Sends data to the remote transport endpoint.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getEndpointId

Id getEndpointId()

Gets the Endpoint Id associated with this session.

Returns:

the Endpoint Id associated with this session

Compliance:

mandatory - This method must be implemented.

getEndpoint

Endpoint getEndpoint()
                     throws OperationFailedException,
                            PermissionDeniedException

Gets the Endpoint associated with this session.

Returns:

the Endpoint associated with this session

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

sendData

DataOutputStream sendData()
                          throws OperationFailedException

Sends data to the remote transport endpoint.

Returns:

the output stream in which to send data

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

hasDataAvailable

boolean hasDataAvailable()

Tests to see if an input stream is available for retrieval.

Returns:

true if a stream is available for reading, false otherwise

Compliance:

mandatory - This method must be implemented.

receiveData

DataInputStream receiveData()
                            throws OperationFailedException

Receives data from the remote transport endpoint.

Returns:

the input stream containing the received data

Throws:

IllegalStateException - hasDataAvailable() is false

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.