public class SearchBloxConnector extends BaseOutputConnector
| Modifier and Type | Class and Description |
|---|---|
protected static class |
SearchBloxConnector.SpecPacker |
| Modifier and Type | Field and Description |
|---|---|
static String |
CREATION_ACTIVITY
Collection Creation activity
|
static String |
INGEST_ACTIVITY
Ingestion activity
|
static String |
REMOVE_ACTIVITY
Document removal activity
|
_rcsidcurrentContext, paramsDOCUMENTSTATUS_ACCEPTED, DOCUMENTSTATUS_REJECTED| Constructor and Description |
|---|
SearchBloxConnector() |
| 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.
|
String |
check() |
boolean |
checkLengthIndexable(VersionContext outputDescription,
long length,
IOutputCheckActivity activities)
Pre-determine whether a document's length is indexable by this connector.
|
boolean |
checkMimeTypeIndexable(VersionContext outputDescription,
String mimeType,
IOutputCheckActivity activities)
Detect if a mime type is indexable or not.
|
void |
connect(ConfigParams configParams)
Connect.
|
void |
disconnect()
Close the connection.
|
String[] |
getActivitiesList()
Return the list of activities that this connector supports (i.e.
|
VersionContext |
getPipelineDescription(Specification spec)
Get an output version string, given an output specification.
|
protected void |
getSession() |
boolean |
isConnected()
This method is called to assess whether to count this connector instance
should actually be counted as being connected.
|
void |
outputConfigurationBody(IThreadContext threadContext,
IHTTPOutput out,
Locale locale,
ConfigParams parameters,
String tabName) |
void |
outputConfigurationHeader(IThreadContext threadContext,
IHTTPOutput out,
Locale locale,
ConfigParams parameters,
List<String> tabsArray) |
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 |
processConfigurationPost(IThreadContext threadContext,
IPostParameters variableContext,
Locale locale,
ConfigParams parameters)
Process a configuration post.
|
String |
processSpecificationPost(IPostParameters variableContext,
Locale locale,
Specification os,
int connectionSequenceNumber)
Process a specification post.
|
void |
removeDocument(String documentURI,
String outputDescription,
IOutputRemoveActivity activities)
Remove a document using the connector.
|
void |
viewConfiguration(IThreadContext threadContext,
IHTTPOutput out,
Locale locale,
ConfigParams parameters) |
void |
viewSpecification(IHTTPOutput out,
Locale locale,
Specification os,
int connectionSequenceNumber)
View specification.
|
addOrReplaceDocument, checkDateIndexable, checkDocumentIndexable, checkDocumentIndexable, checkDocumentIndexable, checkLengthIndexable, checkMimeTypeIndexable, checkMimeTypeIndexable, checkURLIndexable, checkURLIndexable, getFormCheckJavascriptMethodName, getFormPresaveCheckJavascriptMethodName, getOutputDescription, noteAllRecordsRemoved, noteJobComplete, outputSpecificationBody, outputSpecificationBody, outputSpecificationHeader, outputSpecificationHeader, outputSpecificationHeader, processSpecificationPost, processSpecificationPost, requestInfo, viewSpecification, viewSpecificationclearThreadContext, deinstall, getConfiguration, install, outputConfigurationBody, outputConfigurationHeader, outputConfigurationHeader, pack, packFixedList, packList, packList, poll, processConfigurationPost, setThreadContext, unpack, unpackFixedList, unpackList, viewConfigurationclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitclearThreadContext, deinstall, getConfiguration, install, poll, setThreadContextpublic static final String INGEST_ACTIVITY
public static final String REMOVE_ACTIVITY
public static final String CREATION_ACTIVITY
public void connect(ConfigParams configParams)
connect in interface IConnectorconnect in class BaseConnectorpublic boolean isConnected()
isConnected in interface IConnectorisConnected in class BaseConnectorpublic void disconnect()
throws ManifoldCFException
disconnect in interface IConnectordisconnect in class BaseConnectorManifoldCFExceptionpublic String[] getActivitiesList()
getActivitiesList in interface IOutputConnectorgetActivitiesList in class BaseOutputConnectorprotected void getSession()
throws ManifoldCFException
ManifoldCFExceptionpublic String check() throws ManifoldCFException
check in interface IConnectorcheck in class BaseConnectorManifoldCFExceptionpublic VersionContext getPipelineDescription(Specification spec) throws ManifoldCFException, ServiceInterruption
getPipelineDescription in interface IPipelineConnectorgetPipelineDescription in class BaseOutputConnectorspec - is the current output specification for the job that is doing
the crawling.ManifoldCFExceptionServiceInterruptionpublic boolean checkMimeTypeIndexable(VersionContext outputDescription, String mimeType, IOutputCheckActivity activities) throws ManifoldCFException, ServiceInterruption
checkMimeTypeIndexable in interface IPipelineConnectorcheckMimeTypeIndexable in class BaseOutputConnectoroutputDescription - is the document's output version.mimeType - is the mime type of the document.ManifoldCFExceptionServiceInterruptionpublic boolean checkLengthIndexable(VersionContext outputDescription, long length, IOutputCheckActivity activities) throws ManifoldCFException, ServiceInterruption
checkLengthIndexable in interface IPipelineConnectorcheckLengthIndexable in class BaseOutputConnectoroutputDescription - is the document's output version.length - is the length of the document.ManifoldCFExceptionServiceInterruptionpublic int addOrReplaceDocumentWithException(String documentURI, VersionContext pipelineDescription, RepositoryDocument document, String authorityNameString, IOutputAddActivity activities) throws ManifoldCFException, ServiceInterruption, IOException
addOrReplaceDocumentWithException in interface IPipelineConnectoraddOrReplaceDocumentWithException in class 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.pipelineDescription - includes 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 void removeDocument(String documentURI, String outputDescription, IOutputRemoveActivity activities) throws ManifoldCFException, ServiceInterruption
removeDocument in interface IOutputConnectorremoveDocument in class 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.ManifoldCFExceptionServiceInterruptionpublic void outputConfigurationHeader(IThreadContext threadContext, IHTTPOutput out, Locale locale, ConfigParams parameters, List<String> tabsArray) throws ManifoldCFException, IOException
outputConfigurationHeader in interface IConnectoroutputConfigurationHeader in class BaseConnectorManifoldCFExceptionIOExceptionpublic void outputConfigurationBody(IThreadContext threadContext, IHTTPOutput out, Locale locale, ConfigParams parameters, String tabName) throws ManifoldCFException, IOException
outputConfigurationBody in interface IConnectoroutputConfigurationBody in class BaseConnectorManifoldCFExceptionIOExceptionpublic void viewConfiguration(IThreadContext threadContext, IHTTPOutput out, Locale locale, ConfigParams parameters) throws ManifoldCFException, IOException
viewConfiguration in interface IConnectorviewConfiguration in class BaseConnectorManifoldCFExceptionIOExceptionpublic String processConfigurationPost(IThreadContext threadContext, IPostParameters variableContext, Locale locale, ConfigParams parameters) throws ManifoldCFException
processConfigurationPost in interface IConnectorprocessConfigurationPost in class BaseConnectorthreadContext - is the local thread context.variableContext - is the set of variables available from the post, including
binary file post information.parameters - are the configuration parameters, as they currently exist, for
this connection being configured.ManifoldCFExceptionpublic void outputSpecificationHeader(IHTTPOutput out, Locale locale, Specification os, int connectionSequenceNumber, List<String> tabsArray) throws ManifoldCFException, IOException
outputSpecificationHeader in interface IPipelineConnectoroutputSpecificationHeader in class BaseOutputConnectorout - is the output to which any HTML should be sent.locale - is the preferred local of the output.os - is the current pipeline specification for this connection.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 viewSpecification(IHTTPOutput out, Locale locale, Specification os, int connectionSequenceNumber) throws ManifoldCFException, IOException
viewSpecification in interface IPipelineConnectorviewSpecification in class BaseOutputConnectorout - 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 pipeline specification for this job.ManifoldCFExceptionIOExceptionpublic void outputSpecificationBody(IHTTPOutput out, Locale locale, Specification os, int connectionSequenceNumber, int actualSequenceNumber, String tabName) throws ManifoldCFException, IOException
outputSpecificationBody in interface IPipelineConnectoroutputSpecificationBody in class BaseOutputConnectorout - is the output to which any HTML should be sent.locale - is the preferred local of the output.os - is the current pipeline 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 IPipelineConnectorprocessSpecificationPost in class BaseOutputConnectorvariableContext - contains the post data, including binary file-upload
information.locale - is the preferred local of the output.os - is the current pipeline specification for this job.connectionSequenceNumber - is the unique number of this connection within the job.ManifoldCFException