Class PluginResponse.ResponseImpl

  • All Implemented Interfaces:
    Response
    Enclosing class:
    PluginResponse

    private class PluginResponse.ResponseImpl
    extends Object
    implements Response
    An implementation of the Response interface used by the plugin to return information to the client.
    • Nested Class Summary

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private ResponseImpl()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void setClearState()
      This can be used in the configuration phase of a plug-in to clear the stored state and nextCommand information.
      void setContinue​(String nextCommand)
      This method will continue the configuration or execution of the job with a new command to the plugin.
      void setContinue​(String nextCommand, Serializable state)
      Can be used by an executing job to also store state information that will be restored when the job is starting up again.
      void setDone​(String message)
      This will end the job execution and report it as a success.
      void setDone​(String message, Job.ExecutionTime estimatedExecutionTime)
      This will end the configuration of a job and set the estimated execution time for it.
      void setDownloadImmediately​(String message, Job.ExecutionTime estimatedExecutionTime, boolean failIfDenied)
      This will end the configuration of a export job, and start to execute it for immediate download.
      void setDryRun​(boolean dryRun)
      A plug-in may call this method in it's configuration phase or after it has been executed to indicate that the job should be or was executed as a dry-run job.
      void setError​(String message, List<? extends Throwable> errorList)
      This will end the job execution or configuration and report it as a failure.
      void setExecuteImmediately​(String message, Job.ExecutionTime estimatedExecutionTime, boolean failIfDenied)
      This will end the configuration of a job, and start to execute it immediately if the plugin is permitted to do so.
      void setPause​(String message, String nextCommand, Serializable state)
      A plug-in can call this method to notify the core that it has been paused.
      void setSuggestedJobName​(String jobName)
      A plug-in may call this method on it's job configuration phase to suggest a name for the job.
    • Constructor Detail

      • ResponseImpl

        private ResponseImpl()
    • Method Detail

      • setContinue

        public void setContinue​(String nextCommand)
                         throws PermissionDeniedException
        Description copied from interface: Response
        This method will continue the configuration or execution of the job with a new command to the plugin. If the plug-in is currently being configured the configuration will continue with the next command. If the plug-in is currently executing the job will be returned to job queue. The intention is that plug-ins can use this to survive a temporary shutdown of the system after catching the Signal.SHUTDOWN signal.
        Specified by:
        setContinue in interface Response
        Parameters:
        nextCommand - The next command to the plugin
        Throws:
        PermissionDeniedException - If another command isn't allowed
      • setPause

        public void setPause​(String message,
                             String nextCommand,
                             Serializable state)
        Description copied from interface: Response
        A plug-in can call this method to notify the core that it has been paused. The job should remain in the job queue. A user may manually decide to either re-configure the job or resume it from where it was paused. Note to plug-in developers: The job will be resumed in a different instance. Any state information that is needed when resuming can be stored in the 'state' parameter. This information will be provided to the plug-in when re-starting.
        Specified by:
        setPause in interface Response
        Parameters:
        message - An optional message to update the status field
        nextCommand - The command to send to the plug-in when resuming
        state - State information that will be restored when resuming
      • setClearState

        public void setClearState()
        Description copied from interface: Response
        This can be used in the configuration phase of a plug-in to clear the stored state and nextCommand information. The intention is that a PAUSED plug-in that is being re-configured should be able to force a re-start from the beginning if the configuration has changed in a way that restarting from the stored state doesn't make any sense.
        Specified by:
        setClearState in interface Response
      • setDone

        public void setDone​(String message,
                            Job.ExecutionTime estimatedExecutionTime)
        Description copied from interface: Response
        This will end the configuration of a job and set the estimated execution time for it.
        Specified by:
        setDone in interface Response
        Parameters:
        message - An optional message
        estimatedExecutionTime - An estimated execution time for the job, null is the same as ExecutionTime.LONG
      • setExecuteImmediately

        public void setExecuteImmediately​(String message,
                                          Job.ExecutionTime estimatedExecutionTime,
                                          boolean failIfDenied)
        Description copied from interface: Response
        This will end the configuration of a job, and start to execute it immediately if the plugin is permitted to do so. If it is not possible to execute the job immediately it will be added to the job queue for later execution unless the failIfDenied flag is set to true, in which case an exception will be thrown.

        If immediate execution is possible the client application must continue to use the same instance of the plugin object. This means that immediate execution always happens in the same virtual machine. Plugins should be aware of this and avoid excessive use of resources such as memory and CPU time.

        The client application may execute the job in another thread.

        Specified by:
        setExecuteImmediately in interface Response
        Parameters:
        message - An optional message
        estimatedExecutionTime - An estimated execution time for the job, null is the same as ExecutionTime.LONG. This value is only used if immediate execution isn't possible and the job has to be added to the job queue.
        failIfDenied - TRUE if a PermissionDeniedException should be thrown if immediate exection isn't possible, FALSE to add the job to the job queue for later exection
      • setDone

        public void setDone​(String message)
        Description copied from interface: Response
        This will end the job execution and report it as a success.
        Specified by:
        setDone in interface Response
        Parameters:
        message - A message containing any relevant information about what the plugin did, or null
      • setError

        public void setError​(String message,
                             List<? extends Throwable> errorList)
        Description copied from interface: Response
        This will end the job execution or configuration and report it as a failure. If in a configuration sequence the client application may try the same command again with different parameters.
        Specified by:
        setError in interface Response
        Parameters:
        message - Information about the reason for the error
        errorList - Detailed information about the error
      • setDryRun

        public void setDryRun​(boolean dryRun)
        Description copied from interface: Response
        A plug-in may call this method in it's configuration phase or after it has been executed to indicate that the job should be or was executed as a dry-run job. A dry-run job is a job that does all the things a normal job would do except committing the changes to the database. The dry-run job may output a log file with detailed information about what should have happened if it hadn't been a dry-run.

        NOTE! Setting this value to true doesn't change the behaviour of the core. It is the responsibility of the plug-in to check this value(eg. Job.isDryRun() and take appropriate action.

        Specified by:
        setDryRun in interface Response
        Parameters:
        dryRun - TRUE to indicate that the job should be or was executed as a dry-run
      • setSuggestedJobName

        public void setSuggestedJobName​(String jobName)
        Description copied from interface: Response
        A plug-in may call this method on it's job configuration phase to suggest a name for the job. Otherwise a default name will be generated by the core.
        Specified by:
        setSuggestedJobName in interface Response