OSID Logo
OSID Specifications
transport package
Version 3.0.0
Release Candidate Preview
Interfaceosid.transport.TransportProfile
Implementsosid.OsidProfile
Description

The TransportProfile defines the interoperability of the transport OSID.

MethodsupportsVisibleFederation
Description

Tests if any transport endpoint federation is exposed. Federation is exposed when a specific endpoint may be used. Federation is not exposed when a set of endpoints appears as a single endpoint.

Returnboolean true if federation is visible false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsOutboundStream
Description

Tests if outbound stream transport is supported.

Returnboolean true if outbound stream transport is supported , false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsInboundStream
Description

Tests if inbound stream transport is supported.

Returnboolean true if incoming stream transport is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsOutboundMessage
Description

Tests if outbound message transport is supported.

Returnboolean true if outbound message transport is supported , false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsInboundMessage
Description

Tests if inbound message transport is supported.

Returnboolean true if incoming message transport is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsEndpointLookup
Description

Tests if endpoint lookup is supported.

Returnboolean true if endpoint lookup is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetEndpointRecordTypes
Description

Gets a list of supported endpoint record types.

Returnosid.type.TypeLista list of supported endpoint record types
CompliancemandatoryThis method must be implemented.
MethodsupportsEndpointRecordType
Description

Tests if an endpoint record type is supported.

Parametersosid.type.TypeendpointRecordTypean endpoint record type
Returnboolean true if the endpoint record type is supported, false otherwise
ErrorsNULL_ARGUMENT endpointRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetRequestRecordTypes
Description

Gets a list of supported request record types.

Returnosid.type.TypeLista list of supported request record types
CompliancemandatoryThis method must be implemented.
MethodsupportsRequestRecordType
Description

Tests if a request record type is supported.

Parametersosid.type.TyperequestRecordTypea request record type
Returnboolean true if the request record type is supported, false otherwise
ErrorsNULL_ARGUMENT requestRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetResponseRecordTypes
Description

Gets a list of supported response record types.

Returnosid.type.TypeLista list of supported response record types
CompliancemandatoryThis method must be implemented.
MethodsupportsResponseRecordType
Description

Tests if a response record type is supported.

Parametersosid.type.TyperesponseRecordTypea response record type
Returnboolean true if the response record type is supported, false otherwise
ErrorsNULL_ARGUMENT responseRecordType is null
CompliancemandatoryThis method must be implemented.