org.apache.manifoldcf.crawler.connectors.filenet

Class FilenetConnector

java.lang.Object

org.apache.manifoldcf.core.connector.BaseConnector

org.apache.manifoldcf.crawler.connectors.BaseRepositoryConnector

org.apache.manifoldcf.crawler.connectors.filenet.FilenetConnector

All Implemented Interfaces:

org.apache.manifoldcf.core.interfaces.IConnector, org.apache.manifoldcf.crawler.interfaces.IRepositoryConnector

public class FilenetConnector
extends org.apache.manifoldcf.crawler.connectors.BaseRepositoryConnector

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	FilenetConnector.CheckConnectionThread
protected class	FilenetConnector.DestroySessionThread
protected class	FilenetConnector.GetChildFoldersThread
protected class	FilenetConnector.GetDocumentClassesInfoThread
protected class	FilenetConnector.GetDocumentClassesMetadataFieldsInfoThread
protected class	FilenetConnector.GetDocumentContentCountThread
protected class	FilenetConnector.GetDocumentContentsThread
protected class	FilenetConnector.GetDocumentInformationThread
protected class	FilenetConnector.GetMatchingObjectIdsThread
protected class	FilenetConnector.GetSessionThread
protected static class	FilenetConnector.SpecInfo

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	_rcsid
static java.lang.String	ACTIVITY_FETCH
static java.lang.String	CONFIG_PARAM_FILENETDOMAIN
static java.lang.String	CONFIG_PARAM_FILENETDOMAIN_OLD
static java.lang.String	CONFIG_PARAM_OBJECTSTORE
static java.lang.String	CONFIG_PARAM_PASSWORD
static java.lang.String	CONFIG_PARAM_SERVERHOSTNAME
static java.lang.String	CONFIG_PARAM_SERVERPORT
static java.lang.String	CONFIG_PARAM_SERVERPROTOCOL
static java.lang.String	CONFIG_PARAM_SERVERWSILOCATION
static java.lang.String	CONFIG_PARAM_URLHOSTNAME
static java.lang.String	CONFIG_PARAM_URLLOCATION
static java.lang.String	CONFIG_PARAM_URLPORT
static java.lang.String	CONFIG_PARAM_URLPROTOCOL
static java.lang.String	CONFIG_PARAM_USERID
protected java.lang.String	docURIPrefix Document URI protocol, server, port, and location
protected java.lang.String	docUrlLocation Document URI location
protected java.lang.String	docUrlPort Document URI port
protected java.lang.String	docUrlServerName Document URI server name
protected java.lang.String	docUrlServerProtocol Document URI server protocol
protected java.lang.String	filenetDomain Filenet domain
protected long	lastSessionFetch Time last session was created
protected java.lang.String	objectStore Object store
protected java.lang.String	password Password
protected java.lang.String	serverHostname Server host name
protected java.lang.String	serverLocation Server location
protected java.lang.String	serverPort Server port
protected java.lang.String	serverProtocol Server protocol
protected java.lang.String	serverWSIURI URI to get us to the webservices integration
protected IFilenet	session Filenet session handle.
static java.lang.String	SPEC_ATTRIBUTE_ALLMETADATA
static java.lang.String	SPEC_ATTRIBUTE_FIELDNAME
static java.lang.String	SPEC_ATTRIBUTE_MATCHTYPE
static java.lang.String	SPEC_ATTRIBUTE_VALUE
static java.lang.String	SPEC_NODE_DOCUMENTCLASS
static java.lang.String	SPEC_NODE_FOLDER
static java.lang.String	SPEC_NODE_MATCH
static java.lang.String	SPEC_NODE_METADATAFIELD
static java.lang.String	SPEC_NODE_MIMETYPE
protected static long	timeToRelease
protected java.lang.String	userID Username

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

currentContext, params

Fields inherited from interface org.apache.manifoldcf.crawler.interfaces.IRepositoryConnector

