Package org.forgerock.json.resource
Interface CrestApplication
-
public interface CrestApplication
Declare a CREST Application. This interface binds together the CRESTConnectionFactory
that will be used to connect to the API, and the API ID and Version that will be used when describing it.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description String
getApiId()
Get the API ID, that will be used in theApiDescription
.String
getApiVersion()
Get the API Version, that will be used in theApiDescription
.ConnectionFactory
getConnectionFactory()
Get the connection factory for the application.
-
-
-
Method Detail
-
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 theApiDescription
.- Returns:
- The ID.
-
getApiVersion
String getApiVersion()
Get the API Version, that will be used in theApiDescription
.- Returns:
- The Version.
-
-