Package org.apache.manifoldcf.crawler.interfaces

Interface INotificationConnectorPool

All Known Implementing Classes:

NotificationConnectorPool

public interface INotificationConnectorPool

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

Field Detail

_rcsid

static final java.lang.String _rcsid

See Also:

Constant Field Values

Method Detail

grabMultiple

INotificationConnector[] grabMultiple(java.lang.String[] orderingKeys,
                                      INotificationConnection[] notificationConnections)
                               throws ManifoldCFException

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

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

Throws:

ManifoldCFException

grab

INotificationConnector grab(INotificationConnection notificationConnection)
                     throws ManifoldCFException

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

Parameters:

notificationConnection - is the authority connection to base the connector instance on.

Throws:

ManifoldCFException

releaseMultiple

void releaseMultiple(INotificationConnection[] connections,
                     INotificationConnector[] connectors)
              throws ManifoldCFException

Release multiple notification connectors.

Parameters:

connections - are the connections describing the instances to release.

connectors - are the connector instances to release.

Throws:

ManifoldCFException

release

void release(INotificationConnection connection,
             INotificationConnector connector)
      throws ManifoldCFException

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

Throws:

ManifoldCFException