public interface GatewayConfig
| Modifier and Type | Method and Description |
|---|---|
boolean |
allowUnauthenticatedRemoteRegistryReadAccess()
When new remote registry entries must be created, or new ACLs applied to existing entries, this method indicates
whether unauthenticated connections should be given read access to those entries.
|
String |
getAlgorithm()
Configured Algorithm name to be used by the CryptoService
and MasterService implementations
|
List<String> |
getAutoDeployTopologyNames()
Get the list of topology names that should be redeployed on restart.
|
long |
getClouderaManagerAdvancedServiceDiscoveryConfigurationMonitoringInterval() |
long |
getClouderaManagerDescriptorsMonitoringInterval() |
int |
getClusterMonitorPollingInterval(String type) |
String |
getCredentialStoreAlgorithm() |
String |
getCredentialStoreType() |
String |
getDatabaseConnectionUrl() |
String |
getDatabaseHost() |
String |
getDatabaseName() |
int |
getDatabasePort() |
String |
getDatabaseSslTruststoreFileName() |
String |
getDatabaseType() |
String |
getDefaultAppRedirectPath() |
String |
getDefaultDiscoveryAddress()
Determine the default address for discovering service endpoint details.
|
String |
getDefaultDiscoveryCluster()
Determine the default target cluster for discovering service endpoint details.
|
String |
getDefaultTopologyName() |
String |
getDispatchWhitelist() |
List<String> |
getDispatchWhitelistServices()
Get the set of service roles to which the dispatch whitelist will be applied.
|
String |
getEphemeralDHKeySize() |
List<String> |
getExcludedSSLCiphers() |
List<String> |
getExcludedSSLProtocols() |
String |
getFederationHeaderName()
Custom header name to be used to pass the authenticated principal
via dispatch
|
String |
getFrontendUrl() |
InetSocketAddress |
getGatewayAddress() |
String |
getGatewayApplicationsDir()
The location of the gateway applications's root directory
|
String |
getGatewayConfDir()
The location of the gateway configuration.
|
String |
getGatewayDataDir()
The location of the gateway runtime generated data.
|
String |
getGatewayDeploymentDir() |
long |
getGatewayDeploymentsBackupAgeLimit() |
int |
getGatewayDeploymentsBackupVersionLimit() |
String |
getGatewayDescriptorsDir() |
String |
getGatewayHost() |
long |
getGatewayIdleTimeout() |
String |
getGatewayKeystoreDir()
Returns the path to the Gateway's keystore directory
|
String |
getGatewayPath() |
int |
getGatewayPort() |
Map<String,Integer> |
getGatewayPortMappings()
Map of Topology names and their ports.
|
String |
getGatewayProvidersConfigDir() |
String |
getGatewaySecurityDir() |
String |
getGatewayServicesDir()
The location of the gateway services definition's root directory
|
String |
getGatewayTopologyDir() |
String |
getGlobalLogoutPageUrl() |
List<String> |
getGlobalRulesServices() |
String |
getGraphiteHost() |
int |
getGraphitePort() |
int |
getGraphiteReportingFrequency() |
String |
getHadoopConfDir() |
String |
getHeaderNameForRemoteAddress()
Configured name of the HTTP Header that is expected
to be set by a proxy in front of the gateway.
|
Set<String> |
getHiddenTopologiesOnHomepage() |
Map<String,Collection<String>> |
getHomePageProfiles()
Gets the home page profiles (pre-configured and user-defined profiles too).
|
int |
getHttpClientConnectionTimeout() |
int |
getHttpClientMaxConnections() |
int |
getHttpClientSocketTimeout() |
String |
getHttpClientTruststorePasswordAlias()
Returns the configured value for the alias name to use when to looking up the HTTP client's
truststore password.
|
String |
getHttpClientTruststorePath()
Returns the configured value for the path to the truststore to be used by the HTTP client instance
connecting to a service from the Gateway.
|
String |
getHttpClientTruststoreType()
Returns the configured value for the type of the truststore specified by
getHttpClientTruststorePath(). |
int |
getHttpServerRequestBuffer() |
int |
getHttpServerRequestHeaderBuffer() |
int |
getHttpServerResponseBuffer() |
int |
getHttpServerResponseHeaderBuffer() |
String |
getIdentityKeyAlias()
Returns the configured value for the alias name to use when to looking up the Gateway's identity
from the Gateway's identity keystore.
|
String |
getIdentityKeyPassphraseAlias()
Returns the configured value for the alias name to use when to looking up the Gateway's identity
key's password.
|
String |
getIdentityKeystorePasswordAlias()
Returns the configured value for the alias name to use when to looking up the Gateway's identity
keystore's password.
|
String |
getIdentityKeystorePath()
Returns the configured value for the path to the keystore holding the key and certificate for the
Gateway's TLS identity.
|
String |
getIdentityKeystoreType()
Returns the configured value for the type of the keystore holding the Gateway's identity.
|
List<String> |
getIncludedSSLCiphers() |
String |
getIterationCount()
Configured IterationCount to be used by the CryptoService
and MasterService implementations
|
String |
getKerberosConfig() |
String |
getKerberosLoginConfig() |
String |
getKeyLength()
Configured KeyLength to be used by the CryptoService
and MasterService implementations
|
long |
getKeystoreCacheEntryTimeToLiveInMinutes() |
long |
getKeystoreCacheSizeLimit() |
String |
getKeystoreType() |
String |
getKnoxAdminGroups()
Get the comma separated list of group names that represent Knox Admin users
|
String |
getKnoxAdminUsers()
Get the comma separated list of user names that represent Knox Admin users
|
long |
getKnoxTokenEvictionGracePeriod()
Return the configured grace period (in seconds) after which an expired token should be evicted
|
long |
getKnoxTokenEvictionInterval()
Return the configured interval (in seconds) at which token eviction job should run
|
String |
getKnoxTokenHashAlgorithm() |
long |
getKnoxTokenStateAliasPersistenceInterval()
Return the configured token state alias persistence interval (in seconds).
|
int |
getMaximumNumberOfTokensPerUser() |
String |
getPBEAlgorithm()
Configured Algorithm name to be used by the CryptoService
for password based encryption
|
Set<String> |
getPinnedTopologiesOnHomepage() |
List<String> |
getReadOnlyOverrideTopologyNames()
Get the list of those topology names which should be treated as read-only, regardless of their actual read-write
status.
|
Map<String,String> |
getRemoteAliasServiceConfiguration()
Uses result of getRemoteAliasServiceConfigurationPrefix to return configurations
|
String |
getRemoteAliasServiceConfigurationPrefix()
Returns prefix for the remote alias service configuration
|
String |
getRemoteConfigurationMonitorClientName() |
String |
getRemoteRegistryConfiguration(String name) |
List<String> |
getRemoteRegistryConfigurationNames() |
String |
getSaltSize()
Configured SaltSize to be used by the CryptoService
and MasterService implementations
|
String |
getServiceParameter(String service,
String parameter) |
Set<String> |
getServicesToIgnoreDoAs()
Returns a set of service principal names that indicate which services to ignore doAs requests.
|
String |
getSigningKeyAlias() |
String |
getSigningKeyPassphraseAlias()
Returns the configured value for the alias name to use when to looking up the signing key's
password.
|
String |
getSigningKeystoreName() |
String |
getSigningKeystorePasswordAlias()
Returns the configured value for the alias name to use when to looking up the Gateway's signing
keystore's password.
|
String |
getSigningKeystorePath()
Returns the calculated value for the path to the keystore holding the key and certificate for the
Gateway's signing key.
|
String |
getSigningKeystoreType()
Returns the configured value for the type of the keystore holding the Gateway's signing key.
|
int |
getThreadPoolMax() |
String |
getTransformation()
Configured Transformation name to be used by the CryptoService
and MasterService implementations
|
boolean |
getTrustAllCerts() |
String |
getTruststorePasswordAlias()
Returns the configured value for the alias name to use when to looking up the Gateway's
truststore password.
|
String |
getTruststorePath() |
String |
getTruststoreType() |
int |
getWebsocketAsyncWriteTimeout()
Websocket connection async write timeout.
|
int |
getWebsocketIdleTimeout()
Websocket connection idle timeout.
|
int |
getWebsocketInputBufferSize()
Websocket connection input buffer size.
|
int |
getWebsocketMaxBinaryMessageBufferSize()
Websocket connection max binary message buffer size.
|
int |
getWebsocketMaxBinaryMessageSize()
Websocket connection max binary message size.
|
int |
getWebsocketMaxTextMessageBufferSize()
Websocket connection max text message buffer size.
|
int |
getWebsocketMaxTextMessageSize()
Websocket connection max text message size.
|
int |
getWebsocketMaxWaitBufferCount()
Max count of messages that can be temporarily buffered in memory before a connection is properly setup.
|
List<String> |
getXForwardContextAppendServices()
Returns a list of services that need service name appended to
X-Forward-Context header as a result of which the new header would look
/{gateway}/{sandbox}/{serviceName}
|
boolean |
homePageLogoutEnabled() |
boolean |
isClientAuthNeeded() |
boolean |
isClientAuthWanted() |
boolean |
isClusterMonitorEnabled(String type) |
boolean |
isCookieScopingToPathEnabled()
Enable cookie scoping to gateway path
|
boolean |
isDatabaseSslEnabled() |
boolean |
isGatewayPortMappingEnabled()
Is the Port Mapping feature on
|
boolean |
isGatewayServerHeaderEnabled()
Is the Server header suppressed
|
boolean |
isGatewayServerIncomingXForwardedSupportEnabled()
Indicates whether the embedded Jetty Server support for X-Forwarded Headers should
be enabled.
|
boolean |
isGraphiteMetricsReportingEnabled() |
boolean |
isHadoopKerberosSecured() |
boolean |
isJmxMetricsReportingEnabled() |
boolean |
isKerberosDebugEnabled() |
boolean |
isKnoxTokenPermissiveValidationEnabled() |
boolean |
isMetricsEnabled() |
boolean |
isRemoteAliasServiceEnabled()
Returns whether the Remote Alias Service is enabled or not.
|
boolean |
isServerManagedTokenStateEnabled() |
boolean |
isSSLEnabled() |
boolean |
isTopologyValidationEnabled()
Returns true when strict topology validation is enabled,
in which case if topology validation fails Knox will throw
a runtime exception.
|
boolean |
isWebsocketEnabled()
Returns true if websocket feature enabled else false.
|
boolean |
isXForwardedEnabled() |
boolean |
verifyDatabaseSslServerCertificate() |
static final String GATEWAY_HOME_VAR
@Deprecated static final String GATEWAY_CONF_HOME_VAR
KNOX_GATEWAY_CONF_DIR_VAR insteadstatic final String KNOX_GATEWAY_CONF_DIR_VAR
@Deprecated static final String GATEWAY_DATA_HOME_VAR
KNOX_GATEWAY_DATA_DIR insteadstatic final String KNOX_GATEWAY_DATA_DIR
static final String GATEWAY_CONFIG_ATTRIBUTE
static final String HADOOP_KERBEROS_SECURED
static final String KRB5_CONFIG
static final String KRB5_DEBUG
static final String KRB5_LOGIN_CONFIG
static final String KRB5_USE_SUBJECT_CREDS_ONLY
static final String IDENTITY_KEYSTORE_PASSWORD_ALIAS
static final String IDENTITY_KEYSTORE_PATH
static final String IDENTITY_KEYSTORE_TYPE
static final String IDENTITY_KEY_ALIAS
static final String IDENTITY_KEY_PASSPHRASE_ALIAS
static final String DEFAULT_IDENTITY_KEYSTORE_TYPE
static final String DEFAULT_IDENTITY_KEYSTORE_PASSWORD_ALIAS
static final String DEFAULT_IDENTITY_KEY_ALIAS
static final String DEFAULT_IDENTITY_KEY_PASSPHRASE_ALIAS
static final String DEFAULT_GATEWAY_KEYSTORE_NAME
static final String SIGNING_KEYSTORE_NAME
static final String SIGNING_KEYSTORE_PASSWORD_ALIAS
static final String SIGNING_KEYSTORE_TYPE
static final String SIGNING_KEY_ALIAS
static final String SIGNING_KEY_PASSPHRASE_ALIAS
static final String DEFAULT_SIGNING_KEYSTORE_PASSWORD_ALIAS
static final String DEFAULT_SIGNING_KEYSTORE_TYPE
static final String DEFAULT_SIGNING_KEY_ALIAS
static final String DEFAULT_SIGNING_KEY_PASSPHRASE_ALIAS
static final String GATEWAY_TRUSTSTORE_PASSWORD_ALIAS
static final String GATEWAY_TRUSTSTORE_PATH
static final String GATEWAY_TRUSTSTORE_TYPE
static final String DEFAULT_GATEWAY_TRUSTSTORE_TYPE
static final String DEFAULT_GATEWAY_TRUSTSTORE_PASSWORD_ALIAS
static final String HTTP_CLIENT_TRUSTSTORE_PASSWORD_ALIAS
static final String HTTP_CLIENT_TRUSTSTORE_PATH
static final String HTTP_CLIENT_TRUSTSTORE_TYPE
static final String DEFAULT_HTTP_CLIENT_TRUSTSTORE_TYPE
static final String DEFAULT_HTTP_CLIENT_TRUSTSTORE_PASSWORD_ALIAS
static final String CREDENTIAL_STORE_ALG
static final String DEFAULT_CREDENTIAL_STORE_ALG
static final String CREDENTIAL_STORE_TYPE
static final String DEFAULT_CREDENTIAL_STORE_TYPE
static final String REMOTE_CONFIG_REGISTRY_TYPE
static final String REMOTE_CONFIG_REGISTRY_ADDRESS
static final String REMOTE_CONFIG_REGISTRY_NAMESPACE
static final String REMOTE_CONFIG_REGISTRY_AUTH_TYPE
static final String REMOTE_CONFIG_REGISTRY_PRINCIPAL
static final String REMOTE_CONFIG_REGISTRY_CREDENTIAL_ALIAS
static final String REMOTE_CONFIG_REGISTRY_KEYTAB
static final String REMOTE_CONFIG_REGISTRY_USE_KEYTAB
static final String REMOTE_CONFIG_REGISTRY_USE_TICKET_CACHE
static final String ZOOKEEPER_REMOTE_CONFIG_REGISTRY_BACKWARDS_COMPATIBLE
static final String PROXYUSER_SERVICES_IGNORE_DOAS
String getGatewayConfDir()
String getGatewayDataDir()
String getGatewayServicesDir()
String getGatewayApplicationsDir()
String getHadoopConfDir()
String getGatewayHost()
int getGatewayPort()
String getGatewayPath()
String getGatewayProvidersConfigDir()
String getGatewayDescriptorsDir()
String getGatewayTopologyDir()
String getGatewaySecurityDir()
String getGatewayKeystoreDir()
This path is generally calculated to be a subdirectory named "keystores" under the configured "security" directory. However, it may be possible for it to be configured as something else.
String getGatewayDeploymentDir()
InetSocketAddress getGatewayAddress() throws UnknownHostException
UnknownHostExceptionboolean isSSLEnabled()
boolean isHadoopKerberosSecured()
String getKerberosConfig()
boolean isKerberosDebugEnabled()
String getKerberosLoginConfig()
String getDefaultTopologyName()
String getDefaultAppRedirectPath()
String getFrontendUrl()
boolean isClientAuthNeeded()
boolean isClientAuthWanted()
String getTruststorePath()
boolean getTrustAllCerts()
String getKeystoreType()
String getTruststoreType()
String getTruststorePasswordAlias()
boolean isXForwardedEnabled()
String getEphemeralDHKeySize()
int getHttpClientMaxConnections()
int getHttpClientConnectionTimeout()
int getHttpClientSocketTimeout()
String getHttpClientTruststorePath()
null if not setString getHttpClientTruststoreType()
getHttpClientTruststorePath().String getHttpClientTruststorePasswordAlias()
String getCredentialStoreAlgorithm()
String getCredentialStoreType()
int getThreadPoolMax()
int getHttpServerRequestBuffer()
int getHttpServerRequestHeaderBuffer()
int getHttpServerResponseBuffer()
int getHttpServerResponseHeaderBuffer()
int getGatewayDeploymentsBackupVersionLimit()
long getGatewayDeploymentsBackupAgeLimit()
long getGatewayIdleTimeout()
String getIdentityKeystorePath()
null if not setString getIdentityKeystoreType()
String getIdentityKeystorePasswordAlias()
String getIdentityKeyAlias()
String getIdentityKeyPassphraseAlias()
String getSigningKeystoreName()
String getSigningKeystorePath()
null if not setString getSigningKeystoreType()
String getSigningKeyAlias()
String getSigningKeystorePasswordAlias()
String getSigningKeyPassphraseAlias()
boolean isWebsocketEnabled()
int getWebsocketMaxTextMessageSize()
int getWebsocketMaxBinaryMessageSize()
int getWebsocketMaxTextMessageBufferSize()
int getWebsocketMaxBinaryMessageBufferSize()
int getWebsocketInputBufferSize()
int getWebsocketAsyncWriteTimeout()
int getWebsocketIdleTimeout()
int getWebsocketMaxWaitBufferCount()
boolean isMetricsEnabled()
boolean isJmxMetricsReportingEnabled()
boolean isGraphiteMetricsReportingEnabled()
String getGraphiteHost()
int getGraphitePort()
int getGraphiteReportingFrequency()
boolean isCookieScopingToPathEnabled()
String getHeaderNameForRemoteAddress()
String getAlgorithm()
String getPBEAlgorithm()
String getTransformation()
String getSaltSize()
String getIterationCount()
String getKeyLength()
Map<String,Integer> getGatewayPortMappings()
boolean isGatewayPortMappingEnabled()
boolean isGatewayServerHeaderEnabled()
String getDefaultDiscoveryAddress()
String getDefaultDiscoveryCluster()
int getClusterMonitorPollingInterval(String type)
type - The type of cluster configuration monitor for which the interval should be returned.boolean isClusterMonitorEnabled(String type)
type - The type of cluster configuration monitor for which the interval should be returned.List<String> getRemoteRegistryConfigurationNames()
String getRemoteRegistryConfiguration(String name)
name - The name of the remote registry configurationString getRemoteConfigurationMonitorClientName()
boolean allowUnauthenticatedRemoteRegistryReadAccess()
boolean isRemoteAliasServiceEnabled()
String getRemoteAliasServiceConfigurationPrefix()
Map<String,String> getRemoteAliasServiceConfiguration()
List<String> getReadOnlyOverrideTopologyNames()
String getKnoxAdminGroups()
String getKnoxAdminUsers()
String getFederationHeaderName()
List<String> getAutoDeployTopologyNames()
String getDispatchWhitelist()
List<String> getDispatchWhitelistServices()
boolean isTopologyValidationEnabled()
List<String> getXForwardContextAppendServices()
Set<String> getServicesToIgnoreDoAs()
If a service in the returned set sends a Kerberos-authenticated request to the Gateway, the doAs query parameter is to be ignored; thus leaving the authenticated user details intact.
If the (authenticated) service is not authorized to set the specified proxy user (see information related to hadoop.proxyuser.... properties) an error will not be returned since the request to impersonate users is to be ignored.
long getClouderaManagerDescriptorsMonitoringInterval()
long getClouderaManagerAdvancedServiceDiscoveryConfigurationMonitoringInterval()
boolean isServerManagedTokenStateEnabled()
long getKnoxTokenEvictionInterval()
long getKnoxTokenEvictionGracePeriod()
long getKnoxTokenStateAliasPersistenceInterval()
String getKnoxTokenHashAlgorithm()
int getMaximumNumberOfTokensPerUser()
Set<String> getHiddenTopologiesOnHomepage()
Set<String> getPinnedTopologiesOnHomepage()
boolean isKnoxTokenPermissiveValidationEnabled()
String getServiceParameter(String service, String parameter)
service - Service to get the parameter for.parameter - Parameter key to get the value for.boolean homePageLogoutEnabled()
String getGlobalLogoutPageUrl()
long getKeystoreCacheSizeLimit()
long getKeystoreCacheEntryTimeToLiveInMinutes()
boolean isGatewayServerIncomingXForwardedSupportEnabled()
Map<String,Collection<String>> getHomePageProfiles()
String getDatabaseType()
String getDatabaseConnectionUrl()
String getDatabaseHost()
int getDatabasePort()
String getDatabaseName()
boolean isDatabaseSslEnabled()
boolean verifyDatabaseSslServerCertificate()
String getDatabaseSslTruststoreFileName()
Copyright © 2022 The Apache Software Foundation. All rights reserved.