Interface TransportManager

All Superinterfaces:

AutoCloseable, Closeable, OsidManager, OsidManager, OsidProfile, Sourceable, TransportProfile

public interface TransportManager
extends OsidManager, TransportProfile

This manager provides access to the sessions defined in this service. The outbound sessions are used to connect to a remote endpoint and the inbound sessions are used to receive incoming connections.

The two flavors of transport are stream and message oriented. Messages offer more structured requests and responses although their structure may include embedded streams.

Method Summary

Modifier and Type	Method	Description
EndpointLookupSession	getEndpointLookupSession()	Gets the endpoint lookup service.
InboundMessageSession	getInboundMessageSession(MessageReceiver messageReceiver)	Gets a service for inbound message transport.
InboundMessageSession	getInboundMessageSessionForEndpoint(MessageReceiver messageReceiver, Id endpointId)	Gets a service for inbound message transport using a specified Endpoint.
InboundStreamSession	getInboundStreamSession(StreamReceiver streamReceiver)	Gets a service for inbound stream transport.
InboundStreamSession	getInboundStreamSessionForEndpoint(StreamReceiver streamReceiver, Id endpointId)	Gets a service for inbound stream transport using a specified Endpoint .
OutboundMessageSession	getOutboundMessageSession()	Gets a service for outbound message transport.
OutboundMessageSession	getOutboundMessageSessionForEndpoint(Id endpointId)	Gets a service for outbound message transport using a specified Endpoint.
OutboundStreamSession	getOutboundStreamSession()	Gets a service for outbound stream transport.
OutboundStreamSession	getOutboundStreamSessionForEndpoint(Id endpointId)	Gets a service for outbound stream transport using a specified Endpoint .

Methods inherited from interface Closeable

close

Methods inherited from interface OsidManager

close

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

Methods inherited from interface OsidManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime)	Rolls back this service to a point in time.

Methods inherited from interface OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Methods inherited from interface TransportProfile

getEndpointRecordTypes, getRequestRecordTypes, getResponseRecordTypes, supportsEndpointLookup, supportsEndpointRecordType, supportsInboundMessage, supportsInboundStream, supportsOutboundMessage, supportsOutboundStream, supportsRequestRecordType, supportsResponseRecordType, supportsVisibleFederation

Modifier and Type	Method	Description
TypeList	getEndpointRecordTypes()	Gets a list of supported endpoint record types.
TypeList	getRequestRecordTypes()	Gets a list of supported request record types.
TypeList	getResponseRecordTypes()	Gets a list of supported response record types.
boolean	supportsEndpointLookup()	Tests if endpoint lookup is supported.
boolean	supportsEndpointRecordType(Type endpointRecordType)	Tests if an endpoint record type is supported.
boolean	supportsInboundMessage()	Tests if inbound message transport is supported.
boolean	supportsInboundStream()	Tests if inbound stream transport is supported.
boolean	supportsOutboundMessage()	Tests if outbound message transport is supported.
boolean	supportsOutboundStream()	Tests if outbound stream transport is supported.
boolean	supportsRequestRecordType(Type requestRecordType)	Tests if a request record type is supported.
boolean	supportsResponseRecordType(Type responseRecordType)	Tests if a response record type is supported.
boolean	supportsVisibleFederation()	Tests if any transport endpoint federation is exposed.

Method Details

getOutboundStreamSession

OutboundStreamSession getOutboundStreamSession()
                                        throws OperationFailedException

Gets a service for outbound stream transport.

Returns:

an OutboundStreamSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsOutboundStream() is false

Compliance:

optional - This method must be implemented if {@code supportsOutboundStream()} is {@code true} .

getOutboundStreamSessionForEndpoint

OutboundStreamSession getOutboundStreamSessionForEndpoint(Id endpointId)
                                                   throws NotFoundException,
OperationFailedException

Gets a service for outbound stream transport using a specified Endpoint .

Parameters:

endpointId - a transport endpoint

Returns:

an OutboundStreamSession

Throws:

NotFoundException - endpointId is not found

NullArgumentException - endpointId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOutboundStream() or supportsVisibleFederationI() is false

Compliance:

optional - This method must be implemented if {@code supportsOutboundStream()} and {@code supportsVisibleFederation()} are {@code true} .

getInboundStreamSession

InboundStreamSession getInboundStreamSession(StreamReceiver streamReceiver)
                                      throws OperationFailedException

Gets a service for inbound stream transport.

Parameters:

streamReceiver - a stream receiver

Returns:

an InboundStreamSession

Throws:

NullArgumentException - streamReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInboundStream() is false

Compliance:

optional - This method must be implemented if {@code supportsInboundStream()} is {@code true} .

getInboundStreamSessionForEndpoint

InboundStreamSession getInboundStreamSessionForEndpoint(StreamReceiver streamReceiver,
 Id endpointId)
                                                 throws NotFoundException,
OperationFailedException

Gets a service for inbound stream transport using a specified Endpoint .

Parameters:

streamReceiver - a stream receiver

endpointId - a transport endpoint

Returns:

an InboundStreamSession

Throws:

NotFoundException - endpointId is not found

NullArgumentException - streamReceiver or endpointId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInboundStream() or supportsVisibleFederationI() is false

Compliance:

optional - This method must be implemented if {@code supportsInboundStream()} and {@code supportsVisibleFederation()} are {@code true} .

getOutboundMessageSession

OutboundMessageSession getOutboundMessageSession()
                                          throws OperationFailedException

Gets a service for outbound message transport.

Returns:

an OutboundMessageSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsOutboundMessage() is false

Compliance:

optional - This method must be implemented if {@code supportsOutboundMessage()} is {@code true} .

getOutboundMessageSessionForEndpoint

OutboundMessageSession getOutboundMessageSessionForEndpoint(Id endpointId)
                                                     throws NotFoundException,
OperationFailedException

Gets a service for outbound message transport using a specified Endpoint.

Parameters:

endpointId - a transport endpoint

Returns:

an OutboundMessageSession

Throws:

NotFoundException - endpointId is not found

NullArgumentException - endpointId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOutboundMessage() or supportsVisibleFederationI() is false

Compliance:

optional - This method must be implemented if {@code supportsOutboundMessage()} and {@code supportsVisibleFederation()} are {@code true} .

getInboundMessageSession

InboundMessageSession getInboundMessageSession(MessageReceiver messageReceiver)
                                        throws OperationFailedException

Gets a service for inbound message transport.

Parameters:

messageReceiver - a message receiver

Returns:

an InboundMessageSession

Throws:

NullArgumentException - messageReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInboundMessage() is false

Compliance:

optional - This method must be implemented if {@code supportsInboundMessage()} is {@code true} .

getInboundMessageSessionForEndpoint

InboundMessageSession getInboundMessageSessionForEndpoint(MessageReceiver messageReceiver,
 Id endpointId)
                                                   throws NotFoundException,
OperationFailedException

Gets a service for inbound message transport using a specified Endpoint.

Parameters:

messageReceiver - a message receiver

endpointId - a transport endpoint

Returns:

an InboundMessageSession

Throws:

NotFoundException - endpointId is not found

NullArgumentException - messageReceiver or endpointId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInboundMessage() or supportsVisibleFederationI() is false

Compliance:

optional - This method must be implemented if {@code supportsInboundMessage()} and {@code supportsVisibleFederation()} are true.

getEndpointLookupSession

EndpointLookupSession getEndpointLookupSession()
                                        throws OperationFailedException

Gets the endpoint lookup service.

Returns:

an EndpointLookupSesson

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsInbound() is false

Compliance:

optional - This method must be implemented if {@code supportsInbound()} is {@code true} .