org.apache.camel.component.properties

Class PropertiesComponent

java.lang.Object

org.apache.camel.support.service.ServiceSupport

org.apache.camel.support.DefaultComponent

org.apache.camel.component.properties.PropertiesComponent

All Implemented Interfaces:

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

@Component(value="properties")
public class PropertiesComponent
extends org.apache.camel.support.DefaultComponent
implements org.apache.camel.spi.PropertiesComponent

The Properties Component allows you to use property placeholders when defining Endpoint URIs

Property Summary

Type	Property and Description
boolean	isFallbackToUnaugmented Gets the value of the property fallbackToUnaugmentedProperty.

Field Summary

Fields

Modifier and Type	Field and Description
static int	ENVIRONMENT_VARIABLES_MODE_FALLBACK Check OS environment variables if not resolvable in the specified properties.
static int	ENVIRONMENT_VARIABLES_MODE_NEVER Never check OS environment variables.
static int	ENVIRONMENT_VARIABLES_MODE_OVERRIDE Check OS environment variables first, before trying the specified properties.
static String	OVERRIDE_PROPERTIES Key for stores special override properties that containers such as OSGi can store in the OSGi service registry
static int	SYSTEM_PROPERTIES_MODE_FALLBACK Check system properties if not resolvable in the specified properties.
static int	SYSTEM_PROPERTIES_MODE_NEVER Never check system properties.
static int	SYSTEM_PROPERTIES_MODE_OVERRIDE Check system properties variables) first, before trying the specified properties.

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

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

Fields inherited from interface org.apache.camel.spi.PropertiesComponent

DEFAULT_CREATED, DEFAULT_PREFIX_TOKEN, DEFAULT_SUFFIX_TOKEN

Constructor Summary

Constructors

Constructor and Description
PropertiesComponent()
PropertiesComponent(String... locations)
PropertiesComponent(String location)

Method Summary

Modifier and Type	Method and Description
void	addFunction(PropertiesFunction function) Registers the PropertiesFunction as a function to this component.
void	addLocation(String location)
protected org.apache.camel.Endpoint	createEndpoint(String uri, String remaining, Map<String,Object> parameters)
protected Properties	doLoadProperties(List<PropertiesLocation> paths)
protected void	doStart()
protected void	doStop()
String	getEncoding()
int	getEnvironmentVariableMode()
Map<String,PropertiesFunction>	getFunctions() Gets the functions registered in this properties component.
Properties	getInitialProperties()
List<PropertiesLocation>	getLocations()
Properties	getOverrideProperties()
String	getPrefixToken()
PropertiesParser	getPropertiesParser()
PropertiesResolver	getPropertiesResolver()
String	getPropertyPrefix()
String	getPropertySuffix()
String	getSuffixToken()
int	getSystemPropertiesMode()
boolean	hasFunction(String name) Is there a PropertiesFunction with the given name?
boolean	isCache()
boolean	isDefaultFallbackEnabled()
boolean	isFallbackToUnaugmentedProperty() Gets the value of the property fallbackToUnaugmentedProperty.
boolean	isIgnoreMissingLocation()
boolean	isResolvePropertyPlaceholders()
Properties	loadProperties()
Properties	loadProperties(String... locations)
String	parseUri(String uri)
protected String	parseUri(String uri, List<PropertiesLocation> paths)
String	parseUri(String uri, String... locations)
void	setCache(boolean cache) Whether or not to cache loaded properties.
void	setDefaultFallbackEnabled(boolean defaultFallbackEnabled) If false, the component does not attempt to find a default for the key by looking after the colon separator.
void	setEncoding(String encoding) Encoding to use when loading properties file from the file system or classpath.
void	setEnvironmentVariableMode(int environmentVariableMode) Sets the OS environment variables mode.
void	setFallbackToUnaugmentedProperty(boolean fallbackToUnaugmentedProperty) If true, first attempt resolution of property name augmented with propertyPrefix and propertySuffix before falling back the plain property name specified.
void	setIgnoreMissingLocation(boolean ignoreMissingLocation) Whether to silently ignore if a location cannot be located, such as a properties file not found.
void	setInitialProperties(Properties initialProperties) Sets initial properties which will be used before any locations are resolved.
void	setLocation(String location) A list of locations to load properties.
void	setLocations(Collection<String> locationStrings) A list of locations to load properties.
void	setLocations(List<PropertiesLocation> locations) A list of locations to load properties.
void	setLocations(String[] locationStrings) A list of locations to load properties.
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) To use a custom PropertiesParser
void	setPropertiesResolver(PropertiesResolver propertiesResolver) To use a custom PropertiesResolver
void	setPropertyPrefix(String propertyPrefix) Optional prefix prepended to property names before resolution.
void	setPropertySuffix(String propertySuffix) Optional suffix appended to property names before resolution.
void	setSuffixToken(String suffixToken) Sets the value of the suffix token used to identify properties to replace.
void	setSystemPropertiesMode(int systemPropertiesMode) Sets the system property (and environment variable) mode.

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

