org.apache.manifoldcf.agents.transformation.nullconnector

Class NullConnector

java.lang.Object

org.apache.manifoldcf.core.connector.BaseConnector

org.apache.manifoldcf.agents.transformation.BaseTransformationConnector

org.apache.manifoldcf.agents.transformation.nullconnector.NullConnector

All Implemented Interfaces:

org.apache.manifoldcf.agents.interfaces.IPipelineConnector, org.apache.manifoldcf.agents.interfaces.ITransformationConnector, org.apache.manifoldcf.core.interfaces.IConnector

public class NullConnector
extends org.apache.manifoldcf.agents.transformation.BaseTransformationConnector

This connector works as a transformation connector, but does nothing other than logging.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	_rcsid
protected static java.lang.String[]	activitiesList
protected static java.lang.String	ACTIVITY_PROCESS

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

currentContext, params

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

DOCUMENTSTATUS_ACCEPTED, DOCUMENTSTATUS_REJECTED

Constructor Summary

Constructors

Constructor and Description
NullConnector()

Method Summary

Modifier and Type	Method and Description
int	addOrReplaceDocumentWithException(java.lang.String documentURI, org.apache.manifoldcf.core.interfaces.VersionContext pipelineDescription, 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[]	getActivitiesList() Return a list of activities that this connector generates.

Methods inherited from class org.apache.manifoldcf.agents.transformation.BaseTransformationConnector

checkDateIndexable, checkDocumentIndexable, checkLengthIndexable, checkMimeTypeIndexable, checkURLIndexable, getFormCheckJavascriptMethodName, getFormPresaveCheckJavascriptMethodName, getPipelineDescription, outputSpecificationBody, outputSpecificationHeader, processSpecificationPost, requestInfo, viewSpecification

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

check, clearThreadContext, connect, deinstall, disconnect, getConfiguration, install, isConnected, outputConfigurationBody, outputConfigurationBody, outputConfigurationHeader, outputConfigurationHeader, outputConfigurationHeader, pack, packFixedList, packList, packList, poll, processConfigurationPost, processConfigurationPost, setThreadContext, unpack, unpackFixedList, unpackList, viewConfiguration, 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

check, clearThreadContext, connect, deinstall, disconnect, getConfiguration, install, isConnected, outputConfigurationBody, outputConfigurationHeader, poll, processConfigurationPost, setThreadContext, viewConfiguration

Field Detail

_rcsid

public static final java.lang.String _rcsid

See Also:

Constant Field Values

ACTIVITY_PROCESS

protected static final java.lang.String ACTIVITY_PROCESS

See Also:

Constant Field Values

activitiesList

protected static final java.lang.String[] activitiesList

Constructor Detail

NullConnector

public NullConnector()

Method Detail

getActivitiesList

public java.lang.String[] getActivitiesList()

Return a list of activities that this connector generates. The connector does NOT need to be connected before this method is called.

Specified by:

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

Overrides:

getActivitiesList in class org.apache.manifoldcf.agents.transformation.BaseTransformationConnector

Returns:

the set of activities.

addOrReplaceDocumentWithException

public int addOrReplaceDocumentWithException(java.lang.String documentURI,
                                             org.apache.manifoldcf.core.interfaces.VersionContext pipelineDescription,
                                             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,
                                             java.io.IOException

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.

Specified by:

addOrReplaceDocumentWithException in interface org.apache.manifoldcf.agents.interfaces.IPipelineConnector

Overrides:

addOrReplaceDocumentWithException in class org.apache.manifoldcf.agents.transformation.BaseTransformationConnector

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.

pipelineDescription - 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 a pipeline connector may use to perform operations, such as logging processing activity, or sending a modified document to the next stage in the pipeline.

Returns:

the document status (accepted or permanently rejected).

Throws:

java.io.IOException - only if there's a stream error reading the document data.

org.apache.manifoldcf.core.interfaces.ManifoldCFException

org.apache.manifoldcf.agents.interfaces.ServiceInterruption