Enum WelcomeBannerPhase

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<WelcomeBannerPhase>

    public enum WelcomeBannerPhase
    extends java.lang.Enum<WelcomeBannerPhase>
    Used to indicate at which authentication phase to send the welcome banner (if any configured)
    See Also:
    RFC-4252 section 5.4
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      FIRST_AUTHCMD
      On first SSH_MSG_USERAUTH_XXX extension command
      FIRST_FAILURE
      On first SSH_MSG_USERAUTH_FAILURE
      FIRST_REQUEST
      On first SSH_MSG_USERAUTH_REQUEST
      IMMEDIATE
      Immediately after receiving "ssh-userauth" request
      NEVER
      Do not send a welcome banner even if one is configured.
      POST_SUCCESS
      After user successfully authenticates
    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private WelcomeBannerPhase()  
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static WelcomeBannerPhase valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static WelcomeBannerPhase[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Enum Constant Detail

      • IMMEDIATE

        public static final WelcomeBannerPhase IMMEDIATE
        Immediately after receiving "ssh-userauth" request
      • FIRST_REQUEST

        public static final WelcomeBannerPhase FIRST_REQUEST
        On first SSH_MSG_USERAUTH_REQUEST
      • FIRST_AUTHCMD

        public static final WelcomeBannerPhase FIRST_AUTHCMD
        On first SSH_MSG_USERAUTH_XXX extension command
      • FIRST_FAILURE

        public static final WelcomeBannerPhase FIRST_FAILURE
        On first SSH_MSG_USERAUTH_FAILURE
      • POST_SUCCESS

        public static final WelcomeBannerPhase POST_SUCCESS
        After user successfully authenticates
      • NEVER

        public static final WelcomeBannerPhase NEVER
        Do not send a welcome banner even if one is configured. Note: this option is useful when a global welcome banner has been configured but we want to disable it for a specific session.
    • Constructor Detail

      • WelcomeBannerPhase

        private WelcomeBannerPhase()
    • Method Detail

      • values

        public static WelcomeBannerPhase[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (WelcomeBannerPhase c : WelcomeBannerPhase.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static WelcomeBannerPhase valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null