Package org.apache.hadoop.hbase.http

Class HttpServer.Builder

java.lang.Object

org.apache.hadoop.hbase.http.HttpServer.Builder

Enclosing class:

HttpServer

public static class HttpServer.Builder
extends Object

Class to construct instances of HTTP server with specific options.

Field Summary

Fields

Modifier and Type	Field	Description
private org.apache.hadoop.security.authorize.AccessControlList	adminsAcl
private String	appDir
private String	bindAddress	Deprecated. Since 0.99.0.
private org.apache.hadoop.conf.Configuration	conf
private ArrayList<URI>	endpoints
private String	excludeCiphers
private String	excludeProtocols
private boolean	findPort
private String	hostName
private String	includeCiphers
private String	includeProtocols
private String	kerberosNameRulesKey
private String	keyPassword
private String	keyStore
private String	keyStorePassword
private String	keyStoreType
private String	keytabConfKey
private String	logDir
private String	name	Deprecated. Since 0.99.0.
private boolean	needsClientAuth
private String[]	pathSpecs
private int	port	Deprecated. Since 0.99.0.
private boolean	securityEnabled
private String	signatureSecretFileKey
private String	trustStore
private String	trustStorePassword
private String	trustStoreType
private String	usernameConfKey
private boolean	wantsClientAuth

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
HttpServer.Builder	addEndpoint(URI endpoint)	Add an endpoint that the HTTP server should listen to.
HttpServer	build()
void	excludeCiphers(String excludeCiphers)	Deprecated.
HttpServer.Builder	hostName(String hostName)	Set the hostname of the http server.
HttpServer.Builder	keyPassword(String password)
HttpServer.Builder	keyStore(String location, String password, String type)
HttpServer.Builder	needsClientAuth(boolean value)	Specify whether the server should require a client certificate during the SSL handshake (mTLS).
HttpServer.Builder	setACL(org.apache.hadoop.security.authorize.AccessControlList acl)
HttpServer.Builder	setAppDir(String appDir)
HttpServer.Builder	setBindAddress(String bindAddress)	Deprecated. Since 0.99.0.
HttpServer.Builder	setConf(org.apache.hadoop.conf.Configuration conf)
HttpServer.Builder	setExcludeCiphers(String excludeCiphers)
HttpServer.Builder	setExcludeProtocols(String excludeProtocols)
HttpServer.Builder	setFindPort(boolean findPort)
HttpServer.Builder	setIncludeCiphers(String includeCiphers)
HttpServer.Builder	setIncludeProtocols(String includeProtocols)
HttpServer.Builder	setKerberosNameRulesKey(String kerberosNameRulesKey)
HttpServer.Builder	setKeytabConfKey(String keytabConfKey)
HttpServer.Builder	setLogDir(String logDir)
HttpServer.Builder	setName(String name)	Deprecated. Since 0.99.0.
HttpServer.Builder	setPathSpec(String[] pathSpec)
HttpServer.Builder	setPort(int port)	Deprecated. Since 0.99.0.
HttpServer.Builder	setSecurityEnabled(boolean securityEnabled)
HttpServer.Builder	setSignatureSecretFileKey(String signatureSecretFileKey)
HttpServer.Builder	setUsernameConfKey(String usernameConfKey)
HttpServer.Builder	trustStore(String location, String password, String type)
HttpServer.Builder	wantsClientAuth(boolean value)	Specify whether the server should request a client certificate during the SSL handshake but still accept clients that do not present one.

Methods inherited from class java.lang.Object

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

Field Details

endpoints

private ArrayList<URI> endpoints

conf

private org.apache.hadoop.conf.Configuration conf

pathSpecs

private String[] pathSpecs

adminsAcl

private org.apache.hadoop.security.authorize.AccessControlList adminsAcl

securityEnabled

private boolean securityEnabled

usernameConfKey

private String usernameConfKey

keytabConfKey

private String keytabConfKey

needsClientAuth

private boolean needsClientAuth

wantsClientAuth

private boolean wantsClientAuth

includeCiphers

private String includeCiphers

excludeCiphers

private String excludeCiphers

includeProtocols

private String includeProtocols

excludeProtocols

private String excludeProtocols

hostName

private String hostName

appDir

private String appDir

logDir

private String logDir

findPort

private boolean findPort

trustStore

private String trustStore

trustStorePassword

private String trustStorePassword

trustStoreType

private String trustStoreType

keyStore

private String keyStore

keyStorePassword

private String keyStorePassword

keyStoreType

private String keyStoreType

keyPassword

private String keyPassword

kerberosNameRulesKey

private String kerberosNameRulesKey