afterConfiguration, createEndpoint, getAndRemoveOrResolveReferenceParameter, getAndRemoveOrResolveReferenceParameter, getAndRemoveParameter, getAndRemoveParameter, getCamelContext, getExtension, getSupportedExtensions, ifStartsWithReturnRemainder, 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

createEndpoint, getExtension, getSupportedExtensions, trySetComponent, useRawUri

Methods inherited from interface org.apache.camel.CamelContextAware

getCamelContext, setCamelContext, trySetCamelContext

Property Detail

isFallbackToUnaugmented

public boolean isFallbackToUnaugmentedProperty

Gets the value of the property fallbackToUnaugmentedProperty.

Field Detail

SYSTEM_PROPERTIES_MODE_NEVER

public static final int SYSTEM_PROPERTIES_MODE_NEVER

Never check system properties.

See Also:

Constant Field Values

SYSTEM_PROPERTIES_MODE_FALLBACK

public static final int SYSTEM_PROPERTIES_MODE_FALLBACK

Check system properties if not resolvable in the specified properties.

See Also:

Constant Field Values

SYSTEM_PROPERTIES_MODE_OVERRIDE

public static final int SYSTEM_PROPERTIES_MODE_OVERRIDE

Check system properties variables) first, before trying the specified properties. This allows system properties to override any other property source.

This is the default.

See Also:

Constant Field Values

ENVIRONMENT_VARIABLES_MODE_NEVER

public static final int ENVIRONMENT_VARIABLES_MODE_NEVER

Never check OS environment variables.

See Also:

Constant Field Values

ENVIRONMENT_VARIABLES_MODE_FALLBACK

public static final int ENVIRONMENT_VARIABLES_MODE_FALLBACK

Check OS environment variables if not resolvable in the specified properties.

This is the default.

See Also:

Constant Field Values

ENVIRONMENT_VARIABLES_MODE_OVERRIDE

public static final int ENVIRONMENT_VARIABLES_MODE_OVERRIDE

Check OS environment variables first, before trying the specified properties. This allows system properties to override any other property source.

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 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

parseUri

public String parseUri(String uri)
                throws Exception

Specified by:

parseUri in interface org.apache.camel.spi.PropertiesComponent

Throws:

Exception

parseUri

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

Specified by:

parseUri in interface org.apache.camel.spi.PropertiesComponent

Throws:

Exception

loadProperties

public Properties loadProperties()
                          throws Exception

Specified by:

loadProperties in interface org.apache.camel.spi.PropertiesComponent

Throws:

Exception

loadProperties

public Properties loadProperties(String... locations)
                          throws Exception

Specified by:

loadProperties in interface org.apache.camel.spi.PropertiesComponent

Throws:

Exception

doLoadProperties

protected Properties doLoadProperties(List<PropertiesLocation> paths)
                               throws Exception

Throws:

Exception

parseUri

protected String parseUri(String uri,
                          List<PropertiesLocation> paths)
                   throws Exception

Throws:

Exception

getLocations

public List<PropertiesLocation> getLocations()

setLocations

public void setLocations(List<PropertiesLocation> locations)

A list of locations to load properties. This option will override any default locations and only use the locations from this option.

setLocations

public void setLocations(String[] locationStrings)

A list of locations to load properties. This option will override any default locations and only use the locations from this option.

setLocations

public void setLocations(Collection<String> locationStrings)

A list of locations to load properties. This option will override any default locations and only use the locations from this option.

addLocation

public void addLocation(String location)

Specified by:

addLocation in interface org.apache.camel.spi.PropertiesComponent

setLocation

public void setLocation(String location)

A list of locations to load properties. You can use comma to separate multiple locations. This option will override any default locations and only use the locations from this option.

Specified by:

setLocation in interface org.apache.camel.spi.PropertiesComponent

getEncoding

public String getEncoding()

setEncoding

public void setEncoding(String encoding)

