org.apache.camel.component.properties

Class PropertiesEndpoint

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.impl.DefaultEndpoint

org.apache.camel.component.properties.PropertiesEndpoint

All Implemented Interfaces:

CamelContextAware, DelegateEndpoint, Endpoint, IsSingleton, Service, ShutdownableService, HasId, StatefulService, SuspendableService

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

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

Field Summary

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

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

Constructor Summary

Constructors

Constructor and Description
PropertiesEndpoint(String endpointUri, Endpoint delegate, Component component)

Method Summary

Modifier and Type	Method and Description
Consumer	createConsumer(Processor processor) Creates a new Event Driven Consumer which consumes messages from the endpoint using the given processor
Producer	createProducer() Creates a new producer which is used send messages into the endpoint
protected void	doStart() Implementations override this method to support customized start/stop.
protected void	doStop() Implementations override this method to support customized start/stop.
Endpoint	getEndpoint() Gets the delegated Endpoint.
String	getKey()
String	getLocations()
boolean	isIgnoreMissingLocation()
boolean	isSingleton() Whether this class supports being singleton or not.
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.impl.DefaultEndpoint

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

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

Methods inherited from interface org.apache.camel.Endpoint

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

Methods inherited from interface org.apache.camel.Service

start, stop

Constructor Detail

PropertiesEndpoint

public PropertiesEndpoint(String endpointUri,
                          Endpoint delegate,
                          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 Producer createProducer()
                        throws Exception

Description copied from interface: Endpoint

Creates a new producer which is used send messages into the endpoint

Specified by:

createProducer in interface Endpoint

Returns:

a newly created producer

Throws:

Exception - can be thrown

createConsumer

public Consumer createConsumer(Processor processor)
                        throws Exception

Description copied from interface: Endpoint

Creates a new Event Driven Consumer which consumes messages from the endpoint using the given processor

Specified by:

createConsumer in interface Endpoint

Parameters:

processor - the given processor

Returns:

a newly created consumer

Throws:

Exception - can be thrown

isSingleton

public boolean isSingleton()

Description copied from interface: IsSingleton

Whether this class supports being singleton or not.

Specified by:

isSingleton in interface IsSingleton

Returns:

true to be a single shared instance, false to create new instances.

getEndpoint

public Endpoint getEndpoint()

Description copied from interface: DelegateEndpoint

Gets the delegated Endpoint.

Specified by:

getEndpoint in interface DelegateEndpoint

Returns:

the Endpoint we delegate to

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 DefaultEndpoint

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 DefaultEndpoint

Throws:

Exception

See Also:

ServiceSupport.doStart()