org.apache.manifoldcf.crawler.interfaces

Interface INotificationConnector

All Superinterfaces:

IConnector

All Known Implementing Classes:

BaseNotificationConnector

public interface INotificationConnector
extends IConnector

This interface describes an instance of a connection between a notification engine and ManifoldCF's standard "pull" ingestion agent. Each instance of this interface is used in only one thread at a time. Connection Pooling on these kinds of objects is performed by the factory which instantiates repository connectors from symbolic names and config parameters, and is pooled by these parameters. That is, a pooled connector handle is used only if all the connection parameters for the handle match. Implementers of this interface should provide a default constructor which has this signature: xxx(); Connectors are either configured or not. If configured, they will persist in a pool, and be reused multiple times. Certain methods of a connector may be called before the connector is configured. This includes basically all methods that permit inspection of the connector's capabilities. The purpose of the notification connector is to notify people of job interruptions.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	_rcsid

Method Summary

Modifier and Type	Method and Description
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.
void	notifyOfJobEnd(Specification spec) Notify of job end
void	notifyOfJobStopErrorAbort(Specification spec) Notify of job stop due to error abort.
void	notifyOfJobStopManualAbort(Specification spec) Notify of job stop due to manual abort.
void	notifyOfJobStopManualPause(Specification spec) Notify of job stop due to manual pause.
void	notifyOfJobStopRestart(Specification spec) Notify of job stop due to restart.
void	notifyOfJobStopSchedulePause(Specification spec) Notify of job stop due to schedule pause.
void	outputSpecificationBody(IHTTPOutput out, java.util.Locale locale, Specification ds, int connectionSequenceNumber, int actualSequenceNumber, java.lang.String tabName) Output the specification body section.
void	outputSpecificationHeader(IHTTPOutput out, java.util.Locale locale, Specification ds, int connectionSequenceNumber, java.util.List<java.lang.String> tabsArray) Output the specification header section.
java.lang.String	processSpecificationPost(IPostParameters variableContext, java.util.Locale locale, Specification ds, int connectionSequenceNumber) Process a specification post.
boolean	requestInfo(Configuration output, java.lang.String command) Request arbitrary connector information.
void	viewSpecification(IHTTPOutput out, java.util.Locale locale, Specification ds, int connectionSequenceNumber) View specification.

Methods inherited from interface org.apache.manifoldcf.core.interfaces.IConnector

check, clearThreadContext, connect, deinstall, disconnect, getConfiguration, install, isConnected, outputConfigurationBody, outputConfigurationHeader, poll, processConfigurationPost, setThreadContext, viewConfiguration

Field Detail

_rcsid

static final java.lang.String _rcsid

See Also:

Constant Field Values

Method Detail

requestInfo

boolean requestInfo(Configuration output,
                    java.lang.String command)
             throws 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. These are usually used to create external UI's. The connector will be connected before this method is called.

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:

ManifoldCFException

notifyOfJobStopErrorAbort

void notifyOfJobStopErrorAbort(Specification spec)
                        throws ManifoldCFException,
                               ServiceInterruption

Notify of job stop due to error abort.

Parameters:

spec - is the notification specification.

Throws:

ManifoldCFException

ServiceInterruption

notifyOfJobStopManualAbort

void notifyOfJobStopManualAbort(Specification spec)
                         throws ManifoldCFException,
                                ServiceInterruption

Notify of job stop due to manual abort.

Parameters:

spec - is the notification specification.

Throws:

ManifoldCFException

ServiceInterruption

notifyOfJobStopManualPause

void notifyOfJobStopManualPause(Specification spec)
                         throws ManifoldCFException,
                                ServiceInterruption

Notify of job stop due to manual pause.

Parameters:

spec - is the notification specification.

Throws:

ManifoldCFException

ServiceInterruption

notifyOfJobStopSchedulePause

void notifyOfJobStopSchedulePause(Specification spec)
                           throws ManifoldCFException,
                                  ServiceInterruption

Notify of job stop due to schedule pause.

Parameters:

spec - is the notification specification.

Throws:

ManifoldCFException

ServiceInterruption

notifyOfJobStopRestart

void notifyOfJobStopRestart(Specification spec)
                     throws ManifoldCFException,
                            ServiceInterruption

Notify of job stop due to restart.

Parameters:

spec - is the notification specification.

Throws:

ManifoldCFException

ServiceInterruption

notifyOfJobEnd

void notifyOfJobEnd(Specification spec)
             throws ManifoldCFException,
                    ServiceInterruption

Notify of job end

Parameters:

spec - is the notification specification.

Throws:

ManifoldCFException

ServiceInterruption

getFormCheckJavascriptMethodName

java.lang.String getFormCheckJavascriptMethodName(int connectionSequenceNumber)

Obtain the name of the form check javascript method to call.

Parameters:

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

Returns:

the name of the form check javascript method.

getFormPresaveCheckJavascriptMethodName

java.lang.String getFormPresaveCheckJavascriptMethodName(int connectionSequenceNumber)

Obtain the name of the form presave check javascript method to call.

Parameters:

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

Returns:

the name of the form presave check javascript method.

outputSpecificationHeader

void outputSpecificationHeader(IHTTPOutput out,
                               java.util.Locale locale,
                               Specification ds,
                               int connectionSequenceNumber,
                               java.util.List<java.lang.String> tabsArray)
                        throws 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.

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:

ManifoldCFException

java.io.IOException

outputSpecificationBody

void outputSpecificationBody(IHTTPOutput out,
                             java.util.Locale locale,
                             Specification ds,
                             int connectionSequenceNumber,
                             int actualSequenceNumber,
                             java.lang.String tabName)
                      throws 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.

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:

ManifoldCFException

java.io.IOException

processSpecificationPost

java.lang.String processSpecificationPost(IPostParameters variableContext,
                                          java.util.Locale locale,
                                          Specification ds,
                                          int connectionSequenceNumber)
                                   throws 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.

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:

ManifoldCFException

viewSpecification

void viewSpecification(IHTTPOutput out,
                       java.util.Locale locale,
                       Specification ds,
                       int connectionSequenceNumber)
                throws 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.

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:

ManifoldCFException

java.io.IOException