org.apache.manifoldcf.crawler.notifications.slack

Class SlackConnector

java.lang.Object

org.apache.manifoldcf.core.connector.BaseConnector

org.apache.manifoldcf.crawler.notifications.BaseNotificationConnector

org.apache.manifoldcf.crawler.notifications.slack.SlackConnector

All Implemented Interfaces:

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

public class SlackConnector
extends org.apache.manifoldcf.crawler.notifications.BaseNotificationConnector

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	SlackConnector.CheckConnectionThread Class to check the connection.
protected static class	SlackConnector.CloseSessionThread Class to close the session.
protected static class	SlackConnector.ConnectThread Class to set up connection.
protected static class	SlackConnector.SendThread Class to send slack messages.

Field Summary

Fields

Modifier and Type	Field and Description
protected SlackSession.ProxySettings	proxySettings
protected SlackSession	session
protected static long	SESSION_EXPIRATION_MILLISECONDS
protected long	sessionExpiration
protected java.lang.String	webHookUrl

Fields inherited from class org.apache.manifoldcf.crawler.notifications.BaseNotificationConnector

_rcsid

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

currentContext, params

Constructor Summary

Constructors

Constructor and Description
SlackConnector()

Method Summary

Modifier and Type	Method and Description
protected static void	addNodeValue(org.apache.manifoldcf.core.interfaces.SpecificationNode ds, java.lang.String nodeType, java.lang.String value)
protected static void	addRecord(java.util.Map<java.lang.String,java.lang.Object> paramMap, java.lang.String nodeType, java.lang.String channel, java.lang.String message)
java.lang.String	check() Test the connection.
protected void	checkConnection()
void	connect(org.apache.manifoldcf.core.interfaces.ConfigParams configParameters) Connect.
void	disconnect() Close the connection.
protected static void	fillInMessageTab(java.util.Map<java.lang.String,java.lang.Object> paramMap, org.apache.manifoldcf.core.interfaces.Specification ds) Fill in Velocity context for Metadata tab.
protected void	finalizeConnection()
protected static void	gatherRecord(org.apache.manifoldcf.core.interfaces.Specification ds, java.lang.String seqPrefix, org.apache.manifoldcf.core.interfaces.IPostParameters variableContext, java.lang.String nodeType)
protected void	getSession()
protected static void	handleIOException(java.io.IOException e, java.lang.String context) Handle Messaging exceptions in a consistent global manner
void	notifyOfJobEnd(org.apache.manifoldcf.core.interfaces.Specification spec) Notify of job end.
void	notifyOfJobStopErrorAbort(org.apache.manifoldcf.core.interfaces.Specification spec) Notify of job stop due to error abort.
void	notifyOfJobStopManualAbort(org.apache.manifoldcf.core.interfaces.Specification spec) Notify of job stop due to manual abort.
void	notifyOfJobStopManualPause(org.apache.manifoldcf.core.interfaces.Specification spec) Notify of job stop due to manual pause.
void	notifyOfJobStopRestart(org.apache.manifoldcf.core.interfaces.Specification spec) Notify of job stop due to restart.
void	notifyOfJobStopSchedulePause(org.apache.manifoldcf.core.interfaces.Specification spec) Notify of job stop due to schedule pause.
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)
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.
protected void	outputMessageTab(org.apache.manifoldcf.core.interfaces.IHTTPOutput out, java.util.Locale locale, org.apache.manifoldcf.core.interfaces.Specification ds, java.lang.String tabName, int connectionSequenceNumber, int actualSequenceNumber) Take care of "Message" tab.
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.
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, org.apache.manifoldcf.core.interfaces.ConfigParams parameters) Process a configuration post.
protected java.lang.String	processMessageTab(org.apache.manifoldcf.core.interfaces.IPostParameters variableContext, org.apache.manifoldcf.core.interfaces.Specification ds, int connectionSequenceNumber)
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 void	removeNodes(org.apache.manifoldcf.core.interfaces.Specification ds, java.lang.String nodeTypeName)
protected void	sendSlackMessage(org.apache.manifoldcf.core.interfaces.Specification spec, java.lang.String nodeType)
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.notifications.BaseNotificationConnector

getFormCheckJavascriptMethodName, getFormPresaveCheckJavascriptMethodName, notifyOfJobStop, requestInfo

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

clearThreadContext, deinstall, getConfiguration, install, isConnected, 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, isConnected, processConfigurationPost, setThreadContext

