com.marklogic.client

Class DatabaseClientBuilder

java.lang.Object

com.marklogic.client.DatabaseClientBuilder

public class DatabaseClientBuilder
extends java.lang.Object

Intended to support programmatically building a DatabaseClient via chained "with" methods for setting each possible input allowed for connecting to and authenticating with MarkLogic. While the DatabaseClientFactory.Bean class is intended for use in a context such as a Spring container, it requires that a user have already assembled the appropriate DatabaseClientFactory.SecurityContext. This builder instead is intended for a more dynamic environment - in particular, one where the desired authentication strategy is not known until runtime. A client can then collect inputs from a user at runtime and call the appropriate methods on this builder. The builder will handle constructing the correct DatabaseClientFactory.SecurityContext and using that to construct a DatabaseClient.

Since:

6.1.0

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	AUTH_TYPE_BASIC
static java.lang.String	AUTH_TYPE_CERTIFICATE
static java.lang.String	AUTH_TYPE_DIGEST
static java.lang.String	AUTH_TYPE_KERBEROS
static java.lang.String	AUTH_TYPE_MARKLOGIC_CLOUD
static java.lang.String	AUTH_TYPE_OAUTH
static java.lang.String	AUTH_TYPE_SAML
static java.lang.String	PREFIX

Constructor Summary

Constructors

Constructor and Description
DatabaseClientBuilder()
DatabaseClientBuilder(java.util.Map<java.lang.String,java.lang.Object> props) Initialize the builder with the given set of properties.

Method Summary

Modifier and Type	Method and Description
DatabaseClient	build()
DatabaseClientFactory.Bean	buildBean()
DatabaseClientBuilder	withAuthType(java.lang.String type)
DatabaseClientBuilder	withBasePath(java.lang.String basePath)
DatabaseClientBuilder	withBasicAuth(java.lang.String username, java.lang.String password)
DatabaseClientBuilder	withCertificateAuth(javax.net.ssl.SSLContext sslContext, javax.net.ssl.X509TrustManager trustManager)
DatabaseClientBuilder	withCertificateAuth(java.lang.String file, java.lang.String password)
DatabaseClientBuilder	withCertificateFile(java.lang.String file)
DatabaseClientBuilder	withCertificatePassword(java.lang.String password)
DatabaseClientBuilder	withCloudApiKey(java.lang.String cloudApiKey)
DatabaseClientBuilder	withCloudAuth(java.lang.String apiKey, java.lang.String basePath)
DatabaseClientBuilder	withCloudAuth(java.lang.String apiKey, java.lang.String basePath, java.lang.Integer tokenDuration)
DatabaseClientBuilder	withCloudTokenDuration(java.lang.String tokenDuration)
DatabaseClientBuilder	withConnectionType(DatabaseClient.ConnectionType type)
DatabaseClientBuilder	withDatabase(java.lang.String database)
DatabaseClientBuilder	withDigestAuth(java.lang.String username, java.lang.String password)
DatabaseClientBuilder	withGzippedResponsesDisabled() Prevents the underlying OkHttp library from sending an "Accept-Encoding-gzip" request header on each request.
DatabaseClientBuilder	withHost(java.lang.String host)
DatabaseClientBuilder	withKerberosAuth(java.lang.String principal)
DatabaseClientBuilder	withKerberosPrincipal(java.lang.String principal)
DatabaseClientBuilder	withKeyStoreAlgorithm(java.lang.String algorithm)
DatabaseClientBuilder	withKeyStorePassword(java.lang.String password)
DatabaseClientBuilder	withKeyStorePath(java.lang.String path) Enables 2-way SSL by creating an SSL context based on the given key store path.
DatabaseClientBuilder	withKeyStoreType(java.lang.String type)
DatabaseClientBuilder	withOAuth(java.lang.String token)
DatabaseClientBuilder	withOAuthToken(java.lang.String token)
DatabaseClientBuilder	withPassword(java.lang.String password)
DatabaseClientBuilder	withPort(int port)
DatabaseClientBuilder	withSAMLAuth(java.lang.String token)
DatabaseClientBuilder	withSAMLToken(java.lang.String token)
DatabaseClientBuilder	withSecurityContext(DatabaseClientFactory.SecurityContext securityContext)
DatabaseClientBuilder	withSSLContext(javax.net.ssl.SSLContext sslContext)
DatabaseClientBuilder	withSSLHostnameVerifier(DatabaseClientFactory.SSLHostnameVerifier sslHostnameVerifier)
DatabaseClientBuilder	withSSLProtocol(java.lang.String sslProtocol)
DatabaseClientBuilder	withTrustManager(javax.net.ssl.X509TrustManager trustManager)
DatabaseClientBuilder	withTrustStoreAlgorithm(java.lang.String algorithm)
DatabaseClientBuilder	withTrustStorePassword(java.lang.String password)
DatabaseClientBuilder	withTrustStorePath(java.lang.String path) Supports constructing an X509TrustManager based on the given file path, which should point to a Java key store or trust store.
DatabaseClientBuilder	withTrustStoreType(java.lang.String type)
DatabaseClientBuilder	withUsername(java.lang.String username)

