Package org.apache.sshd.server.auth
Enum WelcomeBannerPhase
- All Implemented Interfaces:
Serializable
,Comparable<WelcomeBannerPhase>
,java.lang.constant.Constable
Used to indicate at which authentication phase to send the welcome banner (if any configured)
- Author:
- Apache MINA SSHD Project
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantDescriptionOn firstSSH_MSG_USERAUTH_XXX
extension commandOn firstSSH_MSG_USERAUTH_FAILURE
On firstSSH_MSG_USERAUTH_REQUEST
Immediately after receiving "ssh-userauth" requestDo not send a welcome banner even if one is configured.After user successfully authenticates -
Field Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic WelcomeBannerPhase
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.
-
Enum Constant Details
-
IMMEDIATE
Immediately after receiving "ssh-userauth" request -
FIRST_REQUEST
On firstSSH_MSG_USERAUTH_REQUEST
-
FIRST_AUTHCMD
On firstSSH_MSG_USERAUTH_XXX
extension command -
FIRST_FAILURE
On firstSSH_MSG_USERAUTH_FAILURE
-
POST_SUCCESS
After user successfully authenticates -
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.
-
-
Field Details
-
VALUES
-
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
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:
IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is null
-