Package org.forgerock.json.resource

Interface CrestApplication

public interface CrestApplication

Declare a CREST Application. This interface binds together the CREST ConnectionFactory that will be used to connect to the API, and the API ID and Version that will be used when describing it.

Method Summary

Modifier and Type	Method	Description
String	getApiId()	Get the API ID, that will be used in the ApiDescription.
String	getApiVersion()	Get the API Version, that will be used in the ApiDescription.
ConnectionFactory	getConnectionFactory()	Get the connection factory for the application.

Method Details

getConnectionFactory

ConnectionFactory getConnectionFactory()

Get the connection factory for the application.

Returns:

The factory.

getApiId

String getApiId()

Get the API ID, that will be used in the ApiDescription.

Returns:

The ID.

getApiVersion

String getApiVersion()

Get the API Version, that will be used in the ApiDescription.

Returns:

The Version.