Package org.forgerock.openig.fapi.audit

Class FapiAuditContext

java.lang.Object
org.forgerock.services.context.AbstractContext
org.forgerock.openig.fapi.audit.FapiAuditContext
All Implemented Interfaces:
Context
public class FapiAuditContext extends AbstractContext
A context for audit information about FAPI request.

  • Constructor Details

    • FapiAuditContext

      public FapiAuditContext(Context parent)
      Create an empty FapiAuditContext.
      Parameters:
      parent - the parent Context.

  • Method Details

    • getInteractionId

      public Optional<String> getInteractionId()
      Returns the interaction id or empty.
      Returns:
      the interaction id or empty

    • setInteractionId

      public FapiAuditContext setInteractionId(String interactionId)
      Sets the interaction id of request which must be non-null.
      Parameters:
      interactionId - The interaction id of request
      Returns:
      the ApiClientFapiContext instance

    • getApiClient

      public Optional<ApiClient> getApiClient()
      Gets the ApiClient or empty if null.
      Returns:
      the ApiClient or empty if null

    • setApiClient

      public FapiAuditContext setApiClient(ApiClient apiClient)
      Sets the ApiClient which must be non-null.
      Parameters:
      apiClient - The ApiClient built from request
      Returns:
      the ApiClientFapiContext instance

    • getContextualInfo

      public Map<String,Object> getContextualInfo()
      Returns map of additional custom contextual information about a request.
      Returns:
      map of additional custom contextual information about a request

    • addContextualInfo

      public FapiAuditContext addContextualInfo(String key, Object value)
      Add additional custom key and value to the contextual information.
      Parameters:
      key - the key of the custom information
      value - the value of the custom information
      Returns:
      FapiAuditFilter