Encoding to use when loading properties file from the file system or classpath.

If no encoding has been set, then the properties files is loaded using ISO-8859-1 encoding (latin-1) as documented by Properties.load(java.io.InputStream)

getPropertiesResolver

public PropertiesResolver getPropertiesResolver()

setPropertiesResolver

public void setPropertiesResolver(PropertiesResolver propertiesResolver)

To use a custom PropertiesResolver

getPropertiesParser

public PropertiesParser getPropertiesParser()

setPropertiesParser

public void setPropertiesParser(PropertiesParser propertiesParser)

To use a custom PropertiesParser

isCache

public boolean isCache()

setCache

public void setCache(boolean cache)

Whether or not to cache loaded properties. The default value is true.

getPropertyPrefix

public String getPropertyPrefix()

setPropertyPrefix

public void setPropertyPrefix(String propertyPrefix)

Optional prefix prepended to property names before resolution.

getPropertySuffix

public String getPropertySuffix()

setPropertySuffix

public void setPropertySuffix(String propertySuffix)

Optional suffix appended to property names before resolution.

isFallbackToUnaugmentedProperty

public boolean isFallbackToUnaugmentedProperty()

Gets the value of the property fallbackToUnaugmentedProperty.

setFallbackToUnaugmentedProperty

public void setFallbackToUnaugmentedProperty(boolean fallbackToUnaugmentedProperty)

If true, first attempt resolution of property name augmented with propertyPrefix and propertySuffix before falling back the plain property name specified. If false, only the augmented property name is searched.

isDefaultFallbackEnabled

public boolean isDefaultFallbackEnabled()

setDefaultFallbackEnabled

public void setDefaultFallbackEnabled(boolean defaultFallbackEnabled)

If false, the component does not attempt to find a default for the key by looking after the colon separator.

isIgnoreMissingLocation

public boolean isIgnoreMissingLocation()

setIgnoreMissingLocation

public void setIgnoreMissingLocation(boolean ignoreMissingLocation)

Whether to silently ignore if a location cannot be located, such as a properties file not found.

Specified by:

setIgnoreMissingLocation in interface org.apache.camel.spi.PropertiesComponent

getPrefixToken

public String getPrefixToken()

Specified by:

getPrefixToken in interface org.apache.camel.spi.PropertiesComponent

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 PropertiesComponent.DEFAULT_PREFIX_TOKEN).

getSuffixToken

public String getSuffixToken()

Specified by:

getSuffixToken in interface org.apache.camel.spi.PropertiesComponent

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 PropertiesComponent.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.

Specified by:

setInitialProperties in interface org.apache.camel.spi.PropertiesComponent

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.

Specified by:

setOverrideProperties in interface org.apache.camel.spi.PropertiesComponent

Parameters:

overrideProperties - properties that is used first

getFunctions

public Map<String,PropertiesFunction> getFunctions()

Gets the functions registered in this properties component.

addFunction

public void addFunction(PropertiesFunction function)

Registers the PropertiesFunction as a function to this component.

hasFunction

public boolean hasFunction(String name)

Is there a PropertiesFunction with the given name?

getSystemPropertiesMode

public int getSystemPropertiesMode()

setSystemPropertiesMode

public void setSystemPropertiesMode(int systemPropertiesMode)

Sets the system property (and environment variable) mode. The default mode (override) is to check system properties (and environment variables) first, before trying the specified properties. This allows system properties/environment variables to override any other property source.

See Also:

SYSTEM_PROPERTIES_MODE_NEVER, SYSTEM_PROPERTIES_MODE_FALLBACK, SYSTEM_PROPERTIES_MODE_OVERRIDE

getEnvironmentVariableMode

public int getEnvironmentVariableMode()

setEnvironmentVariableMode

public void setEnvironmentVariableMode(int environmentVariableMode)

Sets the OS environment variables mode. The default mode (fallback) is to check OS environment variables, if the property cannot be resolved from its sources first. This allows environment variables as fallback values.

See Also:

ENVIRONMENT_VARIABLES_MODE_NEVER, ENVIRONMENT_VARIABLES_MODE_FALLBACK, ENVIRONMENT_VARIABLES_MODE_OVERRIDE

isResolvePropertyPlaceholders

public boolean isResolvePropertyPlaceholders()

Overrides:

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

doStart

protected void doStart()
                throws Exception

Overrides:

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

Throws:

Exception

doStop

protected void doStop()
               throws Exception

Overrides:

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

Throws:

Exception