org.flexiblepower.messaging

Interface ConnectionManager

public interface ConnectionManager

The ConnectionManager service should be provided by the FPAI runtime. It has the responsibility to connect ConnectionManager.ManagedEndpoints with each other through Ports that can communicate.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ConnectionManager.EndpointPort The representation of a Port that was defined on an Endpoint.
static interface	ConnectionManager.ManagedEndpoint The wrapper that manages the Endpoint.
static interface	ConnectionManager.PotentialConnection Represents a potential connection, which is when two ConnectionManager.EndpointPort mmatch with their Port.sends() and Port.accepts() definitions.

Method Summary

Methods

Modifier and Type	Method and Description
void	autoConnect() This method tries to connect all ConnectionManager.PotentialConnections for which no other options is available.
ConnectionManager.ManagedEndpoint	getEndpoint(java.lang.String pid)
java.util.SortedMap<java.lang.String,? extends ConnectionManager.ManagedEndpoint>	getEndpoints()

Method Detail

getEndpoint

ConnectionManager.ManagedEndpoint getEndpoint(java.lang.String pid)

Parameters:

pid - The persistent identifier of the endpoint. For Endpoints that are registered using DS, this normally is the service.pid.

Returns:

The ConnectionManager.ManagedEndpoint that manages the ConnectionManager.ManagedEndpoint. This can be used to find possible connections for that ConnectionManager.ManagedEndpoint.

getEndpoints

java.util.SortedMap<java.lang.String,? extends ConnectionManager.ManagedEndpoint> getEndpoints()

Returns:

A map of all the ConnectionManager.ManagedEndpoints. The keys are the persistent identifiers of the ConnectionManager.ManagedEndpoints.

autoConnect

void autoConnect()

This method tries to connect all ConnectionManager.PotentialConnections for which no other options is available. This means that for any unconnected ConnectionManager.EndpointPort with a single cardinality, it tries to determine which ConnectionManager.PotentialConnections are available. If there is only 1 available and the other ConnectionManager.EndpointPort has multiple cardinality, or it has single cardinality with no other options, then it will connect these two.