com.oracle.bmc.loadbalancer.model

Class SSLConfiguration.Builder

java.lang.Object

com.oracle.bmc.loadbalancer.model.SSLConfiguration.Builder

Enclosing class:

SSLConfiguration

public static class SSLConfiguration.Builder
extends Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
SSLConfiguration	build()
SSLConfiguration.Builder	certificateIds(List<String> certificateIds) Ids for OCI certificates service certificates.
SSLConfiguration.Builder	certificateName(String certificateName) A friendly name for the certificate bundle.
SSLConfiguration.Builder	cipherSuiteName(String cipherSuiteName) The name of the cipher suite to use for HTTPS or SSL connections.
SSLConfiguration.Builder	copy(SSLConfiguration model)
SSLConfiguration.Builder	hasSessionResumption(Boolean hasSessionResumption) Whether the load balancer listener should resume an encrypted session by reusing the cryptographic parameters of a previous TLS session, without having to perform a full handshake again.
SSLConfiguration.Builder	protocols(List<String> protocols) A list of SSL protocols the load balancer must support for HTTPS or SSL connections.
SSLConfiguration.Builder	serverOrderPreference(SSLConfiguration.ServerOrderPreference serverOrderPreference) When this attribute is set to ENABLED, the system gives preference to the server ciphers over the client ciphers.
SSLConfiguration.Builder	trustedCertificateAuthorityIds(List<String> trustedCertificateAuthorityIds) Ids for OCI certificates service CA or CA bundles for the load balancer to trust.
SSLConfiguration.Builder	verifyDepth(Integer verifyDepth) The maximum depth for peer certificate chain verification.
SSLConfiguration.Builder	verifyPeerCertificate(Boolean verifyPeerCertificate) Whether the load balancer listener should verify peer certificates.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

verifyDepth

public SSLConfiguration.Builder verifyDepth(Integer verifyDepth)

The maximum depth for peer certificate chain verification.

Example: 3

Parameters:

verifyDepth - the value to set

Returns:

this builder

verifyPeerCertificate

public SSLConfiguration.Builder verifyPeerCertificate(Boolean verifyPeerCertificate)

Whether the load balancer listener should verify peer certificates.

Example: true

Parameters:

verifyPeerCertificate - the value to set

Returns:

this builder

hasSessionResumption

public SSLConfiguration.Builder hasSessionResumption(Boolean hasSessionResumption)

Whether the load balancer listener should resume an encrypted session by reusing the cryptographic parameters of a previous TLS session, without having to perform a full handshake again. If “true”, the service resumes the previous TLS encrypted session. If “false”, the service starts a new TLS encrypted session. Enabling session resumption improves performance but provides a lower level of security. Disabling session resumption improves security but reduces performance.

Example: true

Parameters:

hasSessionResumption - the value to set

Returns:

this builder

trustedCertificateAuthorityIds

public SSLConfiguration.Builder trustedCertificateAuthorityIds(List<String> trustedCertificateAuthorityIds)

Ids for OCI certificates service CA or CA bundles for the load balancer to trust.

Example: [ocid1.cabundle.oc1.us-ashburn-1.amaaaaaaav3bgsaagl4zzyqdop5i2vuwoqewdvauuw34llqa74otq2jdsfyq]

Parameters:

trustedCertificateAuthorityIds - the value to set

Returns:

this builder

certificateIds

public SSLConfiguration.Builder certificateIds(List<String> certificateIds)

Ids for OCI certificates service certificates. Currently only a single Id may be passed.

Example: [ocid1.certificate.oc1.us-ashburn-1.amaaaaaaav3bgsaa5o2q7rh5nfmkkukfkogasqhk6af2opufhjlqg7m6jqzq]

Parameters:

certificateIds - the value to set

Returns:

this builder

certificateName

public SSLConfiguration.Builder certificateName(String certificateName)

A friendly name for the certificate bundle. It must be unique and it cannot be changed. Valid certificate bundle names include only alphanumeric characters, dashes, and underscores. Certificate bundle names cannot contain spaces. Avoid entering confidential information.

Example: example_certificate_bundle

Parameters:

certificateName - the value to set

Returns:

this builder

serverOrderPreference

public SSLConfiguration.Builder serverOrderPreference(SSLConfiguration.ServerOrderPreference serverOrderPreference)

When this attribute is set to ENABLED, the system gives preference to the server ciphers over the client ciphers.

*Note:** This configuration is applicable only when the load balancer is acting as an SSL/HTTPS server. This field is ignored when the SSLConfiguration object is associated with a backend set.

Parameters:

serverOrderPreference - the value to set

Returns:

this builder

cipherSuiteName

public SSLConfiguration.Builder cipherSuiteName(String cipherSuiteName)

The name of the cipher suite to use for HTTPS or SSL connections.

If this field is not specified, the default is oci-default-ssl-cipher-suite-v1.

*Notes:**

You must ensure compatibility between the specified SSL protocols and the ciphers configured in the cipher suite. Clients cannot perform an SSL handshake if there is an incompatible configuration. * You must ensure compatibility between the ciphers configured in the cipher suite and the configured certificates. For example, RSA-based ciphers require RSA certificates and ECDSA-based ciphers require ECDSA certificates. * If the cipher configuration is not modified after load balancer creation, the GET operation returns oci-default-ssl-cipher-suite-v1 as the value of this field in the SSL configuration for existing listeners that predate this feature. * If the cipher configuration was modified using Oracle operations after load balancer creation, the GET operation returns oci-customized-ssl-cipher-suite as the value of this field in the SSL configuration for existing listeners that predate this feature. * The GET operation returns oci-wider-compatible-ssl-cipher-suite-v1 as the value of this field in the SSL configuration for existing backend sets that predate this feature. * If the GET operation on a listener returns oci-customized-ssl-cipher-suite as the value of this field, you must specify an appropriate predefined or custom cipher suite name when updating the resource. * The oci-customized-ssl-cipher-suite Oracle reserved cipher suite name is not accepted as valid input for this field.

example: example_cipher_suite

Parameters:

cipherSuiteName - the value to set

Returns:

this builder

protocols

public SSLConfiguration.Builder protocols(List<String> protocols)

A list of SSL protocols the load balancer must support for HTTPS or SSL connections.

The load balancer uses SSL protocols to establish a secure connection between a client and a server. A secure connection ensures that all data passed between the client and the server is private.

The Load Balancing service supports the following protocols:

TLSv1 * TLSv1.1 * TLSv1.2 * TLSv1.3

If this field is not specified, TLSv1.2 is the default.

*Warning:** All SSL listeners created on a given port must use the same set of SSL protocols.

*Notes:**

The handshake to establish an SSL connection fails if the client supports none of the specified protocols. * You must ensure compatibility between the specified SSL protocols and the ciphers configured in the cipher suite. * For all existing load balancer listeners and backend sets that predate this feature, the GET operation displays a list of SSL protocols currently used by those resources.

example: ["TLSv1.1", "TLSv1.2"]

Parameters:

protocols - the value to set

Returns:

this builder

build

public SSLConfiguration build()

copy

public SSLConfiguration.Builder copy(SSLConfiguration model)