GLOBAL_DENY_TOKEN, JOBMODE_CONTINUOUS, JOBMODE_ONCEONLY, MODEL_ADD, MODEL_ADD_CHANGE, MODEL_ADD_CHANGE_DELETE, MODEL_ALL, MODEL_CHAINED_ADD, MODEL_CHAINED_ADD_CHANGE, MODEL_CHAINED_ADD_CHANGE_DELETE, MODEL_PARTIAL

Constructor Summary

Constructors

Constructor and Description
FilenetConnector() Constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.String	addSeedDocuments(org.apache.manifoldcf.crawler.interfaces.ISeedingActivity activities, org.apache.manifoldcf.core.interfaces.Specification spec, java.lang.String lastSeedVersion, long seedTime, int jobMode) Queue "seed" documents.
protected static java.lang.String	buildTime(java.util.Calendar c, long timeValue)
java.lang.String	check() Test the connection.
protected void	checkConnection() Check connection, with appropriate retries
void	connect(org.apache.manifoldcf.core.interfaces.ConfigParams configParams) Connect to filenet.
protected static java.lang.String	convertToURI(java.lang.String urlBase, java.lang.String documentIdentifier, int elementNumber, java.lang.String documentClass) Convert a document identifier to a URI.
void	disconnect() Disconnect from Filenet.
protected java.lang.String[]	doGetChildFolders(java.lang.String[] folderPath) Get child folder names
protected java.lang.Integer	doGetDocumentContentCount(java.lang.String documentIdentifier)
protected void	doGetDocumentContents(java.lang.String docId, int elementNumber, java.lang.String tempFileName) Get document contents
protected FileInfo	doGetDocumentInformation(java.lang.String docId, java.util.Map<java.lang.String,java.lang.Object> metadataFields) Get document info
protected java.lang.String[]	doGetMatchingObjectIds(java.lang.String sql) Get matching object id's for a given query
java.lang.String[]	getActivitiesList() Return the list of activities that this connector supports (i.e.
java.lang.String[]	getBinNames(java.lang.String documentIdentifier) Get the bin name string for a document identifier.
java.lang.String[]	getChildFolders(java.lang.String folderName) Get child folder names, given a starting folder name.
int	getConnectorModel() Let the crawler know the completeness of the information we are giving it.
DocumentClassDefinition[]	getDocumentClassesDetails() Get the set of available document classes, with details
protected DocumentClassDefinition[]	getDocumentClassesInfo() Get document class details, with appropriate retries
MetadataFieldDefinition[]	getDocumentClassMetadataFieldsDetails(java.lang.String documentClassName) Get the set of available metadata fields per document class
protected MetadataFieldDefinition[]	getDocumentClassMetadataFieldsInfo(java.lang.String documentClassName) Get document class metadata fields details, with appropriate retries
int	getMaxDocumentRequest()
java.lang.String[]	getMimeTypes() Get the set of available mime types
protected void	getSession() Get a DFC session.
protected static void	handleIOException(java.io.IOException e, java.lang.String documentIdentifier, java.lang.String context)
boolean	isConnected() This method is called to assess whether to count this connector instance should actually be counted as being connected.
protected static boolean	likeMatch(java.lang.String matchDocValue, int matchDocPos, java.lang.String matchValue, int matchPos) Match a portion of a string with SQL wildcards (%)
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 ds, 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 ds, int connectionSequenceNumber, java.util.List<java.lang.String> tabsArray) Output the specification header section.
protected static boolean	performMatch(java.lang.String matchType, java.lang.String matchDocValue, java.lang.String matchValue) Emulate the query matching for filenet sql expressions.
void	poll() This method is periodically called for all connectors that are connected but not in active use.
protected static int	print_digit(java.lang.StringBuilder sb, int value, int divisor)
protected static void	print_int(java.lang.StringBuilder sb, int value, int digits)
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.
void	processDocuments(java.lang.String[] documentIdentifiers, org.apache.manifoldcf.crawler.interfaces.IExistingVersions statuses, org.apache.manifoldcf.core.interfaces.Specification spec, org.apache.manifoldcf.crawler.interfaces.IProcessActivity activities, int jobMode, boolean usesDefaultAuthority) Process a set of documents.
java.lang.String	processSpecificationPost(org.apache.manifoldcf.core.interfaces.IPostParameters variableContext, java.util.Locale locale, org.apache.manifoldcf.core.interfaces.Specification ds, int connectionSequenceNumber) Process a specification post.
protected static java.lang.String	quoteSQLString(java.lang.String value)
protected void	releaseCheck() Release the session, if it's time.
boolean	requestInfo(org.apache.manifoldcf.core.interfaces.Configuration output, java.lang.String command) Request arbitrary connector information.
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 ds, int connectionSequenceNumber) View specification.

