Package org.apache.manifoldcf.crawler.connectors.email

Class EmailConnector

  • All Implemented Interfaces:
    org.apache.manifoldcf.core.interfaces.IConnector, org.apache.manifoldcf.crawler.interfaces.IRepositoryConnector
    public class EmailConnector
extends org.apache.manifoldcf.crawler.connectors.BaseRepositoryConnector
    This interface describes an instance of a connection between a repository 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 complete list is:

    The purpose of the repository connector is to allow documents to be fetched from the repository.

    Each repository connector describes a set of documents that are known only to that connector. It therefore establishes a space of document identifiers. Each connector will only ever be asked to deal with identifiers that have in some way originated from the connector.

    Documents are fetched in three stages. First, the getDocuments() method is called in the connector implementation. This returns a set of document identifiers. The document identifiers are used to obtain the current document version strings in the second stage, using the getDocumentVersions() method. The last stage is processDocuments(), which queues up any additional documents needed, and also ingests. This method will not be called if the document version seems to indicate that no document change took place.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected java.lang.String attachmentUrlTemplate  
      protected java.lang.String password  
      protected java.lang.String portString  
      protected java.util.Properties properties  
      protected java.lang.String protocol  
      protected java.lang.String server  
      protected EmailSession session  
      protected static long SESSION_EXPIRATION_MILLISECONDS  
      protected long sessionExpiration  
      protected java.lang.String urlTemplate  
      protected java.lang.String username  

      • Fields inherited from class org.apache.manifoldcf.crawler.connectors.BaseRepositoryConnector

        _rcsid

      • 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 Description
      EmailConnector()  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected static void addFindParameterNode​(org.apache.manifoldcf.core.interfaces.ConfigParams parameters, java.lang.String findParameterName, java.lang.String findParameterValue)  
      protected static void addFindParameterNode​(org.apache.manifoldcf.core.interfaces.Specification ds, java.lang.String findParameterName, java.lang.String findParameterValue)  
      protected static void addFolderNode​(org.apache.manifoldcf.core.interfaces.Specification ds, java.lang.String folderName)  
      protected static void addIncludedMetadataNode​(org.apache.manifoldcf.core.interfaces.Specification ds, java.lang.String metadataName)  
      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.
      java.lang.String check()
      Test the connection.
      protected void checkConnection()  
      void connect​(org.apache.manifoldcf.core.interfaces.ConfigParams configParameters)
      Connect.
      protected static java.lang.String createDocumentIdentifier​(java.lang.String folderName, java.lang.String emailID)
      Create a document identifier from a folder name and an email ID
      void disconnect()
      Close the connection.
      protected static java.lang.Integer extractAttachmentNumberFromDocumentIdentifier​(java.lang.String di)
      Find an attachment number in a document identifier
      protected static java.lang.String extractEmailIDFromDocumentIdentifier​(java.lang.String di)
      Find an email ID in a document identifier
      protected static java.lang.String extractFolderNameFromDocumentIdentifier​(java.lang.String di)
      Find a folder name in a document identifier
      protected static void fillInFilterTab​(java.util.Map<java.lang.String,​java.lang.Object> paramMap, org.apache.manifoldcf.core.interfaces.Specification ds)  
      protected void fillInMetadataAttributes​(java.util.Map<java.lang.String,​java.lang.Object> paramMap)
      Fill in Velocity context with data to permit attribute selection.
      protected static void fillInMetadataTab​(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()  
      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 strings for a document identifier.
      int getConnectorModel()  
      protected java.lang.String[] getFolderNames()
      Get a sorted list of folder names
      int getMaxDocumentRequest()
      Get the maximum number of documents to amalgamate together into one batch, for this connector.
      protected void getSession()  
      protected static void handleIOException​(java.io.IOException e, java.lang.String context)
      Handle IO Exception
      protected static void handleMessagingException​(javax.mail.MessagingException e, java.lang.String context)
      Handle Messaging exceptions in a consistent global manner
      protected static java.lang.String makeDocumentURI​(java.lang.String urlTemplate, java.lang.String folderName, java.lang.String id)
      Create a document's URI given a template, a folder name, and a message ID
      protected static java.lang.String makeDocumentURI​(java.lang.String urlTemplate, java.lang.String folderName, java.lang.String id, int attachmentNumber)
      Create a document's URI given a template, a folder name, a message ID, and an attachment number
      protected static java.lang.String makeSafeFolderName​(java.lang.String folderName)
      Create a safe folder name (which doesn't contain colons)
      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 outputFilterTab​(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)  
      protected void outputMetadataTab​(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 "Metadata" 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.
      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.
      protected java.lang.String processExtractEmail​(org.apache.manifoldcf.core.interfaces.IPostParameters variableContext, org.apache.manifoldcf.core.interfaces.Specification ds, int connectionSequenceNumber)  
      protected java.lang.String processFilterTab​(org.apache.manifoldcf.core.interfaces.IPostParameters variableContext, org.apache.manifoldcf.core.interfaces.Specification ds, int connectionSequenceNumber)  
      protected java.lang.String processMetadataAttributes​(org.apache.manifoldcf.core.interfaces.IPostParameters variableContext, org.apache.manifoldcf.core.interfaces.Specification ds, int connectionSequenceNumber)  
      protected java.lang.String processMetadataTab​(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.ConfigParams parameters, java.lang.String nodeTypeName)  
      protected static void removeNodes​(org.apache.manifoldcf.core.interfaces.Specification ds, java.lang.String nodeTypeName)  
      protected static java.lang.String substitute​(java.lang.String template, java.util.Map<java.lang.String,​java.lang.String> map)  
      protected static java.lang.String unpackSafeFolderName​(java.lang.String packedFolderName)
      Unpack a safe folder name
      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, 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

      • server

        protected java.lang.String server

      • portString

        protected java.lang.String portString

      • username

        protected java.lang.String username

      • password

        protected java.lang.String password

      • protocol

        protected java.lang.String protocol

      • properties

        protected java.util.Properties properties

      • urlTemplate

        protected java.lang.String urlTemplate

      • attachmentUrlTemplate

        protected java.lang.String attachmentUrlTemplate

    • Constructor Detail

      • EmailConnector

        public EmailConnector()

    • 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

      • getConnectorModel

        public int getConnectorModel()
        Specified by:
        getConnectorModel in interface org.apache.manifoldcf.crawler.interfaces.IRepositoryConnector
        Overrides:
        getConnectorModel in class org.apache.manifoldcf.crawler.connectors.BaseRepositoryConnector

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

      • getBinNames

        public java.lang.String[] getBinNames​(java.lang.String documentIdentifier)
        Get the bin name strings 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 set of bin names. If an empty array is returned, it is equivalent to there being no request rate throttling available for this identifier.

      • getMaxDocumentRequest

        public int getMaxDocumentRequest()
        Get the maximum number of documents to amalgamate together into one batch, for this connector.
        Specified by:
        getMaxDocumentRequest in interface org.apache.manifoldcf.crawler.interfaces.IRepositoryConnector
        Overrides:
        getMaxDocumentRequest in class org.apache.manifoldcf.crawler.connectors.BaseRepositoryConnector
        Returns:
        the maximum number. 0 indicates "unlimited".

      • 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).
        lastSeedVersion - is the last seeding version string for this job, or null if the job has no previous seeding version string.
        seedTime - is the end of the time range of documents to consider, exclusive.
        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

      • 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()

      • 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

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

      • outputMetadataTab

        protected void outputMetadataTab​(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 "Metadata" tab.
        Throws:
        org.apache.manifoldcf.core.interfaces.ManifoldCFException
        java.io.IOException

      • fillInMetadataTab

        protected static void fillInMetadataTab​(java.util.Map<java.lang.String,​java.lang.Object> paramMap,
                                        org.apache.manifoldcf.core.interfaces.Specification ds)
        Fill in Velocity context for Metadata tab.

      • fillInMetadataAttributes

        protected void fillInMetadataAttributes​(java.util.Map<java.lang.String,​java.lang.Object> paramMap)
        Fill in Velocity context with data to permit attribute selection.

      • outputFilterTab

        protected void outputFilterTab​(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
        Throws:
        org.apache.manifoldcf.core.interfaces.ManifoldCFException
        java.io.IOException

      • fillInFilterTab

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

      • 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

      • processFilterTab

        protected java.lang.String processFilterTab​(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

      • processMetadataTab

        protected java.lang.String processMetadataTab​(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

      • processMetadataAttributes

        protected java.lang.String processMetadataAttributes​(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

      • processExtractEmail

        protected java.lang.String processExtractEmail​(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

      • 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

      • getFolderNames

        protected java.lang.String[] getFolderNames()
                                     throws org.apache.manifoldcf.core.interfaces.ManifoldCFException,
                                            org.apache.manifoldcf.agents.interfaces.ServiceInterruption
        Get a sorted list of folder names
        Throws:
        org.apache.manifoldcf.core.interfaces.ManifoldCFException
        org.apache.manifoldcf.agents.interfaces.ServiceInterruption

      • makeDocumentURI

        protected static java.lang.String makeDocumentURI​(java.lang.String urlTemplate,
                                                  java.lang.String folderName,
                                                  java.lang.String id)
        Create a document's URI given a template, a folder name, and a message ID

      • makeDocumentURI

        protected static java.lang.String makeDocumentURI​(java.lang.String urlTemplate,
                                                  java.lang.String folderName,
                                                  java.lang.String id,
                                                  int attachmentNumber)
        Create a document's URI given a template, a folder name, a message ID, and an attachment number

      • substitute

        protected static java.lang.String substitute​(java.lang.String template,
                                             java.util.Map<java.lang.String,​java.lang.String> map)

      • addFindParameterNode

        protected static void addFindParameterNode​(org.apache.manifoldcf.core.interfaces.ConfigParams parameters,
                                           java.lang.String findParameterName,
                                           java.lang.String findParameterValue)

      • removeNodes

        protected static void removeNodes​(org.apache.manifoldcf.core.interfaces.ConfigParams parameters,
                                  java.lang.String nodeTypeName)

      • removeNodes

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

      • addIncludedMetadataNode

        protected static void addIncludedMetadataNode​(org.apache.manifoldcf.core.interfaces.Specification ds,
                                              java.lang.String metadataName)

      • addFindParameterNode

        protected static void addFindParameterNode​(org.apache.manifoldcf.core.interfaces.Specification ds,
                                           java.lang.String findParameterName,
                                           java.lang.String findParameterValue)

      • addFolderNode

        protected static void addFolderNode​(org.apache.manifoldcf.core.interfaces.Specification ds,
                                    java.lang.String folderName)

      • createDocumentIdentifier

        protected static java.lang.String createDocumentIdentifier​(java.lang.String folderName,
                                                           java.lang.String emailID)
        Create a document identifier from a folder name and an email ID

      • extractAttachmentNumberFromDocumentIdentifier

        protected static java.lang.Integer extractAttachmentNumberFromDocumentIdentifier​(java.lang.String di)
        Find an attachment number in a document identifier

      • extractFolderNameFromDocumentIdentifier

        protected static java.lang.String extractFolderNameFromDocumentIdentifier​(java.lang.String di)
        Find a folder name in a document identifier

      • extractEmailIDFromDocumentIdentifier

        protected static java.lang.String extractEmailIDFromDocumentIdentifier​(java.lang.String di)
        Find an email ID in a document identifier

      • makeSafeFolderName

        protected static java.lang.String makeSafeFolderName​(java.lang.String folderName)
        Create a safe folder name (which doesn't contain colons)

      • unpackSafeFolderName

        protected static java.lang.String unpackSafeFolderName​(java.lang.String packedFolderName)
        Unpack a safe folder name

      • handleMessagingException

        protected static void handleMessagingException​(javax.mail.MessagingException 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

      • 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 IO Exception
        Throws:
        org.apache.manifoldcf.core.interfaces.ManifoldCFException
        org.apache.manifoldcf.agents.interfaces.ServiceInterruption