Package org.apache.manifoldcf.agents.interfaces

Interface IOutputConnectorPool

All Known Implementing Classes:

OutputConnectorPool

public interface IOutputConnectorPool

An object implementing this interface functions as a pool of output connectors. Coordination and allocation among cluster members is managed within. These objects are thread-local, so do not share them among threads.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	_rcsid

Method Summary

Modifier and Type	Method	Description
void	closeAllConnectors()	Clean up all open output connector handles.
void	flushUnusedConnectors()	Flush only those connector handles that are currently unused.
IOutputConnector	grab(IOutputConnection outputConnection)	Get an output connector.
IOutputConnector[]	grabMultiple(java.lang.String[] orderingKeys, IOutputConnection[] outputConnections)	Get multiple output connectors, all at once.
void	pollAllConnectors()	Idle notification for inactive output connector handles.
void	release(IOutputConnection connection, IOutputConnector connector)	Release an output connector.
void	releaseMultiple(IOutputConnection[] connections, IOutputConnector[] connectors)	Release multiple output connectors.

Field Detail

_rcsid

static final java.lang.String _rcsid

See Also:

Constant Field Values

Method Detail

grabMultiple

IOutputConnector[] grabMultiple(java.lang.String[] orderingKeys,
                                IOutputConnection[] outputConnections)
                         throws ManifoldCFException

Get multiple output connectors, all at once. Do this in a particular order so that any connector exhaustion will not cause a deadlock.

Parameters:

orderingKeys - are the keys which determine in what order the connectors are obtained.

outputConnections - are the connections to use the build the connector instances.

Throws:

ManifoldCFException

grab

IOutputConnector grab(IOutputConnection outputConnection)
               throws ManifoldCFException

Get an output connector. The connector is specified by an output connection object.

Parameters:

outputConnection - is the output connection to base the connector instance on.

Throws:

ManifoldCFException

releaseMultiple

void releaseMultiple(IOutputConnection[] connections,
                     IOutputConnector[] connectors)
              throws ManifoldCFException

Release multiple output connectors.

Parameters:

connections - are the connections describing the instances to release.

connectors - are the connector instances to release.

Throws:

ManifoldCFException

release

void release(IOutputConnection connection,
             IOutputConnector connector)
      throws ManifoldCFException

Release an output connector.

Parameters:

connection - is the connection describing the instance to release.

connector - is the connector to release.

Throws:

ManifoldCFException

pollAllConnectors

void pollAllConnectors()
                throws ManifoldCFException

Idle notification for inactive output connector handles. This method polls all inactive handles.

Throws:

ManifoldCFException

flushUnusedConnectors

void flushUnusedConnectors()
                    throws ManifoldCFException

Flush only those connector handles that are currently unused.

Throws:

ManifoldCFException

closeAllConnectors

void closeAllConnectors()
                 throws ManifoldCFException

Clean up all open output connector handles. This method is called when the connector pool needs to be flushed, to free resources.

Throws:

ManifoldCFException