org.postgresql.core

Enum AuthMethod

java.lang.Object

java.lang.Enum<AuthMethod>

org.postgresql.core.AuthMethod

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<AuthMethod>

public enum AuthMethod
extends java.lang.Enum<AuthMethod>

Enumeration of PostgreSQL authentication methods.

Enum Constant Summary

Enum Constants

Enum Constant and Description
GSS
MD5
NONE
PASSWORD
SCRAM_SHA_256
SSPI

Method Summary

Modifier and Type	Method and Description
static void	checkAuth(java.util.EnumSet<AuthMethod> allowedMethods, AuthMethod authMethod) Refuses an authentication method that requireAuth does not allow.
static AuthMethod	fromString(java.lang.String method)
static java.util.EnumSet<AuthMethod>	parseRequireAuth(java.lang.String requireAuth) Parses a requireAuth value into the authentication methods the server may request.
static AuthMethod	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static AuthMethod[]	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

NONE

public static final AuthMethod NONE

PASSWORD

public static final AuthMethod PASSWORD

MD5

public static final AuthMethod MD5

GSS

public static final AuthMethod GSS

SSPI

public static final AuthMethod SSPI

SCRAM_SHA_256

public static final AuthMethod SCRAM_SHA_256

Method Detail

values

public static AuthMethod[] 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 (AuthMethod c : AuthMethod.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static AuthMethod 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

fromString

public static AuthMethod fromString(java.lang.String method)
                             throws PSQLException

Throws:

PSQLException

parseRequireAuth

public static java.util.EnumSet<AuthMethod> parseRequireAuth(java.lang.String requireAuth)
                                                      throws PSQLException

Parses a requireAuth value into the authentication methods the server may request.

Parameters:

requireAuth - comma-separated method names, either all plain or all prefixed with !

Returns:

null when requireAuth is null, and checkAuth(java.util.EnumSet<org.postgresql.core.AuthMethod>, org.postgresql.core.AuthMethod) allows every method for null; otherwise the allowed methods, empty when the value excludes every method

Throws:

PSQLException - with PSQLState.INVALID_PARAMETER_VALUE if the value mixes the two forms, names a method twice, names an unknown method, or is written without a method

checkAuth

public static void checkAuth(java.util.EnumSet<AuthMethod> allowedMethods,
                             AuthMethod authMethod)
                      throws PSQLException

Refuses an authentication method that requireAuth does not allow.

Parameters:

allowedMethods - the methods to allow, or null to allow every method; an empty set refuses every method

authMethod - the method the server asked for

Throws:

PSQLException - with PSQLState.CONNECTION_REJECTED if the method is not allowed