org.osid.transport

Interface TransportProxyManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidProfile, OsidProxyManager, Sourceable, TransportProfile

public interface TransportProxyManager
extends OsidProxyManager, 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.

Method Summary

Methods

Modifier and Type	Method and Description
EndpointLookupSession	getEndpointLookupSession(Proxy proxy) Gets the endpoint lookup service.
InboundMessageSession	getInboundMessageSession(MessageReceiver messageReceiver, Proxy proxy) Gets a service for inbound message transport.
InboundMessageSession	getInboundMessageSessionForEndpoint(MessageReceiver messageReceiver, Id endpointId, Proxy proxy) Gets a service for inbound message transport using a specified Endpoint.
InboundStreamSession	getInboundStreamSession(StreamReceiver streamReceiver, Proxy proxy) Gets a service for inbound stream transport.
InboundStreamSession	getInboundStreamSessionForEndpoint(StreamReceiver streamReceiver, Id endpointId, Proxy proxy) Gets a service for inbound stream transport using a specified Endpoint.
OutboundMessageSession	getOutboundMessageSession(Proxy proxy) Gets a service for outbound message transport.
OutboundMessageSession	getOutboundMessageSessionForEndpoint(Id endpointId, Proxy proxy) Gets a service for outbound message transport using a specified Endpoint.
OutboundStreamSession	getOutboundStreamSession(Proxy proxy) Gets a service for outbound stream transport.
OutboundStreamSession	getOutboundStreamSessionForEndpoint(Id endpointId, Proxy proxy) Gets a service for outbound stream transport using a specified Endpoint.

Methods inherited from interface org.osid.OsidProxyManager

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidProxyManager

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.transport.TransportProfile

getEndpointRecordTypes, getRequestRecordTypes, getResponseRecordTypes, supportsEndpointLookup, supportsEndpointRecordType, supportsInboundMessage, supportsInboundStream, supportsOutboundMessage, supportsOutboundStream, supportsRequestRecordType, supportsResponseRecordType, supportsVisibleFederation

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

getOutboundStreamSession

OutboundStreamSession getOutboundStreamSession(Proxy proxy)
                                               throws OperationFailedException

Gets a service for outbound stream transport.

Parameters:

proxy - a proxy

Returns:

an OutboundStreamSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOutboundStream() is false

Compliance:

optional - This method must be implemented if supportsOutboundStream() is true.

getOutboundStreamSessionForEndpoint

OutboundStreamSession getOutboundStreamSessionForEndpoint(Id endpointId,
                                                        Proxy proxy)
                                                          throws NotFoundException,
                                                                 OperationFailedException

Gets a service for outbound stream transport using a specified Endpoint.

Parameters:

endpointId - a transport endpoint

proxy - a proxy

Returns:

an OutboundStreamSession

Throws:

NotFoundException - endpointId or proxy is not found

NullArgumentException - endpointId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOutboundStream() or supportsVisibleFederationI() is false

Compliance:

optional - This method must be implemented if supportsOutboundStream() and supportsVisibleFederation() are true.

getInboundStreamSession

InboundStreamSession getInboundStreamSession(StreamReceiver streamReceiver,
                                           Proxy proxy)
                                             throws OperationFailedException

Gets a service for inbound stream transport.

Parameters:

streamReceiver - a stream receiver

proxy - a proxy

Returns:

an InboundStreamSession

Throws:

NullArgumentException - streamReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInboundStream() is false

Compliance:

optional - This method must be implemented if supportsInboundStream() is true.

getInboundStreamSessionForEndpoint

InboundStreamSession getInboundStreamSessionForEndpoint(StreamReceiver streamReceiver,
                                                      Id endpointId,
                                                      Proxy proxy)
                                                        throws NotFoundException,
                                                               OperationFailedException

Gets a service for inbound stream transport using a specified Endpoint.

Parameters:

streamReceiver - a stream receiver

endpointId - a transport endpoint

proxy - a proxy

Returns:

an InboundStreamSession

Throws:

NotFoundException - endpointId is not found

NullArgumentException - streamReceiver, endpointId or porxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInboundStream() or supportsVisibleFederationI() is false

Compliance:

optional - This method must be implemented if supportsInboundStream() and supportsVisibleFederation() are true.

getOutboundMessageSession

OutboundMessageSession getOutboundMessageSession(Proxy proxy)
                                                 throws OperationFailedException

Gets a service for outbound message transport.

Parameters:

proxy - a proxy

Returns:

an OutboundMessageSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOutboundMessage() is false

Compliance:

optional - This method must be implemented if supportsOutboundMessage() is true.

getOutboundMessageSessionForEndpoint

OutboundMessageSession getOutboundMessageSessionForEndpoint(Id endpointId,
                                                          Proxy proxy)
                                                            throws NotFoundException,
                                                                   OperationFailedException

Gets a service for outbound message transport using a specified Endpoint.

Parameters:

endpointId - a transport endpoint

proxy - a proxy

Returns:

an OutboundMessageSession

Throws:

NotFoundException - endpointId is not found

NullArgumentException - endpointId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOutboundMessage() or supportsVisibleFederationI() is false

Compliance:

optional - This method must be implemented if supportsOutboundMessage() and supportsVisibleFederation() are true.

getInboundMessageSession

InboundMessageSession getInboundMessageSession(MessageReceiver messageReceiver,
                                             Proxy proxy)
                                               throws OperationFailedException

Gets a service for inbound message transport.

Parameters:

messageReceiver - a message receiver

proxy - a proxy

Returns:

an InboundMessageSession

Throws:

NullArgumentException - messageReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInboundMessage() is false

Compliance:

optional - This method must be implemented if supportsInboundMessage() is true.

getInboundMessageSessionForEndpoint

InboundMessageSession getInboundMessageSessionForEndpoint(MessageReceiver messageReceiver,
                                                        Id endpointId,
                                                        Proxy proxy)
                                                          throws NotFoundException,
                                                                 OperationFailedException

Gets a service for inbound message transport using a specified Endpoint.

Parameters:

messageReceiver - a message receiver

endpointId - a transport endpoint

proxy - a proxy

Returns:

an InboundMessageSession

Throws:

NotFoundException - endpointId is not found

NullArgumentException - messageReceiver, endpointId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInboundMessage() or supportsVisibleFederationI() is false

Compliance:

optional - This method must be implemented if supportsInboundMessage() and supportsVisibleFederation() are true.

getEndpointLookupSession

EndpointLookupSession getEndpointLookupSession(Proxy proxy)
                                               throws OperationFailedException

Gets the endpoint lookup service.

Parameters:

proxy - a proxy

Returns:

an EndpointLookupSesson

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInbound() is false

Compliance:

optional - This method must be implemented if supportsInbound() is true.