public interface INotificationConnector extends IConnector
| Modifier and Type | Method and Description |
|---|---|
String |
getFormCheckJavascriptMethodName(int connectionSequenceNumber)
Obtain the name of the form check javascript method to call.
|
String |
getFormPresaveCheckJavascriptMethodName(int connectionSequenceNumber)
Obtain the name of the form presave check javascript method to call.
|
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,
Locale locale,
Specification ds,
int connectionSequenceNumber,
int actualSequenceNumber,
String tabName)
Output the specification body section.
|
void |
outputSpecificationHeader(IHTTPOutput out,
Locale locale,
Specification ds,
int connectionSequenceNumber,
List<String> tabsArray)
Output the specification header section.
|
String |
processSpecificationPost(IPostParameters variableContext,
Locale locale,
Specification ds,
int connectionSequenceNumber)
Process a specification post.
|
boolean |
requestInfo(Configuration output,
String command)
Request arbitrary connector information.
|
void |
viewSpecification(IHTTPOutput out,
Locale locale,
Specification ds,
int connectionSequenceNumber)
View specification.
|
check, clearThreadContext, connect, deinstall, disconnect, getConfiguration, install, isConnected, outputConfigurationBody, outputConfigurationHeader, poll, processConfigurationPost, setThreadContext, viewConfigurationstatic final String _rcsid
boolean requestInfo(Configuration output, String command) throws ManifoldCFException
output - is the response object, to be filled in by this method.command - is the command, which is taken directly from the API request.ManifoldCFExceptionvoid notifyOfJobStopErrorAbort(Specification spec) throws ManifoldCFException, ServiceInterruption
spec - is the notification specification.ManifoldCFExceptionServiceInterruptionvoid notifyOfJobStopManualAbort(Specification spec) throws ManifoldCFException, ServiceInterruption
spec - is the notification specification.ManifoldCFExceptionServiceInterruptionvoid notifyOfJobStopManualPause(Specification spec) throws ManifoldCFException, ServiceInterruption
spec - is the notification specification.ManifoldCFExceptionServiceInterruptionvoid notifyOfJobStopSchedulePause(Specification spec) throws ManifoldCFException, ServiceInterruption
spec - is the notification specification.ManifoldCFExceptionServiceInterruptionvoid notifyOfJobStopRestart(Specification spec) throws ManifoldCFException, ServiceInterruption
spec - is the notification specification.ManifoldCFExceptionServiceInterruptionvoid notifyOfJobEnd(Specification spec) throws ManifoldCFException, ServiceInterruption
spec - is the notification specification.ManifoldCFExceptionServiceInterruptionString getFormCheckJavascriptMethodName(int connectionSequenceNumber)
connectionSequenceNumber - is the unique number of this connection within the job.String getFormPresaveCheckJavascriptMethodName(int connectionSequenceNumber)
connectionSequenceNumber - is the unique number of this connection within the job.void outputSpecificationHeader(IHTTPOutput out, Locale locale, Specification ds, int connectionSequenceNumber, List<String> tabsArray) throws ManifoldCFException, IOException
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.ManifoldCFExceptionIOExceptionvoid outputSpecificationBody(IHTTPOutput out, Locale locale, Specification ds, int connectionSequenceNumber, int actualSequenceNumber, String tabName) throws ManifoldCFException, IOException
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.ManifoldCFExceptionIOExceptionString processSpecificationPost(IPostParameters variableContext, Locale locale, Specification ds, int connectionSequenceNumber) throws ManifoldCFException
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.ManifoldCFExceptionvoid viewSpecification(IHTTPOutput out, Locale locale, Specification ds, int connectionSequenceNumber) throws ManifoldCFException, IOException
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.ManifoldCFExceptionIOException