public abstract class BaseTransformationConnector extends BaseConnector implements ITransformationConnector
| Modifier and Type | Field and Description |
|---|---|
static String |
_rcsid |
currentContext, paramsDOCUMENTSTATUS_ACCEPTED, DOCUMENTSTATUS_REJECTED| Constructor and Description |
|---|
BaseTransformationConnector() |
| Modifier and Type | Method and Description |
|---|---|
int |
addOrReplaceDocumentWithException(String documentURI,
VersionContext pipelineDescription,
RepositoryDocument document,
String authorityNameString,
IOutputAddActivity activities)
Add (or replace) a document in the output data store using the connector.
|
boolean |
checkDateIndexable(VersionContext pipelineDescription,
Date date,
IOutputCheckActivity checkActivity)
Detect if a document date is acceptable or not.
|
boolean |
checkDocumentIndexable(VersionContext pipelineDescription,
File localFile,
IOutputCheckActivity checkActivity)
Pre-determine whether a document (passed here as a File object) is acceptable or not.
|
boolean |
checkLengthIndexable(VersionContext pipelineDescription,
long length,
IOutputCheckActivity checkActivity)
Pre-determine whether a document's length is acceptable.
|
boolean |
checkMimeTypeIndexable(VersionContext pipelineDescription,
String mimeType,
IOutputCheckActivity checkActivity)
Detect if a mime type is acceptable or not.
|
boolean |
checkURLIndexable(VersionContext pipelineDescription,
String url,
IOutputCheckActivity checkActivity)
Pre-determine whether a document's URL is acceptable.
|
String[] |
getActivitiesList()
Return the list of activities that this connector supports (i.e.
|
String |
getFormCheckJavascriptMethodName(int connectionSequenceNumber)
Obtain the name of the form check javascript method to call.
|
String |
getFormPresaveCheckJavascriptMethodName(int connectionSequenceNumber)
Obtain the name of the form presave check javascript method to call.
|
VersionContext |
getPipelineDescription(Specification spec)
Get a pipeline version string, given a pipeline specification object.
|
void |
outputSpecificationBody(IHTTPOutput out,
Locale locale,
Specification os,
int connectionSequenceNumber,
int actualSequenceNumber,
String tabName)
Output the specification body section.
|
void |
outputSpecificationHeader(IHTTPOutput out,
Locale locale,
Specification os,
int connectionSequenceNumber,
List<String> tabsArray)
Output the specification header section.
|
String |
processSpecificationPost(IPostParameters variableContext,
Locale locale,
Specification os,
int connectionSequenceNumber)
Process a specification post.
|
boolean |
requestInfo(Configuration output,
String command)
Request arbitrary connector information.
|
void |
viewSpecification(IHTTPOutput out,
Locale locale,
Specification os,
int connectionSequenceNumber)
View specification.
|
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, viewConfigurationclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitcheck, clearThreadContext, connect, deinstall, disconnect, getConfiguration, install, isConnected, outputConfigurationBody, outputConfigurationHeader, poll, processConfigurationPost, setThreadContext, viewConfigurationpublic static final String _rcsid
public String[] getActivitiesList()
getActivitiesList in interface ITransformationConnectorpublic boolean requestInfo(Configuration output, String command) throws ManifoldCFException
requestInfo in interface ITransformationConnectoroutput - is the response object, to be filled in by this method.command - is the command, which is taken directly from the API request.ManifoldCFExceptionpublic boolean checkDateIndexable(VersionContext pipelineDescription, Date date, IOutputCheckActivity checkActivity) throws ManifoldCFException, ServiceInterruption
checkDateIndexable in interface IPipelineConnectorpipelineDescription - is the document's pipeline version string, for this connection.date - is the date of the document.checkActivity - is an object including the activities that can be performed by this method.ManifoldCFExceptionServiceInterruptionpublic boolean checkMimeTypeIndexable(VersionContext pipelineDescription, String mimeType, IOutputCheckActivity checkActivity) throws ManifoldCFException, ServiceInterruption
checkMimeTypeIndexable in interface IPipelineConnectorpipelineDescription - is the document's pipeline version string, for this connection.mimeType - is the mime type of the document.checkActivity - is an object including the activities that can be performed by this method.ManifoldCFExceptionServiceInterruptionpublic boolean checkDocumentIndexable(VersionContext pipelineDescription, File localFile, IOutputCheckActivity checkActivity) throws ManifoldCFException, ServiceInterruption
checkDocumentIndexable in interface IPipelineConnectorpipelineDescription - is the document's pipeline version string, for this connection.localFile - is the local file to check.checkActivity - is an object including the activities that can be done by this method.ManifoldCFExceptionServiceInterruptionpublic boolean checkLengthIndexable(VersionContext pipelineDescription, long length, IOutputCheckActivity checkActivity) throws ManifoldCFException, ServiceInterruption
checkLengthIndexable in interface IPipelineConnectorpipelineDescription - is the document's pipeline version string, for this connection.length - is the length of the document.checkActivity - is an object including the activities that can be done by this method.ManifoldCFExceptionServiceInterruptionpublic boolean checkURLIndexable(VersionContext pipelineDescription, String url, IOutputCheckActivity checkActivity) throws ManifoldCFException, ServiceInterruption
checkURLIndexable in interface IPipelineConnectorpipelineDescription - is the document's pipeline version string, for this connection.url - is the URL of the document.checkActivity - is an object including the activities that can be done by this method.ManifoldCFExceptionServiceInterruptionpublic VersionContext getPipelineDescription(Specification spec) throws ManifoldCFException, ServiceInterruption
getPipelineDescription in interface IPipelineConnectorspec - is the current pipeline specification object for this connection for the job that is doing the crawling.ManifoldCFExceptionServiceInterruptionpublic int addOrReplaceDocumentWithException(String documentURI, VersionContext pipelineDescription, RepositoryDocument document, String authorityNameString, IOutputAddActivity activities) throws ManifoldCFException, ServiceInterruption, IOException
addOrReplaceDocumentWithException in interface IPipelineConnectordocumentURI - 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 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.IOException - only if there's a stream error reading the document data.ManifoldCFExceptionServiceInterruptionpublic String getFormCheckJavascriptMethodName(int connectionSequenceNumber)
getFormCheckJavascriptMethodName in interface IPipelineConnectorconnectionSequenceNumber - is the unique number of this connection within the job.public String getFormPresaveCheckJavascriptMethodName(int connectionSequenceNumber)
getFormPresaveCheckJavascriptMethodName in interface IPipelineConnectorconnectionSequenceNumber - is the unique number of this connection within the job.public void outputSpecificationHeader(IHTTPOutput out, Locale locale, Specification os, int connectionSequenceNumber, List<String> tabsArray) throws ManifoldCFException, IOException
outputSpecificationHeader in interface IPipelineConnectorout - is the output to which any HTML should be sent.locale - is the preferred local of the output.os - is the current output specification for this job.connectionSequenceNumber - is the unique number of this connection within the job.tabsArray - is an array of tab names. Add to this array any tab names that are specific to the connector.ManifoldCFExceptionIOExceptionpublic void outputSpecificationBody(IHTTPOutput out, Locale locale, Specification os, int connectionSequenceNumber, int actualSequenceNumber, String tabName) throws ManifoldCFException, IOException
outputSpecificationBody in interface IPipelineConnectorout - is the output to which any HTML should be sent.locale - is the preferred local of the output.os - is the current output specification for this job.connectionSequenceNumber - is the unique number of this connection within the job.actualSequenceNumber - is the connection within the job that has currently been selected.tabName - is the current tab name.ManifoldCFExceptionIOExceptionpublic String processSpecificationPost(IPostParameters variableContext, Locale locale, Specification os, int connectionSequenceNumber) throws ManifoldCFException
processSpecificationPost in interface IPipelineConnectorvariableContext - contains the post data, including binary file-upload information.locale - is the preferred local of the output.os - is the current output specification for this job.connectionSequenceNumber - is the unique number of this connection within the job.ManifoldCFExceptionpublic void viewSpecification(IHTTPOutput out, Locale locale, Specification os, int connectionSequenceNumber) throws ManifoldCFException, IOException
viewSpecification in interface IPipelineConnectorout - is the output to which any HTML should be sent.locale - is the preferred local of the output.connectionSequenceNumber - is the unique number of this connection within the job.os - is the current output specification for this job.ManifoldCFExceptionIOException