Package org.apache.drill.common.logical

Enum StoragePluginConfig.AuthMode

java.lang.Object

java.lang.Enum<StoragePluginConfig.AuthMode>

org.apache.drill.common.logical.StoragePluginConfig.AuthMode

All Implemented Interfaces:

Serializable, Comparable<StoragePluginConfig.AuthMode>

Enclosing class:

StoragePluginConfig

public static enum StoragePluginConfig.AuthMode
extends Enum<StoragePluginConfig.AuthMode>

The standardised authentication modes that storage plugins may offer.

Enum Constant Summary

Enum Constants

Enum Constant	Description
SHARED_USER	Connects using a single set of shared credentials stored in some credential provider.
USER_IMPERSONATION	Depending on the plugin, connects using one of the two modes above then instructs the external storage to set the identity on the connection to that of the Drill query user.
USER_TRANSLATION	Connects with stored credentials looked up for (translated from) the Drill query user.

Method Summary

Modifier and Type	Method	Description
static StoragePluginConfig.AuthMode	parseOrDefault(String authMode, StoragePluginConfig.AuthMode defavlt)
static StoragePluginConfig.AuthMode	valueOf(String name)	Returns the enum constant of this type with the specified name.
static StoragePluginConfig.AuthMode[]	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 Details

SHARED_USER

public static final StoragePluginConfig.AuthMode SHARED_USER

Connects using a single set of shared credentials stored in some credential provider. If no credentials are present, the plugin may connect with no credentials or make implicit use of the Drillbit's identity (e.g. OS process user). Unaffected by the Drill query user's identity.

USER_IMPERSONATION

public static final StoragePluginConfig.AuthMode USER_IMPERSONATION

Depending on the plugin, connects using one of the two modes above then instructs the external storage to set the identity on the connection to that of the Drill query user. User identity in the external system will match the Drill query user's identity.

USER_TRANSLATION

public static final StoragePluginConfig.AuthMode USER_TRANSLATION

Connects with stored credentials looked up for (translated from) the Drill query user. User identity in the external system will be a function of the Drill query user's identity (1-1 or *-1) .

Method Details

values

public static StoragePluginConfig.AuthMode[] 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

public static StoragePluginConfig.AuthMode valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

parseOrDefault

public static StoragePluginConfig.AuthMode parseOrDefault(String authMode,
 StoragePluginConfig.AuthMode defavlt)