Package org.apache.drill.common.logical

Class StoragePluginConfig

java.lang.Object

org.apache.drill.common.logical.StoragePluginConfig

Direct Known Subclasses:

CassandraStorageConfig, DrillStoragePluginConfig, DruidStoragePluginConfig, ElasticsearchStorageConfig, FileSystemConfig, GoogleSheetsStoragePluginConfig, HBaseStoragePluginConfig, HiveStoragePluginConfig, HttpStoragePluginConfig, InfoSchemaConfig, JdbcStorageConfig, KafkaStoragePluginConfig, KuduStoragePluginConfig, MockStorageEngineConfig, MongoStoragePluginConfig, OpenTSDBStoragePluginConfig, PhoenixStoragePluginConfig, SplunkPluginConfig, SystemTablePluginConfig

public abstract class StoragePluginConfig
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	StoragePluginConfig.AuthMode	The standardised authentication modes that storage plugins may offer.

Field Summary

Fields

Modifier and Type	Field	Description
protected final StoragePluginConfig.AuthMode	authMode
protected final CredentialsProvider	credentialsProvider
protected final boolean	directCredentials
protected Boolean	enabled
protected OAuthConfig	oAuthConfig

Constructor Summary

Constructors

Constructor	Description
StoragePluginConfig()
StoragePluginConfig(CredentialsProvider credentialsProvider, boolean directCredentials)
StoragePluginConfig(CredentialsProvider credentialsProvider, boolean directCredentials, StoragePluginConfig.AuthMode authMode)
StoragePluginConfig(CredentialsProvider credentialsProvider, boolean directCredentials, StoragePluginConfig.AuthMode authMode, OAuthConfig oAuthConfig)

Method Summary

Modifier and Type	Method	Description
abstract boolean	equals(Object o)
StoragePluginConfig.AuthMode	getAuthMode()
CredentialsProvider	getCredentialsProvider()
String	getValue(String key)
abstract int	hashCode()
boolean	isEnabled()	Check for enabled status of the plugin
boolean	isEnabledStatusPresent()	Allows to check whether the enabled status is present in config
OAuthConfig	oAuthConfig()
void	setEnabled(Boolean enabled)
StoragePluginConfig	updateCredentialProvider(CredentialsProvider credentialsProvider)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Details

enabled

protected Boolean enabled

directCredentials

protected final boolean directCredentials

credentialsProvider

protected final CredentialsProvider credentialsProvider

authMode

protected final StoragePluginConfig.AuthMode authMode

oAuthConfig

protected OAuthConfig oAuthConfig

Constructor Details

StoragePluginConfig

public StoragePluginConfig()

StoragePluginConfig

public StoragePluginConfig(CredentialsProvider credentialsProvider,
 boolean directCredentials)

StoragePluginConfig

public StoragePluginConfig(CredentialsProvider credentialsProvider,
 boolean directCredentials,
 StoragePluginConfig.AuthMode authMode)

StoragePluginConfig

public StoragePluginConfig(CredentialsProvider credentialsProvider,
 boolean directCredentials,
 StoragePluginConfig.AuthMode authMode,
 OAuthConfig oAuthConfig)

Method Details

isEnabled

public boolean isEnabled()

Check for enabled status of the plugin

Returns:

true, when enabled. False, when disabled or status is absent

setEnabled

public void setEnabled(Boolean enabled)

isEnabledStatusPresent

public boolean isEnabledStatusPresent()

Allows to check whether the enabled status is present in config

Returns:

true if enabled status is present, false otherwise

getValue

public String getValue(String key)

getCredentialsProvider

public CredentialsProvider getCredentialsProvider()

updateCredentialProvider

public StoragePluginConfig updateCredentialProvider(CredentialsProvider credentialsProvider)

getAuthMode

public StoragePluginConfig.AuthMode getAuthMode()

oAuthConfig

public OAuthConfig oAuthConfig()

equals

public abstract boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public abstract int hashCode()

Overrides:

hashCode in class Object