public abstract class BaseNotificationConnector extends BaseConnector implements INotificationConnector
| Modifier and Type | Field and Description |
|---|---|
static String |
_rcsid |
currentContext, params| Constructor and Description |
|---|
BaseNotificationConnector() |
| 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 |
notifyOfJobStop(Specification spec)
Notify of job stop.
|
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, outputConfigurationBody, outputConfigurationHeader, outputConfigurationHeader, outputConfigurationHeader, pack, packFixedList, packList, packList, poll, processConfigurationPost, processConfigurationPost, setThreadContext, unpack, unpackFixedList, unpackList, viewConfiguration, viewConfigurationclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitcheck, clearThreadContext, connect, deinstall, disconnect, getConfiguration, install, isConnected, outputConfigurationBody, outputConfigurationHeader, poll, processConfigurationPost, setThreadContext, viewConfigurationpublic static final String _rcsid
public boolean requestInfo(Configuration output, String command) throws ManifoldCFException
requestInfo in interface INotificationConnectoroutput - is the response object, to be filled in by this method.command - is the command, which is taken directly from the API request.ManifoldCFExceptionpublic void notifyOfJobStopErrorAbort(Specification spec) throws ManifoldCFException, ServiceInterruption
notifyOfJobStopErrorAbort in interface INotificationConnectorspec - is the notification specification.ManifoldCFExceptionServiceInterruptionpublic void notifyOfJobStopManualAbort(Specification spec) throws ManifoldCFException, ServiceInterruption
notifyOfJobStopManualAbort in interface INotificationConnectorspec - is the notification specification.ManifoldCFExceptionServiceInterruptionpublic void notifyOfJobStopManualPause(Specification spec) throws ManifoldCFException, ServiceInterruption
notifyOfJobStopManualPause in interface INotificationConnectorspec - is the notification specification.ManifoldCFExceptionServiceInterruptionpublic void notifyOfJobStopSchedulePause(Specification spec) throws ManifoldCFException, ServiceInterruption
notifyOfJobStopSchedulePause in interface INotificationConnectorspec - is the notification specification.ManifoldCFExceptionServiceInterruptionpublic void notifyOfJobStopRestart(Specification spec) throws ManifoldCFException, ServiceInterruption
notifyOfJobStopRestart in interface INotificationConnectorspec - is the notification specification.ManifoldCFExceptionServiceInterruptionpublic void notifyOfJobStop(Specification spec) throws ManifoldCFException, ServiceInterruption
spec - is the notification specification.ManifoldCFExceptionServiceInterruptionpublic void notifyOfJobEnd(Specification spec) throws ManifoldCFException, ServiceInterruption
notifyOfJobEnd in interface INotificationConnectorspec - is the notification specification.ManifoldCFExceptionServiceInterruptionpublic String getFormCheckJavascriptMethodName(int connectionSequenceNumber)
getFormCheckJavascriptMethodName in interface INotificationConnectorconnectionSequenceNumber - is the unique number of this connection within the job.public String getFormPresaveCheckJavascriptMethodName(int connectionSequenceNumber)
getFormPresaveCheckJavascriptMethodName in interface INotificationConnectorconnectionSequenceNumber - is the unique number of this connection within the job.public void outputSpecificationHeader(IHTTPOutput out, Locale locale, Specification ds, int connectionSequenceNumber, List<String> tabsArray) throws ManifoldCFException, IOException
outputSpecificationHeader in interface INotificationConnectorout - 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.ManifoldCFExceptionIOExceptionpublic void outputSpecificationBody(IHTTPOutput out, Locale locale, Specification ds, int connectionSequenceNumber, int actualSequenceNumber, String tabName) throws ManifoldCFException, IOException
outputSpecificationBody in interface INotificationConnectorout - 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.ManifoldCFExceptionIOExceptionpublic String processSpecificationPost(IPostParameters variableContext, Locale locale, Specification ds, int connectionSequenceNumber) throws ManifoldCFException
processSpecificationPost in interface INotificationConnectorvariableContext - 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.ManifoldCFExceptionpublic void viewSpecification(IHTTPOutput out, Locale locale, Specification ds, int connectionSequenceNumber) throws ManifoldCFException, IOException
viewSpecification in interface INotificationConnectorout - 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