Package software.amazon.awssdk.crt.io

Class TlsContext

java.lang.Object

software.amazon.awssdk.crt.CrtResource

software.amazon.awssdk.crt.io.TlsContext

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

ClientTlsContext, ServerTlsContext

public class TlsContext
extends CrtResource

This class wraps the aws_tls_context from aws-c-io to provide access to TLS configuration contexts in the AWS Common Runtime.

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.awssdk.crt.CrtResource

CrtResource.ResourceInstance

Constructor Summary

Constructors

Constructor	Description
TlsContext()	Creates a new Client TlsContext.
TlsContext(TlsContextOptions options)	Creates a new Client TlsContext.

Method Summary

Modifier and Type	Method	Description
TlsContextOptions.CertificateSource	getCertificateSource()	Returns the TlsContextOptions.CertificateSource of the configured mTLS, or null if no mTLS source has been set on the options used to create this context.
TlsCipherPreference	getCipherPreference()	Returns the TlsCipherPreference configured on this context.
TlsContextOptions.TlsVersions	getMinimumTlsVersion()	Returns the minimum TLS version configured on this context.

Methods inherited from class software.amazon.awssdk.crt.CrtResource

addRef, addRef, addReferenceTo, close, close, collectNativeResource, collectNativeResources, decRef, decRef, decRef, getNativeHandle, getResourceLogDescription, isNull, logNativeResources, logNativeResources, removeReferenceTo, setDescription, waitForNoResources

Methods inherited from class java.lang.Object

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

Constructor Details

TlsContext

public TlsContext(TlsContextOptions options)
           throws CrtRuntimeException

Creates a new Client TlsContext. There are significant native resources consumed to create a TlsContext, so most applications will only need to create one and re-use it for all connections.

Parameters:

options - A set of options for this context

Throws:

CrtRuntimeException - If the provided options are malformed or the system is unable to allocate space for a native tls context

TlsContext

public TlsContext()
           throws CrtRuntimeException

Creates a new Client TlsContext. There are significant native resources consumed to create a TlsContext, so most applications will only need to create one and re-use it for all connections.

Throws:

CrtRuntimeException

Method Details

getCipherPreference

public TlsCipherPreference getCipherPreference()

Returns the TlsCipherPreference configured on this context.

Returns:

the cipher preference

getMinimumTlsVersion

public TlsContextOptions.TlsVersions getMinimumTlsVersion()

Returns the minimum TLS version configured on this context.

Returns:

the minimum TLS version

getCertificateSource

public TlsContextOptions.CertificateSource getCertificateSource()

Returns the TlsContextOptions.CertificateSource of the configured mTLS, or null if no mTLS source has been set on the options used to create this context.

Returns:

the certificate source