Package org.dspace.scripts.handler

Interface DSpaceRunnableHandler

  • All Known Implementing Classes:
    CommandLineDSpaceRunnableHandler
    public interface DSpaceRunnableHandler
    This is an interface meant to be implemented by any DSpaceRunnableHandler to specify specific execution methods of the script depending on where it was called from

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void handleCompletion()
      This method handles the completion of the script
      void handleException​(Exception e)
      This method handles an exception thrown by the script
      void handleException​(String message)
      This method handles an exception thrown by the script
      void handleException​(String message, Exception e)
      This method handles an exception thrown by the script
      void logDebug​(String message)
      This method will perform the debug logging of the message given
      void logError​(String message)
      This method will perform the error logging of the message given
      void logInfo​(String message)
      This method will perform the info logging of the message given
      void logWarning​(String message)
      This method will perform the warning logging of the message given
      void printHelp​(org.apache.commons.cli.Options options, String name)
      This method will print the help for the options and name
      void start()
      This method handles the start of the script

    • Method Detail

      • start

        void start()
    throws SQLException
        This method handles the start of the script
        Throws:
        SQLException - If something goes wrong

      • handleCompletion

        void handleCompletion()
               throws SQLException
        This method handles the completion of the script
        Throws:
        SQLException - If something goes wrong

      • handleException

        void handleException​(Exception e)
        This method handles an exception thrown by the script
        Parameters:
        e - The exception thrown by the script

      • handleException

        void handleException​(String message)
        This method handles an exception thrown by the script
        Parameters:
        message - The String message for the exception thrown by the script

      • handleException

        void handleException​(String message,
                     Exception e)
        This method handles an exception thrown by the script
        Parameters:
        message - The String message for the exception thrown by the script
        e - The exception thrown by the script

      • logDebug

        void logDebug​(String message)
        This method will perform the debug logging of the message given
        Parameters:
        message - The message to be logged as debug

      • logInfo

        void logInfo​(String message)
        This method will perform the info logging of the message given
        Parameters:
        message - The message to be logged as info

      • logWarning

        void logWarning​(String message)
        This method will perform the warning logging of the message given
        Parameters:
        message - The message to be logged as warning

      • logError

        void logError​(String message)
        This method will perform the error logging of the message given
        Parameters:
        message - The message to be logged as an error

      • printHelp

        void printHelp​(org.apache.commons.cli.Options options,
               String name)
        This method will print the help for the options and name
        Parameters:
        options - The options for the script
        name - The name of the script