Package org.apache.drill.exec.store.http

Class HttpStoragePluginConfig

java.lang.Object

org.apache.drill.common.logical.StoragePluginConfig

org.apache.drill.exec.store.http.HttpStoragePluginConfig

public class HttpStoragePluginConfig
extends StoragePluginConfig

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.drill.common.logical.StoragePluginConfig

StoragePluginConfig.AuthMode

Field Summary

Fields

Modifier and Type	Field	Description
final boolean	cacheResults
final Map<String,HttpApiConfig>	connections
final boolean	enableEnhancedParamSyntax
static final String	NAME
final String	proxyHost
final int	proxyPort
final String	proxyType
final int	retryDelay
final int	timeout	Timeout in TimeUnit.SECONDS.

Fields inherited from class org.apache.drill.common.logical.StoragePluginConfig

authMode, credentialsProvider, directCredentials, enabled, oAuthConfig

Constructor Summary

Constructors

Constructor	Description
HttpStoragePluginConfig(Boolean cacheResults, Boolean enableEnhancedParamSyntax, Map<String,HttpApiConfig> connections, Integer timeout, Integer retryDelay, String username, String password, String proxyHost, Integer proxyPort, String proxyType, String proxyUsername, String proxyPassword, OAuthConfig oAuthConfig, CredentialsProvider credentialsProvider, String authMode)
HttpStoragePluginConfig(HttpStoragePluginConfig that, OAuthConfig oAuthConfig)	Clone constructor used for updating OAuth tokens

Method Summary

Modifier and Type	Method	Description
boolean	cacheResults()
Map<String,HttpApiConfig>	connections()
HttpStoragePluginConfig	copyForPlan(String connectionName)	Create a copy of the plugin config with only the indicated connection.
boolean	enableEnhancedParamSyntax()
boolean	equals(Object that)
HttpApiConfig	getConnection(String connectionName)
static Optional<OAuthTokenCredentials>	getOAuthCredentials(CredentialsProvider credentialsProvider)
Optional<UsernamePasswordWithProxyCredentials>	getUsernamePasswordCredentials()
Optional<UsernamePasswordWithProxyCredentials>	getUsernamePasswordCredentials(String username)
int	hashCode()
String	password()
String	proxyHost()
String	proxyPassword()
int	proxyPort()
String	proxyType()
String	proxyUsername()
int	retryDelay()
int	timeout()
String	toString()
HttpStoragePluginConfig	updateCredentialProvider(CredentialsProvider credentialsProvider)
String	username()

Methods inherited from class org.apache.drill.common.logical.StoragePluginConfig

getAuthMode, getCredentialsProvider, getValue, isEnabled, isEnabledStatusPresent, oAuthConfig, setEnabled

Methods inherited from class java.lang.Object

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

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

connections

public final Map<String,HttpApiConfig> connections

cacheResults

public final boolean cacheResults

proxyHost

public final String proxyHost

proxyPort

public final int proxyPort

proxyType

public final String proxyType

enableEnhancedParamSyntax

public final boolean enableEnhancedParamSyntax

timeout

public final int timeout

Timeout in TimeUnit.SECONDS.

retryDelay

public final int retryDelay

Constructor Details

HttpStoragePluginConfig

public HttpStoragePluginConfig(Boolean cacheResults,
 Boolean enableEnhancedParamSyntax,
 Map<String,HttpApiConfig> connections,
 Integer timeout,
 Integer retryDelay,
 String username,
 String password,
 String proxyHost,
 Integer proxyPort,
 String proxyType,
 String proxyUsername,
 String proxyPassword,
 OAuthConfig oAuthConfig,
 CredentialsProvider credentialsProvider,
 String authMode)

HttpStoragePluginConfig

public HttpStoragePluginConfig(HttpStoragePluginConfig that,
 OAuthConfig oAuthConfig)

Clone constructor used for updating OAuth tokens

Parameters:

that - The current HTTP Plugin Config

oAuthConfig - The updated OAuth config

Method Details

copyForPlan

public HttpStoragePluginConfig copyForPlan(String connectionName)

Create a copy of the plugin config with only the indicated connection. The copy is used in the query plan to avoid including unnecessary information.

equals

public boolean equals(Object that)

Specified by:

equals in class StoragePluginConfig

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Specified by:

hashCode in class StoragePluginConfig

cacheResults

public boolean cacheResults()

enableEnhancedParamSyntax

public boolean enableEnhancedParamSyntax()

connections

public Map<String,HttpApiConfig> connections()

timeout

public int timeout()

retryDelay

public int retryDelay()

proxyHost

public String proxyHost()

proxyPort

public int proxyPort()

username

public String username()

password

public String password()

proxyUsername

public String proxyUsername()

proxyPassword

public String proxyPassword()

proxyType

public String proxyType()

getConnection

public HttpApiConfig getConnection(String connectionName)

getUsernamePasswordCredentials

public Optional<UsernamePasswordWithProxyCredentials> getUsernamePasswordCredentials()

getUsernamePasswordCredentials

public Optional<UsernamePasswordWithProxyCredentials> getUsernamePasswordCredentials(String username)

getOAuthCredentials

public static Optional<OAuthTokenCredentials> getOAuthCredentials(CredentialsProvider credentialsProvider)

updateCredentialProvider

public HttpStoragePluginConfig updateCredentialProvider(CredentialsProvider credentialsProvider)

Overrides:

updateCredentialProvider in class StoragePluginConfig