Package org.forgerock.openig.http

Class AdminHttpApplication

java.lang.Object

org.forgerock.openig.http.AdminHttpApplication

All Implemented Interfaces:

org.forgerock.http.DescribedHttpApplication, org.forgerock.http.HttpApplication

public class AdminHttpApplication
extends Object
implements org.forgerock.http.DescribedHttpApplication

Configuration class for the OpenIG Administration.

Constructor Summary

Constructors

Constructor	Description
AdminHttpApplication(String adminPrefix, org.forgerock.json.JsonValue config, Environment environment, RunMode mode)	Construct a AdminHttpApplication.

Method Summary

Modifier and Type	Method	Description
org.forgerock.http.swagger.SwaggerApiProducer	getApiProducer()	Needed to enforce generation of CREST APIs.
org.forgerock.util.Factory<org.forgerock.http.io.Buffer>	getBufferFactory()
EndpointRegistry	getEndpointRegistry()	Returns the API endpoint registry.
protected org.forgerock.http.routing.Router	getOpenIGRouter()	Returns the router that represents the /openig namespace (or whatever path/prefix value that was configured).
org.forgerock.http.Handler	start()
void	stop()

Methods inherited from class java.lang.Object

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

Constructor Detail

AdminHttpApplication

public AdminHttpApplication(String adminPrefix,
                            org.forgerock.json.JsonValue config,
                            Environment environment,
                            RunMode mode)
                     throws IOException

Construct a AdminHttpApplication.

Parameters:

adminPrefix - the prefix to use in the URL to access the admin endpoints

config - the admin configuration

environment - the OpenIG environment

mode - OpenIG run mode

Throws:

IOException - when initialization failed

Method Detail

start

public org.forgerock.http.Handler start()
                                 throws org.forgerock.http.HttpApplicationException

Specified by:

start in interface org.forgerock.http.HttpApplication

Throws:

org.forgerock.http.HttpApplicationException

getBufferFactory

public org.forgerock.util.Factory<org.forgerock.http.io.Buffer> getBufferFactory()

Specified by:

getBufferFactory in interface org.forgerock.http.HttpApplication

stop

public void stop()

Specified by:

stop in interface org.forgerock.http.HttpApplication

getEndpointRegistry

public EndpointRegistry getEndpointRegistry()

Returns the API endpoint registry.

Returns:

the API endpoint registry

getOpenIGRouter

protected org.forgerock.http.routing.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

getApiProducer

public org.forgerock.http.swagger.SwaggerApiProducer getApiProducer()

Needed to enforce generation of CREST APIs.

Specified by:

getApiProducer in interface org.forgerock.http.DescribedHttpApplication

Returns:

a swagger api producer.