org.apache.manifoldcf.agents.interfaces
Class AgentManagerFactory

java.lang.Object
  org.apache.manifoldcf.agents.interfaces.AgentManagerFactory

public class AgentManagerFactory
extends java.lang.Object

Agent manager factory class.

Field Summary

static java.lang.String	_rcsid
protected static java.lang.String	agentManager

Method Summary

static IAgent[]	instantiateAllAgents(IThreadContext threadContext) Instantiate the complete set of IAgent objects.
static boolean	isOutputConnectionInUse(IThreadContext threadContext, java.lang.String connName) Request permission from all registered agents to delete an output connection.
static IAgentManager	make(IThreadContext threadContext) Make an agent manager instance.
static void	noteOutputConnectionChange(IThreadContext threadContext, java.lang.String connectionName) Note to all registered agents the change of configuration of an output connection.
static void	noteOutputConnectorDeregistration(IThreadContext threadContext, java.lang.String[] connectionNames) Note to all registered agents the deregistration of an output connector used by the specified connections.
static void	noteOutputConnectorRegistration(IThreadContext threadContext, java.lang.String[] connectionNames) Note to all registered agents the registration of an output connector used by the specified connections.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

_rcsid

public static final java.lang.String _rcsid

See Also:

Constant Field Values

agentManager

protected static final java.lang.String agentManager

See Also:

Constant Field Values

Method Detail

make

public static IAgentManager make(IThreadContext threadContext)
                          throws ManifoldCFException

Make an agent manager instance.

Parameters:

threadContext - is the thread context.

Returns:

the manager.

Throws:

ManifoldCFException

isOutputConnectionInUse

public static boolean isOutputConnectionInUse(IThreadContext threadContext,
                                              java.lang.String connName)
                                       throws ManifoldCFException

Request permission from all registered agents to delete an output connection.

Parameters:

threadContext - is the thread context.

connName - is the name of the output connection.

Returns:

true if the connection is in use, false otherwise.

Throws:

ManifoldCFException

noteOutputConnectorDeregistration

public static void noteOutputConnectorDeregistration(IThreadContext threadContext,
                                                     java.lang.String[] connectionNames)
                                              throws ManifoldCFException

Note to all registered agents the deregistration of an output connector used by the specified connections. This method will be called when the connector is deregistered.

Parameters:

threadContext - is the thread context.

connectionNames - is the set of connection names.

Throws:

ManifoldCFException

noteOutputConnectorRegistration

public static void noteOutputConnectorRegistration(IThreadContext threadContext,
                                                   java.lang.String[] connectionNames)
                                            throws ManifoldCFException

Note to all registered agents the registration of an output connector used by the specified connections. This method will be called when a connector is registered, on which the specified connections depend.

Parameters:

threadContext - is the thread context.

connectionNames - is the set of connection names.

Throws:

ManifoldCFException

noteOutputConnectionChange

public static void noteOutputConnectionChange(IThreadContext threadContext,
                                              java.lang.String connectionName)
                                       throws ManifoldCFException

Note to all registered agents the change of configuration of an output connection. This method will be called when the connection's xml is modified.

Parameters:

threadContext - is the thread context.

connectionName - is the connection name.

Throws:

ManifoldCFException

instantiateAllAgents

public static IAgent[] instantiateAllAgents(IThreadContext threadContext)
                                     throws ManifoldCFException

Instantiate the complete set of IAgent objects.

Parameters:

threadContext - is the thread context.

Returns:

the array of such objects.

Throws:

ManifoldCFException