Package org.springframework.credhub.support

Class ClientOptions

java.lang.Object

org.springframework.credhub.support.ClientOptions

public class ClientOptions
extends Object

Client options for CredHub connectivity.

Author:

Mark Paluch, Scott Frederick

Constructor Summary

Constructors

Constructor	Description
ClientOptions()	Create new ClientOptions with default values.
ClientOptions(Duration connectionTimeout, Duration readTimeout, String[] caCertFiles)	Create a ClientOptions with the provided values.

Method Summary

Modifier and Type	Method	Description
String @Nullable []	getCaCertFiles()	Get the CA certificate files to use when connecting.
@Nullable Duration	getConnectionTimeout()	Get the connection timeout in TimeUnit.MILLISECONDS.
@Nullable Integer	getConnectionTimeoutMillis()	Get the connection timeout in TimeUnit.MILLISECONDS.
@Nullable Duration	getReadTimeout()	Get the read timeout in TimeUnit.MILLISECONDS.
@Nullable Integer	getReadTimeoutMillis()	Get the read timeout in TimeUnit.MILLISECONDS.
void	setCaCertFiles(String @Nullable [] caCertFiles)	Set the CA certificate files to use when connecting.
void	setConnectionTimeout(@Nullable Duration connectionTimeout)	Set the connection timeout.
void	setReadTimeout(@Nullable Duration readTimeout)	Set the read timeout.

Methods inherited from class java.lang.Object

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

Constructor Details

ClientOptions

public ClientOptions()

Create new ClientOptions with default values.

ClientOptions

public ClientOptions(Duration connectionTimeout,
 Duration readTimeout,
 String[] caCertFiles)

Create a ClientOptions with the provided values.

Parameters:

connectionTimeout - connection timeout in TimeUnit.MILLISECONDS, must be greater 0

readTimeout - read timeout in TimeUnit.MILLISECONDS, must be greater 0

caCertFiles - one or more CA certificate files to use when connecting

Method Details

getConnectionTimeout

public @Nullable Duration getConnectionTimeout()

Get the connection timeout in TimeUnit.MILLISECONDS.

Returns:

the connection timeout; can be null if not explicitly set

getConnectionTimeoutMillis

public @Nullable Integer getConnectionTimeoutMillis()

Get the connection timeout in TimeUnit.MILLISECONDS.

Returns:

the connection timeout; can be null if not explicitly set

setConnectionTimeout

public void setConnectionTimeout(@Nullable Duration connectionTimeout)

Set the connection timeout.

Parameters:

connectionTimeout - the connection timeout

getReadTimeout

public @Nullable Duration getReadTimeout()

Get the read timeout in TimeUnit.MILLISECONDS.

Returns:

the read timeout; can be null if not explicitly set

getReadTimeoutMillis

public @Nullable Integer getReadTimeoutMillis()

Get the read timeout in TimeUnit.MILLISECONDS.

Returns:

the read timeout; can be null if not explicitly set

setReadTimeout

public void setReadTimeout(@Nullable Duration readTimeout)

Set the read timeout.

Parameters:

readTimeout - the read timeout

getCaCertFiles

public String @Nullable [] getCaCertFiles()

Get the CA certificate files to use when connecting.

Returns:

the CA certificate file paths; can be null

setCaCertFiles

public void setCaCertFiles(String @Nullable [] caCertFiles)

Set the CA certificate files to use when connecting.

Parameters:

caCertFiles - the CA certificate file paths