Package | Description |
---|---|
org.forgerock.http |
Models and manages elements of the Hypertext Transfer Protocol.
|
org.forgerock.http.swagger |
Classes to support OpenAPI API Descriptions using Swagger.
|
org.forgerock.json.resource |
Classes and interfaces for core types including connections, request
handlers, resources, and their exceptions.
|
org.forgerock.services.descriptor |
Classes that allow services to be described.
|
org.forgerock.services.routing |
This package provides a simple framework for implementing routers.
|
Modifier and Type | Method and Description |
---|---|
ApiProducer<io.swagger.models.Swagger> |
DescribedHttpApplication.getApiProducer()
Provides the OpenAPI descriptor producer with which to produce the API.
|
ApiProducer<D> |
ApiProducer.newChildProducer(String idFragment)
Create a child producer with the same type, but with the extra ID fragment.
|
Modifier and Type | Method and Description |
---|---|
static DescribedHttpApplication |
Applications.describedHttpApplication(Handler handler,
Factory<Buffer> storage,
ApiProducer<io.swagger.models.Swagger> apiProducer)
Create a simple
DescribedHttpApplication that just returns the provided arguments from the appropriate
methods. |
Modifier and Type | Class and Description |
---|---|
class |
SwaggerApiProducer
An API Producer for APIs that use the Swagger model implementation of the OpenAPI specification.
|
Modifier and Type | Method and Description |
---|---|
ApiProducer<io.swagger.models.Swagger> |
SwaggerApiProducer.newChildProducer(String subPath) |
Modifier and Type | Method and Description |
---|---|
org.forgerock.api.models.ApiDescription |
FilterChain.api(ApiProducer<org.forgerock.api.models.ApiDescription> producer) |
org.forgerock.api.models.ApiDescription |
DescribedSyncRequestHandlerAdapter.api(ApiProducer<org.forgerock.api.models.ApiDescription> producer) |
org.forgerock.api.models.ApiDescription |
AbstractConnectionWrapper.api(ApiProducer<org.forgerock.api.models.ApiDescription> producer) |
Modifier and Type | Method and Description |
---|---|
D |
Describable.api(ApiProducer<D> producer)
Provide the API description for the component.
|
Modifier and Type | Method and Description |
---|---|
D |
AbstractRouter.api(ApiProducer<D> producer) |
protected D |
AbstractRouter.buildApi(ApiProducer<D> producer)
Build an api with a given
ApiProducer . |
abstract <D> D |
RouteMatcher.transformApi(D descriptor,
ApiProducer<D> producer)
Transform the API Descriptor as appropriate for the parent router's view of the child routes.
|
<D> D |
DelegatingRouteMatcher.transformApi(D descriptor,
ApiProducer<D> producer) |
Copyright 2011-2017 ForgeRock AS.