Package org.apache.manifoldcf.crawler.interfaces

Class RepositoryConnectorFactory

java.lang.Object

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

org.apache.manifoldcf.crawler.interfaces.RepositoryConnectorFactory

public class RepositoryConnectorFactory
extends ConnectorFactory<IRepositoryConnector>

This is the factory class for IRepositoryConnector objects.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	_rcsid
protected static RepositoryConnectorFactory	thisFactory

Method Summary

Modifier and Type	Method	Description
static void	deinstall(IThreadContext threadContext, java.lang.String className)	Uninstall connector.
static java.lang.String[]	getActivitiesList(IThreadContext threadContext, java.lang.String className)	Get the activities supported by this connector.
static int	getConnectorModel(IThreadContext threadContext, java.lang.String className)	Get the operating mode for a connector.
static IRepositoryConnector	getConnectorNoCheck(java.lang.String className)	Get a repository connector instance, without checking for installed connector.
static java.lang.String[]	getRelationshipTypes(IThreadContext threadContext, java.lang.String className)	Get the link types logged by this connector.
protected java.lang.String[]	getThisActivitiesList(IThreadContext threadContext, java.lang.String className)	Get the activities supported by this connector.
protected int	getThisConnectorModel(IThreadContext threadContext, java.lang.String className)	Get the operating mode for a connector.
protected java.lang.String[]	getThisRelationshipTypes(IThreadContext threadContext, java.lang.String className)	Get the link types logged by this connector.
static void	install(IThreadContext threadContext, java.lang.String className)	Install connector.
protected boolean	isInstalled(IThreadContext tc, java.lang.String className)	Override this method to hook into a connector manager.
static void	outputConfigurationBody(IThreadContext threadContext, java.lang.String className, IHTTPOutput out, java.util.Locale locale, ConfigParams parameters, java.lang.String tabName)	Output the configuration body section.
static void	outputConfigurationHeader(IThreadContext threadContext, java.lang.String className, IHTTPOutput out, java.util.Locale locale, ConfigParams parameters, java.util.ArrayList tabsArray)	Output the configuration header section.
static java.lang.String	processConfigurationPost(IThreadContext threadContext, java.lang.String className, IPostParameters variableContext, java.util.Locale locale, ConfigParams configParams)	Process configuration post data for a connector.
static void	viewConfiguration(IThreadContext threadContext, java.lang.String className, IHTTPOutput out, java.util.Locale locale, ConfigParams configParams)	View connector configuration.

Methods inherited from class org.apache.manifoldcf.core.interfaces.ConnectorFactory

deinstallThis, getThisConnector, getThisConnectorNoCheck, getThisConnectorRaw, installThis, outputThisConfigurationBody, outputThisConfigurationHeader, processThisConfigurationPost, viewThisConfiguration

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

thisFactory

protected static final RepositoryConnectorFactory thisFactory

Method Detail

isInstalled

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

Description copied from class: ConnectorFactory

Override this method to hook into a connector manager.

Specified by:

isInstalled in class ConnectorFactory<IRepositoryConnector>

Throws:

ManifoldCFException

getThisActivitiesList

protected java.lang.String[] getThisActivitiesList(IThreadContext threadContext,
                                                   java.lang.String className)
                                            throws ManifoldCFException

Get the activities supported by this connector.

Parameters:

className - is the class name.

Returns:

the list of activities.

Throws:

ManifoldCFException

getThisRelationshipTypes

protected java.lang.String[] getThisRelationshipTypes(IThreadContext threadContext,
                                                      java.lang.String className)
                                               throws ManifoldCFException

Get the link types logged by this connector.

Parameters:

className - is the class name.

Returns:

the list of link types, in sorted order.

Throws:

ManifoldCFException

getThisConnectorModel

protected int getThisConnectorModel(IThreadContext threadContext,
                                    java.lang.String className)
                             throws ManifoldCFException

Get the operating mode for a connector.

Parameters:

className - is the class name.

Returns:

the connector operating model, as specified in IRepositoryConnector.

Throws:

ManifoldCFException

install

public static void install(IThreadContext threadContext,
                           java.lang.String className)
                    throws ManifoldCFException

Install connector.

Parameters:

className - is the class name.

Throws:

ManifoldCFException

deinstall

public static void deinstall(IThreadContext threadContext,
                             java.lang.String className)
                      throws ManifoldCFException

Uninstall connector.

Parameters:

className - is the class name.

Throws:

ManifoldCFException

getActivitiesList

public static java.lang.String[] getActivitiesList(IThreadContext threadContext,
                                                   java.lang.String className)
                                            throws ManifoldCFException

Get the activities supported by this connector.

Parameters:

className - is the class name.

Returns:

the list of activities.

Throws:

ManifoldCFException

getRelationshipTypes

public static java.lang.String[] getRelationshipTypes(IThreadContext threadContext,
                                                      java.lang.String className)
                                               throws ManifoldCFException

Get the link types logged by this connector.

Parameters:

className - is the class name.

Returns:

the list of link types, in sorted order.

Throws:

ManifoldCFException

getConnectorModel

public static int getConnectorModel(IThreadContext threadContext,
                                    java.lang.String className)
                             throws ManifoldCFException

Get the operating mode for a connector.

Parameters:

className - is the class name.

Returns:

the connector operating model, as specified in IRepositoryConnector.

Throws:

ManifoldCFException

outputConfigurationHeader

public static void outputConfigurationHeader(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

outputConfigurationBody

public static void outputConfigurationBody(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

processConfigurationPost

public static java.lang.String processConfigurationPost(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

viewConfiguration

public static void viewConfiguration(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

getConnectorNoCheck

public static IRepositoryConnector getConnectorNoCheck(java.lang.String className)
                                                throws ManifoldCFException

Get a repository connector instance, without checking for installed connector.

Parameters:

className - is the class name.

Returns:

the instance.

Throws:

ManifoldCFException