Package org.apache.camel.spi
Interface RestRegistry
-
- All Superinterfaces:
AutoCloseable
,Service
public interface RestRegistry extends Service
A registry of all REST services running within theCamelContext
which have been defined and created using the Rest DSL.
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interface
RestRegistry.RestService
Details about the REST service
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addRestService(Consumer consumer, String url, String baseUrl, String basePath, String uriTemplate, String method, String consumes, String produces, String inType, String outType, String routeId, String description)
Adds a new REST service to the registry.String
apiDocAsJson()
Outputs the Rest services API documentation in JSON (requires camel-swagger-java on classpath)List<RestRegistry.RestService>
listAllRestServices()
List all REST services from this registry.void
removeRestService(Consumer consumer)
Removes the REST service from the registryint
size()
Number of rest services in the registry.
-
-
-
Method Detail
-
addRestService
void addRestService(Consumer consumer, String url, String baseUrl, String basePath, String uriTemplate, String method, String consumes, String produces, String inType, String outType, String routeId, String description)
Adds a new REST service to the registry.- Parameters:
consumer
- the consumerurl
- the absolute url of the REST servicebaseUrl
- the base url of the REST servicebasePath
- the base pathuriTemplate
- the uri templatemethod
- the HTTP methodconsumes
- optional details about what media-types the REST service acceptsproduces
- optional details about what media-types the REST service returnsinType
- optional detail input binding to a FQN class nameoutType
- optional detail output binding to a FQN class namerouteId
- the id of the route this rest service will be usingdescription
- optional description about the service
-
removeRestService
void removeRestService(Consumer consumer)
Removes the REST service from the registry- Parameters:
consumer
- the consumer
-
listAllRestServices
List<RestRegistry.RestService> listAllRestServices()
List all REST services from this registry.- Returns:
- all the REST services
-
size
int size()
Number of rest services in the registry.- Returns:
- number of rest services in the registry.
-
apiDocAsJson
String apiDocAsJson()
Outputs the Rest services API documentation in JSON (requires camel-swagger-java on classpath)- Returns:
- the API docs in JSon, or null if camel-swagger-java is not on classpath
-
-