Package org.forgerock.openig.openam

Class UserProfileServiceHeaplet

java.lang.Object

org.forgerock.openig.heap.GenericHeaplet

org.forgerock.openig.openam.UserProfileServiceHeaplet

All Implemented Interfaces:

Heaplet

public class UserProfileServiceHeaplet
extends GenericHeaplet

Creates and initializes a UserProfileService in a heap environment. Configuration options:

 {
      "type": "UserProfileService",
      "config": {
          "amService"           : AmService              [REQUIRED]
          "realm"               : Realm                  [OPTIONAL - realm where to find subjects, defaults to
                                                                     the realm specified in AmService.]
          "profileAttributes"   : string list            [OPTIONAL - the list of user's profile attributes to
                                                                     request from Access Management.
                                                                     Default retrieves all attributes.
          "cache"               : object                 [OPTIONAL - By default the user profile cache is disabled.]
          {
              "enabled" :             expression(boolean)   [OPTIONAL - Allow to disable the cache while still
                                                                        keeping the configuration for later use.
                                                                        Default is false.]
              "maximumSize" :         expression(long)      [OPTIONAL - Sets the maximum size of the user
                                                                        profile cache.]
              "maximumTimeToCache" :  expression(long)      [OPTIONAL - Sets the maximum time to cache a
                                                                        user profile.]
              "executor" :            executor              [OPTIONAL - By default,
                                                      {@link java.util.concurrent.ForkJoinPool#commonPool()} is used.]
          }
      }
  }
  
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME	Public name used by resolver.

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

config, heap, name, object, qualified

Constructor Summary

Constructors

Constructor	Description
UserProfileServiceHeaplet()

Method Summary

Modifier and Type	Method	Description
Object	create()	Called to request the heaplet create an object.
void	destroy()	Releases observability resources: deregisters the HTTP endpoint, all meters, and startup metrics.

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

create, endpointRegistry, evaluatedWithHeapProperties, expression, getConfig, getHeap, getType, initialBindings, meterRegistryHolder, start

Methods inherited from class java.lang.Object

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

Field Details

NAME

public static final String NAME

Public name used by resolver.

See Also:

• Constant Field Values

Constructor Details

UserProfileServiceHeaplet

public UserProfileServiceHeaplet()

Method Details

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.

destroy

public void destroy()

Description copied from class: GenericHeaplet

Releases observability resources: deregisters the HTTP endpoint, all meters, and startup metrics.

Subclasses that override this method must call super.destroy() last, after releasing their own domain resources. This ensures that monitoring remains active for the full lifetime of those resources and that any metrics emitted during shutdown are not lost.

Specified by:

destroy in interface Heaplet

Overrides:

destroy in class GenericHeaplet