Package org.forgerock.openig.filter

Class HttpBasicAuthenticationClientFilterHeaplet

java.lang.Object

org.forgerock.openig.heap.GenericHeaplet

org.forgerock.openig.filter.HttpBasicAuthenticationClientFilterHeaplet

All Implemented Interfaces:

Heaplet

public class HttpBasicAuthenticationClientFilterHeaplet
extends GenericHeaplet

Creates and initializes a Filter supporting the injection of a Basic Authorization header in the request for the configured credentials.

The HttpBasicAuthenticationClientFilterHeaplet has the following configuration:

 {
      "type": "HttpBasicAuthenticationClientFilter",
      "config": {
        "username"              : expression       [REQUIRED - the 'username'. ]
        "passwordSecretId"      : expression       [REQUIRED - secret ID used to obtain the 'password'. ]
        "secretsProvider"       : secrets provider [REQUIRED - secrets provider used to obtain "password secret id". ]
        "urlEncodeCredentials"  : expression       [OPTIONAL - {@literal true} if the credentials should each be
                                                               URL-encoded prior to base64 encoding - default is
                                                               false. ]
      }
 }
 
 

Field Summary

Fields inherited from class org.forgerock.openig.heap.GenericHeaplet

config, heap, name, object, qualified

Constructor Summary

Constructors

Constructor	Description
HttpBasicAuthenticationClientFilterHeaplet()

Method Summary

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

HttpBasicAuthenticationClientFilterHeaplet

public HttpBasicAuthenticationClientFilterHeaplet()

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.