public class CrestApiProducer extends Object implements org.forgerock.http.ApiProducer<ApiDescription>
ApiProducer
implementation for CREST resources, that provides ApiDescription
descriptors.Constructor and Description |
---|
CrestApiProducer(String id,
String apiVersion)
Construct a new producer.
|
CrestApiProducer(String id,
String apiVersion,
LocalizableString description)
Construct a new producer.
|
Modifier and Type | Method and Description |
---|---|
ApiDescription |
addApiInfo(ApiDescription api) |
ApiDescription |
merge(List<ApiDescription> descriptions) |
org.forgerock.http.ApiProducer<ApiDescription> |
newChildProducer(String idFragment) |
ApiDescription |
withPath(ApiDescription api,
String parentPath) |
ApiDescription |
withVersion(ApiDescription api,
org.forgerock.http.routing.Version version) |
public CrestApiProducer(String id, String apiVersion, LocalizableString description)
id
- The API ID fragment for this producer.apiVersion
- The version of the API being described.description
- The API description.public ApiDescription withPath(ApiDescription api, String parentPath)
withPath
in interface org.forgerock.http.ApiProducer<ApiDescription>
public ApiDescription withVersion(ApiDescription api, org.forgerock.http.routing.Version version)
withVersion
in interface org.forgerock.http.ApiProducer<ApiDescription>
public ApiDescription merge(List<ApiDescription> descriptions)
merge
in interface org.forgerock.http.ApiProducer<ApiDescription>
public ApiDescription addApiInfo(ApiDescription api)
addApiInfo
in interface org.forgerock.http.ApiProducer<ApiDescription>
public org.forgerock.http.ApiProducer<ApiDescription> newChildProducer(String idFragment)
newChildProducer
in interface org.forgerock.http.ApiProducer<ApiDescription>
Copyright 2010-2020 ForgeRock AS.