Package com.redwood.scheduler.api.model

Interface MailConnector

    • Method Detail

      • getServer

        String getServer()
        Get the value for Server. (E-mail server) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • getUsername

        String getUsername()
        Get the value for Username. (Username for the mail connection.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • getPassword

        String getPassword()
        Get the value for Password. (The password for the connection)
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • getProtocol

        MailConnectionProtocol getProtocol()
        Get the value for Protocol. (Connection protocol) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • getInboxFolder

        String getInboxFolder()
        Get the value for InboxFolder. (Inbox folder in the mailbox) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • getErrorFolder

        String getErrorFolder()
        Get the value for ErrorFolder. (Error folder in the mailbox) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • getProcessedFolder

        String getProcessedFolder()
        Get the value for ProcessedFolder. (Processed folder in the mailbox) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • getPollInterval

        Long getPollInterval()
        Get the value for PollInterval. (Polling interval (in seconds) that servers as the upper bound for how often the check is performed. The value should be more as 5 seconds.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • getStatus

        ProcessServerStatus getStatus()
        Get the value for Status. (The status of the BAE Connector.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • isStartOnStartup

        boolean isStartOnStartup()
        Get the value for StartOnStartup. (Start this mail connector at system startup.)
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • getServerSecret

        String getServerSecret()
        Get the value for ServerSecret. (Server phrase used for generation of server key.)
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • setServer

        void setServer​(String newServer)
        Set the value for Server. (E-mail server) This value is mandatory.
        Parameters:
        newServer - the new value for Server. If this is null, then the object cannot be persisted.
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • setUsername

        void setUsername​(String newUsername)
        Set the value for Username. (Username for the mail connection.) This value is mandatory.
        Parameters:
        newUsername - the new value for Username. If this is null, then the object cannot be persisted.
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • setPassword

        void setPassword​(String newPassword)
        Set the value for Password. (The password for the connection) This value is optional.
        Parameters:
        newPassword - the new value for Password.
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • setProtocol

        void setProtocol​(MailConnectionProtocol newProtocol)
        Set the value for Protocol. (Connection protocol) This value is mandatory.
        Parameters:
        newProtocol - the new value for Protocol. If this is null, then the object cannot be persisted.
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • setInboxFolder

        void setInboxFolder​(String newInboxFolder)
        Set the value for InboxFolder. (Inbox folder in the mailbox) This value is mandatory.
        Parameters:
        newInboxFolder - the new value for InboxFolder. If this is null, then the object cannot be persisted.
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • setErrorFolder

        void setErrorFolder​(String newErrorFolder)
        Set the value for ErrorFolder. (Error folder in the mailbox) This value is mandatory.
        Parameters:
        newErrorFolder - the new value for ErrorFolder. If this is null, then the object cannot be persisted.
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • setProcessedFolder

        void setProcessedFolder​(String newProcessedFolder)
        Set the value for ProcessedFolder. (Processed folder in the mailbox) This value is mandatory.
        Parameters:
        newProcessedFolder - the new value for ProcessedFolder. If this is null, then the object cannot be persisted.
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • setPollInterval

        void setPollInterval​(Long newPollInterval)
        Set the value for PollInterval. (Polling interval (in seconds) that servers as the upper bound for how often the check is performed. The value should be more as 5 seconds.) This value is mandatory.
        Parameters:
        newPollInterval - the new value for PollInterval. If this is null, then the object cannot be persisted.
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • setStartOnStartup

        void setStartOnStartup​(boolean newStartOnStartup)
        Set the value for StartOnStartup. (Start this mail connector at system startup.)
        Parameters:
        newStartOnStartup - the new value for StartOnStartup.
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • setServerSecret

        void setServerSecret​(String newServerSecret)
        Set the value for ServerSecret. (Server phrase used for generation of server key.) This value is optional.
        Parameters:
        newServerSecret - the new value for ServerSecret.
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • checkConnection

        String checkConnection()
        Check the connection string for validity.
        Returns:
        Return an error if the connection failed, otherwise return null.

      • start

        void start()
        Start the mail connector.

      • stop

        void stop()
        Stop the mail connector normally.

      • getMonitorRootPath

        String getMonitorRootPath()
        Get the root path label to use for the Mail Connector in the monitor tree. Depends on the configuration/Monitoring/MonitorRootPath registry key: (a) KeyValue = PartitionColonNonGlobal (default) -> if partition is GLOBAL return MailConnectorName else return Partition:MailConnectorName. (b) KeyValue = PartitionColonAlways -> Always return Partition:MailConnectorName. (c) KeyValue = PartitionPathAlways -> Always return Partition/MailConnectorName.
        Returns:
        The String to use as the root path in the monitor tree

      • stop

        void stop​(ProcessServerStatus status)
        Stop the mail connector with Status.
        Parameters:
        status - Status in which process server should stop.

      • encodeArmor

        String[] encodeArmor​(String data)
              throws com.redwood.scheduler.api.exception.MailInvalidArmorException
        Encrypts any string input as armor.
        Parameters:
        data - Data that needs to be encrypted.
        Returns:
        An array with lines for resulted armor
        Throws:
        com.redwood.scheduler.api.exception.MailInvalidArmorException - Failed by encoding/decoding armor

      • decodeArmor

        String decodeArmor​(String armor)
            throws com.redwood.scheduler.api.exception.MailInvalidArmorException
        Decrypts the armor to get data back.
        Parameters:
        armor - Armor that needs to be decrypted
        Returns:
        A string with the decrypted data.
        Throws:
        com.redwood.scheduler.api.exception.MailInvalidArmorException - Failed by encoding/decoding armor

      • getJobDefinition

        JobDefinition getJobDefinition()
        Get the JobDefinition.
        Returns:
        JobDefinition
        Throws:
        com.redwood.scheduler.api.exception.ObjectDeletedException - If this method is called when the object has been marked for deletion.
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - If this method is called when the object has been removed from it's session.

      • setJobDefinition

        void setJobDefinition​(JobDefinition newJobDefinition)
        Set the value for JobDefinition. This value is mandatory.
        Parameters:
        newJobDefinition - is the object to set JobDefinition to. The process definition to trigger on getting a mail. If this is null, then the object cannot be persisted.

      • checkCreatePrivilege

        RequiredPermission checkCreatePrivilege()
        Check whether or not the create action can be performed on this object.
        Returns:
        a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.

      • checkViewPrivilege

        RequiredPermission checkViewPrivilege()
        Check whether or not the view action can be performed on this object.
        Returns:
        a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.

      • checkControlPrivilege

        RequiredPermission checkControlPrivilege()
        Check whether or not the control action can be performed on this object.
        Returns:
        a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.

      • checkEditPrivilege

        RequiredPermission checkEditPrivilege()
        Check whether or not the edit action can be performed on this object.
        Returns:
        a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.

      • checkDeletePrivilege

        RequiredPermission checkDeletePrivilege()
        Check whether or not the delete action can be performed on this object.
        Returns:
        a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.

      • checkBusinessAutomationAPIPrivilege

        RequiredPermission checkBusinessAutomationAPIPrivilege()
        Check whether or not the businessAutomationAPI action can be performed on this object.
        Returns:
        a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.