Package org.forgerock.openig.http

Class AdminHttpApplication

java.lang.Object
org.forgerock.openig.http.AdminHttpApplication
All Implemented Interfaces:
DescribedHttpApplication, HttpApplication
public class AdminHttpApplication extends Object implements DescribedHttpApplication
Configuration class for the Identity Gateway Administration.

  • Constructor Details

    • AdminHttpApplication

      public AdminHttpApplication(String adminPrefix, JsonValue config, Environment environment, RunMode mode, org.forgerock.config.resolvers.PropertyResolver propertyResolver, org.forgerock.monitoring.api.instrument.MeterRegistry meterRegistry, HttpClientProvider httpClientProvider, WebSocketClientProvider webSocketClientProvider, Clock clock, IgTicker ticker, AsyncSessionManager sessionManager, ProductInfo productInfo) throws IOException, HttpApplicationException
      Construct a AdminHttpApplication.
      Parameters:
      adminPrefix - the prefix to use in the URL to access the admin endpoints
      config - the admin configuration
      environment - the IG environment
      mode - IG run mode
      propertyResolver - root property resolver
      meterRegistry - the meter registry
      httpClientProvider - The provider of HttpClient
      webSocketClientProvider - The WebSocket Client Provider
      clock - The clock to use
      ticker - The ticker to use
      sessionManager - The session manager to use
      productInfo - The product information
      Throws:
      IOException - when initialization failed
      HttpApplicationException - when initialization failed

  • Method Details

    • start

      public Handler start() throws HttpApplicationException
      Description copied from interface: HttpApplication
      Gets the root Handler that will handle all HTTP requests.

      The Handler returned from this method MUST be a singleton.

      Specified by:
      start in interface HttpApplication
      Returns:
      The Handler to handle HTTP requests.
      Throws:
      HttpApplicationException - If there is a problem constructing the root application Handler.

    • getBufferFactory

      public Factory<Buffer> getBufferFactory()
      Description copied from interface: HttpApplication
      Gets the Factory that will create temporary storage Buffers to handle the processing of requests.

      May return null indicating that the container should provide a default buffer factory.

      Specified by:
      getBufferFactory in interface HttpApplication
      Returns:
      A Buffer Factory or null.

    • stop

      public void stop()
      Description copied from interface: HttpApplication
      Called when HTTP application is shutdown.

      Implementation should use this method to clear up all remaining resources.

      Specified by:
      stop in interface HttpApplication

    • getEndpointRegistry

      public EndpointRegistry getEndpointRegistry()
      Returns the API endpoint registry.
      Returns:
      the API endpoint registry

    • getOpenIGRouter

      protected Router getOpenIGRouter()
      Returns the router that represents the /openig namespace (or whatever path/prefix value that was configured).
      Returns:
      the router that represents the /openig namespace

    • getHeap

      public Heap getHeap()
      Returns the heap based on the contents of the admin configuration.
      Returns:
      the heap based on the contents of the admin configuration.

    • getApiProducer

      public SwaggerApiProducer getApiProducer()
      Needed to enforce generation of CREST APIs.
      Specified by:
      getApiProducer in interface DescribedHttpApplication
      Returns:
      a swagger api producer.