org.apache.manifoldcf.agents.interfaces

Interface IAgentManager

All Known Implementing Classes:

AgentManager

public interface IAgentManager

This interface describes the management of the agent registry.

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
void	deinstall() Uninstall.
java.lang.String[]	getAllAgents() Get a list of all registered agent class names.
void	install() Install.
void	registerAgent(java.lang.String className) Register an agent.
void	removeAgent(java.lang.String className) Remove an agent.
void	unregisterAgent(java.lang.String className) Unregister an agent.

Field Detail

_rcsid

static final java.lang.String _rcsid

See Also:

Constant Field Values

Method Detail

install

void install()
      throws ManifoldCFException

Install.

Throws:

ManifoldCFException

deinstall

void deinstall()
        throws ManifoldCFException

Uninstall. Also uninstalls all remaining agents.

Throws:

ManifoldCFException

registerAgent

void registerAgent(java.lang.String className)
            throws ManifoldCFException

Register an agent.

Parameters:

className - is the class.

Throws:

ManifoldCFException

unregisterAgent

void unregisterAgent(java.lang.String className)
              throws ManifoldCFException

Unregister an agent.

Parameters:

className - is the class to unregister.

Throws:

ManifoldCFException

removeAgent

void removeAgent(java.lang.String className)
          throws ManifoldCFException

Remove an agent. Use this when the agent cannot be invoked. The agent becomes unavailable, but its schema is not cleaned up.

Parameters:

className - is the class to remove.

Throws:

ManifoldCFException

getAllAgents

java.lang.String[] getAllAgents()
                         throws ManifoldCFException

Get a list of all registered agent class names.

Returns:

the classnames in an array.

Throws:

ManifoldCFException