Field Detail

SESSION_EXPIRATION_MILLISECONDS

protected static final long SESSION_EXPIRATION_MILLISECONDS

See Also:

Constant Field Values

sessionExpiration

protected long sessionExpiration

webHookUrl

protected java.lang.String webHookUrl

proxySettings

protected SlackSession.ProxySettings proxySettings

session

protected SlackSession session

Constructor Detail

SlackConnector

public SlackConnector()

Method Detail

connect

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

Connect.

Specified by:

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

Overrides:

connect in class org.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 this instance of the repository connector.

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

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

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

checkConnection

protected void checkConnection()
                        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

getSession

protected void getSession()
                   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

finalizeConnection

protected void finalizeConnection()

notifyOfJobStopErrorAbort

public void notifyOfJobStopErrorAbort(org.apache.manifoldcf.core.interfaces.Specification spec)
                               throws org.apache.manifoldcf.core.interfaces.ManifoldCFException,
                                      org.apache.manifoldcf.agents.interfaces.ServiceInterruption

Notify of job stop due to error abort.

Specified by:

notifyOfJobStopErrorAbort in interface org.apache.manifoldcf.crawler.interfaces.INotificationConnector

Overrides:

notifyOfJobStopErrorAbort in class org.apache.manifoldcf.crawler.notifications.BaseNotificationConnector

Parameters:

spec - is the notification specification.

Throws:

org.apache.manifoldcf.core.interfaces.ManifoldCFException

org.apache.manifoldcf.agents.interfaces.ServiceInterruption

notifyOfJobStopManualAbort

public void notifyOfJobStopManualAbort(org.apache.manifoldcf.core.interfaces.Specification spec)
                                throws org.apache.manifoldcf.core.interfaces.ManifoldCFException,
                                       org.apache.manifoldcf.agents.interfaces.ServiceInterruption

Notify of job stop due to manual abort.

Specified by:

notifyOfJobStopManualAbort in interface org.apache.manifoldcf.crawler.interfaces.INotificationConnector

Overrides:

notifyOfJobStopManualAbort in class org.apache.manifoldcf.crawler.notifications.BaseNotificationConnector

Parameters:

spec - is the notification specification.

Throws:

org.apache.manifoldcf.core.interfaces.ManifoldCFException

org.apache.manifoldcf.agents.interfaces.ServiceInterruption

notifyOfJobStopManualPause

public void notifyOfJobStopManualPause(org.apache.manifoldcf.core.interfaces.Specification spec)
                                throws org.apache.manifoldcf.core.interfaces.ManifoldCFException,
                                       org.apache.manifoldcf.agents.interfaces.ServiceInterruption

Notify of job stop due to manual pause.

Specified by:

notifyOfJobStopManualPause in interface org.apache.manifoldcf.crawler.interfaces.INotificationConnector

Overrides:

notifyOfJobStopManualPause in class org.apache.manifoldcf.crawler.notifications.BaseNotificationConnector

Parameters:

spec - is the notification specification.

Throws:

org.apache.manifoldcf.core.interfaces.ManifoldCFException

org.apache.manifoldcf.agents.interfaces.ServiceInterruption

notifyOfJobStopSchedulePause

public void notifyOfJobStopSchedulePause(org.apache.manifoldcf.core.interfaces.Specification spec)
                                  throws org.apache.manifoldcf.core.interfaces.ManifoldCFException,
                                         org.apache.manifoldcf.agents.interfaces.ServiceInterruption

Notify of job stop due to schedule pause.

Specified by:

notifyOfJobStopSchedulePause in interface org.apache.manifoldcf.crawler.interfaces.INotificationConnector

Overrides:

notifyOfJobStopSchedulePause in class org.apache.manifoldcf.crawler.notifications.BaseNotificationConnector

Parameters:

spec - is the notification specification.

Throws:

org.apache.manifoldcf.core.interfaces.ManifoldCFException

org.apache.manifoldcf.agents.interfaces.ServiceInterruption

notifyOfJobStopRestart

public void notifyOfJobStopRestart(org.apache.manifoldcf.core.interfaces.Specification spec)
                            throws org.apache.manifoldcf.core.interfaces.ManifoldCFException,
                                   org.apache.manifoldcf.agents.interfaces.ServiceInterruption

Notify of job stop due to restart.

Specified by:

