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[]	getCaCertFiles()
Duration	getConnectionTimeout()	Get the connection timeout in TimeUnit.MILLISECONDS.
Integer	getConnectionTimeoutMillis()	Get the connection timeout in TimeUnit.MILLISECONDS.
Duration	getReadTimeout()	Get the read timeout in TimeUnit.MILLISECONDS.
Integer	getReadTimeoutMillis()	Get the read timeout in TimeUnit.MILLISECONDS.
void	setCaCertFiles(String[] caCertFiles)
void	setConnectionTimeout(Duration connectionTimeout)
void	setReadTimeout(Duration readTimeout)

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 Duration getConnectionTimeout()

Get the connection timeout in TimeUnit.MILLISECONDS.

Returns:

the connection timeout; can be null if not explicitly set

getConnectionTimeoutMillis

public Integer getConnectionTimeoutMillis()

Get the connection timeout in TimeUnit.MILLISECONDS.

Returns:

the connection timeout; can be null if not explicitly set

setConnectionTimeout

public void setConnectionTimeout(Duration connectionTimeout)

getReadTimeout

public Duration getReadTimeout()

Get the read timeout in TimeUnit.MILLISECONDS.

Returns:

the read timeout; can be null if not explicitly set

getReadTimeoutMillis

public Integer getReadTimeoutMillis()

Get the read timeout in TimeUnit.MILLISECONDS.

Returns:

the read timeout; can be null if not explicitly set

setReadTimeout

public void setReadTimeout(Duration readTimeout)

getCaCertFiles

public String[] getCaCertFiles()

setCaCertFiles

public void setCaCertFiles(String[] caCertFiles)