org.osid.transport

Interface TransportProfile

All Superinterfaces:

OsidProfile, Sourceable

All Known Subinterfaces:

TransportManager, TransportProxyManager

public interface TransportProfile
extends OsidProfile

The TransportProfile defines the interoperability of the transport OSID.

Method Summary

Methods

Modifier and Type	Method and 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.

Methods inherited from interface org.osid.OsidProfile

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

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

supportsVisibleFederation

boolean supportsVisibleFederation()

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.

Returns:

true if federation is visible false otherwise

Compliance:

mandatory - This method must be implemented.

supportsOutboundStream

boolean supportsOutboundStream()

Tests if outbound stream transport is supported.

Returns:

true if outbound stream transport is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsInboundStream

boolean supportsInboundStream()

Tests if inbound stream transport is supported.

Returns:

true if incoming stream transport is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsOutboundMessage

boolean supportsOutboundMessage()

Tests if outbound message transport is supported.

Returns:

true if outbound message transport is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsInboundMessage

boolean supportsInboundMessage()

Tests if inbound message transport is supported.

Returns:

true if incoming message transport is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsEndpointLookup

boolean supportsEndpointLookup()

Tests if endpoint lookup is supported.

Returns:

true if endpoint lookup is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

getEndpointRecordTypes

TypeList getEndpointRecordTypes()

Gets a list of supported endpoint record types.

Returns:

a list of supported endpoint record types

Compliance:

mandatory - This method must be implemented.

supportsEndpointRecordType

boolean supportsEndpointRecordType(Type endpointRecordType)

Tests if an endpoint record type is supported.

Parameters:

endpointRecordType - an endpoint record type

Returns:

true if the endpoint record type is supported, false otherwise

Throws:

NullArgumentException - endpointRecordType is null

Compliance:

mandatory - This method must be implemented.

getRequestRecordTypes

TypeList getRequestRecordTypes()

Gets a list of supported request record types.

Returns:

a list of supported request record types

Compliance:

mandatory - This method must be implemented.

supportsRequestRecordType

boolean supportsRequestRecordType(Type requestRecordType)

Tests if a request record type is supported.

Parameters:

requestRecordType - a request record type

Returns:

true if the request record type is supported, false otherwise

Throws:

NullArgumentException - requestRecordType is null

Compliance:

mandatory - This method must be implemented.

getResponseRecordTypes

TypeList getResponseRecordTypes()

Gets a list of supported response record types.

Returns:

a list of supported response record types

Compliance:

mandatory - This method must be implemented.

supportsResponseRecordType

boolean supportsResponseRecordType(Type responseRecordType)

Tests if a response record type is supported.

Parameters:

responseRecordType - a response record type

Returns:

true if the response record type is supported, false otherwise

Throws:

NullArgumentException - responseRecordType is null

Compliance:

mandatory - This method must be implemented.