Package de.uplanet.lucy.server.mailservice.workflow.eventsource

Class AbstractIMAPFolderWorkflowEventSource

java.lang.Object
de.uplanet.lucy.server.workflow.eventsource.AbstractWorkflowEventSource
de.uplanet.lucy.server.workflow.eventsource.AbstractSingleThreadedWorkflowEventSource
de.uplanet.lucy.server.mailservice.workflow.eventsource.AbstractIMAPFolderWorkflowEventSource
All Implemented Interfaces:
IActivatableWorkflowObject, de.uplanet.lucy.server.workflow.IImpersonateUser, ILogLevelAware, INamedWorkflowObject, de.uplanet.lucy.server.workflow.INeedClusterInfo, INeedWorkflow, IRunnableWorkflowObject, IStartableWorkflowObject, ISupportAfterStopEvent, ISupportBeforeStartEvent, ISupportGlobalSharedState, IWorkflowEventSource, IWorkflowObject, Serializable
Direct Known Subclasses:
ExchangeOnlineIMAPFolderPollingWorkflowEventSource, IMAPFolderPollingWorkflowEventSource
public abstract class AbstractIMAPFolderWorkflowEventSource extends AbstractSingleThreadedWorkflowEventSource implements de.uplanet.lucy.server.workflow.INeedClusterInfo, ISupportGlobalSharedState, ISupportBeforeStartEvent, ISupportAfterStopEvent
Since:
Intrexx 7.0.
See Also:

  • Method Details

    • getClusterInfo

      public de.uplanet.lucy.server.workflow.IClusterInfo getClusterInfo()
      Specified by:
      getClusterInfo in interface de.uplanet.lucy.server.workflow.INeedClusterInfo

    • setClusterInfo

      public void setClusterInfo(de.uplanet.lucy.server.workflow.IClusterInfo p_clusterInfo)
      Specified by:
      setClusterInfo in interface de.uplanet.lucy.server.workflow.INeedClusterInfo

    • isSendBeforeStartEvent

      public boolean isSendBeforeStartEvent()
      This property determines if an IBeforeStartWatchIMAPFolderWorkflowEvent should be sent.
      Specified by:
      isSendBeforeStartEvent in interface ISupportBeforeStartEvent
      Returns:
      true if the event should be sent before the workflow object's activity is about to being started, or false otherwise.

    • setSendBeforeStartEvent

      public void setSendBeforeStartEvent(boolean p_bSendBeforeStartEvent)
      This property determines if an IBeforeStartWatchIMAPFolderWorkflowEvent should be sent.
      Specified by:
      setSendBeforeStartEvent in interface ISupportBeforeStartEvent
      Parameters:
      p_bSendBeforeStartEvent - true if the event should be sent before the workflow object's activity is about to being started, or false otherwise.

    • isSendAfterStopEvent

      public boolean isSendAfterStopEvent()
      This property determines if an IAfterStopWatchIMAPFolderWorkflowEvent should be sent.
      Specified by:
      isSendAfterStopEvent in interface ISupportAfterStopEvent
      Returns:
      true if the event should be sent after the workflow object's activity has been stopped, or false otherwise.

    • setSendAfterStopEvent

      public void setSendAfterStopEvent(boolean p_bSendAfterStopEvent)
      This property determines if an IAfterStopWatchIMAPFolderWorkflowEvent should be sent.
      Specified by:
      setSendAfterStopEvent in interface ISupportAfterStopEvent
      Parameters:
      p_bSendAfterStopEvent - true if the event should be sent after the workflow object's activity has been stopped, or false otherwise.

    • getDispatchDelay

      public long getDispatchDelay()
      Get the dispatch delay, i.e. the delay before an IMAP message event is dispatched to the workflows.
      Returns:
      The dispatch delay in milliseconds.

    • setDispatchDelay

      public void setDispatchDelay(long p_lDispatchDelay)
      Set the dispatch delay, i.e. the delay before an IMAP message event is dispatched to the workflows.
      Parameters:
      p_lDispatchDelay - The dispatch delay in milliseconds.

    • isLoadIncomingMessagesImmediately

      public boolean isLoadIncomingMessagesImmediately()
      This property determines if incoming messages should be loaded immediately and be included in the generated events.

      If set to false loading of the message will be delayed until it is accessed through the event's message property.

      The default value is false.

      Returns:
      true if incoming messages should be loaded immediately, or false otherwise.

    • setLoadIncomingMessagesImmediately

      public void setLoadIncomingMessagesImmediately(boolean p_bLoadIncomingMessagesImmediately)
      This property determines if incoming messages should be loaded immediately and be included in the generated events.

      If set to false loading of the message will be delayed until it is accessed through the event's message property.

      The default value is false.

      Parameters:
      p_bLoadIncomingMessagesImmediately - true if incoming messages should be loaded immediately, or false otherwise.

    • isGlobalSharedState

      public boolean isGlobalSharedState()
      This property determines if a global shared state should be used for all events created by this event source.
      Specified by:
      isGlobalSharedState in interface ISupportGlobalSharedState
      Returns:
      true if a global shared state should be used, or false otherwise.

    • setGlobalSharedState

      public void setGlobalSharedState(boolean p_bGlobalSharedState)
      This property determines if a global shared state should be used for all events created by this event source.
      Specified by:
      setGlobalSharedState in interface ISupportGlobalSharedState
      Parameters:
      p_bGlobalSharedState - true if a global shared state should be used, or false otherwise.

    • getOnErrorRestartWaitTimeout

      public long getOnErrorRestartWaitTimeout()
      Get the time in milliseconds the event source will wait before it tries to restart after an error occurred that prevented it to running the source loop.

      The default value is 60000 milliseconds (one minute).

      Returns:
      The timeout in milliseconds.

    • setOnErrorRestartWaitTimeout

      public void setOnErrorRestartWaitTimeout(long p_lOnErrorRestartWaitTimeout)
      Set the time in milliseconds the event source will wait before it tries to restart after an error occurred that prevented it to running the source loop.
      Parameters:
      p_lOnErrorRestartWaitTimeout - The timeout in milliseconds.

    • getProtocol

      public String getProtocol()
      Get the protocol.
      Returns:
      Either IMAP, or IMAPS, or IMAP_STARTTLS.

    • setProtocol

      public void setProtocol(String p_strProtocol)
      Set the protocol.
      Parameters:
      p_strProtocol - The protocol, i.e. either IMAP, or IMAPS, or IMAP_STARTTLS.

    • getHost

      public String getHost()
      Get the IMAP server to connect to.
      Returns:
      The IMAP server.

    • setHost

      public void setHost(String p_strHost)
      Set the IMAP server to connect to.
      Parameters:
      p_strHost - The IMAP server.

    • getPort

      public int getPort()
      Get the port the IMAP server listens to.
      Returns:
      The port.

    • setPort

      public void setPort(int p_iPort)
      Set the port the IMAP server listens to.
      Parameters:
      p_iPort - The port.

    • getFolder

      public String getFolder()

    • setFolder

      public void setFolder(String p_strFolder)

    • getJavaMailProperties

      public Map<String,String> getJavaMailProperties()

    • setJavaMailProperties

      public void setJavaMailProperties(Map<String,String> p_javaMailProperties)

    • getMessageSelectFilter

      public MessageSelectFilterCfg getMessageSelectFilter()
      Get the filter for selecting messages that are to be processed.
      Returns:
      The message filter.

    • setMessageSelectFilter

      public void setMessageSelectFilter(MessageSelectFilterCfg p_selectFilter)
      Set the filter for selecting messages that are to be processed.
      Parameters:
      p_selectFilter - The message filter.

    • getFinishAction

      public IMAPFinishActionCfg getFinishAction()
      Get the action to be performed after an IMAP message has been processed.
      Returns:
      The finish action.

    • setFinishAction

      public void setFinishAction(IMAPFinishActionCfg p_finishAction)
      Set the action to be performed after an IMAP message has been processed.
      Parameters:
      p_finishAction - The finish action.