OSID Specifications
transport package
Version 3.0.0
Release Candidate Preview
transport package
Version 3.0.0
Release Candidate Preview
| Interface | osid.transport.TransportManager | ||
|---|---|---|---|
| Implements | osid.OsidManager | ||
osid.transport.TransportProfile | |||
| Description |
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 | getOutboundStreamSession | ||
| Description |
Gets a service for outbound stream transport. | ||
| Return | osid.transport.OutboundStreamSession | an OutboundStreamSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsOutboundStream() is false | ||
| Compliance | optional | This method must be implemented if supportsOutboundStream()
is true. | |
| Method | getOutboundStreamSessionForEndpoint | ||
| Description |
Gets a service for outbound stream transport using a
specified | ||
| Parameters | osid.id.Id | endpointId | a transport endpoint |
| Return | osid.transport.OutboundStreamSession | an OutboundStreamSession | |
| Errors | NOT_FOUND | endpointId is not found | |
| NULL_ARGUMENT | endpointId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsOutboundStream() or
supportsVisibleFederationI() is false | ||
| Compliance | optional | This method must be implemented if supportsOutboundStream()
and supportsVisibleFederation() are true. | |
| Method | getInboundStreamSession | ||
| Description |
Gets a service for inbound stream transport. | ||
| Parameters | osid.transport.StreamReceiver | streamReceiver | a stream receiver |
| Return | osid.transport.InboundStreamSession | an InboundStreamSession | |
| Errors | NULL_ARGUMENT | streamReceiver is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsInboundStream() is false | ||
| Compliance | optional | This method must be implemented if supportsInboundStream()
is true. | |
| Method | getInboundStreamSessionForEndpoint | ||
| Description |
Gets a service for inbound stream transport using a
specified | ||
| Parameters | osid.transport.StreamReceiver | streamReceiver | a stream receiver |
osid.id.Id | endpointId | a transport endpoint | |
| Return | osid.transport.InboundStreamSession | an InboundStreamSession | |
| Errors | NOT_FOUND | endpointId is not found | |
| NULL_ARGUMENT | streamReceiver or endpointId is null
| ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsInboundStream() or
supportsVisibleFederationI() is false | ||
| Compliance | optional | This method must be implemented if supportsInboundStream()
and supportsVisibleFederation() are true. | |
| Method | getOutboundMessageSession | ||
| Description |
Gets a service for outbound message transport. | ||
| Return | osid.transport.OutboundMessageSession | an OutboundMessageSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsOutboundMessage() is false | ||
| Compliance | optional | This method must be implemented if supportsOutboundMessage()
is true. | |
| Method | getOutboundMessageSessionForEndpoint | ||
| Description |
Gets a service for outbound message transport using a specified Endpoint. | ||
| Parameters | osid.id.Id | endpointId | a transport endpoint |
| Return | osid.transport.OutboundMessageSession | an OutboundMessageSession | |
| Errors | NOT_FOUND | endpointId is not found | |
| NULL_ARGUMENT | endpointId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsOutboundMessage() or supportsVisibleFederationI() is false
| ||
| Compliance | optional | This method must be implemented if supportsOutboundMessage()
and supportsVisibleFederation() are true. | |
| Method | getInboundMessageSession | ||
| Description |
Gets a service for inbound message transport. | ||
| Parameters | osid.transport.MessageReceiver | messageReceiver | a message receiver |
| Return | osid.transport.InboundMessageSession | an InboundMessageSession | |
| Errors | NULL_ARGUMENT | messageReceiver is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsInboundMessage() is false | ||
| Compliance | optional | This method must be implemented if supportsInboundMessage()
is true. | |
| Method | getInboundMessageSessionForEndpoint | ||
| Description |
Gets a service for inbound message transport using a specified Endpoint. | ||
| Parameters | osid.transport.MessageReceiver | messageReceiver | a message receiver |
osid.id.Id | endpointId | a transport endpoint | |
| Return | osid.transport.InboundMessageSession | an InboundMessageSession | |
| Errors | NOT_FOUND | endpointId is not found | |
| NULL_ARGUMENT | messageReceiver or endpointId is null
| ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsInboundMessage() or supportsVisibleFederationI() is false
| ||
| Compliance | optional | This method must be implemented if supportsInboundMessage()
and supportsVisibleFederation() are true. | |
| Method | getEndpointLookupSession | ||
| Description |
Gets the endpoint lookup service. | ||
| Return | osid.transport.EndpointLookupSession | an EndpointLookupSesson | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsInbound() is false | ||
| Compliance | optional | This method must be implemented if supportsInbound() is
true. | |