org.apache.camel.impl
Class DefaultComponent

java.lang.Object
  extended by org.apache.camel.impl.ServiceSupport
      extended by org.apache.camel.impl.DefaultComponent
All Implemented Interfaces:
CamelContextAware, Component, Service, ShutdownableService
Direct Known Subclasses:
ApnsComponent, BeanComponent, BeanValidatorComponent, BrowseComponent, CacheComponent, CometdComponent, DataSetComponent, DigitalSignatureComponent, DirectComponent, DnsComponent, EventAdminComponent, EventComponent, ExecComponent, FeedComponent, GAuthComponent, GenericFileComponent, GLoginComponent, GMailComponent, HazelcastComponent, HdfsComponent, HeaderFilterStrategyComponent, IrcComponent, JavaSpaceComponent, JcrComponent, JdbcComponent, JmsComponent, JMXComponent, JpaComponent, Jt400Component, KestrelComponent, LanguageComponent, LdapComponent, LocalContextComponent, LogComponent, LuceneComponent, MailComponent, MinaComponent, MockComponent, MyBatisComponent, NagiosComponent, NettyComponent, PaxLoggingComponent, PrinterComponent, PropertiesComponent, QualifiedContextComponent, QuartzComponent, QuickfixjComponent, RefComponent, ResourceBasedComponent, RmiComponent, RouteboxComponent, S3Component, SedaComponent, SipComponent, SmppComponent, SnmpComponent, SnsComponent, SpringIntegrationComponent, SpringWebserviceComponent, SqlComponent, SqsComponent, StreamComponent, TestComponent, TimerComponent, XmppComponent

public abstract class DefaultComponent
extends ServiceSupport
implements Component

Default component to use for base for components implementations.

Version:

Constructor Summary
DefaultComponent()
           
DefaultComponent(CamelContext context)
           
 
Method Summary
protected  void afterConfiguration(String uri, String remaining, Endpoint endpoint, Map<String,Object> parameters)
          Strategy to do post configuration logic.
 Endpoint createEndpoint(String uri)
          Attempt to resolve an endpoint for the given URI if the component is capable of handling the URI
protected abstract  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
protected  void doStart()
           
protected  void doStop()
           
<T> T
getAndRemoveParameter(Map<String,Object> parameters, String key, Class<T> type)
          Gets the parameter and remove it from the parameter map.
<T> T
getAndRemoveParameter(Map<String,Object> parameters, String key, Class<T> type, T defaultValue)
          Gets the parameter and remove it from the parameter map.
 CamelContext getCamelContext()
          Get the CamelContext
protected  String ifStartsWithReturnRemainder(String prefix, String text)
          Returns the reminder of the text if it starts with the prefix.
<T> List<T>
resolveAndRemoveReferenceListParameter(Map<String,Object> parameters, String key, Class<T> elementType)
          Resolves a reference list parameter in the registry and removes it from the map.
<T> List<T>
resolveAndRemoveReferenceListParameter(Map<String,Object> parameters, String key, Class<T> elementType, List<T> defaultValue)
          Resolves a reference list parameter in the registry and removes it from the map.
<T> T
resolveAndRemoveReferenceParameter(Map<String,Object> parameters, String key, Class<T> type)
          Resolves a reference parameter in the registry and removes it from the map.
<T> T
resolveAndRemoveReferenceParameter(Map<String,Object> parameters, String key, Class<T> type, T defaultValue)
          Resolves a reference parameter in the registry and removes it from the map.
 void setCamelContext(CamelContext context)
          Injects the CamelContext
protected  void setProperties(Object bean, Map<String,Object> parameters)
          Sets the bean properties on the given bean
protected  boolean useIntrospectionOnEndpoint()
          Derived classes may wish to overload this to prevent the default introspection of URI parameters on the created Endpoint instance
protected  void validateParameters(String uri, Map<String,Object> parameters, String optionPrefix)
          Strategy for validation of parameters, that was not able to be resolved to any endpoint options.
protected  void validateURI(String uri, String path, Map<String,Object> parameters)
          Strategy for validation of the uri when creating the endpoint.
 
Methods inherited from class org.apache.camel.impl.ServiceSupport
addChildService, doResume, doShutdown, doSuspend, getStatus, getVersion, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isSuspended, isSuspending, removeChildService, resume, shutdown, start, start, stop, suspend
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DefaultComponent

public DefaultComponent()

DefaultComponent

public DefaultComponent(CamelContext context)
Method Detail

createEndpoint

public Endpoint createEndpoint(String uri)
                        throws Exception
Description copied from interface: Component
Attempt to resolve an endpoint for the given URI if the component is capable of handling the URI

Specified by:
createEndpoint in interface Component
Parameters:
uri - the URI to create
Returns:
a newly created endpoint or null if this component cannot create instances of the given uri
Throws:
Exception - is thrown if error creating the endpoint

afterConfiguration

protected void afterConfiguration(String uri,
                                  String remaining,
                                  Endpoint endpoint,
                                  Map<String,Object> parameters)
                           throws Exception
Strategy to do post configuration logic.

Can be used to construct an URI based on the remaining parameters. For example the parameters that configures the endpoint have been removed from the parameters which leaves only the additional parameters left.

Parameters:
endpoint - the created endpoint
parameters - the remaining parameters after the endpoint has been created and parsed the parameters
Throws:
Exception - can be thrown to indicate error creating the endpoint

validateParameters

protected void validateParameters(String uri,
                                  Map<String,Object> parameters,
                                  String optionPrefix)