Methods inherited from class org.apache.manifoldcf.crawler.connectors.BaseRepositoryConnector

getFormCheckJavascriptMethodName, getFormPresaveCheckJavascriptMethodName, getRelationshipTypes

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

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

clearThreadContext, deinstall, getConfiguration, install, setThreadContext

Field Detail

_rcsid

public static final java.lang.String _rcsid

See Also:

Constant Field Values

CONFIG_PARAM_USERID

public static final java.lang.String CONFIG_PARAM_USERID

See Also:

Constant Field Values

CONFIG_PARAM_PASSWORD

public static final java.lang.String CONFIG_PARAM_PASSWORD

See Also:

Constant Field Values

CONFIG_PARAM_FILENETDOMAIN_OLD

public static final java.lang.String CONFIG_PARAM_FILENETDOMAIN_OLD

See Also:

Constant Field Values

CONFIG_PARAM_FILENETDOMAIN

public static final java.lang.String CONFIG_PARAM_FILENETDOMAIN

See Also:

Constant Field Values

CONFIG_PARAM_OBJECTSTORE

public static final java.lang.String CONFIG_PARAM_OBJECTSTORE

See Also:

Constant Field Values

CONFIG_PARAM_SERVERPROTOCOL

public static final java.lang.String CONFIG_PARAM_SERVERPROTOCOL

See Also:

Constant Field Values

CONFIG_PARAM_SERVERHOSTNAME

public static final java.lang.String CONFIG_PARAM_SERVERHOSTNAME

See Also:

Constant Field Values

CONFIG_PARAM_SERVERPORT

public static final java.lang.String CONFIG_PARAM_SERVERPORT

See Also:

Constant Field Values

CONFIG_PARAM_SERVERWSILOCATION

public static final java.lang.String CONFIG_PARAM_SERVERWSILOCATION

See Also:

Constant Field Values

CONFIG_PARAM_URLPROTOCOL

public static final java.lang.String CONFIG_PARAM_URLPROTOCOL

See Also:

Constant Field Values

CONFIG_PARAM_URLHOSTNAME

public static final java.lang.String CONFIG_PARAM_URLHOSTNAME

See Also:

Constant Field Values

CONFIG_PARAM_URLPORT

public static final java.lang.String CONFIG_PARAM_URLPORT

See Also:

Constant Field Values

CONFIG_PARAM_URLLOCATION

public static final java.lang.String CONFIG_PARAM_URLLOCATION

See Also:

Constant Field Values

SPEC_NODE_FOLDER

public static final java.lang.String SPEC_NODE_FOLDER

See Also:

Constant Field Values

SPEC_NODE_MIMETYPE

public static final java.lang.String SPEC_NODE_MIMETYPE

See Also:

Constant Field Values

SPEC_NODE_DOCUMENTCLASS

public static final java.lang.String SPEC_NODE_DOCUMENTCLASS

See Also:

Constant Field Values

SPEC_NODE_METADATAFIELD

public static final java.lang.String SPEC_NODE_METADATAFIELD

See Also:

Constant Field Values

SPEC_NODE_MATCH

public static final java.lang.String SPEC_NODE_MATCH

See Also:

Constant Field Values

SPEC_ATTRIBUTE_VALUE

public static final java.lang.String SPEC_ATTRIBUTE_VALUE

See Also:

Constant Field Values

SPEC_ATTRIBUTE_ALLMETADATA

public static final java.lang.String SPEC_ATTRIBUTE_ALLMETADATA

See Also:

Constant Field Values

