BrowserAzureOAuth2CredentialsProvider (amazon-redshift-jdbc-driver 2.1.0.31 API)

java.lang.Object
- com.amazon.redshift.plugin.JwtCredentialsProvider
- - com.amazon.redshift.plugin.BrowserAzureOAuth2CredentialsProvider

All Implemented Interfaces:

INativePlugin
```
public class BrowserAzureOAuth2CredentialsProvider
extends JwtCredentialsProvider
```
Class to get JWT Token from any IDP using OAuth 2.0 API

Field Summary

Fields
Modifier and Type	Field and Description
`protected static Pattern`	`IAM_HTTP_URL_PATTERN`
`protected static Pattern`	`IAM_URL_PATTERN`
`static String`	`KEY_CLIENT_ID` Key for setting client ID.
`static String`	`KEY_IDP_RESPONSE_TIMEOUT` Key for setting timeout for IDP response.
`static String`	`KEY_IDP_TENANT` Key for setting idp tenant.
`static String`	`KEY_LISTEN_PORT` Key for setting the port number for listening.
`static String`	`KEY_SCOPE` Key for setting Scope.
`protected static String`	`KEY_SSL_INSECURE`
`protected RedshiftLogger`	`m_log`
`protected boolean`	`m_sslInsecure`
`static String`	`OAUTH_CLIENT_ID_PARAMETER_NAME` Key for setting client ID.
`static String`	`OAUTH_GRANT_TYPE_PARAMETER_NAME` Key for setting grant type.
`static String`	`OAUTH_IDP_CODE_PARAMETER_NAME` Key for setting code.
`static String`	`OAUTH_REDIRECT_PARAMETER_NAME` Key for setting redirect URI.
`static String`	`OAUTH_REQUESTED_TOKEN_TYPE_PARAMETER_NAME` Key for setting requested token type.
`static String`	`OAUTH_RESOURCE_PARAMETER_NAME` Key for setting resource.
`static String`	`OAUTH_RESPONSE_MODE_PARAMETER_NAME` Key for setting response mode.
`static String`	`OAUTH_RESPONSE_TYPE_PARAMETER_NAME` Key for setting OAUTH response type.
`static String`	`OAUTH_SCOPE_PARAMETER_NAME` Key for setting scope.
`static String`	`OAUTH_STATE_PARAMETER_NAME` Key for setting state.

Fields inherited from class com.amazon.redshift.plugin.JwtCredentialsProvider
m_disableCache

Constructor Summary

Constructors
Constructor and Description

BrowserAzureOAuth2CredentialsProvider()

Constructors
Constructor and Description
`BrowserAzureOAuth2CredentialsProvider()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addParameter(String key, String value)` Overwritten method to grab the field parameters from JDBC connection string.
`protected CloseableHttpClient`	`getHttpClient()`
`protected String`	`getJwtAssertion()` Overridden method to grab the JWT Response.
`String`	`getPluginSpecificCacheKey()`
`protected static String`	`getRegexForJsonKey(String keyName)`
`protected void`	`validateURL(String paramString)`

Methods inherited from class com.amazon.redshift.plugin.JwtCredentialsProvider
getCacheKey, getCredentials, getIdpToken, isNullOrEmpty, refresh, setLogger

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - KEY_IDP_RESPONSE_TIMEOUT
```
public static final String KEY_IDP_RESPONSE_TIMEOUT
```
    Key for setting timeout for IDP response.
    
    See Also:
    
    Constant Field Values
  - KEY_LISTEN_PORT
```
public static final String KEY_LISTEN_PORT
```
    Key for setting the port number for listening.
    
    See Also:
    
    Constant Field Values
  - KEY_IDP_TENANT
```
public static final String KEY_IDP_TENANT
```
    Key for setting idp tenant.
    
    See Also:
    
    Constant Field Values
  - KEY_CLIENT_ID
```
public static final String KEY_CLIENT_ID
```
    Key for setting client ID.
    
    See Also:
    
    Constant Field Values
  - KEY_SCOPE
```
public static final String KEY_SCOPE
```
    Key for setting Scope.
    
    See Also:
    
    Constant Field Values
  - OAUTH_STATE_PARAMETER_NAME
```
public static final String OAUTH_STATE_PARAMETER_NAME
```
    Key for setting state.
    
    See Also:
    
    Constant Field Values
  - OAUTH_REDIRECT_PARAMETER_NAME
```
public static final String OAUTH_REDIRECT_PARAMETER_NAME
```
    Key for setting redirect URI.
    
    See Also:
    
    Constant Field Values
  - OAUTH_IDP_CODE_PARAMETER_NAME
```
public static final String OAUTH_IDP_CODE_PARAMETER_NAME
```
    Key for setting code.
    
    See Also:
    
    Constant Field Values
  - OAUTH_CLIENT_ID_PARAMETER_NAME
```
public static final String OAUTH_CLIENT_ID_PARAMETER_NAME
```
    Key for setting client ID.
    
    See Also:
    
    Constant Field Values
  - OAUTH_RESPONSE_TYPE_PARAMETER_NAME