signatureSecretFileKey

private String signatureSecretFileKey

name

@Deprecated
private String name

Deprecated.

Since 0.99.0. Use builder pattern via setAppDir(String) instead.

See Also:

• setAppDir(String)

bindAddress

@Deprecated
private String bindAddress

Deprecated.

Since 0.99.0. Use builder pattern via addEndpoint(URI) instead.

See Also:

• addEndpoint(URI)

port

@Deprecated
private int port

Deprecated.

Since 0.99.0. Use builder pattern via addEndpoint(URI) instead.

See Also:

• addEndpoint(URI)

Constructor Details

Builder

public Builder()

Method Details

addEndpoint

public HttpServer.Builder addEndpoint(URI endpoint)

Add an endpoint that the HTTP server should listen to. the endpoint of that the HTTP server should listen to. The scheme specifies the protocol (i.e. HTTP / HTTPS), the host specifies the binding address, and the port specifies the listening port. Unspecified or zero port means that the server can listen to any port.

hostName

public HttpServer.Builder hostName(String hostName)

Set the hostname of the http server. The host name is used to resolve the _HOST field in Kerberos principals. The hostname of the first listener will be used if the name is unspecified.

trustStore

public HttpServer.Builder trustStore(String location,
 String password,
 String type)

keyStore

public HttpServer.Builder keyStore(String location,
 String password,
 String type)

keyPassword

public HttpServer.Builder keyPassword(String password)

needsClientAuth

public HttpServer.Builder needsClientAuth(boolean value)

Specify whether the server should require a client certificate during the SSL handshake (mTLS). When true, clients that do not present a valid certificate are rejected.

Takes precedence over wantsClientAuth(boolean) in Jetty when both are set.

Callers enabling either mode must also configure a truststore, since Jetty otherwise silently falls back to the keystore or the JVM cacerts as the client-cert trust anchor. See X509Util.validateClientAuthTrustStore(org.apache.hadoop.hbase.io.crypto.tls.X509Util.ClientAuth, java.lang.String, java.lang.String, java.lang.String...).

wantsClientAuth

public HttpServer.Builder wantsClientAuth(boolean value)

Specify whether the server should request a client certificate during the SSL handshake but still accept clients that do not present one. Weaker than needsClientAuth(boolean): use this to signal "opportunistic mTLS" where a client cert is validated when supplied but its absence is tolerated.

setName

@Deprecated
public HttpServer.Builder setName(String name)

Deprecated.

Since 0.99.0. Use setAppDir(String) instead.

See Also:

• setAppDir(String)

setBindAddress

@Deprecated
public HttpServer.Builder setBindAddress(String bindAddress)

Deprecated.

Since 0.99.0. Use addEndpoint(URI) instead.

See Also:

• addEndpoint(URI)

setPort

@Deprecated
public HttpServer.Builder setPort(int port)

Deprecated.

Since 0.99.0. Use addEndpoint(URI) instead.

See Also:

• addEndpoint(URI)

setFindPort

public HttpServer.Builder setFindPort(boolean findPort)

setConf

public HttpServer.Builder setConf(org.apache.hadoop.conf.Configuration conf)

setPathSpec

public HttpServer.Builder setPathSpec(String[] pathSpec)

setACL

public HttpServer.Builder setACL(org.apache.hadoop.security.authorize.AccessControlList acl)

setSecurityEnabled

public HttpServer.Builder setSecurityEnabled(boolean securityEnabled)

setUsernameConfKey

public HttpServer.Builder setUsernameConfKey(String usernameConfKey)

setKeytabConfKey

public HttpServer.Builder setKeytabConfKey(String keytabConfKey)

setKerberosNameRulesKey

public HttpServer.Builder setKerberosNameRulesKey(String kerberosNameRulesKey)

setSignatureSecretFileKey

public HttpServer.Builder setSignatureSecretFileKey(String signatureSecretFileKey)

setAppDir

public HttpServer.Builder setAppDir(String appDir)

setLogDir

public HttpServer.Builder setLogDir(String logDir)

excludeCiphers

@Deprecated
public void excludeCiphers(String excludeCiphers)

Deprecated.

setExcludeCiphers

public HttpServer.Builder setExcludeCiphers(String excludeCiphers)

setIncludeCiphers

public HttpServer.Builder setIncludeCiphers(String includeCiphers)

setIncludeProtocols

public HttpServer.Builder setIncludeProtocols(String includeProtocols)

setExcludeProtocols

public HttpServer.Builder setExcludeProtocols(String excludeProtocols)

build

public HttpServer build()
                 throws IOException

Throws:

IOException