Class AbstractApiComponent<E extends Enum<E> & ApiName,T,S extends ApiCollection<E,T>>
java.lang.Object
org.apache.camel.support.service.BaseService
org.apache.camel.support.service.ServiceSupport
org.apache.camel.support.DefaultComponent
org.apache.camel.support.component.AbstractApiComponent<E,T,S>
- All Implemented Interfaces:
AutoCloseable
,org.apache.camel.CamelContextAware
,org.apache.camel.Component
,org.apache.camel.Service
,org.apache.camel.ShutdownableService
,org.apache.camel.spi.HasCamelContext
,org.apache.camel.StatefulService
,org.apache.camel.SuspendableService
public abstract class AbstractApiComponent<E extends Enum<E> & ApiName,T,S extends ApiCollection<E,T>>
extends DefaultComponent
Abstract base class for API Component Camel
Component
classes.-
Field Summary
Fields inherited from class org.apache.camel.support.service.BaseService
BUILT, FAILED, INITIALIZED, INITIALIZING, lock, NEW, SHUTDOWN, SHUTTING_DOWN, STARTED, STARTING, status, STOPPED, STOPPING, SUSPENDED, SUSPENDING
-
Constructor Summary
ModifierConstructorDescriptionAbstractApiComponent
(Class<? extends org.apache.camel.Endpoint> endpointClass, Class<E> apiNameClass, S collection) Deprecated.protected
AbstractApiComponent
(Class<E> apiNameClass, S collection) Creates a new AbstractApiComponentAbstractApiComponent
(org.apache.camel.CamelContext context, Class<? extends org.apache.camel.Endpoint> endpointClass, Class<E> apiNameClass, S collection) Deprecated.protected
AbstractApiComponent
(org.apache.camel.CamelContext context, Class<E> apiNameClass, S collection) Creates a new AbstractApiComponent -
Method Summary
Modifier and TypeMethodDescriptionprotected void
afterPropertiesSet
(T endpointConfiguration) protected abstract org.apache.camel.Endpoint
createEndpoint
(String uri, String methodName, E apiName, T endpointConfiguration) protected org.apache.camel.Endpoint
A factory method allowing derived components to create a new endpoint from the given URI, remaining path and optional parametersprotected T
createEndpointConfiguration
(E name) protected abstract E
getApiName
(String apiNameStr) void
setConfiguration
(T configuration) Methods inherited from class org.apache.camel.support.DefaultComponent
afterConfiguration, createEndpoint, createEndpoint, doBuild, doInit, getAndRemoveOrResolveReferenceParameter, getAndRemoveOrResolveReferenceParameter, getAndRemoveParameter, getAndRemoveParameter, getCamelContext, getComponentPropertyConfigurer, getDefaultName, getEndpointPropertyConfigurer, getExtension, getSupportedExtensions, ifStartsWithReturnRemainder, isAutowiredEnabled, isBridgeErrorHandler, isLazyStartProducer, registerExtension, registerExtension, resolveAndRemoveReferenceListParameter, resolveAndRemoveReferenceListParameter, resolveAndRemoveReferenceParameter, resolveAndRemoveReferenceParameter, resolveRawParameterValues, setAutowiredEnabled, setBridgeErrorHandler, setCamelContext, setLazyStartProducer, setProperties, setProperties, setProperties, useIntrospectionOnEndpoint, useRawUri, validateParameters, validateURI
Methods inherited from class org.apache.camel.support.service.BaseService
build, doFail, doLifecycleChange, doResume, doShutdown, doStart, doStop, doSuspend, fail, getStatus, init, isBuild, 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.Service
build, close, init, start, stop
Methods inherited from interface org.apache.camel.ShutdownableService
shutdown
Methods inherited from interface org.apache.camel.StatefulService
getStatus, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isSuspending
Methods inherited from interface org.apache.camel.SuspendableService
isSuspended, resume, suspend
-
Field Details
-
configuration
-
collection
-
apiNameClass
-
-
Constructor Details
-
AbstractApiComponent
@Deprecated public AbstractApiComponent(Class<? extends org.apache.camel.Endpoint> endpointClass, Class<E> apiNameClass, S collection) Deprecated.Deprecated constructor for AbstractApiComponent.- Parameters:
endpointClass
- This is deprecated. Do not useapiNameClass
- The API name classcollection
- The collection of API methods
-
AbstractApiComponent
@Deprecated public AbstractApiComponent(org.apache.camel.CamelContext context, Class<? extends org.apache.camel.Endpoint> endpointClass, Class<E> apiNameClass, S collection) Deprecated.Deprecated constructor for AbstractApiComponent.- Parameters:
context
- The CamelContextendpointClass
- This is deprecated. Do not useapiNameClass
- The API name classcollection
- The collection of API methods
-
AbstractApiComponent
Creates a new AbstractApiComponent- Parameters:
apiNameClass
- The API name classcollection
- The collection of API methods
-
AbstractApiComponent
protected AbstractApiComponent(org.apache.camel.CamelContext context, Class<E> apiNameClass, S collection) Creates a new AbstractApiComponent- Parameters:
context
- The CamelContextapiNameClass
- The API name classcollection
- The collection of API methods
-
-
Method Details
-
createEndpoint
protected org.apache.camel.Endpoint createEndpoint(String uri, String remaining, Map<String, Object> parameters) throws ExceptionDescription 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 classDefaultComponent
- Parameters:
uri
- the full URI of the endpointremaining
- the remaining part of the URI without the query parameters or component prefixparameters
- 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
-
afterPropertiesSet
-
getApiName
-
createEndpoint
-
createEndpointConfiguration
- Throws:
Exception
-
getConfiguration
-
setConfiguration
-
AbstractApiComponent(Class, ApiCollection)