```
public static final String OAUTH_RESPONSE_TYPE_PARAMETER_NAME
```
    Key for setting OAUTH response type.
    
    See Also:
    
    Constant Field Values
  - OAUTH_REQUESTED_TOKEN_TYPE_PARAMETER_NAME
```
public static final String OAUTH_REQUESTED_TOKEN_TYPE_PARAMETER_NAME
```
    Key for setting requested token type.
    
    See Also:
    
    Constant Field Values
  - OAUTH_GRANT_TYPE_PARAMETER_NAME
```
public static final String OAUTH_GRANT_TYPE_PARAMETER_NAME
```
    Key for setting grant type.
    
    See Also:
    
    Constant Field Values
  - OAUTH_SCOPE_PARAMETER_NAME
```
public static final String OAUTH_SCOPE_PARAMETER_NAME
```
    Key for setting scope.
    
    See Also:
    
    Constant Field Values
  - OAUTH_RESOURCE_PARAMETER_NAME
```
public static final String OAUTH_RESOURCE_PARAMETER_NAME
```
    Key for setting resource.
    
    See Also:
    
    Constant Field Values
  - OAUTH_RESPONSE_MODE_PARAMETER_NAME
```
public static final String OAUTH_RESPONSE_MODE_PARAMETER_NAME
```
    Key for setting response mode.
    
    See Also:
    
    Constant Field Values
  - KEY_SSL_INSECURE
```
protected static final String KEY_SSL_INSECURE
```
    See Also:
    
    Constant Field Values
  - m_sslInsecure
```
protected boolean m_sslInsecure
```
  - IAM_URL_PATTERN
```
protected static final Pattern IAM_URL_PATTERN
```
  - IAM_HTTP_URL_PATTERN
```
protected static final Pattern IAM_HTTP_URL_PATTERN
```
  - m_log
```
protected RedshiftLogger m_log
```
- Constructor Detail
  - BrowserAzureOAuth2CredentialsProvider
```
public BrowserAzureOAuth2CredentialsProvider()
```
- Method Detail
  - getJwtAssertion
```
protected String getJwtAssertion()
                          throws IOException
```
    Overridden method to grab the JWT Response. Used in base class to refresh temporary credentials.
    
    Specified by:
    
    getJwtAssertion in class JwtCredentialsProvider
    
    Returns:
    
    Base64 encoded JWT Response string
    
    Throws:
    
    IOException - indicating the error
  - addParameter
```
public void addParameter(String key,
                         String value)
```
    Overwritten method to grab the field parameters from JDBC connection string. This method calls the base class' addParameter method and adds to it new specific parameters.
    
    Specified by:
    
    addParameter in interface INativePlugin
    
    Overrides:
    
    addParameter in class JwtCredentialsProvider
    
    Parameters:
    
    key - parameter key passed to JDBC
    
    value - parameter value associated with the given key
  - getPluginSpecificCacheKey
```
public String getPluginSpecificCacheKey()
```
    Specified by:
    
    getPluginSpecificCacheKey in interface INativePlugin
    
    Overrides:
    
    getPluginSpecificCacheKey in class JwtCredentialsProvider
  - getHttpClient
```
protected CloseableHttpClient getHttpClient()
                                     throws GeneralSecurityException
```
    Throws:
    
    GeneralSecurityException
  - validateURL
```
protected void validateURL(String paramString)
                    throws IOException
```
    Throws:
    
    IOException
  - getRegexForJsonKey
```
protected static String getRegexForJsonKey(String keyName)
```

Class BrowserAzureOAuth2CredentialsProvider

Field Summary

Fields inherited from class com.amazon.redshift.plugin.JwtCredentialsProvider

Constructor Summary

Method Summary

Methods inherited from class com.amazon.redshift.plugin.JwtCredentialsProvider

Methods inherited from class java.lang.Object

Field Detail

KEY_IDP_RESPONSE_TIMEOUT

KEY_LISTEN_PORT

KEY_IDP_TENANT

KEY_CLIENT_ID

KEY_SCOPE

OAUTH_STATE_PARAMETER_NAME

OAUTH_REDIRECT_PARAMETER_NAME

OAUTH_IDP_CODE_PARAMETER_NAME

OAUTH_CLIENT_ID_PARAMETER_NAME

OAUTH_RESPONSE_TYPE_PARAMETER_NAME

OAUTH_REQUESTED_TOKEN_TYPE_PARAMETER_NAME

OAUTH_GRANT_TYPE_PARAMETER_NAME

OAUTH_SCOPE_PARAMETER_NAME

OAUTH_RESOURCE_PARAMETER_NAME

OAUTH_RESPONSE_MODE_PARAMETER_NAME

KEY_SSL_INSECURE

m_sslInsecure

IAM_URL_PATTERN

IAM_HTTP_URL_PATTERN

m_log

Constructor Detail

BrowserAzureOAuth2CredentialsProvider

Method Detail

getJwtAssertion

addParameter

getPluginSpecificCacheKey

getHttpClient

validateURL

getRegexForJsonKey