public interface TransportManager extends OsidManager, TransportProfile
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.
Modifier and Type | Method and Description |
---|---|
EndpointLookupSession |
getEndpointLookupSession()
Gets the endpoint lookup service.
|
InboundMessageSession |
getInboundMessageSession(MessageReceiver messageReceiver)
Gets a service for inbound message transport.
|
InboundMessageSession |
getInboundMessageSessionForEndpoint(MessageReceiver messageReceiver,
Id endpointId)
Gets a service for inbound message transport using a specified
Endpoint.
|
InboundStreamSession |
getInboundStreamSession(StreamReceiver streamReceiver)
Gets a service for inbound stream transport.
|
InboundStreamSession |
getInboundStreamSessionForEndpoint(StreamReceiver streamReceiver,
Id endpointId)
Gets a service for inbound stream transport using a specified
Endpoint. |
OutboundMessageSession |
getOutboundMessageSession()
Gets a service for outbound message transport.
|
OutboundMessageSession |
getOutboundMessageSessionForEndpoint(Id endpointId)
Gets a service for outbound message transport using a specified
Endpoint.
|
OutboundStreamSession |
getOutboundStreamSession()
Gets a service for outbound stream transport.
|
OutboundStreamSession |
getOutboundStreamSessionForEndpoint(Id endpointId)
Gets a service for outbound stream transport using a specified
Endpoint. |
changeBranch, initialize, rollbackService
close
getEndpointRecordTypes, getRequestRecordTypes, getResponseRecordTypes, supportsEndpointLookup, supportsEndpointRecordType, supportsInboundMessage, supportsInboundStream, supportsOutboundMessage, supportsOutboundStream, supportsRequestRecordType, supportsResponseRecordType, supportsVisibleFederation
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
OutboundStreamSession getOutboundStreamSession() throws OperationFailedException
OutboundStreamSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsOutboundStream()
is false
optional
- This method must be implemented if
supportsOutboundStream()
is true.
OutboundStreamSession getOutboundStreamSessionForEndpoint(Id endpointId) throws NotFoundException, OperationFailedException
Endpoint.
endpointId
- a transport endpoint OutboundStreamSession
NotFoundException
- endpointId
is not
foundNullArgumentException
- endpointId
is
null
OperationFailedException
- unable to complete
request
UnimplementedException
-
supportsOutboundStream()
or
supportsVisibleFederationI()
is false
optional
- This method must be implemented if
supportsOutboundStream()
and
supportsVisibleFederation()
are true.
InboundStreamSession getInboundStreamSession(StreamReceiver streamReceiver) throws OperationFailedException
streamReceiver
- a stream receiver InboundStreamSession
NullArgumentException
- streamReceiver
is null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsInboundStream()
is false
optional
- This method must be implemented if
supportsInboundStream()
is true.
InboundStreamSession getInboundStreamSessionForEndpoint(StreamReceiver streamReceiver, Id endpointId) throws NotFoundException, OperationFailedException
Endpoint.
streamReceiver
- a stream receiverendpointId
- a transport endpoint InboundStreamSession
NotFoundException
- endpointId
is not
foundNullArgumentException
- streamReceiver
or endpointId
is null
OperationFailedException
- unable to complete
request
UnimplementedException
- supportsInboundStream()
or supportsVisibleFederationI()
is
false
optional
- This method must be implemented if
supportsInboundStream()
and
supportsVisibleFederation()
are true.
OutboundMessageSession getOutboundMessageSession() throws OperationFailedException
OutboundMessageSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsOutboundMessage() is false
optional
- This method must be implemented if
supportsOutboundMessage()
is true.
OutboundMessageSession getOutboundMessageSessionForEndpoint(Id endpointId) throws NotFoundException, OperationFailedException
endpointId
- a transport endpoint OutboundMessageSession
NotFoundException
- endpointId
is not
foundNullArgumentException
- endpointId
is
null
OperationFailedException
- unable to complete
request
UnimplementedException
-
supportsOutboundMessage() or supportsVisibleFederationI() is
false
optional
- This method must be implemented if
supportsOutboundMessage()
and
supportsVisibleFederation()
are true.
InboundMessageSession getInboundMessageSession(MessageReceiver messageReceiver) throws OperationFailedException
messageReceiver
- a message receiver InboundMessageSession
NullArgumentException
- messageReceiver
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsInboundMessage() is false
optional
- This method must be implemented if
supportsInboundMessage()
is true.
InboundMessageSession getInboundMessageSessionForEndpoint(MessageReceiver messageReceiver, Id endpointId) throws NotFoundException, OperationFailedException
messageReceiver
- a message receiverendpointId
- a transport endpoint InboundMessageSession
NotFoundException
- endpointId
is not
foundNullArgumentException
- messageReceiver
or endpointId
is null
OperationFailedException
- unable to complete
request
UnimplementedException
-
supportsInboundMessage() or supportsVisibleFederationI() is
false
optional
- This method must be implemented if
supportsInboundMessage()
and
supportsVisibleFederation()
are true. EndpointLookupSession getEndpointLookupSession() throws OperationFailedException
EndpointLookupSesson
OperationFailedException
- unable to complete requestUnimplementedException
- supportsInbound()
is false
optional
- This method must be implemented if
supportsInbound()
is true.