public class NullConnector
extends org.apache.manifoldcf.agents.output.BaseOutputConnector
| Modifier and Type | Field and Description |
|---|---|
static java.lang.String |
_rcsid |
static java.lang.String |
INGEST_ACTIVITY
Ingestion activity
|
static java.lang.String |
JOB_COMPLETE_ACTIVITY
Job notify activity
|
static java.lang.String |
REMOVE_ACTIVITY
Document removal activity
|
| Constructor and Description |
|---|
NullConnector()
Constructor.
|
| Modifier and Type | Method and Description |
|---|---|
int |
addOrReplaceDocumentWithException(java.lang.String documentURI,
org.apache.manifoldcf.core.interfaces.VersionContext 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.
|
org.apache.manifoldcf.core.interfaces.VersionContext |
getPipelineDescription(org.apache.manifoldcf.core.interfaces.Specification spec)
Get an output version string, given an output specification.
|
protected void |
getSession()
Set up a session
|
void |
noteJobComplete(org.apache.manifoldcf.agents.interfaces.IOutputNotifyActivity activities)
Notify the connector of a completed job.
|
void |
removeDocument(java.lang.String documentURI,
java.lang.String outputDescription,
org.apache.manifoldcf.agents.interfaces.IOutputRemoveActivity activities)
Remove a document using the connector.
|
checkDateIndexable, checkDocumentIndexable, checkLengthIndexable, checkMimeTypeIndexable, checkURLIndexable, getFormCheckJavascriptMethodName, getFormPresaveCheckJavascriptMethodName, noteAllRecordsRemoved, outputSpecificationBody, outputSpecificationHeader, processSpecificationPost, requestInfo, viewSpecificationclearThreadContext, deinstall, getConfiguration, install, isConnected, outputConfigurationBody, outputConfigurationBody, outputConfigurationHeader, outputConfigurationHeader, outputConfigurationHeader, pack, packFixedList, packList, packList, poll, processConfigurationPost, processConfigurationPost, setThreadContext, unpack, unpackFixedList, unpackList, viewConfiguration, viewConfigurationpublic static final java.lang.String _rcsid
public static final java.lang.String INGEST_ACTIVITY
public static final java.lang.String REMOVE_ACTIVITY
public static final java.lang.String JOB_COMPLETE_ACTIVITY
public java.lang.String[] getActivitiesList()
getActivitiesList in interface org.apache.manifoldcf.agents.interfaces.IOutputConnectorgetActivitiesList in class org.apache.manifoldcf.agents.output.BaseOutputConnectorpublic void connect(org.apache.manifoldcf.core.interfaces.ConfigParams configParameters)
connect in interface org.apache.manifoldcf.core.interfaces.IConnectorconnect in class org.apache.manifoldcf.core.connector.BaseConnectorconfigParameters - 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.)public void disconnect()
throws org.apache.manifoldcf.core.interfaces.ManifoldCFException
disconnect in interface org.apache.manifoldcf.core.interfaces.IConnectordisconnect in class org.apache.manifoldcf.core.connector.BaseConnectororg.apache.manifoldcf.core.interfaces.ManifoldCFExceptionprotected void getSession()
throws org.apache.manifoldcf.core.interfaces.ManifoldCFException,
org.apache.manifoldcf.agents.interfaces.ServiceInterruption
org.apache.manifoldcf.core.interfaces.ManifoldCFExceptionorg.apache.manifoldcf.agents.interfaces.ServiceInterruptionpublic java.lang.String check()
throws org.apache.manifoldcf.core.interfaces.ManifoldCFException
check in interface org.apache.manifoldcf.core.interfaces.IConnectorcheck in class org.apache.manifoldcf.core.connector.BaseConnectororg.apache.manifoldcf.core.interfaces.ManifoldCFExceptionpublic org.apache.manifoldcf.core.interfaces.VersionContext getPipelineDescription(org.apache.manifoldcf.core.interfaces.Specification spec)
throws org.apache.manifoldcf.core.interfaces.ManifoldCFException,
org.apache.manifoldcf.agents.interfaces.ServiceInterruption
getPipelineDescription in interface org.apache.manifoldcf.agents.interfaces.IPipelineConnectorgetPipelineDescription in class org.apache.manifoldcf.agents.output.BaseOutputConnectorspec - is the current output specification for the job that is doing the crawling.org.apache.manifoldcf.core.interfaces.ManifoldCFExceptionorg.apache.manifoldcf.agents.interfaces.ServiceInterruptionpublic int addOrReplaceDocumentWithException(java.lang.String documentURI,
org.apache.manifoldcf.core.interfaces.VersionContext 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,
java.io.IOException
addOrReplaceDocumentWithException in interface org.apache.manifoldcf.agents.interfaces.IPipelineConnectoraddOrReplaceDocumentWithException in class org.apache.manifoldcf.agents.output.BaseOutputConnectordocumentURI - 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.org.apache.manifoldcf.core.interfaces.ManifoldCFExceptionorg.apache.manifoldcf.agents.interfaces.ServiceInterruptionjava.io.IOExceptionpublic 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
removeDocument in interface org.apache.manifoldcf.agents.interfaces.IOutputConnectorremoveDocument in class org.apache.manifoldcf.agents.output.BaseOutputConnectordocumentURI - 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.org.apache.manifoldcf.core.interfaces.ManifoldCFExceptionorg.apache.manifoldcf.agents.interfaces.ServiceInterruptionpublic void noteJobComplete(org.apache.manifoldcf.agents.interfaces.IOutputNotifyActivity activities)
throws org.apache.manifoldcf.core.interfaces.ManifoldCFException,
org.apache.manifoldcf.agents.interfaces.ServiceInterruption
noteJobComplete in interface org.apache.manifoldcf.agents.interfaces.IOutputConnectornoteJobComplete in class org.apache.manifoldcf.agents.output.BaseOutputConnectoractivities - is the handle to an object that the implementer of an output connector may use to perform operations, such as logging processing activity.org.apache.manifoldcf.core.interfaces.ManifoldCFExceptionorg.apache.manifoldcf.agents.interfaces.ServiceInterruption