SPEC_ATTRIBUTE_MATCHTYPE

public static final java.lang.String SPEC_ATTRIBUTE_MATCHTYPE

See Also:

Constant Field Values

SPEC_ATTRIBUTE_FIELDNAME

public static final java.lang.String SPEC_ATTRIBUTE_FIELDNAME

See Also:

Constant Field Values

ACTIVITY_FETCH

public static final java.lang.String ACTIVITY_FETCH

See Also:

Constant Field Values

timeToRelease

protected static final long timeToRelease

See Also:

Constant Field Values

session

protected IFilenet session

Filenet session handle.

lastSessionFetch

protected long lastSessionFetch

Time last session was created

userID

protected java.lang.String userID

Username

password

protected java.lang.String password

Password

filenetDomain

protected java.lang.String filenetDomain

Filenet domain

objectStore

protected java.lang.String objectStore

Object store

serverProtocol

protected java.lang.String serverProtocol

Server protocol

serverHostname

protected java.lang.String serverHostname

Server host name

serverPort

protected java.lang.String serverPort

Server port

serverLocation

protected java.lang.String serverLocation

Server location

serverWSIURI

protected java.lang.String serverWSIURI

URI to get us to the webservices integration

docUrlServerProtocol

protected java.lang.String docUrlServerProtocol

Document URI server protocol

docUrlServerName

protected java.lang.String docUrlServerName

Document URI server name

docUrlPort

protected java.lang.String docUrlPort

Document URI port

docUrlLocation

protected java.lang.String docUrlLocation

Document URI location

docURIPrefix

protected java.lang.String docURIPrefix

Document URI protocol, server, port, and location

Constructor Detail

FilenetConnector

public FilenetConnector()

Constructor.

Method Detail

getSession

protected void getSession()
                   throws org.apache.manifoldcf.core.interfaces.ManifoldCFException,
                          org.apache.manifoldcf.agents.interfaces.ServiceInterruption

Get a DFC session. This will be done every time it is needed.

Throws:

org.apache.manifoldcf.core.interfaces.ManifoldCFException

org.apache.manifoldcf.agents.interfaces.ServiceInterruption

releaseCheck

protected void releaseCheck()
                     throws org.apache.manifoldcf.core.interfaces.ManifoldCFException

Release the session, if it's time.

Throws:

org.apache.manifoldcf.core.interfaces.ManifoldCFException

getConnectorModel

public int getConnectorModel()

Let the crawler know the completeness of the information we are giving it.

Specified by:

getConnectorModel in interface org.apache.manifoldcf.crawler.interfaces.IRepositoryConnector

Overrides:

getConnectorModel in class org.apache.manifoldcf.crawler.connectors.BaseRepositoryConnector

getBinNames

public java.lang.String[] getBinNames(java.lang.String documentIdentifier)

Get the bin name string for a document identifier. The bin name describes the queue to which the document will be assigned for throttling purposes. Throttling controls the rate at which items in a given queue are fetched; it does not say anything about the overall fetch rate, which may operate on multiple queues or bins. For example, if you implement a web crawler, a good choice of bin name would be the server name, since that is likely to correspond to a real resource that will need real throttle protection.

Specified by:

getBinNames in interface org.apache.manifoldcf.crawler.interfaces.IRepositoryConnector

Overrides:

getBinNames in class org.apache.manifoldcf.crawler.connectors.BaseRepositoryConnector

Parameters:

documentIdentifier - is the document identifier.

Returns:

the bin name.

getActivitiesList

public java.lang.String[] getActivitiesList()

Return the list of activities that this connector supports (i.e. writes into the log).

Specified by:

getActivitiesList in interface org.apache.manifoldcf.crawler.interfaces.IRepositoryConnector

Overrides:

getActivitiesList in class org.apache.manifoldcf.crawler.connectors.BaseRepositoryConnector

Returns:

the list.

connect

public void connect(org.apache.manifoldcf.core.interfaces.ConfigParams configParams)

Connect to filenet.

Specified by:

connect in interface org.apache.manifoldcf.core.interfaces.IConnector

Overrides:

connect in class org.apache.manifoldcf.core.connector.BaseConnector

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 interface org.apache.manifoldcf.core.interfaces.IConnector

Overrides:

check in class org.apache.manifoldcf.core.connector.BaseConnector

Returns:

the connection's status as a displayable string.

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 interface org.apache.manifoldcf.core.interfaces.IConnector

Overrides:

poll in class org.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 interface org.apache.manifoldcf.core.interfaces.IConnector

Overrides:

isConnected in class org.apache.manifoldcf.core.connector.BaseConnector

Returns:

true if the connector instance is actually connected.

disconnect

public void disconnect()
                throws org.apache.manifoldcf.core.interfaces.ManifoldCFException

Disconnect from Filenet.

Specified by:

disconnect in interface org.apache.manifoldcf.core.interfaces.IConnector

Overrides:

disconnect in class org.apache.manifoldcf.core.connector.BaseConnector

Throws:

org.apache.manifoldcf.core.interfaces.ManifoldCFException

requestInfo

public boolean requestInfo(org.apache.manifoldcf.core.interfaces.Configuration output,
                           java.lang.String command)
                    throws org.apache.manifoldcf.core.interfaces.ManifoldCFException

Request arbitrary connector information. This method is called directly from the API in order to allow API users to perform any one of several connector-specific queries.

Specified by:

requestInfo in interface org.apache.manifoldcf.crawler.interfaces.IRepositoryConnector

Overrides:

requestInfo in class org.apache.manifoldcf.crawler.connectors.BaseRepositoryConnector

Parameters:

output - is the response object, to be filled in by this method.

command - is the command, which is taken directly from the API request.

Returns:

true if the resource is found, false if not. In either case, output may be filled in.

Throws:

org.apache.manifoldcf.core.interfaces.ManifoldCFException

getChildFolders

public java.lang.String[] getChildFolders(java.lang.String folderName)
                                   throws org.apache.manifoldcf.core.interfaces.ManifoldCFException,
                                          org.apache.manifoldcf.agents.interfaces.ServiceInterruption

Get child folder names, given a starting folder name.

Parameters:

folderName - is the starting folder name.

Returns:

the child folder names.

Throws:

org.apache.manifoldcf.core.interfaces.ManifoldCFException

org.apache.manifoldcf.agents.interfaces.ServiceInterruption

addSeedDocuments

public java.lang.String addSeedDocuments(org.apache.manifoldcf.crawler.interfaces.ISeedingActivity activities,
                                         org.apache.manifoldcf.core.interfaces.Specification spec,
                                         java.lang.String lastSeedVersion,
                                         long seedTime,
                                         int jobMode)
                                  throws org.apache.manifoldcf.core.interfaces.ManifoldCFException,
                                         org.apache.manifoldcf.agents.interfaces.ServiceInterruption

Queue "seed" documents. Seed documents are the starting places for crawling activity. Documents are seeded when this method calls appropriate methods in the passed in ISeedingActivity object. This method can choose to find repository changes that happen only during the specified time interval. The seeds recorded by this method will be viewed by the framework based on what the getConnectorModel() method returns. It is not a big problem if the connector chooses to create more seeds than are strictly necessary; it is merely a question of overall work required. The end time and seeding version string passed to this method may be interpreted for greatest efficiency. For continuous crawling jobs, this method will be called once, when the job starts, and at various periodic intervals as the job executes. When a job's specification is changed, the framework automatically resets the seeding version string to null. The seeding version string may also be set to null on each job run, depending on the connector model returned by getConnectorModel(). Note that it is always ok to send MORE documents rather than less to this method. The connector will be connected before this method can be called.

Specified by:

addSeedDocuments in interface org.apache.manifoldcf.crawler.interfaces.IRepositoryConnector

Overrides:

addSeedDocuments in class org.apache.manifoldcf.crawler.connectors.BaseRepositoryConnector

Parameters:

activities - is the interface this method should use to perform whatever framework actions are desired.

spec - is a document specification (that comes from the job).

seedTime - is the end of the time range of documents to consider, exclusive.