Strategy for validation of parameters, that was not able to be resolved to any endpoint options.

Parameters:
uri - the uri - the uri the end user provided untouched
parameters - the parameters, an empty map if no parameters given
optionPrefix - optional prefix to filter the parameters for validation. Use null for validate all.
Throws:
ResolveEndpointFailedException - should be thrown if the URI validation failed

validateURI

protected void validateURI(String uri,
                           String path,
                           Map<String,Object> parameters)
Strategy for validation of the uri when creating the endpoint.

Parameters:
uri - the uri - the uri the end user provided untouched
path - the path - part after the scheme
parameters - the parameters, an empty map if no parameters given
Throws:
ResolveEndpointFailedException - should be thrown if the URI validation failed

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 context)
Description copied from interface: CamelContextAware
Injects the CamelContext

Specified by:
setCamelContext in interface CamelContextAware
Parameters:
context - the Camel context

doStart

protected void doStart()
                throws Exception
Specified by:
doStart in class ServiceSupport
Throws:
Exception

doStop

protected void doStop()
               throws Exception
Specified by:
doStop in class ServiceSupport
Throws:
Exception

createEndpoint

protected abstract Endpoint createEndpoint(String uri,
                                           String remaining,
                                           Map<String,Object> parameters)
                                    throws Exception
A factory method allowing derived components to create a new endpoint from the given URI, remaining path and optional parameters

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

setProperties

protected void setProperties(Object bean,
                             Map<String,Object> parameters)
                      throws Exception
Sets the bean properties on the given bean

Parameters:
bean - the bean
parameters - properties to set
Throws:
Exception

useIntrospectionOnEndpoint

protected boolean useIntrospectionOnEndpoint()
Derived classes may wish to overload this to prevent the default introspection of URI parameters on the created Endpoint instance


getAndRemoveParameter

public <T> T getAndRemoveParameter(Map<String,Object> parameters,
                                   String key,
                                   Class<T> type)
Gets the parameter and remove it from the parameter map. This method doesn't resolve reference parameters in the registry.

Parameters:
parameters - the parameters
key - the key
type - the requested type to convert the value from the parameter
Returns:
the converted value parameter, null if parameter does not exists.
See Also:
resolveAndRemoveReferenceParameter(Map, String, Class)

getAndRemoveParameter

public <T> T getAndRemoveParameter(Map<String,Object> parameters,
                                   String key,
                                   Class<T> type,
                                   T defaultValue)
Gets the parameter and remove it from the parameter map. This method doesn't resolve reference parameters in the registry.

Parameters:
parameters - the parameters
key - the key
type - the requested type to convert the value from the parameter
defaultValue - use this default value if the parameter does not contain the key
Returns:
the converted value parameter
See Also:
resolveAndRemoveReferenceParameter(Map, String, Class, Object)

resolveAndRemoveReferenceParameter

public <T> T resolveAndRemoveReferenceParameter(Map<String,Object> parameters,
                                                String key,
                                                Class<T> type)
Resolves a reference parameter in the registry and removes it from the map.

Type Parameters:
T - type of object to lookup in the registry.
Parameters:
parameters - parameter map.
key - parameter map key.
type - type of object to lookup in the registry.
Returns:
the referenced object or null if the parameter map doesn't contain the key.
Throws:
IllegalArgumentException - if a non-null reference was not found in registry.

resolveAndRemoveReferenceParameter

public <T> T resolveAndRemoveReferenceParameter(Map<String,Object> parameters,
                                                String key,
                                                Class<T> type,
                                                T defaultValue)
Resolves a reference parameter in the registry and removes it from the map.

Type Parameters:
T - type of object to lookup in the registry.
Parameters:
parameters - parameter map.
key - parameter map key.
type - type of object to lookup in the registry.
defaultValue - default value to use if the parameter map doesn't contain the key.
Returns:
the referenced object or the default value.
Throws:
IllegalArgumentException - if referenced object was not found in registry.

resolveAndRemoveReferenceListParameter

public <T> List<T> resolveAndRemoveReferenceListParameter(Map<String,Object> parameters,
                                                          String key,
                                                          Class<T> elementType)
Resolves a reference list parameter in the registry and removes it from the map.

Parameters:
parameters - parameter map.
key - parameter map key.
elementType - result list element type.
Returns:
the list of referenced objects or an empty list if the parameter map doesn't contain the key.
Throws:
IllegalArgumentException - if any of the referenced objects was not found in registry.
See Also:
EndpointHelper.resolveReferenceListParameter(CamelContext, String, Class)

resolveAndRemoveReferenceListParameter

public <T> List<T> resolveAndRemoveReferenceListParameter(Map<String,Object> parameters,
                                                          String key,
                                                          Class<T> elementType,
                                                          List<T> defaultValue)
Resolves a reference list parameter in the registry and removes it from the map.

Parameters:
parameters - parameter map.
key - parameter map key.
elementType - result list element type.
defaultValue - default value to use if the parameter map doesn't contain the key.
Returns:
the list of referenced objects or the default value.
Throws:
IllegalArgumentException - if any of the referenced objects was not found in registry.
See Also:
EndpointHelper.resolveReferenceListParameter(CamelContext, String, Class)

ifStartsWithReturnRemainder

protected String ifStartsWithReturnRemainder(String prefix,
                                             String text)
Returns the reminder of the text if it starts with the prefix.

Is useable for string parameters that contains commands.

Parameters:
prefix - the prefix
text - the text
Returns:
the reminder, or null if no reminder


Apache CAMEL