Package com.axemble.vdoc.sdk.agent.base

Class BaseAgent

java.lang.Object
com.axemble.vdoc.sdk.agent.base.BaseAgent
@Deprecated public abstract class BaseAgent extends Object
Deprecated.
use IAgentProcessing or IStoppableAgentProcessing
This base class provides direct access to the SDK API. It allows creating agents which can be scheduled through the Agent administration user interface. The following methods are available: - getWorkflowModule() : the module to manipulate the workflow system;
Version:
1.0, 15/04/2008
Author:
vlygeros
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected final Logger
    LOGGER
    Deprecated.
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    BaseAgent()
    Deprecated.
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected abstract void
    execute()
    Deprecated.
     
    protected final IAgent
    getAgent()
    Deprecated.
    Allows to retrieve the current agent.
    protected final Element
    getConfiguration()
    Deprecated.
    Allows to retrieve the configuration of the current agent.
    protected final IDirectoryModule
    getDirectoryModule()
    Deprecated.
    Gets the directory module object.
    protected final Date
    getLastRunDate()
    Deprecated.
     
    protected final IPortalModule
    getPortalModule()
    Deprecated.
    Gets the portal module object.
    protected final IProjectModule
    getProjectModule()
    Deprecated.
    Gets the project module object.
    protected final IReport
    getReport()
    Deprecated.
     
    protected final IWorkflowModule
    getWorkflowModule()
    Deprecated.
    Gets the workflow module object.
    protected final void
    printDebug(String message)
    Deprecated.
    Print debug message into the agent administration report tab
    protected final void
    printError(String message)
    Deprecated.
    Print error message into the agent administration report tab
    protected final void
    printInfo(String message)
    Deprecated.
    Print information message into the report page of the agent administration tab
    protected final void
    printLine()
    Deprecated.
    Print an empty line into the agent administration report tab
    protected final void
    printSeparator()
    Deprecated.
    Print a separator into the agent administration report tab
    protected final void
    printSuccess(String message)
    Deprecated.
    use printInfo method instead
    protected final void
    printWarning(String message)
    Deprecated.
    Print warning message into the agent administration report tab
    final void
    runAgent(com.axemble.vdp.utils.ReportCollector reportCollector, com.axemble.vdoc.agent.domain.Agent agent)
    Deprecated.
     

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • LOGGER

      protected final Logger LOGGER
      Deprecated.

  • Constructor Details

    • BaseAgent

      public BaseAgent()
      Deprecated.

  • Method Details

    • runAgent

      public final void runAgent(com.axemble.vdp.utils.ReportCollector reportCollector, com.axemble.vdoc.agent.domain.Agent agent)
      Deprecated.

    • execute

      protected abstract void execute()
      Deprecated.

    • getPortalModule

      protected final IPortalModule getPortalModule()
      Deprecated.
      Gets the portal module object.
      Returns:
      A IPortalModule object.

    • getDirectoryModule

      protected final IDirectoryModule getDirectoryModule()
      Deprecated.
      Gets the directory module object.
      Returns:
      A IDirectoryModule object.

    • getProjectModule

      protected final IProjectModule getProjectModule()
      Deprecated.
      Gets the project module object.
      Returns:
      A IProjectModule object.

    • getWorkflowModule

      protected final IWorkflowModule getWorkflowModule()
      Deprecated.
      Gets the workflow module object.
      Returns:
      A IWorkflowModule object.

    • getConfiguration

      protected final Element getConfiguration()
      Deprecated.
      Allows to retrieve the configuration of the current agent.
      Returns:
      The org.w3c.dom.Element of the current agent.

    • getAgent

      protected final IAgent getAgent()
      Deprecated.
      Allows to retrieve the current agent.
      Returns:
      An IAgent object.

    • printInfo

      protected final void printInfo(String message)
      Deprecated.
      Print information message into the report page of the agent administration tab
      Parameters:
      message - The message to print

    • printError

      protected final void printError(String message)
      Deprecated.
      Print error message into the agent administration report tab
      Parameters:
      message - The message to print

    • printWarning

      protected final void printWarning(String message)
      Deprecated.
      Print warning message into the agent administration report tab
      Parameters:
      message - The message to print

    • printSuccess

      @Deprecated protected final void printSuccess(String message)
      Deprecated.
      use printInfo method instead
      Print success message into the agent administration report tab
      Parameters:
      message - The message to print

    • printSeparator

      protected final void printSeparator()
      Deprecated.
      Print a separator into the agent administration report tab

    • printLine

      protected final void printLine()
      Deprecated.
      Print an empty line into the agent administration report tab

    • printDebug

      protected final void printDebug(String message)
      Deprecated.
      Print debug message into the agent administration report tab
      Parameters:
      message - The message to print

    • getReport

      protected final IReport getReport()
      Deprecated.
      Returns:
      this agent report collector

    • getLastRunDate

      protected final Date getLastRunDate()
      Deprecated.
      Returns:
      last time this agent was executed