Interface InboundMessageSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface InboundMessageSession
extends OsidSession

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

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

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.

registerCallback

void registerCallback(MessageReceiver receiver)
               throws OperationFailedException

Registers a callback to receive incoming data.

Parameters:

receiver - a message receievr

Throws:

NullArgumentException - receiver is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.