org.apache.camel.component.properties

Class PropertiesEndpoint

java.lang.Object

org.apache.camel.support.service.ServiceSupport

org.apache.camel.support.DefaultEndpoint

org.apache.camel.component.properties.PropertiesEndpoint

All Implemented Interfaces:

org.apache.camel.CamelContextAware, org.apache.camel.DelegateEndpoint, org.apache.camel.Endpoint, org.apache.camel.IsSingleton, org.apache.camel.Service, org.apache.camel.ShutdownableService, org.apache.camel.spi.HasId, org.apache.camel.StatefulService, org.apache.camel.SuspendableService

@UriEndpoint(firstVersion="2.3.0",
             scheme="properties",
             title="Properties",
             syntax="properties:key",
             label="core,endpoint")
public class PropertiesEndpoint
extends org.apache.camel.support.DefaultEndpoint
implements org.apache.camel.DelegateEndpoint

The properties component is used for using property placeholders in endpoint uris.

Field Summary

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

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

Constructor Summary

Constructors

Constructor and Description
PropertiesEndpoint(String endpointUri, org.apache.camel.Endpoint delegate, org.apache.camel.Component component)

Method Summary

Modifier and Type	Method and Description
org.apache.camel.Consumer	createConsumer(org.apache.camel.Processor processor)
org.apache.camel.Producer	createProducer()
protected void	doStart()
protected void	doStop()
org.apache.camel.Endpoint	getEndpoint()
String	getKey()
String	getLocations()
boolean	isIgnoreMissingLocation()
boolean	isSingleton()
void	setIgnoreMissingLocation(boolean ignoreMissingLocation) Whether to silently ignore if a location cannot be located, such as a properties file not found.
void	setKey(String key) Property key to use as placeholder
void	setLocations(String locations) A list of locations to load properties.

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

configureConsumer, configurePollingConsumer, configureProperties, createAsyncProducer, createEndpointUri, createExchange, createExchange, createPollingConsumer, equals, getCamelContext, getComponent, getConsumerProperties, getEndpointKey, getEndpointUri, getExceptionHandler, getExchangePattern, getId, getPollingConsumerBlockTimeout, getPollingConsumerQueueSize, hashCode, isBridgeErrorHandler, isLenientProperties, isPollingConsumerBlockWhenFull, isSynchronous, setBridgeErrorHandler, setCamelContext, setConsumerProperties, setEndpointUri, setEndpointUriIfNotSpecified, setExceptionHandler, setExchangePattern, setPollingConsumerBlockTimeout, setPollingConsumerBlockWhenFull, setPollingConsumerQueueSize, setProperties, setSynchronous, toString

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, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.camel.Endpoint

configureProperties, createAsyncProducer, createExchange, createExchange, createPollingConsumer, getCamelContext, getEndpointKey, getEndpointUri, isLenientProperties, setCamelContext

Methods inherited from interface org.apache.camel.Service

init, start, stop

Methods inherited from interface org.apache.camel.CamelContextAware

trySetCamelContext

Constructor Detail

PropertiesEndpoint

public PropertiesEndpoint(String endpointUri,
                          org.apache.camel.Endpoint delegate,
                          org.apache.camel.Component component)

Method Detail

getKey

public String getKey()

setKey

public void setKey(String key)

Property key to use as placeholder

getLocations

public String getLocations()

setLocations

public void setLocations(String locations)

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.

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.

createProducer

public org.apache.camel.Producer createProducer()
                                         throws Exception

Specified by:

createProducer in interface org.apache.camel.Endpoint

Throws:

Exception

createConsumer

public org.apache.camel.Consumer createConsumer(org.apache.camel.Processor processor)
                                         throws Exception

Specified by:

createConsumer in interface org.apache.camel.Endpoint

Throws:

Exception

isSingleton

public boolean isSingleton()

Specified by:

isSingleton in interface org.apache.camel.IsSingleton

getEndpoint

public org.apache.camel.Endpoint getEndpoint()

Specified by:

getEndpoint in interface org.apache.camel.DelegateEndpoint

doStart

protected void doStart()
                throws Exception

Overrides:

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

Throws:

Exception

doStop

protected void doStop()
               throws Exception

Overrides:

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

Throws:

Exception