Package com.aspectran.shell.service

Interface ShellService

  • All Superinterfaces:
    com.aspectran.core.service.CoreService
    All Known Implementing Classes:
    AbstractShellService, DefaultShellService
    public interface ShellService
extends com.aspectran.core.service.CoreService
    The Interface ShellService.

    Created: 2017. 10. 28.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getGreetings()
      Returns the greeting message.
      boolean isExposable​(java.lang.String transletName)
      Returns whether or not the translet can be exposed to the shell service.
      boolean isVerbose()
      Tests if the verbose mode is enabled.
      com.aspectran.core.adapter.SessionAdapter newSessionAdapter()
      Create and return a new session adapter from the shell service.
      void printGreetings()
      Prints greeting message.
      void printHelp()
      Prints help information.
      void setGreetings​(java.lang.String greetings)
      Specifies the greeting message.
      void setVerbose​(boolean verbose)
      Enables or disables the verbose mode.
      com.aspectran.core.activity.Translet translate​(TransletCommandLine transletCommandLine, Console console)
      Executes translet.

      • Methods inherited from interface com.aspectran.core.service.CoreService

        getActivityContext, getAspectranClassLoader, getAspectranConfig, getBasePath, getDefaultActivity, getSchedulerService, getServiceController, isDerived, isHardReload, isLateStart, joinDerivedService, leaveFromRootService, withdrawDerivedService

    • Method Detail

      • isVerbose

        boolean isVerbose()
        Tests if the verbose mode is enabled. If verbose mode is on, a detailed description is printed each time the command is executed. Returns a flag indicating whether to show the description or not.
        Returns:
        true if the verbose mode is enabled

      • setVerbose

        void setVerbose​(boolean verbose)
        Enables or disables the verbose mode. If verbose mode is on, a detailed description is printed each time the command is executed. Sets a flag indicating whether to show the description or not.
        Parameters:
        verbose - true to enable the verbose mode; false to disable

      • getGreetings

        java.lang.String getGreetings()
        Returns the greeting message.
        Returns:
        the greeting message

      • setGreetings

        void setGreetings​(java.lang.String greetings)
        Specifies the greeting message.
        Parameters:
        greetings - the greeting message

      • printGreetings

        void printGreetings()
        Prints greeting message.

      • printHelp

        void printHelp()
        Prints help information.

      • isExposable

        boolean isExposable​(java.lang.String transletName)
        Returns whether or not the translet can be exposed to the shell service.
        Parameters:
        transletName - the name of the translet to check
        Returns:
        true if the translet can be exposed; false otherwise

      • newSessionAdapter

        com.aspectran.core.adapter.SessionAdapter newSessionAdapter()
        Create and return a new session adapter from the shell service.
        Returns:
        the session adapter

      • translate

        com.aspectran.core.activity.Translet translate​(TransletCommandLine transletCommandLine,
                                               Console console)
                                        throws com.aspectran.core.activity.TransletNotFoundException
        Executes translet.
        Parameters:
        transletCommandLine - the translet command line
        console - the Console instance
        Returns:
        the Translet instance
        Throws:
        com.aspectran.core.activity.TransletNotFoundException