Package org.forgerock.api

Class CrestApiProducer

java.lang.Object

org.forgerock.api.CrestApiProducer

All Implemented Interfaces:

ApiProducer<ApiDescription>

public class CrestApiProducer
extends Object
implements ApiProducer<ApiDescription>

An ApiProducer implementation for CREST resources, that provides ApiDescription descriptors.

Constructor Summary

Constructors

Constructor	Description
CrestApiProducer(String id, String apiVersion)	Construct a new producer.
CrestApiProducer(String id, String apiVersion, LocalizableString description)	Construct a new producer.

Method Summary

Modifier and Type	Method	Description
ApiDescription	addApiInfo(ApiDescription api)
ApiDescription	merge(List<ApiDescription> descriptions)
ApiProducer<ApiDescription>	newChildProducer(String idFragment)
ApiDescription	withPath(ApiDescription api, String parentPath)
ApiDescription	withVersion(ApiDescription api, Version version)

Methods inherited from class java.lang.Object

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

Constructor Details

CrestApiProducer

public CrestApiProducer(String id,
 String apiVersion,
 LocalizableString description)

Construct a new producer.

Parameters:

id - The API ID fragment for this producer.

apiVersion - The version of the API being described.

description - The API description.

CrestApiProducer

public CrestApiProducer(String id,
 String apiVersion)

Construct a new producer.

Parameters:

id - The API ID fragment for this producer.

apiVersion - The version of the API being described.

Method Details

withPath

public ApiDescription withPath(ApiDescription api,
 String parentPath)

Specified by:

withPath in interface ApiProducer<ApiDescription>

withVersion

public ApiDescription withVersion(ApiDescription api,
 Version version)

Specified by:

withVersion in interface ApiProducer<ApiDescription>

merge

public ApiDescription merge(List<ApiDescription> descriptions)

Specified by:

merge in interface ApiProducer<ApiDescription>

addApiInfo

public ApiDescription addApiInfo(ApiDescription api)

Specified by:

addApiInfo in interface ApiProducer<ApiDescription>

newChildProducer

public ApiProducer<ApiDescription> newChildProducer(String idFragment)

Specified by:

newChildProducer in interface ApiProducer<ApiDescription>