TlsOptionsHeaplet (Microservice Token Validation Doc 1.0.2-SNAPSHOT Documentation)

java.lang.Object
- org.forgerock.openig.heap.GenericHeaplet
- - org.forgerock.openig.security.TlsOptionsHeaplet

All Implemented Interfaces:

Heaplet
```
public class TlsOptionsHeaplet
extends GenericHeaplet
```
Creates and initializes TLS options in a heap environment.
The sslContextAlgorithm optional attribute used to set the SSL Context Algorithm for SSL/TLS connections, it defaults to TLS. See the JavaSE docs for the full list of supported values.
The keyManager and trustManager optional attributes are referencing a list of KeyManager (and TrustManager respectively). They support singleton value (use a single reference) as well as multi-valued references (a list):
```
 
     "keyManager": "SingleKeyManagerReference",
     "trustManager": [ "RefOne", "RefTwo" ]
 
 
```
The sslEnabledProtocols optional attribute specifies the protocol versions to be enabled for use on the connection.
The sslCipherSuites optional attribute specifies cipher suite names used by the SSL connection.

- Field Summary
  - Fields inherited from class org.forgerock.openig.heap.GenericHeaplet
    config, heap, name, object, qualified
- Constructor Summary
  
  Constructors
  Constructor Description
  
  TlsOptionsHeaplet()
- Method Summary
  
  All Methods Instance Methods Concrete Methods
  Modifier and Type Method Description
  
  Object create()
  Called to request the heaplet create an object.
  - Methods inherited from class org.forgerock.openig.heap.GenericHeaplet
    create, destroy, endpointRegistry, evaluatedWithHeapProperties, expression, getConfig, getHeap, getSecretService, getType, meterRegistryHolder, start
  - Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - TlsOptionsHeaplet
```
public TlsOptionsHeaplet()
```
- Method Detail
  - create
```
public Object create()
              throws HeapException
```
    Description copied from class: GenericHeaplet
    
    Called to request the heaplet create an object. Called by Heaplet.create(Name, JsonValue, Heap) after initializing the protected field members. Implementations should parse configuration but not acquire resources, start threads, or log any initialization messages. These tasks should be performed by the GenericHeaplet.start() method.
    
    Specified by:
    
    create in class GenericHeaplet
    
    Returns:
    
    The created object.
    
    Throws:
    
    HeapException - if an exception occurred during creation of the heap object or any of its dependencies.