org.apache.manifoldcf.authorities.interfaces

Class AuthorityConnectorFactory

java.lang.Object

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

org.apache.manifoldcf.authorities.interfaces.AuthorityConnectorFactory

public class AuthorityConnectorFactory
extends ConnectorFactory<IAuthorityConnector>

This class manages a pool of authority connectors.

Field Summary

Fields

Modifier and Type	Field and Description
protected static AuthorityConnectorFactory	thisFactory

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

_rcsid

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AuthorityConnectorFactory()

Method Summary

Modifier and Type	Method and Description
static void	deinstall(IThreadContext threadContext, java.lang.String className) Uninstall connector.
static IAuthorityConnector	getConnectorNoCheck(java.lang.String className) Get a repository connector instance, but do NOT check if class is installed first!
static AuthorizationResponse	getDefaultAuthorizationResponse(IThreadContext threadContext, java.lang.String className, java.lang.String userName) Get the default response from a connector.
AuthorizationResponse	getThisDefaultAuthorizationResponse(IThreadContext threadContext, java.lang.String className, java.lang.String userName) Get the default response from a 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

thisFactory

protected static final AuthorityConnectorFactory thisFactory

Constructor Detail

AuthorityConnectorFactory

protected AuthorityConnectorFactory()

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<IAuthorityConnector>

Throws:

ManifoldCFException

getThisDefaultAuthorizationResponse

public AuthorizationResponse getThisDefaultAuthorizationResponse(IThreadContext threadContext,
                                                                 java.lang.String className,
                                                                 java.lang.String userName)
                                                          throws ManifoldCFException

Get the default response from a connector. Called if the connection attempt fails.

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

getDefaultAuthorizationResponse

public static AuthorizationResponse getDefaultAuthorizationResponse(IThreadContext threadContext,
                                                                    java.lang.String className,
                                                                    java.lang.String userName)
                                                             throws ManifoldCFException

Get the default response from a connector. Called if the connection attempt fails.

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 IAuthorityConnector getConnectorNoCheck(java.lang.String className)
                                               throws ManifoldCFException

Get a repository connector instance, but do NOT check if class is installed first!

Parameters:

className - is the class name.

Returns:

the instance.

Throws:

ManifoldCFException