|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.camel.support.ServiceSupport org.apache.camel.impl.DefaultComponent org.apache.camel.component.properties.PropertiesComponent
public class PropertiesComponent
The properties component.
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. |
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 |
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.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 |
---|
public static final String DEFAULT_PREFIX_TOKEN
public static final String DEFAULT_SUFFIX_TOKEN
@Deprecated public static final String PREFIX_TOKEN
DEFAULT_PREFIX_TOKEN
instead.
@Deprecated public static final String SUFFIX_TOKEN
DEFAULT_SUFFIX_TOKEN
instead.
public static final String OVERRIDE_PROPERTIES
Constructor Detail |
---|
public PropertiesComponent()
public PropertiesComponent(String location)
public PropertiesComponent(String... locations)
Method Detail |
---|
protected Endpoint createEndpoint(String uri, String remaining, Map<String,Object> parameters) throws Exception
DefaultComponent
createEndpoint
in class DefaultComponent
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
Exception
- is thrown if error creating the endpointpublic String parseUri(String uri) throws Exception
Exception
public String parseUri(String uri, String... paths) throws Exception
Exception
public String[] getLocations()
public void setLocations(String[] locations)
public void setLocation(String location)
public PropertiesResolver getPropertiesResolver()
public void setPropertiesResolver(PropertiesResolver propertiesResolver)
public PropertiesParser getPropertiesParser()
public void setPropertiesParser(PropertiesParser propertiesParser)
public boolean isCache()
public void setCache(boolean cache)
public String getPropertyPrefix()
public void setPropertyPrefix(String propertyPrefix)
public String getPropertySuffix()
public void setPropertySuffix(String propertySuffix)
public boolean isFallbackToUnaugmentedProperty()
public void setFallbackToUnaugmentedProperty(boolean fallbackToUnaugmentedProperty)
public boolean isIgnoreMissingLocation()
public void setIgnoreMissingLocation(boolean ignoreMissingLocation)
public String getPrefixToken()
public void setPrefixToken(String prefixToken)
null
restores the default token (@link DEFAULT_PREFIX_TOKEN
).
public String getSuffixToken()
public void setSuffixToken(String suffixToken)
null
restores the default token (@link DEFAULT_SUFFIX_TOKEN
).
public Properties getOverrideProperties()
public void setOverrideProperties(Properties overrideProperties)
overrideProperties
- properties that is used firstprotected void doStop() throws Exception
ServiceSupport
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.
doStop
in class DefaultComponent
Exception
ServiceSupport.doStart()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |