org.apache.camel.component.properties
Class PropertiesComponent

java.lang.Object
  org.apache.camel.support.ServiceSupport
      org.apache.camel.impl.DefaultComponent
          org.apache.camel.component.properties.PropertiesComponent

All Implemented Interfaces:

CamelContextAware, Component, Service, ShutdownableService, StatefulService, SuspendableService

public class PropertiesComponent
extends DefaultComponent

The properties component.

Version:

Field Summary

static String	DEFAULT_PREFIX_TOKEN The default prefix token.
static String	DEFAULT_SUFFIX_TOKEN The default suffix token.
static String	OVERRIDE_PROPERTIES Key for stores special override properties that containers such as OSGi can store in the OSGi service registry
static String	PREFIX_TOKEN Deprecated. Use DEFAULT_PREFIX_TOKEN instead.
static String	SUFFIX_TOKEN Deprecated. Use DEFAULT_SUFFIX_TOKEN instead.

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

shutdown, shuttingdown, started, starting, stopped, stopping, suspended, suspending

Constructor Summary

PropertiesComponent()

PropertiesComponent(String... locations)

PropertiesComponent(String location)

Method Summary

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
protected void	doStop() Implementations override this method to support customized start/stop.
Properties	getInitialProperties()
String[]	getLocations()
Properties	getOverrideProperties()
String	getPrefixToken()
PropertiesParser	getPropertiesParser()
PropertiesResolver	getPropertiesResolver()
String	getPropertyPrefix()
String	getPropertySuffix()
String	getSuffixToken()
boolean	isCache()
boolean	isFallbackToUnaugmentedProperty()
boolean	isIgnoreMissingLocation()
String	parseUri(String uri)
String	parseUri(String uri, String... paths)
void	setCache(boolean cache)
void	setFallbackToUnaugmentedProperty(boolean fallbackToUnaugmentedProperty)
void	setIgnoreMissingLocation(boolean ignoreMissingLocation)
void	setInitialProperties(Properties initialProperties) Sets initial properties which will be used before any locations are resolved.
void	setLocation(String location)
void	setLocations(String[] locations)
void	setOverrideProperties(Properties overrideProperties) Sets a special list of override properties that take precedence and will use first, if a property exist.
void	setPrefixToken(String prefixToken) Sets the value of the prefix token used to identify properties to replace.
void	setPropertiesParser(PropertiesParser propertiesParser)
void	setPropertiesResolver(PropertiesResolver propertiesResolver)
void	setPropertyPrefix(String propertyPrefix)
void	setPropertySuffix(String propertySuffix)
void	setSuffixToken(String suffixToken) Sets the value of the suffix token used to identify properties to replace.

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

afterConfiguration, createComponentConfiguration, createConfiguration, createEndpoint, doStart, 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

Field Detail

DEFAULT_PREFIX_TOKEN

public static final String DEFAULT_PREFIX_TOKEN

The default prefix token.

See Also:

Constant Field Values

DEFAULT_SUFFIX_TOKEN

public static final String DEFAULT_SUFFIX_TOKEN

The default suffix token.

See Also:

Constant Field Values

PREFIX_TOKEN

@Deprecated
public static final String PREFIX_TOKEN

Deprecated. Use DEFAULT_PREFIX_TOKEN instead.

The default prefix token.

See Also:

Constant Field Values

SUFFIX_TOKEN

@Deprecated
public static final String SUFFIX_TOKEN

Deprecated. Use DEFAULT_SUFFIX_TOKEN instead.

The default suffix token.

See Also:

Constant Field Values

OVERRIDE_PROPERTIES

public static final String OVERRIDE_PROPERTIES

Key for stores special override properties that containers such as OSGi can store in the OSGi service registry

Constructor Detail

PropertiesComponent

public PropertiesComponent()

PropertiesComponent

public PropertiesComponent(String location)

PropertiesComponent

public PropertiesComponent(String... locations)

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

parseUri

public String parseUri(String uri)
                throws Exception

Throws:

Exception

parseUri

public String parseUri(String uri,
                       String... paths)
                throws Exception

Throws:

Exception

getLocations

public String[] getLocations()

setLocations

public void setLocations(String[] locations)

setLocation

public void setLocation(String location)

getPropertiesResolver

public PropertiesResolver getPropertiesResolver()

setPropertiesResolver

public void setPropertiesResolver(PropertiesResolver propertiesResolver)

getPropertiesParser

public PropertiesParser getPropertiesParser()

setPropertiesParser

public void setPropertiesParser(PropertiesParser propertiesParser)

isCache

public boolean isCache()

setCache

public void setCache(boolean cache)

getPropertyPrefix

public String getPropertyPrefix()

setPropertyPrefix

public void setPropertyPrefix(String propertyPrefix)

getPropertySuffix

public String getPropertySuffix()

setPropertySuffix

public void setPropertySuffix(String propertySuffix)

isFallbackToUnaugmentedProperty

public boolean isFallbackToUnaugmentedProperty()

setFallbackToUnaugmentedProperty

public void setFallbackToUnaugmentedProperty(boolean fallbackToUnaugmentedProperty)

isIgnoreMissingLocation

public boolean isIgnoreMissingLocation()

setIgnoreMissingLocation

public void setIgnoreMissingLocation(boolean ignoreMissingLocation)

getPrefixToken

public String getPrefixToken()

setPrefixToken

public void setPrefixToken(String prefixToken)

Sets the value of the prefix token used to identify properties to replace. Setting a value of null restores the default token (@link DEFAULT_PREFIX_TOKEN).

getSuffixToken

public String getSuffixToken()

setSuffixToken

public void setSuffixToken(String suffixToken)

Sets the value of the suffix token used to identify properties to replace. Setting a value of null restores the default token (@link DEFAULT_SUFFIX_TOKEN).

getInitialProperties

public Properties getInitialProperties()

setInitialProperties

public void setInitialProperties(Properties initialProperties)

Sets initial properties which will be used before any locations are resolved.

Parameters:

initialProperties - properties that are added first

getOverrideProperties

public Properties getOverrideProperties()

setOverrideProperties

public void setOverrideProperties(Properties overrideProperties)

Sets a special list of override properties that take precedence and will use first, if a property exist.

Parameters:

overrideProperties - properties that is used first

doStop

protected void doStop()
               throws Exception

Description copied from class: ServiceSupport

Implementations override this method to support customized start/stop.

Important: Camel will invoke this ServiceSupport.doStop() method when the service is being stopped. This method will also be invoked if the service is still in uninitialized state (eg has not been started). The method is always called to allow the service to do custom logic when the service is being stopped, such as when CamelContext is shutting down.

Overrides:

doStop in class DefaultComponent

Throws:

Exception

See Also:

ServiceSupport.doStart()