Methods inherited from class java.lang.Object

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

Field Detail

PREFIX

public static final java.lang.String PREFIX

See Also:

Constant Field Values

AUTH_TYPE_BASIC

public static final java.lang.String AUTH_TYPE_BASIC

See Also:

Constant Field Values

AUTH_TYPE_DIGEST

public static final java.lang.String AUTH_TYPE_DIGEST

See Also:

Constant Field Values

AUTH_TYPE_MARKLOGIC_CLOUD

public static final java.lang.String AUTH_TYPE_MARKLOGIC_CLOUD

See Also:

Constant Field Values

AUTH_TYPE_KERBEROS

public static final java.lang.String AUTH_TYPE_KERBEROS

See Also:

Constant Field Values

AUTH_TYPE_CERTIFICATE

public static final java.lang.String AUTH_TYPE_CERTIFICATE

See Also:

Constant Field Values

AUTH_TYPE_SAML

public static final java.lang.String AUTH_TYPE_SAML

See Also:

Constant Field Values

AUTH_TYPE_OAUTH

public static final java.lang.String AUTH_TYPE_OAUTH

See Also:

Constant Field Values

Constructor Detail

DatabaseClientBuilder

public DatabaseClientBuilder()

DatabaseClientBuilder

public DatabaseClientBuilder(java.util.Map<java.lang.String,java.lang.Object> props)

Initialize the builder with the given set of properties.

Parameters:

props -

Method Detail

build

public DatabaseClient build()

Returns:

a DatabaseClient based on the inputs that have been provided via the "with" builder methods and any inputs provided via this instance's constructor

buildBean

public DatabaseClientFactory.Bean buildBean()

Returns:

an instance of DatabaseClientFactory.Bean based on the inputs that have been provided via the "with" builder methods and any inputs provided via this instance's constructor

withHost

public DatabaseClientBuilder withHost(java.lang.String host)

withPort

public DatabaseClientBuilder withPort(int port)

withBasePath

public DatabaseClientBuilder withBasePath(java.lang.String basePath)

withDatabase

public DatabaseClientBuilder withDatabase(java.lang.String database)

withUsername

public DatabaseClientBuilder withUsername(java.lang.String username)

withPassword

public DatabaseClientBuilder withPassword(java.lang.String password)

withSecurityContext

public DatabaseClientBuilder withSecurityContext(DatabaseClientFactory.SecurityContext securityContext)

withAuthType

public DatabaseClientBuilder withAuthType(java.lang.String type)

Parameters:

type - must be one of "basic", "digest", "cloud", "kerberos", "certificate", or "saml"

Returns:

withBasicAuth

public DatabaseClientBuilder withBasicAuth(java.lang.String username,
                                           java.lang.String password)

withDigestAuth

public DatabaseClientBuilder withDigestAuth(java.lang.String username,
                                            java.lang.String password)

withCloudAuth

public DatabaseClientBuilder withCloudAuth(java.lang.String apiKey,
                                           java.lang.String basePath)

withCloudAuth

public DatabaseClientBuilder withCloudAuth(java.lang.String apiKey,
                                           java.lang.String basePath,
                                           java.lang.Integer tokenDuration)

Parameters:

apiKey -

basePath -

tokenDuration - length in minutes until the generated access token expires

