org.apache.manifoldcf.agents.interfaces
Interface IOutputConnectorManager

All Known Implementing Classes:

OutputConnectorManager

public interface IOutputConnectorManager

This interface describes a manager for the registry of output connectors. Use this to register or remove a connector from the list of available choices.

Field Summary

static java.lang.String

_rcsid

Method Summary

void	deinstall() Uninstall.
IResultSet	getConnectors() Get ordered list of connectors.
java.lang.String	getDescription(java.lang.String className) Get a description given a class name.
void	install() Install.
boolean	isInstalled(java.lang.String className) Check if a particular connector is installed or not.
void	registerConnector(java.lang.String description, java.lang.String className) Register a new connector.
void	removeConnector(java.lang.String className) Remove a connector.
void	unregisterConnector(java.lang.String className) Unregister a connector.

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. This also unregisters all connectors.

Throws:

ManifoldCFException

registerConnector

void registerConnector(java.lang.String description,
                       java.lang.String className)
                       throws ManifoldCFException

Register a new connector. The connector's install method will also be called.

Parameters:

description - is the description to use in the UI.

className - is the class name.

Throws:

ManifoldCFException

unregisterConnector

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

Unregister a connector. The connector's deinstall method will also be called.

Parameters:

className - is the connector class to unregister.

Throws:

ManifoldCFException

removeConnector

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

Remove a connector. Use this method when the connector doesn't seem to be in the classpath, so deregistration cannot occur.

Parameters:

className - is the connector class to remove.

Throws:

ManifoldCFException

getConnectors

IResultSet getConnectors()
                         throws ManifoldCFException

Get ordered list of connectors.

Returns:

a resultset with the columns "description" and "classname". These will be ordered by description.

Throws:

ManifoldCFException

getDescription

java.lang.String getDescription(java.lang.String className)
                                throws ManifoldCFException

Get a description given a class name.

Parameters:

className - is the class name.

Returns:

the description, or null if the class is not registered.

Throws:

ManifoldCFException

isInstalled

boolean isInstalled(java.lang.String className)
                    throws ManifoldCFException

Check if a particular connector is installed or not.

Parameters:

className - is the class name of the connector.

Returns:

true if installed, false otherwise.

Throws:

ManifoldCFException