org.apache.manifoldcf.agents.output.nullconnector
Class NullConnector

java.lang.Object
  org.apache.manifoldcf.core.connector.BaseConnector
      org.apache.manifoldcf.agents.output.BaseOutputConnector
          org.apache.manifoldcf.agents.output.nullconnector.NullConnector

All Implemented Interfaces:

org.apache.manifoldcf.agents.interfaces.IOutputConnector, org.apache.manifoldcf.core.interfaces.IConnector

public class NullConnector
extends org.apache.manifoldcf.agents.output.BaseOutputConnector

This is a null output connector. It eats all output and simply logs the events.

Field Summary

static java.lang.String	_rcsid
static java.lang.String	INGEST_ACTIVITY Ingestion activity
static java.lang.String	REMOVE_ACTIVITY Document removal activity

Fields inherited from class org.apache.manifoldcf.core.connector.BaseConnector

currentContext, params

Fields inherited from interface org.apache.manifoldcf.agents.interfaces.IOutputConnector

DOCUMENTSTATUS_ACCEPTED, DOCUMENTSTATUS_REJECTED

Constructor Summary

NullConnector()
Constructor.

Method Summary

int	addOrReplaceDocument(java.lang.String documentURI, java.lang.String outputDescription, org.apache.manifoldcf.agents.interfaces.RepositoryDocument document, java.lang.String authorityNameString, org.apache.manifoldcf.agents.interfaces.IOutputAddActivity activities) Add (or replace) a document in the output data store using the connector.
java.lang.String	check() Test the connection.
void	connect(org.apache.manifoldcf.core.interfaces.ConfigParams configParameters) Connect.
void	disconnect() Close the connection.
java.lang.String[]	getActivitiesList() Return the list of activities that this connector supports (i.e.
java.lang.String	getJSPFolder() Return the path for the UI interface JSP elements.
java.lang.String	getOutputDescription(org.apache.manifoldcf.agents.interfaces.OutputSpecification spec) Get an output version string, given an output specification.
protected void	getSession() Set up a session
void	removeDocument(java.lang.String documentURI, java.lang.String outputDescription, org.apache.manifoldcf.agents.interfaces.IOutputRemoveActivity activities) Remove a document using the connector.

Methods inherited from class org.apache.manifoldcf.agents.output.BaseOutputConnector

checkDocumentIndexable, checkMimeTypeIndexable, noteJobComplete, outputSpecificationBody, outputSpecificationHeader, processSpecificationPost, requestInfo, viewSpecification

Methods inherited from class org.apache.manifoldcf.core.connector.BaseConnector

clearThreadContext, deinstall, getConfiguration, install, outputConfigurationBody, outputConfigurationHeader, poll, processConfigurationPost, setThreadContext, viewConfiguration

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.manifoldcf.core.interfaces.IConnector

clearThreadContext, deinstall, getConfiguration, install, outputConfigurationBody, outputConfigurationHeader, poll, processConfigurationPost, setThreadContext, viewConfiguration

Field Detail

_rcsid

public static final java.lang.String _rcsid

See Also:

Constant Field Values

INGEST_ACTIVITY

public static final java.lang.String INGEST_ACTIVITY

Ingestion activity

See Also:

Constant Field Values

REMOVE_ACTIVITY

public static final java.lang.String REMOVE_ACTIVITY

Document removal activity

See Also:

Constant Field Values

Constructor Detail

NullConnector

public NullConnector()

Constructor.

Method Detail

getActivitiesList

public java.lang.String[] getActivitiesList()

Return the list of activities that this connector supports (i.e. writes into the log).

Specified by:

getActivitiesList in interface org.apache.manifoldcf.agents.interfaces.IOutputConnector

Overrides:

getActivitiesList in class org.apache.manifoldcf.agents.output.BaseOutputConnector

Returns:

the list.

getJSPFolder

public java.lang.String getJSPFolder()

Return the path for the UI interface JSP elements. This method should return the name of the folder, under the /output/ area, where the appropriate JSP's can be found. The name should NOT have a slash in it.

Returns:

the folder part

connect

public void connect(org.apache.manifoldcf.core.interfaces.ConfigParams configParameters)

Connect.

Specified by:

connect in interface org.apache.manifoldcf.core.interfaces.IConnector

Overrides:

connect in class org.apache.manifoldcf.core.connector.BaseConnector

Parameters:

configParameters - is the set of configuration parameters, which in this case describe the target appliance, basic auth configuration, etc. (This formerly came out of the ini file.)

disconnect

public void disconnect()
                throws org.apache.manifoldcf.core.interfaces.ManifoldCFException

Close the connection. Call this before discarding the connection.

Specified by:

disconnect in interface org.apache.manifoldcf.core.interfaces.IConnector

Overrides:

disconnect in class org.apache.manifoldcf.core.connector.BaseConnector

Throws:

org.apache.manifoldcf.core.interfaces.ManifoldCFException

getSession

protected void getSession()
                   throws org.apache.manifoldcf.core.interfaces.ManifoldCFException,
                          org.apache.manifoldcf.agents.interfaces.ServiceInterruption

Set up a session

Throws:

org.apache.manifoldcf.core.interfaces.ManifoldCFException

org.apache.manifoldcf.agents.interfaces.ServiceInterruption

check

public java.lang.String check()
                       throws org.apache.manifoldcf.core.interfaces.ManifoldCFException

Test the connection. Returns a string describing the connection integrity.

Specified by:

check in interface org.apache.manifoldcf.core.interfaces.IConnector

Overrides:

check in class org.apache.manifoldcf.core.connector.BaseConnector

Returns:

the connection's status as a displayable string.

Throws:

org.apache.manifoldcf.core.interfaces.ManifoldCFException

getOutputDescription

public java.lang.String getOutputDescription(org.apache.manifoldcf.agents.interfaces.OutputSpecification spec)
                                      throws org.apache.manifoldcf.core.interfaces.ManifoldCFException

Get an output version string, given an output specification. The output version string is used to uniquely describe the pertinent details of the output specification and the configuration, to allow the Connector Framework to determine whether a document will need to be output again. Note that the contents of the document cannot be considered by this method, and that a different version string (defined in IRepositoryConnector) is used to describe the version of the actual document. This method presumes that the connector object has been configured, and it is thus able to communicate with the output data store should that be necessary.

Parameters:

spec - is the current output specification for the job that is doing the crawling.

Returns:

a string, of unlimited length, which uniquely describes output configuration and specification in such a way that if two such strings are equal, the document will not need to be sent again to the output data store.

Throws:

org.apache.manifoldcf.core.interfaces.ManifoldCFException

addOrReplaceDocument

public int addOrReplaceDocument(java.lang.String documentURI,
                                java.lang.String outputDescription,
                                org.apache.manifoldcf.agents.interfaces.RepositoryDocument document,
                                java.lang.String authorityNameString,
                                org.apache.manifoldcf.agents.interfaces.IOutputAddActivity activities)
                         throws org.apache.manifoldcf.core.interfaces.ManifoldCFException,
                                org.apache.manifoldcf.agents.interfaces.ServiceInterruption

Add (or replace) a document in the output data store using the connector. This method presumes that the connector object has been configured, and it is thus able to communicate with the output data store should that be necessary. The OutputSpecification is *not* provided to this method, because the goal is consistency, and if output is done it must be consistent with the output description, since that was what was partly used to determine if output should be taking place. So it may be necessary for this method to decode an output description string in order to determine what should be done.

Parameters:

documentURI - is the URI of the document. The URI is presumed to be the unique identifier which the output data store will use to process and serve the document. This URI is constructed by the repository connector which fetches the document, and is thus universal across all output connectors.

outputDescription - is the description string that was constructed for this document by the getOutputDescription() method.

document - is the document data to be processed (handed to the output data store).

authorityNameString - is the name of the authority responsible for authorizing any access tokens passed in with the repository document. May be null.

activities - is the handle to an object that the implementer of an output connector may use to perform operations, such as logging processing activity.

Returns:

the document status (accepted or permanently rejected).

Throws:

org.apache.manifoldcf.core.interfaces.ManifoldCFException

org.apache.manifoldcf.agents.interfaces.ServiceInterruption

removeDocument

public void removeDocument(java.lang.String documentURI,
                           java.lang.String outputDescription,
                           org.apache.manifoldcf.agents.interfaces.IOutputRemoveActivity activities)
                    throws org.apache.manifoldcf.core.interfaces.ManifoldCFException,
                           org.apache.manifoldcf.agents.interfaces.ServiceInterruption

Remove a document using the connector. Note that the last outputDescription is included, since it may be necessary for the connector to use such information to know how to properly remove the document.

Parameters:

documentURI - is the URI of the document. The URI is presumed to be the unique identifier which the output data store will use to process and serve the document. This URI is constructed by the repository connector which fetches the document, and is thus universal across all output connectors.

outputDescription - is the last description string that was constructed for this document by the getOutputDescription() method above.

activities - is the handle to an object that the implementer of an output connector may use to perform operations, such as logging processing activity.

Throws:

org.apache.manifoldcf.core.interfaces.ManifoldCFException

org.apache.manifoldcf.agents.interfaces.ServiceInterruption