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 Details

    • 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.

    • supportsEndpointQuery

      boolean supportsEndpointQuery()
      Tests if endpoint query is supported.
      Returns:
      true if endpoint query is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsEndpointSearch

      boolean supportsEndpointSearch()
      Tests if endpoint search is supported.
      Returns:
      true if endpoint search is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsEndpointAdmin

      boolean supportsEndpointAdmin()
      Tests if endpoint administration is supported.
      Returns:
      true if endpoint administration is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsEndpointNotification

      boolean supportsEndpointNotification()
      Tests if endpoint notification is supported. Messages may be sent when Endpoint objects are created, deleted or updated. Notifications for resources within endpoints are sent via the resource notification session.
      Returns:
      true if endpoint notification is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsEndpointHierarchy

      boolean supportsEndpointHierarchy()
      Tests if a endpoint hierarchy traversal is supported.
      Returns:
      true if a endpoint hierarchy traversal is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsEndpointHierarchyDesign

      boolean supportsEndpointHierarchyDesign()
      Tests if a endpoint hierarchy design is supported.
      Returns:
      true if a endpoint hierarchy design is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getEndpointSearchRecordTypes

      TypeList getEndpointSearchRecordTypes()
      Gets all the endpoint search record types supported.
      Returns:
      the list of supported endpoint search record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsEndpointSearchRecordType

      boolean supportsEndpointSearchRecordType(Type endpointSearchRecordType)
      Tests if a given endpoint search record type is supported.
      Parameters:
      endpointSearchRecordType - the endpoint search record type
      Returns:
      true if the endpoint search record type is supported, false otherwise
      Throws:
      NullArgumentException - endpointSearchRecordType 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.