lastSeedVersion - is the last seeding version string for this job, or null if the job has no previous seeding version string.

jobMode - is an integer describing how the job is being run, whether continuous or once-only.

Returns:

an updated seeding version string, to be stored with the job.

Throws:

org.apache.manifoldcf.core.interfaces.ManifoldCFException

org.apache.manifoldcf.agents.interfaces.ServiceInterruption

quoteSQLString

protected static java.lang.String quoteSQLString(java.lang.String value)

buildTime

protected static java.lang.String buildTime(java.util.Calendar c,
                                            long timeValue)

print_int

protected static void print_int(java.lang.StringBuilder sb,
                                int value,
                                int digits)

print_digit

protected static int print_digit(java.lang.StringBuilder sb,
                                 int value,
                                 int divisor)

processDocuments

public void processDocuments(java.lang.String[] documentIdentifiers,
                             org.apache.manifoldcf.crawler.interfaces.IExistingVersions statuses,
                             org.apache.manifoldcf.core.interfaces.Specification spec,
                             org.apache.manifoldcf.crawler.interfaces.IProcessActivity activities,
                             int jobMode,
                             boolean usesDefaultAuthority)
                      throws org.apache.manifoldcf.core.interfaces.ManifoldCFException,
                             org.apache.manifoldcf.agents.interfaces.ServiceInterruption

Process a set of documents. This is the method that should cause each document to be fetched, processed, and the results either added to the queue of documents for the current job, and/or entered into the incremental ingestion manager. The document specification allows this class to filter what is done based on the job. The connector will be connected before this method can be called.

Specified by:

processDocuments in interface org.apache.manifoldcf.crawler.interfaces.IRepositoryConnector

Overrides:

processDocuments in class org.apache.manifoldcf.crawler.connectors.BaseRepositoryConnector

Parameters:

documentIdentifiers - is the set of document identifiers to process.

statuses - are the currently-stored document versions for each document in the set of document identifiers passed in above.

activities - is the interface this method should use to queue up new document references and ingest documents.

jobMode - is an integer describing how the job is being run, whether continuous or once-only.

usesDefaultAuthority - will be true only if the authority in use for these documents is the default one.

Throws:

org.apache.manifoldcf.core.interfaces.ManifoldCFException

org.apache.manifoldcf.agents.interfaces.ServiceInterruption

handleIOException

protected static void handleIOException(java.io.IOException e,
                                        java.lang.String documentIdentifier,
                                        java.lang.String context)
                                 throws org.apache.manifoldcf.core.interfaces.ManifoldCFException,
                                        org.apache.manifoldcf.agents.interfaces.ServiceInterruption

Throws:

org.apache.manifoldcf.core.interfaces.ManifoldCFException

org.apache.manifoldcf.agents.interfaces.ServiceInterruption

performMatch

protected static boolean performMatch(java.lang.String matchType,
                                      java.lang.String matchDocValue,
                                      java.lang.String matchValue)

Emulate the query matching for filenet sql expressions.

likeMatch

protected static boolean likeMatch(java.lang.String matchDocValue,
                                   int matchDocPos,
                                   java.lang.String matchValue,
                                   int matchPos)

Match a portion of a string with SQL wildcards (%)

getMaxDocumentRequest

public int getMaxDocumentRequest()

Specified by:

getMaxDocumentRequest in interface org.apache.manifoldcf.crawler.interfaces.IRepositoryConnector

Overrides:

getMaxDocumentRequest in class org.apache.manifoldcf.crawler.connectors.BaseRepositoryConnector

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 interface org.apache.manifoldcf.core.interfaces.IConnector

Overrides:

outputConfigurationHeader in class org.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 interface org.apache.manifoldcf.core.interfaces.IConnector

Overrides:

outputConfigurationBody in class org.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 interface org.apache.manifoldcf.core.interfaces.IConnector

Overrides:

processConfigurationPost in class org.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 interface org.apache.manifoldcf.core.interfaces.IConnector

Overrides:

viewConfiguration in class org.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

outputSpecificationHeader

