org.apache.camel.component.rest

Class RestComponent

java.lang.Object

org.apache.camel.support.service.ServiceSupport

org.apache.camel.support.DefaultComponent

org.apache.camel.component.rest.RestComponent

All Implemented Interfaces:

org.apache.camel.CamelContextAware, org.apache.camel.Component, org.apache.camel.Service, org.apache.camel.ShutdownableService, org.apache.camel.StatefulService, org.apache.camel.SuspendableService

@Component(value="rest")
 @Metadata(label="verifiers",
          enums="parameters,connectivity")
public class RestComponent
extends org.apache.camel.support.DefaultComponent

Rest component.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_REST_CONFIGURATION_ID

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

FAILED, INITIALIZED, lock, log, NEW, SHUTDOWN, SHUTTINGDOWN, STARTED, STARTING, status, STOPPED, STOPPING, SUSPENDED, SUSPENDING

Constructor Summary

Constructors

Constructor and Description
RestComponent()

Method Summary

Modifier and Type	Method and Description
protected org.apache.camel.Endpoint	createEndpoint(String uri, String remaining, Map<String,Object> parameters)
String	getApiDoc()
String	getComponentName()
String	getHost()
org.apache.camel.component.extension.ComponentVerifierExtension	getVerifier()
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.support.DefaultComponent

afterConfiguration, 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.service.ServiceSupport

doInit, doResume, doShutdown, doSuspend, getStatus, init, isInit, isNew, isRunAllowed, isShutdown, isStarted, isStarting, isStartingOrStarted, 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.Component

trySetComponent

Methods inherited from interface org.apache.camel.CamelContextAware

trySetCamelContext

Field Detail

DEFAULT_REST_CONFIGURATION_ID

public static final String DEFAULT_REST_CONFIGURATION_ID

See Also:

Constant Field Values

Constructor Detail

RestComponent

public RestComponent()

Method Detail

createEndpoint

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

Specified by:

createEndpoint in class org.apache.camel.support.DefaultComponent

Throws:

Exception

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 org.apache.camel.component.extension.ComponentVerifierExtension getVerifier()