Top Description Fields Constructors Methods
org.apache.sshd.server.auth

public final Enum WelcomeBannerPhase

extends Enum<WelcomeBannerPhase>
Class Inheritance
Imports
java.util.Collections, .EnumSet, .Set
Used to indicate at which authentication phase to send the welcome banner (if any configured)
Author
Apache MINA SSHD Project
See Also
RFC-4252 section 5.4

Field Summary

Modifier and TypeField and Description
public static final WelcomeBannerPhase
FIRST_AUTHCMD

On first SSH_MSG_USERAUTH_XXX extension command

public static final WelcomeBannerPhase
FIRST_FAILURE

On first SSH_MSG_USERAUTH_FAILURE

public static final WelcomeBannerPhase
FIRST_REQUEST

On first SSH_MSG_USERAUTH_REQUEST

public static final WelcomeBannerPhase
IMMEDIATE

Immediately after receiving "ssh-userauth" request

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.

public static final WelcomeBannerPhase
POST_SUCCESS

After user successfully authenticates

public static final Set<WelcomeBannerPhase>
VALUES

Constructor Summary

AccessConstructor and Description
private
WelcomeBannerPhase()

Method Summary

Modifier and TypeMethod and Description
public static WelcomeBannerPhase
valueOf(String name)

public static WelcomeBannerPhase[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

FIRST_AUTHCMDback to summary
public static final WelcomeBannerPhase FIRST_AUTHCMD

On first SSH_MSG_USERAUTH_XXX extension command

FIRST_FAILUREback to summary
public static final WelcomeBannerPhase FIRST_FAILURE

On first SSH_MSG_USERAUTH_FAILURE

FIRST_REQUESTback to summary
public static final WelcomeBannerPhase FIRST_REQUEST

On first SSH_MSG_USERAUTH_REQUEST

IMMEDIATEback to summary
public static final WelcomeBannerPhase IMMEDIATE

Immediately after receiving "ssh-userauth" request

NEVERback to summary
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.

POST_SUCCESSback to summary
public static final WelcomeBannerPhase POST_SUCCESS

After user successfully authenticates

VALUESback to summary
public static final Set<WelcomeBannerPhase> VALUES

Constructor Detail

WelcomeBannerPhaseback to summary
private WelcomeBannerPhase()

Method Detail

valueOfback to summary
public static WelcomeBannerPhase valueOf(String name)
valuesback to summary
public static WelcomeBannerPhase[] values()