Interface OutboundStreamSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, 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

Modifier and Type	Method	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 Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

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

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

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.