OSID Specifications
transport package
Version 3.1.0
transport package
Version 3.1.0
| Interface | osid.transport.TransportProxyManager | ||
|---|---|---|---|
| Implements | osid.OsidProxyManager | ||
osid.transport.TransportProfile | |||
| Used By | osid.orchestration.OrchestrationManager | ||
| 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. | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy |
| Return | osid.transport.OutboundStreamSession | an OutboundStreamSession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| 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 |
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.transport.OutboundStreamSession | an OutboundStreamSession | |
| Errors | NOT_FOUND | endpointId or proxy 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 |
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.transport.InboundStreamSession | an InboundStreamSession | |
| Errors | NULL_ARGUMENT | streamReceiver or proxy 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 | |
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.transport.InboundStreamSession | an InboundStreamSession | |
| Errors | NOT_FOUND | endpointId is not found | |
| NULL_ARGUMENT | streamReceiver, endpointId or porxy 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. | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy |
| Return | osid.transport.OutboundMessageSession | an OutboundMessageSession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| 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 |
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.transport.OutboundMessageSession | an OutboundMessageSession | |
| Errors | NOT_FOUND | endpointId is not found | |
| NULL_ARGUMENT | endpointId or proxy 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 |
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.transport.InboundMessageSession | an InboundMessageSession | |
| Errors | NULL_ARGUMENT | messageReceiver or proxy 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 | |
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.transport.InboundMessageSession | an InboundMessageSession | |
| Errors | NOT_FOUND | endpointId is not found | |
| NULL_ARGUMENT | messageReceiver, endpointId or proxy 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. | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy |
| Return | osid.transport.EndpointLookupSession | an EndpointLookupSesson | |
| Errors | NULL_ARGUMENT | proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsInbound() is false | ||
| Compliance | optional | This method must be implemented if supportsInbound() is
true. | |
| Method | getEndpointQuerySession | ||
| Description |
Gets the endpoint query session. | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy |
| Return | osid.transport.EndpointQuerySession | a EndpointQuerySession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsEndpointQuery() is false | ||
| Compliance | optional | This method must be implemented if supportsEndpointQuery() is
true. | |
| Method | getEndpointSearchSession | ||
| Description |
Gets the endpoint search session. | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy |
| Return | osid.transport.EndpointSearchSession | a EndpointSearchSession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsEndpointSearch() is false | ||
| Compliance | optional | This method must be implemented if supportsEndpointSearch()
is true. | |
| Method | getEndpointAdminSession | ||
| Description |
Gets the endpoint administrative session for creating, updating and deleteing endpoints. | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy |
| Return | osid.transport.EndpointAdminSession | a EndpointAdminSession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsEndpointAdmin() is false | ||
| Compliance | optional | This method must be implemented if supportsEndpointAdmin() is
true. | |
| Method | getEndpointNotificationSession | ||
| Description |
Gets the notification session for subscribing to changes to a endpoint. | ||
| Parameters | osid.transport.EndpointReceiver | endpointReceiver | notification callback |
osid.proxy.Proxy | proxy | a proxy | |
| Return | osid.transport.EndpointNotificationSession | a EndpointNotificationSession | |
| Errors | NULL_ARGUMENT | endpointReceiver or proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsEndpointNotification() is false | ||
| Compliance | optional | This method must be implemented if
supportsEndpointNotification() is true. | |
| Method | getEndpointHierarchySession | ||
| Description |
Gets the endpoint hierarchy traversal session. | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy |
| Return | osid.transport.EndpointHierarchySession | a EndpointHierarchySession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| UNIMPLEMENTED | supportsEndpointHierarchy() is false | ||
| Compliance | optional | This method must be implemented if
supportsEndpointHierarchy() is true. | |
| Method | getEndpointHierarchyDesignSession | ||
| Description |
Gets the endpoint hierarchy design session. | ||
| Parameters | osid.proxy.Proxy | proxy | a proxy |
| Return | osid.transport.EndpointHierarchyDesignSession | a EndpointHierarchyDesignSession | |
| Errors | NULL_ARGUMENT | proxy is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| UNIMPLEMENTED | supportsEndpointHierarchyDesign() is false | ||
| Compliance | optional | This method must be implemented if
supportsEndpointHierarchyDesign() is true. | |