org.apache.camel.component.rest

Class RestComponent

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.impl.DefaultComponent

org.apache.camel.component.rest.RestComponent

All Implemented Interfaces:

CamelContextAware, Component, Service, ShutdownableService, StatefulService, SuspendableService, VerifiableComponent

@Metadata(label="verifiers",
          enums="parameters,connectivity")
public class RestComponent
extends DefaultComponent
implements VerifiableComponent

Rest component.

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
RestComponent()

Method Summary

Modifier and Type	Method and Description
protected Endpoint	createEndpoint(String uri, String remaining, Map<String,Object> parameters) A factory method allowing derived components to create a new endpoint from the given URI, remaining path and optional parameters
String	getApiDoc()
String	getComponentName()
String	getHost()
ComponentVerifier	getVerifier() Get the ComponentVerifier
void	setApiDoc(String apiDoc) The swagger api doc resource to use.
void	setComponentName(String componentName) The Camel Rest component to use for the REST transport, such as restlet, spark-rest.
void	setHost(String host) Host and port of HTTP service to use (override host in swagger schema)

Methods inherited from class org.apache.camel.impl.DefaultComponent

afterConfiguration, createComponentConfiguration, createConfiguration, createEndpoint, doStart, doStop, getAndRemoveOrResolveReferenceParameter, getAndRemoveOrResolveReferenceParameter, getAndRemoveParameter, getAndRemoveParameter, getCamelContext, getExtension, getSupportedExtensions, ifStartsWithReturnRemainder, isResolvePropertyPlaceholders, preProcessUri, registerExtension, registerExtension, resolveAndRemoveReferenceListParameter, resolveAndRemoveReferenceListParameter, resolveAndRemoveReferenceParameter, resolveAndRemoveReferenceParameter, setCamelContext, setProperties, setProperties, setResolvePropertyPlaceholders, useIntrospectionOnEndpoint, useRawUri, validateParameters, validateURI

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

Constructor Detail

RestComponent

public RestComponent()

Method Detail

createEndpoint

protected Endpoint createEndpoint(String uri,
                                  String remaining,
                                  Map<String,Object> parameters)
                           throws Exception

Description copied from class: DefaultComponent

A factory method allowing derived components to create a new endpoint from the given URI, remaining path and optional parameters

Specified by:

createEndpoint in class DefaultComponent

Parameters:

uri - the full URI of the endpoint

remaining - the remaining part of the URI without the query parameters or component prefix

parameters - the optional parameters passed in

Returns:

a newly created endpoint or null if the endpoint cannot be created based on the inputs

Throws:

Exception - is thrown if error creating the endpoint

getComponentName

public String getComponentName()

setComponentName

public void setComponentName(String componentName)

The Camel Rest component to use for the REST transport, such as restlet, spark-rest. If no component has been explicit configured, then Camel will lookup if there is a Camel component that integrates with the Rest DSL, or if a org.apache.camel.spi.RestConsumerFactory (consumer) or org.apache.camel.spi.RestProducerFactory (producer) is registered in the registry. If either one is found, then that is being used.

getApiDoc

public String getApiDoc()

setApiDoc

public void setApiDoc(String apiDoc)

The swagger api doc resource to use. The resource is loaded from classpath by default and must be in JSon format.

getHost

public String getHost()

setHost

public void setHost(String host)

Host and port of HTTP service to use (override host in swagger schema)

getVerifier

public ComponentVerifier getVerifier()

Description copied from interface: VerifiableComponent

Get the ComponentVerifier

Specified by:

getVerifier in interface VerifiableComponent

Returns:

the Component Verifier