notifyOfJobStopRestart in interface org.apache.manifoldcf.crawler.interfaces.INotificationConnector

Overrides:

notifyOfJobStopRestart in class org.apache.manifoldcf.crawler.notifications.BaseNotificationConnector

Parameters:

spec - is the notification specification.

Throws:

org.apache.manifoldcf.core.interfaces.ManifoldCFException

org.apache.manifoldcf.agents.interfaces.ServiceInterruption

notifyOfJobEnd

public void notifyOfJobEnd(org.apache.manifoldcf.core.interfaces.Specification spec)
                    throws org.apache.manifoldcf.core.interfaces.ManifoldCFException,
                           org.apache.manifoldcf.agents.interfaces.ServiceInterruption

Notify of job end.

Specified by:

notifyOfJobEnd in interface org.apache.manifoldcf.crawler.interfaces.INotificationConnector

Overrides:

notifyOfJobEnd in class org.apache.manifoldcf.crawler.notifications.BaseNotificationConnector

Parameters:

spec - is the notification specification.

Throws:

org.apache.manifoldcf.core.interfaces.ManifoldCFException

org.apache.manifoldcf.agents.interfaces.ServiceInterruption

sendSlackMessage

protected void sendSlackMessage(org.apache.manifoldcf.core.interfaces.Specification spec,
                                java.lang.String nodeType)
                         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

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. The connector does not need to be connected for this method to be called.

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.

locale - is the desired locale.

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

Specified by:

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

Overrides:

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

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,
                                                 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 always "editconnection". The connector does not need to be connected for this method to be called.

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.INotificationConnector

Overrides:

outputSpecificationHeader in class org.apache.manifoldcf.crawler.notifications.BaseNotificationConnector

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.INotificationConnector

Overrides:

outputSpecificationBody in class org.apache.manifoldcf.crawler.notifications.BaseNotificationConnector

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

outputMessageTab

protected void outputMessageTab(org.apache.manifoldcf.core.interfaces.IHTTPOutput out,
                                java.util.Locale locale,
                                org.apache.manifoldcf.core.interfaces.Specification ds,
                                java.lang.String tabName,
                                int connectionSequenceNumber,
                                int actualSequenceNumber)
                         throws org.apache.manifoldcf.core.interfaces.ManifoldCFException,
                                java.io.IOException

Take care of "Message" tab.

Throws:

org.apache.manifoldcf.core.interfaces.ManifoldCFException

java.io.IOException

fillInMessageTab

protected static void fillInMessageTab(java.util.Map<java.lang.String,java.lang.Object> paramMap,
                                       org.apache.manifoldcf.core.interfaces.Specification ds)

Fill in Velocity context for Metadata tab.

addRecord

protected static void addRecord(java.util.Map<java.lang.String,java.lang.Object> paramMap,
                                java.lang.String nodeType,
                                java.lang.String channel,
                                java.lang.String message)

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.INotificationConnector

Overrides:

processSpecificationPost in class org.apache.manifoldcf.crawler.notifications.BaseNotificationConnector

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

processMessageTab

protected java.lang.String processMessageTab(org.apache.manifoldcf.core.interfaces.IPostParameters variableContext,
                                             org.apache.manifoldcf.core.interfaces.Specification ds,
                                             int connectionSequenceNumber)
                                      throws org.apache.manifoldcf.core.interfaces.ManifoldCFException

Throws:

org.apache.manifoldcf.core.interfaces.ManifoldCFException

gatherRecord

protected static void gatherRecord(org.apache.manifoldcf.core.interfaces.Specification ds,
                                   java.lang.String seqPrefix,
                                   org.apache.manifoldcf.core.interfaces.IPostParameters variableContext,
                                   java.lang.String nodeType)

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.INotificationConnector

Overrides:

viewSpecification in class org.apache.manifoldcf.crawler.notifications.BaseNotificationConnector

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

removeNodes

protected static void removeNodes(org.apache.manifoldcf.core.interfaces.Specification ds,
                                  java.lang.String nodeTypeName)

addNodeValue

protected static void addNodeValue(org.apache.manifoldcf.core.interfaces.SpecificationNode ds,
                                   java.lang.String nodeType,
                                   java.lang.String value)

handleIOException

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

Handle Messaging exceptions in a consistent global manner

Throws:

org.apache.manifoldcf.core.interfaces.ManifoldCFException

org.apache.manifoldcf.agents.interfaces.ServiceInterruption