Package org.apache.manifoldcf.core.interfaces

Class ConnectorFactory<T extends IConnector>

java.lang.Object

org.apache.manifoldcf.core.interfaces.ConnectorFactory<T>

Direct Known Subclasses:

AuthorityConnectorFactory, MappingConnectorFactory, NotificationConnectorFactory, OutputConnectorFactory, RepositoryConnectorFactory, TransformationConnectorFactory

public abstract class ConnectorFactory<T extends IConnector>
extends java.lang.Object

This is the base factory class for all IConnector objects.

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ConnectorFactory()

Method Summary

Modifier and Type	Method	Description
protected void	deinstallThis(IThreadContext threadContext, java.lang.String className)	Uninstall connector.
protected T	getThisConnector(IThreadContext threadContext, java.lang.String className)	Get a connector instance.
protected T	getThisConnectorNoCheck(java.lang.String className)	Get a connector instance, without checking for installed connector.
protected T	getThisConnectorRaw(java.lang.String className)	Instantiate a connector, but return null if the class is not found.
protected void	installThis(IThreadContext threadContext, java.lang.String className)	Install connector.
protected abstract boolean	isInstalled(IThreadContext tc, java.lang.String className)	Override this method to hook into a connector manager.
protected void	outputThisConfigurationBody(IThreadContext threadContext, java.lang.String className, IHTTPOutput out, java.util.Locale locale, ConfigParams parameters, java.lang.String tabName)	Output the configuration body section.
protected void	outputThisConfigurationHeader(IThreadContext threadContext, java.lang.String className, IHTTPOutput out, java.util.Locale locale, ConfigParams parameters, java.util.ArrayList tabsArray)	Output the configuration header section.
protected java.lang.String	processThisConfigurationPost(IThreadContext threadContext, java.lang.String className, IPostParameters variableContext, java.util.Locale locale, ConfigParams configParams)	Process configuration post data for a connector.
protected void	viewThisConfiguration(IThreadContext threadContext, java.lang.String className, IHTTPOutput out, java.util.Locale locale, ConfigParams configParams)	View connector configuration.

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

Constructor Detail

ConnectorFactory

protected ConnectorFactory()

Method Detail

isInstalled

protected abstract boolean isInstalled(IThreadContext tc,
                                       java.lang.String className)
                                throws ManifoldCFException

Override this method to hook into a connector manager.

Throws:

ManifoldCFException

installThis

protected void installThis(IThreadContext threadContext,
                           java.lang.String className)
                    throws ManifoldCFException

Install connector.

Parameters:

className - is the class name.

Throws:

ManifoldCFException

deinstallThis

protected void deinstallThis(IThreadContext threadContext,
                             java.lang.String className)
                      throws ManifoldCFException

Uninstall connector.

Parameters:

className - is the class name.

Throws:

ManifoldCFException

outputThisConfigurationHeader

protected void outputThisConfigurationHeader(IThreadContext threadContext,
                                             java.lang.String className,
                                             IHTTPOutput out,
                                             java.util.Locale locale,
                                             ConfigParams parameters,
                                             java.util.ArrayList tabsArray)
                                      throws ManifoldCFException,
                                             java.io.IOException

Output the configuration header section.

Throws:

ManifoldCFException

java.io.IOException

outputThisConfigurationBody

protected void outputThisConfigurationBody(IThreadContext threadContext,
                                           java.lang.String className,
                                           IHTTPOutput out,
                                           java.util.Locale locale,
                                           ConfigParams parameters,
                                           java.lang.String tabName)
                                    throws ManifoldCFException,
                                           java.io.IOException

Output the configuration body section.

Throws:

ManifoldCFException

java.io.IOException

processThisConfigurationPost

protected java.lang.String processThisConfigurationPost(IThreadContext threadContext,
                                                        java.lang.String className,
                                                        IPostParameters variableContext,
                                                        java.util.Locale locale,
                                                        ConfigParams configParams)
                                                 throws ManifoldCFException

Process configuration post data for a connector.

Throws:

ManifoldCFException

viewThisConfiguration

protected void viewThisConfiguration(IThreadContext threadContext,
                                     java.lang.String className,
                                     IHTTPOutput out,
                                     java.util.Locale locale,
                                     ConfigParams configParams)
                              throws ManifoldCFException,
                                     java.io.IOException

View connector configuration.

Throws:

ManifoldCFException

java.io.IOException

getThisConnectorNoCheck

protected T getThisConnectorNoCheck(java.lang.String className)
                             throws ManifoldCFException

Get a connector instance, without checking for installed connector.

Parameters:

className - is the class name.

Returns:

the instance.

Throws:

ManifoldCFException

getThisConnector

protected T getThisConnector(IThreadContext threadContext,
                             java.lang.String className)
                      throws ManifoldCFException

Get a connector instance.

Parameters:

className - is the class name.

Returns:

the instance.

Throws:

ManifoldCFException

getThisConnectorRaw

protected T getThisConnectorRaw(java.lang.String className)
                         throws ManifoldCFException

Instantiate a connector, but return null if the class is not found.

Throws:

ManifoldCFException