org.apache.camel.component.properties

Class PropertiesComponent

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.impl.DefaultComponent

org.apache.camel.impl.UriEndpointComponent

org.apache.camel.component.properties.PropertiesComponent

All Implemented Interfaces:

CamelContextAware, Component, Service, ShutdownableService, StatefulService, SuspendableService

public class PropertiesComponent
extends UriEndpointComponent

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 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.
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 first, before trying the specified properties.

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

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

Constructor Summary

Constructors

Constructor and Description
PropertiesComponent()
PropertiesComponent(boolean isDefaultCreated)
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.
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	doStart() Implementations override this method to support customized start/stop.
protected void	doStop() Implementations override this method to support customized start/stop.
String	getEncoding()
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	isDefaultCreated() Is this component created as a default by CamelContext during starting up Camel.
boolean	isDefaultFallbackEnabled()
boolean	isFallbackToUnaugmentedProperty() Gets the value of the property fallbackToUnaugmentedProperty.
boolean	isIgnoreMissingLocation()
boolean	isResolvePropertyPlaceholders() Whether the component should resolve property placeholders on itself when starting.
String	parseUri(String uri)
String	parseUri(String uri, List<PropertiesLocation> paths)
String	parseUri(String uri, String... uris)
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	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 mode.

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

createComponentConfiguration, createParameterConfigurationMap, getEndpointClass, getParameterConfigurationMap, populateParameterConfigurationMap, setEndpointClass

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

afterConfiguration, createConfiguration, 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.ServiceSupport

doResume, doShutdown, doSuspend, getStatus, getVersion, isRunAllowed, isStarted, isStarting, 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

Property Detail

isFallbackToUnaugmented

public boolean isFallbackToUnaugmentedProperty

Gets the value of the property fallbackToUnaugmentedProperty.

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

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

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(boolean isDefaultCreated)

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... uris)
                throws Exception

Throws:

Exception

parseUri

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

Throws:

Exception

isDefaultCreated

public boolean isDefaultCreated()

Is this component created as a default by CamelContext during starting up Camel.

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.

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.

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.

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

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

See Also:

SYSTEM_PROPERTIES_MODE_NEVER, SYSTEM_PROPERTIES_MODE_FALLBACK, SYSTEM_PROPERTIES_MODE_OVERRIDE

isResolvePropertyPlaceholders

public boolean isResolvePropertyPlaceholders()

Description copied from class: DefaultComponent

Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders.

Overrides:

isResolvePropertyPlaceholders in class DefaultComponent

doStart

protected void doStart()
                throws Exception

Description copied from class: ServiceSupport

Implementations override this method to support customized start/stop.

Important: See ServiceSupport.doStop() for more details.

Overrides:

doStart in class DefaultComponent

Throws:

Exception

See Also:

ServiceSupport.doStop()

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