org.osid.transport

Interface InboundStreamSession

All Superinterfaces:

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

public interface InboundStreamSession
extends OsidSession

The inbound stream session is used as a listener. A callback is registered using a StreamReceiver. The listener is closed when this session is closed.

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.
void	registerCallback(StreamReceiver receiver) Registers a callback to receive incoming data.

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.

registerCallback

void registerCallback(StreamReceiver receiver)
                      throws OperationFailedException

Registers a callback to receive incoming data.

Parameters:

receiver - a stream receievr

Throws:

NullArgumentException - receiver is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.