Class TikaExtractor
- java.lang.Object
-
- org.apache.manifoldcf.core.connector.BaseConnector
-
- org.apache.manifoldcf.agents.transformation.BaseTransformationConnector
-
- org.apache.manifoldcf.agents.transformation.tikaservice.rmeta.TikaExtractor
-
- All Implemented Interfaces:
org.apache.manifoldcf.agents.interfaces.IPipelineConnector
,org.apache.manifoldcf.agents.interfaces.ITransformationConnector
,org.apache.manifoldcf.core.interfaces.IConnector
public class TikaExtractor extends org.apache.manifoldcf.agents.transformation.BaseTransformationConnector
This connector works as a transformation connector, but does nothing other than logging.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected static interface
TikaExtractor.DestinationStorage
protected static class
TikaExtractor.FileDestinationStorage
protected static class
TikaExtractor.MemoryDestinationStorage
protected static class
TikaExtractor.SpecPacker
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
_rcsid
protected static java.lang.String[]
activitiesList
protected static java.lang.String
ACTIVITY_EXTRACT
protected static long
inMemoryMaximumFile
We handle up to 64K in memory; after that we go to disk.protected static java.net.URI
rmetaURI
Metadata URIprotected static long
sessionExpirationInterval
-
Constructor Summary
Constructors Constructor Description TikaExtractor()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method 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
check()
Test the connection.boolean
checkDocumentIndexable(org.apache.manifoldcf.core.interfaces.VersionContext pipelineDescription, java.io.File localFile, org.apache.manifoldcf.agents.interfaces.IOutputCheckActivity checkActivity)
Pre-determine whether a document (passed here as a File object) is acceptable or not.boolean
checkLengthIndexable(org.apache.manifoldcf.core.interfaces.VersionContext pipelineDescription, long length, org.apache.manifoldcf.agents.interfaces.IOutputCheckActivity checkActivity)
Pre-determine whether a document's length is acceptable.boolean
checkMimeTypeIndexable(org.apache.manifoldcf.core.interfaces.VersionContext pipelineDescription, java.lang.String mimeType, org.apache.manifoldcf.agents.interfaces.IOutputCheckActivity checkActivity)
Detect if a mime type is acceptable or not.void
connect(org.apache.manifoldcf.core.interfaces.ConfigParams configParameters)
Connect.void
disconnect()
Close the connection.protected void
expireSession()
Expire the current sessionprotected static void
fillInServerTab(java.util.Map<java.lang.String,java.lang.Object> velocityContext, org.apache.manifoldcf.core.interfaces.IHTTPOutput out, org.apache.manifoldcf.core.interfaces.ConfigParams parameters)
protected static void
fillInTikaSpecificationMap(java.util.Map<java.lang.String,java.lang.Object> paramMap, org.apache.manifoldcf.core.interfaces.Specification os)
java.lang.String[]
getActivitiesList()
Return a list of activities that this connector generates.java.lang.String
getFormCheckJavascriptMethodName(int connectionSequenceNumber)
Obtain the name of the form check javascript method to call.java.lang.String
getFormPresaveCheckJavascriptMethodName(int connectionSequenceNumber)
Obtain the name of the form presave check javascript method to call.org.apache.manifoldcf.core.interfaces.VersionContext
getPipelineDescription(org.apache.manifoldcf.core.interfaces.Specification os)
Get an output version string, given an output specification.protected void
getSession()
Set up a sessionprotected static int
handleIOException(java.io.IOException e)
protected static int
handleTikaServerError(java.lang.String description)
protected static int
handleTikaServerException(java.io.IOException e)
protected static int
handleTikaServerException(org.json.simple.parser.ParseException e)
protected static int
handleTikaServerRejects(java.lang.String reason)
boolean
isConnected()
This method is called to assess whether to count this connector instance should actually be counted as being connected.void
outputConfigurationBody(org.apache.manifoldcf.core.interfaces.IThreadContext threadContext, org.apache.manifoldcf.core.interfaces.IHTTPOutput out, java.util.Locale locale, org.apache.manifoldcf.core.interfaces.ConfigParams parameters, java.lang.String tabName)
Output the configuration body section.void
outputConfigurationHeader(org.apache.manifoldcf.core.interfaces.IThreadContext threadContext, org.apache.manifoldcf.core.interfaces.IHTTPOutput out, java.util.Locale locale, org.apache.manifoldcf.core.interfaces.ConfigParams parameters, java.util.List<java.lang.String> tabsArray)
Output the configuration header section.void
outputSpecificationBody(org.apache.manifoldcf.core.interfaces.IHTTPOutput out, java.util.Locale locale, org.apache.manifoldcf.core.interfaces.Specification os, int connectionSequenceNumber, int actualSequenceNumber, java.lang.String tabName)
Output the specification body section.void
outputSpecificationHeader(org.apache.manifoldcf.core.interfaces.IHTTPOutput out, java.util.Locale locale, org.apache.manifoldcf.core.interfaces.Specification os, int connectionSequenceNumber, java.util.List<java.lang.String> tabsArray)
Output the specification header section.void
poll()
This method is periodically called for all connectors that are connected but not in active use.java.lang.String
processConfigurationPost(org.apache.manifoldcf.core.interfaces.IThreadContext threadContext, org.apache.manifoldcf.core.interfaces.IPostParameters variableContext, java.util.Locale locale, org.apache.manifoldcf.core.interfaces.ConfigParams parameters)
Process a configuration post.java.lang.String
processSpecificationPost(org.apache.manifoldcf.core.interfaces.IPostParameters variableContext, java.util.Locale locale, org.apache.manifoldcf.core.interfaces.Specification os, int connectionSequenceNumber)
Process a specification post.void
viewConfiguration(org.apache.manifoldcf.core.interfaces.IThreadContext threadContext, org.apache.manifoldcf.core.interfaces.IHTTPOutput out, java.util.Locale locale, org.apache.manifoldcf.core.interfaces.ConfigParams parameters)
View configuration.void
viewSpecification(org.apache.manifoldcf.core.interfaces.IHTTPOutput out, java.util.Locale locale, org.apache.manifoldcf.core.interfaces.Specification os, int connectionSequenceNumber)
View specification.-
Methods inherited from class org.apache.manifoldcf.agents.transformation.BaseTransformationConnector
checkDateIndexable, checkURLIndexable, requestInfo
-
Methods inherited from class org.apache.manifoldcf.core.connector.BaseConnector
clearThreadContext, deinstall, getConfiguration, install, outputConfigurationBody, outputConfigurationHeader, outputConfigurationHeader, pack, packFixedList, packList, packList, processConfigurationPost, setThreadContext, unpack, unpackFixedList, unpackList, viewConfiguration
-
-
-
-
Field Detail
-
_rcsid
public static final java.lang.String _rcsid
- See Also:
- Constant Field Values
-
ACTIVITY_EXTRACT
protected static final java.lang.String ACTIVITY_EXTRACT
- See Also:
- Constant Field Values
-
activitiesList
protected static final java.lang.String[] activitiesList
-
sessionExpirationInterval
protected static final long sessionExpirationInterval
- See Also:
- Constant Field Values
-
inMemoryMaximumFile
protected static final long inMemoryMaximumFile
We handle up to 64K in memory; after that we go to disk.- See Also:
- Constant Field Values
-
rmetaURI
protected static final java.net.URI rmetaURI
Metadata URI
-
-
Method Detail
-
connect
public void connect(org.apache.manifoldcf.core.interfaces.ConfigParams configParameters)
Connect.- Specified by:
connect
in interfaceorg.apache.manifoldcf.core.interfaces.IConnector
- Overrides:
connect
in classorg.apache.manifoldcf.core.connector.BaseConnector
- Parameters:
configParameters
- is the set of configuration parameters, which in this case describe the root directory.
-
disconnect
public void disconnect() throws org.apache.manifoldcf.core.interfaces.ManifoldCFException
Close the connection. Call this before discarding the repository connector.- Specified by:
disconnect
in interfaceorg.apache.manifoldcf.core.interfaces.IConnector
- Overrides:
disconnect
in classorg.apache.manifoldcf.core.connector.BaseConnector
- Throws:
org.apache.manifoldcf.core.interfaces.ManifoldCFException
-
poll
public void poll() throws org.apache.manifoldcf.core.interfaces.ManifoldCFException
This method is periodically called for all connectors that are connected but not in active use.- Specified by:
poll
in interfaceorg.apache.manifoldcf.core.interfaces.IConnector
- Overrides:
poll
in classorg.apache.manifoldcf.core.connector.BaseConnector
- Throws:
org.apache.manifoldcf.core.interfaces.ManifoldCFException
-
isConnected
public boolean isConnected()
This method is called to assess whether to count this connector instance should actually be counted as being connected.- Specified by:
isConnected
in interfaceorg.apache.manifoldcf.core.interfaces.IConnector
- Overrides:
isConnected
in classorg.apache.manifoldcf.core.connector.BaseConnector
- Returns:
- true if the connector instance is actually connected.
-
getSession
protected void getSession() throws org.apache.manifoldcf.core.interfaces.ManifoldCFException
Set up a session- Throws:
org.apache.manifoldcf.core.interfaces.ManifoldCFException
-
expireSession
protected void expireSession() throws org.apache.manifoldcf.core.interfaces.ManifoldCFException
Expire the current session- Throws:
org.apache.manifoldcf.core.interfaces.ManifoldCFException
-
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 interfaceorg.apache.manifoldcf.core.interfaces.IConnector
- Overrides:
check
in classorg.apache.manifoldcf.core.connector.BaseConnector
- Returns:
- the connection's status as a displayable string.
- Throws:
org.apache.manifoldcf.core.interfaces.ManifoldCFException
-
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 interfaceorg.apache.manifoldcf.agents.interfaces.ITransformationConnector
- Overrides:
getActivitiesList
in classorg.apache.manifoldcf.agents.transformation.BaseTransformationConnector
- Returns:
- the set of activities.
-
outputConfigurationHeader
public void outputConfigurationHeader(org.apache.manifoldcf.core.interfaces.IThreadContext threadContext, org.apache.manifoldcf.core.interfaces.IHTTPOutput out, java.util.Locale locale, org.apache.manifoldcf.core.interfaces.ConfigParams parameters, java.util.List<java.lang.String> tabsArray) throws org.apache.manifoldcf.core.interfaces.ManifoldCFException, java.io.IOException
Output the configuration header section. This method is called in the head section of the connector's configuration page. Its purpose is to add the required tabs to the list, and to output any javascript methods that might be needed by the configuration editing HTML.- Specified by:
outputConfigurationHeader
in interfaceorg.apache.manifoldcf.core.interfaces.IConnector
- Overrides:
outputConfigurationHeader
in classorg.apache.manifoldcf.core.connector.BaseConnector
- Parameters:
threadContext
- is the local thread context.out
- is the output to which any HTML should be sent.parameters
- are the configuration parameters, as they currently exist, for this connection being configured.tabsArray
- is an array of tab names. Add to this array any tab names that are specific to the connector.- Throws:
org.apache.manifoldcf.core.interfaces.ManifoldCFException
java.io.IOException
-
outputConfigurationBody
public void outputConfigurationBody(org.apache.manifoldcf.core.interfaces.IThreadContext threadContext, org.apache.manifoldcf.core.interfaces.IHTTPOutput out, java.util.Locale locale, org.apache.manifoldcf.core.interfaces.ConfigParams parameters, java.lang.String tabName) throws org.apache.manifoldcf.core.interfaces.ManifoldCFException, java.io.IOException
Output the configuration body section. This method is called in the body section of the connector's configuration page. Its purpose is to present the required form elements for editing. The coder can presume that the HTML that is output from this configuration will be within appropriate <html>, <body>, and <form> tags. The name of the form is "editconnection".- Specified by:
outputConfigurationBody
in interfaceorg.apache.manifoldcf.core.interfaces.IConnector
- Overrides:
outputConfigurationBody
in classorg.apache.manifoldcf.core.connector.BaseConnector
- Parameters:
threadContext
- is the local thread context.out
- is the output to which any HTML should be sent.parameters
- are the configuration parameters, as they currently exist, for this connection being configured.tabName
- is the current tab name.- Throws:
org.apache.manifoldcf.core.interfaces.ManifoldCFException
java.io.IOException
-
processConfigurationPost
public java.lang.String processConfigurationPost(org.apache.manifoldcf.core.interfaces.IThreadContext threadContext, org.apache.manifoldcf.core.interfaces.IPostParameters variableContext, java.util.Locale locale, org.apache.manifoldcf.core.interfaces.ConfigParams parameters) throws org.apache.manifoldcf.core.interfaces.ManifoldCFException
Process a configuration post. This method is called at the start of the connector's configuration page, whenever there is a possibility that form data for a connection has been posted. Its purpose is to gather form information and modify the configuration parameters accordingly. The name of the posted form is "editconnection".- Specified by:
processConfigurationPost
in interfaceorg.apache.manifoldcf.core.interfaces.IConnector
- Overrides:
processConfigurationPost
in classorg.apache.manifoldcf.core.connector.BaseConnector
- Parameters:
threadContext
- 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.- Returns:
- null if all is well, or a string error message if there is an error that should prevent saving of the connection (and cause a redirection to an error page).
- Throws:
org.apache.manifoldcf.core.interfaces.ManifoldCFException
-
viewConfiguration
public void viewConfiguration(org.apache.manifoldcf.core.interfaces.IThreadContext threadContext, org.apache.manifoldcf.core.interfaces.IHTTPOutput out, java.util.Locale locale, org.apache.manifoldcf.core.interfaces.ConfigParams parameters) throws org.apache.manifoldcf.core.interfaces.ManifoldCFException, java.io.IOException
View configuration. This method is called in the body section of the connector's view configuration page. Its purpose is to present the connection information to the user. The coder can presume that the HTML that is output from this configuration will be within appropriate <html> and <body> tags.- Specified by:
viewConfiguration
in interfaceorg.apache.manifoldcf.core.interfaces.IConnector
- Overrides:
viewConfiguration
in classorg.apache.manifoldcf.core.connector.BaseConnector
- Parameters:
threadContext
- is the local thread context.out
- is the output to which any HTML should be sent.parameters
- are the configuration parameters, as they currently exist, for this connection being configured.- Throws:
org.apache.manifoldcf.core.interfaces.ManifoldCFException
java.io.IOException
-
fillInServerTab
protected static void fillInServerTab(java.util.Map<java.lang.String,java.lang.Object> velocityContext, org.apache.manifoldcf.core.interfaces.IHTTPOutput out, org.apache.manifoldcf.core.interfaces.ConfigParams parameters) throws org.apache.manifoldcf.core.interfaces.ManifoldCFException
- Throws:
org.apache.manifoldcf.core.interfaces.ManifoldCFException
-
getPipelineDescription
public org.apache.manifoldcf.core.interfaces.VersionContext getPipelineDescription(org.apache.manifoldcf.core.interfaces.Specification os) throws org.apache.manifoldcf.core.interfaces.ManifoldCFException, org.apache.manifoldcf.agents.interfaces.ServiceInterruption
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.- Specified by:
getPipelineDescription
in interfaceorg.apache.manifoldcf.agents.interfaces.IPipelineConnector
- Overrides:
getPipelineDescription
in classorg.apache.manifoldcf.agents.transformation.BaseTransformationConnector
- Parameters:
os
- 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
org.apache.manifoldcf.agents.interfaces.ServiceInterruption
-
checkMimeTypeIndexable
public boolean checkMimeTypeIndexable(org.apache.manifoldcf.core.interfaces.VersionContext pipelineDescription, java.lang.String mimeType, org.apache.manifoldcf.agents.interfaces.IOutputCheckActivity checkActivity) throws org.apache.manifoldcf.core.interfaces.ManifoldCFException, org.apache.manifoldcf.agents.interfaces.ServiceInterruption
Detect if a mime type is acceptable or not. This method is used to determine whether it makes sense to fetch a document in the first place.- Specified by:
checkMimeTypeIndexable
in interfaceorg.apache.manifoldcf.agents.interfaces.IPipelineConnector
- Overrides:
checkMimeTypeIndexable
in classorg.apache.manifoldcf.agents.transformation.BaseTransformationConnector
- Parameters:
pipelineDescription
- 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.- Returns:
- true if the mime type can be accepted by this connector.
- Throws:
org.apache.manifoldcf.core.interfaces.ManifoldCFException
org.apache.manifoldcf.agents.interfaces.ServiceInterruption
-
checkDocumentIndexable
public boolean checkDocumentIndexable(org.apache.manifoldcf.core.interfaces.VersionContext pipelineDescription, java.io.File localFile, org.apache.manifoldcf.agents.interfaces.IOutputCheckActivity checkActivity) throws org.apache.manifoldcf.core.interfaces.ManifoldCFException, org.apache.manifoldcf.agents.interfaces.ServiceInterruption
Pre-determine whether a document (passed here as a File object) is acceptable or not. This method is used to determine whether a document needs to be actually transferred. This hook is provided mainly to support search engines that only handle a small set of accepted file types.- Specified by:
checkDocumentIndexable
in interfaceorg.apache.manifoldcf.agents.interfaces.IPipelineConnector
- Overrides:
checkDocumentIndexable
in classorg.apache.manifoldcf.agents.transformation.BaseTransformationConnector
- Parameters:
pipelineDescription
- 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.- Returns:
- true if the file is acceptable, false if not.
- Throws:
org.apache.manifoldcf.core.interfaces.ManifoldCFException
org.apache.manifoldcf.agents.interfaces.ServiceInterruption
-
checkLengthIndexable
public boolean checkLengthIndexable(org.apache.manifoldcf.core.interfaces.VersionContext pipelineDescription, long length, org.apache.manifoldcf.agents.interfaces.IOutputCheckActivity checkActivity) throws org.apache.manifoldcf.core.interfaces.ManifoldCFException, org.apache.manifoldcf.agents.interfaces.ServiceInterruption
Pre-determine whether a document's length is acceptable. This method is used to determine whether to fetch a document in the first place.- Specified by:
checkLengthIndexable
in interfaceorg.apache.manifoldcf.agents.interfaces.IPipelineConnector
- Overrides:
checkLengthIndexable
in classorg.apache.manifoldcf.agents.transformation.BaseTransformationConnector
- Parameters:
pipelineDescription
- 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.- Returns:
- true if the file is acceptable, false if not.
- Throws:
org.apache.manifoldcf.core.interfaces.ManifoldCFException
org.apache.manifoldcf.agents.interfaces.ServiceInterruption
-
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 interfaceorg.apache.manifoldcf.agents.interfaces.IPipelineConnector
- Overrides:
addOrReplaceDocumentWithException
in classorg.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
-
getFormCheckJavascriptMethodName
public java.lang.String getFormCheckJavascriptMethodName(int connectionSequenceNumber)
Obtain the name of the form check javascript method to call.- Specified by:
getFormCheckJavascriptMethodName
in interfaceorg.apache.manifoldcf.agents.interfaces.IPipelineConnector
- Overrides:
getFormCheckJavascriptMethodName
in classorg.apache.manifoldcf.agents.transformation.BaseTransformationConnector
- Parameters:
connectionSequenceNumber
- is the unique number of this connection within the job.- Returns:
- the name of the form check javascript method.
-
getFormPresaveCheckJavascriptMethodName
public java.lang.String getFormPresaveCheckJavascriptMethodName(int connectionSequenceNumber)
Obtain the name of the form presave check javascript method to call.- Specified by:
getFormPresaveCheckJavascriptMethodName
in interfaceorg.apache.manifoldcf.agents.interfaces.IPipelineConnector
- Overrides:
getFormPresaveCheckJavascriptMethodName
in classorg.apache.manifoldcf.agents.transformation.BaseTransformationConnector
- Parameters:
connectionSequenceNumber
- is the unique number of this connection within the job.- Returns:
- the name of the form presave check javascript method.
-
outputSpecificationHeader
public void outputSpecificationHeader(org.apache.manifoldcf.core.interfaces.IHTTPOutput out, java.util.Locale locale, org.apache.manifoldcf.core.interfaces.Specification os, int connectionSequenceNumber, java.util.List<java.lang.String> tabsArray) throws org.apache.manifoldcf.core.interfaces.ManifoldCFException, java.io.IOException
Output the specification header section. This method is called in the head section of a job page which has selected a pipeline connection of the current type. Its purpose is to add the required tabs to the list, and to output any javascript methods that might be needed by the job editing HTML.- Specified by:
outputSpecificationHeader
in interfaceorg.apache.manifoldcf.agents.interfaces.IPipelineConnector
- Overrides:
outputSpecificationHeader
in classorg.apache.manifoldcf.agents.transformation.BaseTransformationConnector
- Parameters:
out
- 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.- Throws:
org.apache.manifoldcf.core.interfaces.ManifoldCFException
java.io.IOException
-
outputSpecificationBody
public void outputSpecificationBody(org.apache.manifoldcf.core.interfaces.IHTTPOutput out, java.util.Locale locale, org.apache.manifoldcf.core.interfaces.Specification os, int connectionSequenceNumber, int actualSequenceNumber, java.lang.String tabName) throws org.apache.manifoldcf.core.interfaces.ManifoldCFException, java.io.IOException
Output the specification body section. This method is called in the body section of a job page which has selected a pipeline connection of the current type. Its purpose is to present the required form elements for editing. The coder can presume that the HTML that is output from this configuration will be within appropriate <html>, <body>, and <form> tags. The name of the form is "editjob".- Specified by:
outputSpecificationBody
in interfaceorg.apache.manifoldcf.agents.interfaces.IPipelineConnector
- Overrides:
outputSpecificationBody
in classorg.apache.manifoldcf.agents.transformation.BaseTransformationConnector
- Parameters:
out
- 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.- Throws:
org.apache.manifoldcf.core.interfaces.ManifoldCFException
java.io.IOException
-
processSpecificationPost
public java.lang.String processSpecificationPost(org.apache.manifoldcf.core.interfaces.IPostParameters variableContext, java.util.Locale locale, org.apache.manifoldcf.core.interfaces.Specification os, int connectionSequenceNumber) throws org.apache.manifoldcf.core.interfaces.ManifoldCFException
Process a specification post. This method is called at the start of job's edit or view page, whenever there is a possibility that form data for a connection has been posted. Its purpose is to gather form information and modify the transformation specification accordingly. The name of the posted form is "editjob".- Specified by:
processSpecificationPost
in interfaceorg.apache.manifoldcf.agents.interfaces.IPipelineConnector
- Overrides:
processSpecificationPost
in classorg.apache.manifoldcf.agents.transformation.BaseTransformationConnector
- Parameters:
variableContext
- 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.- Returns:
- null if all is well, or a string error message if there is an error that should prevent saving of the job (and cause a redirection to an error page).
- Throws:
org.apache.manifoldcf.core.interfaces.ManifoldCFException
-
viewSpecification
public void viewSpecification(org.apache.manifoldcf.core.interfaces.IHTTPOutput out, java.util.Locale locale, org.apache.manifoldcf.core.interfaces.Specification os, int connectionSequenceNumber) throws org.apache.manifoldcf.core.interfaces.ManifoldCFException, java.io.IOException
View specification. This method is called in the body section of a job's view page. Its purpose is to present the pipeline specification information to the user. The coder can presume that the HTML that is output from this configuration will be within appropriate <html> and <body> tags.- Specified by:
viewSpecification
in interfaceorg.apache.manifoldcf.agents.interfaces.IPipelineConnector
- Overrides:
viewSpecification
in classorg.apache.manifoldcf.agents.transformation.BaseTransformationConnector
- Parameters:
out
- 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.- Throws:
org.apache.manifoldcf.core.interfaces.ManifoldCFException
java.io.IOException
-
fillInTikaSpecificationMap
protected static void fillInTikaSpecificationMap(java.util.Map<java.lang.String,java.lang.Object> paramMap, org.apache.manifoldcf.core.interfaces.Specification os)
-
handleTikaServerRejects
protected static int handleTikaServerRejects(java.lang.String reason) throws java.io.IOException, org.apache.manifoldcf.core.interfaces.ManifoldCFException, org.apache.manifoldcf.agents.interfaces.ServiceInterruption
- Throws:
java.io.IOException
org.apache.manifoldcf.core.interfaces.ManifoldCFException
org.apache.manifoldcf.agents.interfaces.ServiceInterruption
-
handleTikaServerError
protected static int handleTikaServerError(java.lang.String description) throws java.io.IOException, org.apache.manifoldcf.core.interfaces.ManifoldCFException, org.apache.manifoldcf.agents.interfaces.ServiceInterruption
- Throws:
java.io.IOException
org.apache.manifoldcf.core.interfaces.ManifoldCFException
org.apache.manifoldcf.agents.interfaces.ServiceInterruption
-
handleTikaServerException
protected static int handleTikaServerException(java.io.IOException e) throws java.io.IOException, org.apache.manifoldcf.core.interfaces.ManifoldCFException, org.apache.manifoldcf.agents.interfaces.ServiceInterruption
- Throws:
java.io.IOException
org.apache.manifoldcf.core.interfaces.ManifoldCFException
org.apache.manifoldcf.agents.interfaces.ServiceInterruption
-
handleTikaServerException
protected static int handleTikaServerException(org.json.simple.parser.ParseException e) throws java.io.IOException, org.apache.manifoldcf.core.interfaces.ManifoldCFException, org.apache.manifoldcf.agents.interfaces.ServiceInterruption
- Throws:
java.io.IOException
org.apache.manifoldcf.core.interfaces.ManifoldCFException
org.apache.manifoldcf.agents.interfaces.ServiceInterruption
-
handleIOException
protected static int handleIOException(java.io.IOException e) throws org.apache.manifoldcf.core.interfaces.ManifoldCFException
- Throws:
org.apache.manifoldcf.core.interfaces.ManifoldCFException
-
-