org.apache.camel.impl
Class UriEndpointComponent
java.lang.Object
org.apache.camel.support.ServiceSupport
org.apache.camel.impl.DefaultComponent
org.apache.camel.impl.UriEndpointComponent
- All Implemented Interfaces:
- CamelContextAware, Component, Service, ShutdownableService, StatefulService, SuspendableService
- Direct Known Subclasses:
- BeanComponent, BrowseComponent, ControlBusComponent, DataFormatComponent, DataSetComponent, DirectComponent, DirectVmComponent, GenericFileComponent, LanguageComponent, LogComponent, MockComponent, SedaComponent, TestComponent, TimerComponent, XsltComponent
public abstract class UriEndpointComponent
- extends DefaultComponent
A component implementation for endpoints which are annotated with UriEndpoint to describe
their configurable parameters via annotations
Method Summary |
ComponentConfiguration |
createComponentConfiguration()
Creates a configuration helper object for a component that lets you configure the various
URI and parameter values; then create the full URI for it, create a new Endpoint from it
or configure an existing Endpoint from the values. |
static SortedMap<String,ParameterConfiguration> |
createParameterConfigurationMap(Class<? extends Endpoint> endpointClass)
Returns a newly created sorted map, indexed by name of all the parameter configurations
of the given endpoint class using introspection for the various annotations like
UriEndpoint , UriParam , UriParams |
Class<? extends Endpoint> |
getEndpointClass()
|
SortedMap<String,ParameterConfiguration> |
getParameterConfigurationMap()
Returns the sorted map of all the URI query parameter names to their ParameterConfiguration objects |
protected static void |
populateParameterConfigurationMap(SortedMap<String,ParameterConfiguration> parameterMap,
Class<?> aClass,
String prefix)
|
void |
setEndpointClass(Class<? extends Endpoint> endpointClass)
To use a specific endpoint class, instead of what has been provided by the constructors. |
Methods inherited from class org.apache.camel.impl.DefaultComponent |
afterConfiguration, createConfiguration, createEndpoint, createEndpoint, doStart, doStop, getAndRemoveOrResolveReferenceParameter, getAndRemoveOrResolveReferenceParameter, getAndRemoveParameter, getAndRemoveParameter, getCamelContext, ifStartsWithReturnRemainder, preProcessUri, resolveAndRemoveReferenceListParameter, resolveAndRemoveReferenceListParameter, resolveAndRemoveReferenceParameter, resolveAndRemoveReferenceParameter, setCamelContext, setProperties, 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, resume, shutdown, start, stop, suspend |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
UriEndpointComponent
public UriEndpointComponent(Class<? extends Endpoint> endpointClass)
UriEndpointComponent
public UriEndpointComponent(CamelContext context,
Class<? extends Endpoint> endpointClass)
setEndpointClass
public void setEndpointClass(Class<? extends Endpoint> endpointClass)
- To use a specific endpoint class, instead of what has been provided by the constructors.
- Parameters:
endpointClass
- the endpoint class to use
createComponentConfiguration
public ComponentConfiguration createComponentConfiguration()
- Description copied from interface:
Component
- Creates a configuration helper object for a component that lets you configure the various
URI and parameter values; then create the full URI for it, create a new Endpoint from it
or configure an existing Endpoint from the values.
This method is intended to be used in cases where there is not yet a full URI to
configure an endpoint yet; but rather there are a number of parameters to configure
to then build up a new URI or directly create an Endpoint from the parameter values.
- Specified by:
createComponentConfiguration
in interface Component
- Overrides:
createComponentConfiguration
in class DefaultComponent
createParameterConfigurationMap
public static SortedMap<String,ParameterConfiguration> createParameterConfigurationMap(Class<? extends Endpoint> endpointClass)
- Returns a newly created sorted map, indexed by name of all the parameter configurations
of the given endpoint class using introspection for the various annotations like
UriEndpoint
, UriParam
, UriParams
populateParameterConfigurationMap
protected static void populateParameterConfigurationMap(SortedMap<String,ParameterConfiguration> parameterMap,
Class<?> aClass,
String prefix)
getEndpointClass
public Class<? extends Endpoint> getEndpointClass()
getParameterConfigurationMap
public SortedMap<String,ParameterConfiguration> getParameterConfigurationMap()
- Returns the sorted map of all the URI query parameter names to their
ParameterConfiguration
objects
Apache Camel