Package org.apache.manifoldcf.authorities.interfaces

Interface IMappingConnectorPool

All Known Implementing Classes:

MappingConnectorPool

public interface IMappingConnectorPool

An object implementing this interface functions as a pool of mapping 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 mapping connector handles.
void	flushUnusedConnectors()	Flush only those connector handles that are currently unused.
IMappingConnector	grab(IMappingConnection mappingConnection)	Get a mapping connector.
IMappingConnector[]	grabMultiple(java.lang.String[] orderingKeys, IMappingConnection[] mappingConnections)	Get multiple mapping connectors, all at once.
void	pollAllConnectors()	Idle notification for inactive mapping connector handles.
void	release(IMappingConnection connection, IMappingConnector connector)	Release a mapping connector.
void	releaseMultiple(IMappingConnection[] connections, IMappingConnector[] connectors)	Release multiple mapping connectors.

Field Detail

_rcsid

static final java.lang.String _rcsid

See Also:

Constant Field Values

Method Detail

grabMultiple

IMappingConnector[] grabMultiple(java.lang.String[] orderingKeys,
                                 IMappingConnection[] mappingConnections)
                          throws ManifoldCFException

Get multiple mapping 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.

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

Throws:

ManifoldCFException

grab

IMappingConnector grab(IMappingConnection mappingConnection)
                throws ManifoldCFException

Get a mapping connector. The connector is specified by a mapping connection object.

Parameters:

mappingConnection - is the mapping connection to base the connector instance on.

Throws:

ManifoldCFException

releaseMultiple

void releaseMultiple(IMappingConnection[] connections,
                     IMappingConnector[] connectors)
              throws ManifoldCFException

Release multiple mapping connectors.

Parameters:

connections - are the connections describing the instances to release.

connectors - are the connector instances to release.

Throws:

ManifoldCFException

release

void release(IMappingConnection connection,
             IMappingConnector connector)
      throws ManifoldCFException

Release a mapping 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 mapping 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 mapping connector handles. This method is called when the connector pool needs to be flushed, to free resources.

Throws:

ManifoldCFException