org.apache.camel.impl

Class DefaultRestRegistry

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.impl.DefaultRestRegistry

All Implemented Interfaces:

CamelContextAware, Service, ShutdownableService, RestRegistry, StatefulService, StaticService, SuspendableService

public class DefaultRestRegistry
extends ServiceSupport
implements StaticService, RestRegistry, CamelContextAware

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.camel.spi.RestRegistry

RestRegistry.RestService

Field Summary

Fields inherited from class org.apache.camel.support.ServiceSupport

shutdown, shuttingdown, started, starting, stopped, stopping, suspended, suspending

Constructor Summary

Constructors

Constructor and Description
DefaultRestRegistry()

Method Summary

Methods

Modifier and Type	Method and 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)
protected void	doStart() Implementations override this method to support customized start/stop.
protected void	doStop() Implementations override this method to support customized start/stop.
CamelContext	getCamelContext() Get the CamelContext
List<RestRegistry.RestService>	listAllRestServices() List all REST services from this registry.
void	removeRestService(Consumer consumer) Removes the REST service from the registry
void	setCamelContext(CamelContext camelContext) Injects the CamelContext
int	size() Number of rest services in the registry.

Methods inherited from class org.apache.camel.support.ServiceSupport

doResume, doShutdown, doSuspend, getStatus, getVersion, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isStoppingOrStopped, isSuspended, isSuspending, isSuspendingOrSuspended, resume, shutdown, start, stop, suspend

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.camel.Service

start, stop

Constructor Detail

DefaultRestRegistry

public DefaultRestRegistry()

Method Detail

addRestService

public 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)

Description copied from interface: RestRegistry

Adds a new REST service to the registry.

Specified by:

addRestService in interface RestRegistry

Parameters:

consumer - the consumer

url - the absolute url of the REST service

baseUrl - the base url of the REST service

basePath - the base path

uriTemplate - the uri template

method - the HTTP method

consumes - optional details about what media-types the REST service accepts

produces - optional details about what media-types the REST service returns

inType - optional detail input binding to a FQN class name

outType - optional detail output binding to a FQN class name

routeId - the id of the route this rest service will be using

description - optional description about the the service

removeRestService

public void removeRestService(Consumer consumer)

Description copied from interface: RestRegistry

Removes the REST service from the registry

Specified by:

removeRestService in interface RestRegistry

Parameters:

consumer - the consumer

listAllRestServices

public List<RestRegistry.RestService> listAllRestServices()

Description copied from interface: RestRegistry

List all REST services from this registry.

Specified by:

listAllRestServices in interface RestRegistry

Returns:

all the REST services

size

public int size()

Description copied from interface: RestRegistry

Number of rest services in the registry.

Specified by:

size in interface RestRegistry

Returns:

number of rest services in the registry.

apiDocAsJson

public String apiDocAsJson()

Description copied from interface: RestRegistry

Outputs the Rest services API documentation in JSon (requires camel-swagger-java on classpath)

Specified by:

apiDocAsJson in interface RestRegistry

Returns:

the API docs in JSon, or null if camel-swagger-java is not on classpath

getCamelContext

public CamelContext getCamelContext()

Description copied from interface: CamelContextAware

Get the CamelContext

Specified by:

getCamelContext in interface CamelContextAware

Returns:

camelContext the Camel context

setCamelContext

public void setCamelContext(CamelContext camelContext)

Description copied from interface: CamelContextAware

Injects the CamelContext

Specified by:

setCamelContext in interface CamelContextAware

Parameters:

camelContext - the Camel context

doStart

protected void doStart()
                throws Exception

Description copied from class: ServiceSupport

Implementations override this method to support customized start/stop.

Important: See ServiceSupport.doStop() for more details.

Specified by:

doStart in class ServiceSupport

Throws:

Exception

See Also:

ServiceSupport.doStop()

doStop

protected void doStop()
               throws Exception

Description copied from class: ServiceSupport

Implementations override this method to support customized start/stop.

Important: Camel will invoke this ServiceSupport.doStop() method when the service is being stopped. This method will also be invoked if the service is still in uninitialized state (eg has not been started). The method is always called to allow the service to do custom logic when the service is being stopped, such as when CamelContext is shutting down.

Specified by:

doStop in class ServiceSupport

Throws:

Exception

See Also:

ServiceSupport.doStart()