Class ShellServerOptions

java.lang.Object
io.vertx.ext.shell.ShellServerOptions
Direct Known Subclasses:
ShellServiceOptions
public class ShellServerOptions extends Object
The configurations options for the shell server.
Author:
Julien Viet

  • Field Details

    • DEFAULT_REAPER_INTERVAL

      public static final long DEFAULT_REAPER_INTERVAL
      Default of how often, in ms, to check for expired sessions
      See Also:

    • DEFAULT_SESSION_TIMEOUT

      public static final long DEFAULT_SESSION_TIMEOUT
      Default time, in ms, that a shell session lasts for without being accessed before expiring.
      See Also:

    • DEFAULT_WELCOME_MESSAGE

      public static final String DEFAULT_WELCOME_MESSAGE

  • Constructor Details

    • ShellServerOptions

      public ShellServerOptions()

    • ShellServerOptions

      public ShellServerOptions(ShellServerOptions that)

    • ShellServerOptions

      public ShellServerOptions(JsonObject json)

  • Method Details

    • getWelcomeMessage

      public String getWelcomeMessage()
      Returns:
      the shell welcome message

    • setWelcomeMessage

      public ShellServerOptions setWelcomeMessage(String welcomeMessage)
      Set the shell welcome message, i.e the message displayed in the user console when he connects to the shell.
      Parameters:
      welcomeMessage - the welcome message
      Returns:
      a reference to this, so the API can be used fluently

    • getSessionTimeout

      public long getSessionTimeout()
      Returns:
      the session timeout

    • setSessionTimeout

      public ShellServerOptions setSessionTimeout(long sessionTimeout)
      Set the session timeout.
      Parameters:
      sessionTimeout - the new session timeout
      Returns:
      a reference to this, so the API can be used fluently

    • getReaperInterval

      public long getReaperInterval()
      Returns:
      the reaper interval

    • setReaperInterval

      public ShellServerOptions setReaperInterval(long reaperInterval)
      Set the repear interval, i.e the period at which session eviction is performed.
      Parameters:
      reaperInterval - the new repeat interval
      Returns:
      a reference to this, so the API can be used fluently