org.apache.camel.component.properties
Class PropertiesComponent

java.lang.Object
  org.apache.camel.impl.ServiceSupport
      org.apache.camel.impl.DefaultComponent
          org.apache.camel.component.properties.PropertiesComponent

All Implemented Interfaces:

CamelContextAware, Component, Service, ShutdownableService

public class PropertiesComponent
extends DefaultComponent

The properties component.

Version:

$Revision: 1024230 $

Field Summary

static String	PREFIX_TOKEN
static String	SUFFIX_TOKEN

Constructor Summary

PropertiesComponent()

PropertiesComponent(String... locations)

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()
String[]	getLocations()
PropertiesParser	getPropertiesParser()
PropertiesResolver	getPropertiesResolver()
boolean	isCache()
String	parseUri(String uri)
String	parseUri(String uri, String... paths)
void	setCache(boolean cache)
void	setLocation(String location)
void	setLocations(String[] locations)
void	setPropertiesParser(PropertiesParser propertiesParser)
void	setPropertiesResolver(PropertiesResolver propertiesResolver)

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

afterConfiguration, createEndpoint, doStart, getAndRemoveParameter, getAndRemoveParameter, getCamelContext, ifStartsWithReturnRemainder, resolveAndRemoveReferenceListParameter, resolveAndRemoveReferenceListParameter, resolveAndRemoveReferenceParameter, resolveAndRemoveReferenceParameter, setCamelContext, setProperties, useIntrospectionOnEndpoint, validateParameters, validateURI

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

addChildService, doResume, doShutdown, doSuspend, getStatus, getVersion, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isSuspended, isSuspending, removeChildService, resume, shutdown, start, start, stop, suspend

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PREFIX_TOKEN

public static final String PREFIX_TOKEN

See Also:

Constant Field Values

SUFFIX_TOKEN

public static final String SUFFIX_TOKEN

See Also:

Constant Field Values

Constructor Detail

PropertiesComponent

public PropertiesComponent()

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

parseUri

public String parseUri(String uri)
                throws Exception

Throws:

Exception

parseUri

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

Throws:

Exception

getLocations

public String[] getLocations()

setLocations

public void setLocations(String[] locations)

setLocation

public void setLocation(String location)

getPropertiesResolver

public PropertiesResolver getPropertiesResolver()

setPropertiesResolver

public void setPropertiesResolver(PropertiesResolver propertiesResolver)

getPropertiesParser

public PropertiesParser getPropertiesParser()

setPropertiesParser

public void setPropertiesParser(PropertiesParser propertiesParser)

isCache

public boolean isCache()

setCache

public void setCache(boolean cache)

doStop

protected void doStop()
               throws Exception

Overrides:

doStop in class DefaultComponent

Throws:

Exception