Returns:

Since:

6.3.0

withKerberosAuth

public DatabaseClientBuilder withKerberosAuth(java.lang.String principal)

withCertificateAuth

public DatabaseClientBuilder withCertificateAuth(java.lang.String file,
                                                 java.lang.String password)

withCertificateAuth

public DatabaseClientBuilder withCertificateAuth(javax.net.ssl.SSLContext sslContext,
                                                 javax.net.ssl.X509TrustManager trustManager)

Parameters:

sslContext -

trustManager -

Returns:

Since:

6.2.2

withSAMLAuth

public DatabaseClientBuilder withSAMLAuth(java.lang.String token)

withOAuth

public DatabaseClientBuilder withOAuth(java.lang.String token)

Parameters:

token -

Returns:

Since:

6.6.0

withOAuthToken

public DatabaseClientBuilder withOAuthToken(java.lang.String token)

Parameters:

token -

Returns:

Since:

6.6.0

withConnectionType

public DatabaseClientBuilder withConnectionType(DatabaseClient.ConnectionType type)

withCloudApiKey

public DatabaseClientBuilder withCloudApiKey(java.lang.String cloudApiKey)

withCloudTokenDuration

public DatabaseClientBuilder withCloudTokenDuration(java.lang.String tokenDuration)

Parameters:

tokenDuration - length in minutes until the generated access token expires

Returns:

Since:

6.3.0

withCertificateFile

public DatabaseClientBuilder withCertificateFile(java.lang.String file)

withCertificatePassword

public DatabaseClientBuilder withCertificatePassword(java.lang.String password)

withKerberosPrincipal

public DatabaseClientBuilder withKerberosPrincipal(java.lang.String principal)

withSAMLToken

public DatabaseClientBuilder withSAMLToken(java.lang.String token)

withSSLContext

public DatabaseClientBuilder withSSLContext(javax.net.ssl.SSLContext sslContext)

withSSLProtocol

public DatabaseClientBuilder withSSLProtocol(java.lang.String sslProtocol)

withTrustManager

public DatabaseClientBuilder withTrustManager(javax.net.ssl.X509TrustManager trustManager)

withSSLHostnameVerifier

public DatabaseClientBuilder withSSLHostnameVerifier(DatabaseClientFactory.SSLHostnameVerifier sslHostnameVerifier)

withGzippedResponsesDisabled

public DatabaseClientBuilder withGzippedResponsesDisabled()

Prevents the underlying OkHttp library from sending an "Accept-Encoding-gzip" request header on each request.

Returns:

Since:

6.3.0

withKeyStorePath

public DatabaseClientBuilder withKeyStorePath(java.lang.String path)

Enables 2-way SSL by creating an SSL context based on the given key store path.

Parameters:

path -

Returns:

Since:

6.4.0

withKeyStorePassword

public DatabaseClientBuilder withKeyStorePassword(java.lang.String password)

Parameters:

password - optional password for a key store

Returns:

Since:

6.4.0

withKeyStoreType

public DatabaseClientBuilder withKeyStoreType(java.lang.String type)

Parameters:

type - e.g. "JKS"

Returns:

Since:

6.4.0

withKeyStoreAlgorithm

public DatabaseClientBuilder withKeyStoreAlgorithm(java.lang.String algorithm)

Parameters:

algorithm - e.g. "SunX509"

Returns:

Since:

6.4.0

withTrustStorePath

public DatabaseClientBuilder withTrustStorePath(java.lang.String path)

Supports constructing an X509TrustManager based on the given file path, which should point to a Java key store or trust store.

Parameters:

path -

Returns:

Since:

6.5.0

withTrustStorePassword

public DatabaseClientBuilder withTrustStorePassword(java.lang.String password)

Parameters:

password - optional password for a trust store

Returns:

Since:

6.5.0

withTrustStoreType

public DatabaseClientBuilder withTrustStoreType(java.lang.String type)

Parameters:

type - e.g. "JKS"

Returns:

Since:

6.5.0

withTrustStoreAlgorithm

public DatabaseClientBuilder withTrustStoreAlgorithm(java.lang.String algorithm)

Parameters:

algorithm - e.g. "SunX509"

Returns:

Since:

6.5.0