public void outputSpecificationHeader(org.apache.manifoldcf.core.interfaces.IHTTPOutput out,
                                      java.util.Locale locale,
                                      org.apache.manifoldcf.core.interfaces.Specification ds,
                                      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 repository 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. The connector will be connected before this method can be called.

Specified by:

outputSpecificationHeader in interface org.apache.manifoldcf.crawler.interfaces.IRepositoryConnector

Overrides:

outputSpecificationHeader in class org.apache.manifoldcf.crawler.connectors.BaseRepositoryConnector

Parameters:

out - is the output to which any HTML should be sent.

locale - is the locale the output is preferred to be in.

ds - is the current document 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.

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 ds,
                                    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 repository 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 always "editjob". The connector will be connected before this method can be called.

Specified by:

outputSpecificationBody in interface org.apache.manifoldcf.crawler.interfaces.IRepositoryConnector

Overrides:

outputSpecificationBody in class org.apache.manifoldcf.crawler.connectors.BaseRepositoryConnector

Parameters:

out - is the output to which any HTML should be sent.

locale - is the locale the output is preferred to be in.

ds - is the current document 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. (actualSequenceNumber, tabName) form a unique tuple within the job.

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 ds,
                                                 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 document specification accordingly. The name of the posted form is always "editjob". The connector will be connected before this method can be called.

Specified by:

processSpecificationPost in interface org.apache.manifoldcf.crawler.interfaces.IRepositoryConnector

Overrides:

processSpecificationPost in class org.apache.manifoldcf.crawler.connectors.BaseRepositoryConnector

Parameters:

variableContext - contains the post data, including binary file-upload information.

locale - is the locale the output is preferred to be in.

ds - is the current document 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 ds,
                              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 document 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. The connector will be connected before this method can be called.

Specified by:

viewSpecification in interface org.apache.manifoldcf.crawler.interfaces.IRepositoryConnector

Overrides:

viewSpecification in class org.apache.manifoldcf.crawler.connectors.BaseRepositoryConnector

Parameters:

out - is the output to which any HTML should be sent.

locale - is the locale the output is preferred to be in.

ds - is the current document specification for this job.

connectionSequenceNumber - is the unique number of this connection within the job.

Throws:

org.apache.manifoldcf.core.interfaces.ManifoldCFException

java.io.IOException

getDocumentClassesDetails

public DocumentClassDefinition[] getDocumentClassesDetails()
                                                    throws org.apache.manifoldcf.core.interfaces.ManifoldCFException,
                                                           org.apache.manifoldcf.agents.interfaces.ServiceInterruption

Get the set of available document classes, with details

Throws:

org.apache.manifoldcf.core.interfaces.ManifoldCFException

org.apache.manifoldcf.agents.interfaces.ServiceInterruption

getDocumentClassMetadataFieldsDetails

public MetadataFieldDefinition[] getDocumentClassMetadataFieldsDetails(java.lang.String documentClassName)
                                                                throws org.apache.manifoldcf.agents.interfaces.ServiceInterruption,
                                                                       org.apache.manifoldcf.core.interfaces.ManifoldCFException

Get the set of available metadata fields per document class

Throws:

org.apache.manifoldcf.agents.interfaces.ServiceInterruption

org.apache.manifoldcf.core.interfaces.ManifoldCFException

getMimeTypes

public java.lang.String[] getMimeTypes()
                                throws org.apache.manifoldcf.core.interfaces.ManifoldCFException,
                                       org.apache.manifoldcf.agents.interfaces.ServiceInterruption

Get the set of available mime types

Throws:

org.apache.manifoldcf.core.interfaces.ManifoldCFException

org.apache.manifoldcf.agents.interfaces.ServiceInterruption

convertToURI

protected static java.lang.String convertToURI(java.lang.String urlBase,
                                               java.lang.String documentIdentifier,
                                               int elementNumber,
                                               java.lang.String documentClass)

Convert a document identifier to a URI. The URI is the URI that will be the unique key from the search index, and will be presented to the user as part of the search results.

Parameters:

documentIdentifier - is the document identifier.

Returns:

the document uri.

checkConnection

protected void checkConnection()
                        throws FilenetException,
                               org.apache.manifoldcf.core.interfaces.ManifoldCFException,
                               org.apache.manifoldcf.agents.interfaces.ServiceInterruption

Check connection, with appropriate retries

Throws:

FilenetException

org.apache.manifoldcf.core.interfaces.ManifoldCFException

org.apache.manifoldcf.agents.interfaces.ServiceInterruption

getDocumentClassesInfo

protected DocumentClassDefinition[] getDocumentClassesInfo()
                                                    throws FilenetException,
                                                           org.apache.manifoldcf.core.interfaces.ManifoldCFException,
                                                           org.apache.manifoldcf.agents.interfaces.ServiceInterruption

Get document class details, with appropriate retries

Throws:

FilenetException

org.apache.manifoldcf.core.interfaces.ManifoldCFException

org.apache.manifoldcf.agents.interfaces.ServiceInterruption

getDocumentClassMetadataFieldsInfo

protected MetadataFieldDefinition[] getDocumentClassMetadataFieldsInfo(java.lang.String documentClassName)
                                                                throws FilenetException,
                                                                       org.apache.manifoldcf.core.interfaces.ManifoldCFException,
                                                                       org.apache.manifoldcf.agents.interfaces.ServiceInterruption

Get document class metadata fields details, with appropriate retries

Throws:

FilenetException

org.apache.manifoldcf.core.interfaces.ManifoldCFException

org.apache.manifoldcf.agents.interfaces.ServiceInterruption

doGetChildFolders

protected java.lang.String[] doGetChildFolders(java.lang.String[] folderPath)
                                        throws FilenetException,
                                               org.apache.manifoldcf.core.interfaces.ManifoldCFException,
                                               org.apache.manifoldcf.agents.interfaces.ServiceInterruption

Get child folder names

Throws:

FilenetException

org.apache.manifoldcf.core.interfaces.ManifoldCFException

org.apache.manifoldcf.agents.interfaces.ServiceInterruption

doGetMatchingObjectIds

protected java.lang.String[] doGetMatchingObjectIds(java.lang.String sql)
                                             throws FilenetException,
                                                    org.apache.manifoldcf.core.interfaces.ManifoldCFException,
                                                    org.apache.manifoldcf.agents.interfaces.ServiceInterruption

Get matching object id's for a given query

Throws:

FilenetException

org.apache.manifoldcf.core.interfaces.ManifoldCFException

org.apache.manifoldcf.agents.interfaces.ServiceInterruption

doGetDocumentContentCount

protected java.lang.Integer doGetDocumentContentCount(java.lang.String documentIdentifier)
                                               throws FilenetException,
                                                      org.apache.manifoldcf.core.interfaces.ManifoldCFException,
                                                      org.apache.manifoldcf.agents.interfaces.ServiceInterruption

Throws:

FilenetException

org.apache.manifoldcf.core.interfaces.ManifoldCFException

org.apache.manifoldcf.agents.interfaces.ServiceInterruption

doGetDocumentInformation

protected FileInfo doGetDocumentInformation(java.lang.String docId,
                                            java.util.Map<java.lang.String,java.lang.Object> metadataFields)
                                     throws FilenetException,
                                            org.apache.manifoldcf.core.interfaces.ManifoldCFException,
                                            org.apache.manifoldcf.agents.interfaces.ServiceInterruption

Get document info

Throws:

FilenetException

org.apache.manifoldcf.core.interfaces.ManifoldCFException

org.apache.manifoldcf.agents.interfaces.ServiceInterruption

doGetDocumentContents

protected void doGetDocumentContents(java.lang.String docId,
                                     int elementNumber,
                                     java.lang.String tempFileName)
                              throws FilenetException,
                                     org.apache.manifoldcf.core.interfaces.ManifoldCFException,
                                     org.apache.manifoldcf.agents.interfaces.ServiceInterruption

Get document contents

Throws:

FilenetException

org.apache.manifoldcf.core.interfaces.ManifoldCFException

org.apache.manifoldcf.agents.interfaces.ServiceInterruption