org.apache.camel
Interface EndpointConfiguration

All Known Implementing Classes:

DefaultEndpointConfiguration, MappedEndpointConfiguration

public interface EndpointConfiguration

Holds an Endpoint configuration as a pojo that can be manipulated and validated. Camel endpoint configuration is strongly related to URIs.

Nested Class Summary

static class

EndpointConfiguration.UriFormat DataFormat operations.

Field Summary

static String	URI_AUTHORITY
static String	URI_FRAGMENT
static String	URI_HOST
static String	URI_PATH
static String	URI_PORT
static String	URI_QUERY
static String	URI_SCHEME
static String	URI_SCHEME_SPECIFIC_PART
static String	URI_USER_INFO

Method Summary

<T> T	getParameter(String name) Gets the value of a particular parameter.
URI	getURI() Returns the URI configuration of an Endpoint.
<T> void	setParameter(String name, T value) Sets the value of a particular parameter.
String	toUriString(EndpointConfiguration.UriFormat format) Returns the formatted configuration string of an Endpoint.

Field Detail

URI_SCHEME

static final String URI_SCHEME

See Also:

Constant Field Values

URI_SCHEME_SPECIFIC_PART

static final String URI_SCHEME_SPECIFIC_PART

See Also:

Constant Field Values

URI_AUTHORITY

static final String URI_AUTHORITY

See Also:

Constant Field Values

URI_USER_INFO

static final String URI_USER_INFO

See Also:

Constant Field Values

URI_HOST

static final String URI_HOST

See Also:

Constant Field Values

URI_PORT

static final String URI_PORT

See Also:

Constant Field Values

URI_PATH

static final String URI_PATH

See Also:

Constant Field Values

URI_QUERY

static final String URI_QUERY

See Also:

Constant Field Values

URI_FRAGMENT

static final String URI_FRAGMENT

See Also:

Constant Field Values

Method Detail

getURI

URI getURI()

Returns the URI configuration of an Endpoint.

Returns:

the configuration URI.

getParameter

<T> T getParameter(String name)
               throws RuntimeCamelException

Gets the value of a particular parameter.

Parameters:

name - the parameter name

Returns:

the configuration URI.

Throws:

RuntimeCamelException - is thrown if error getting the parameter

setParameter

<T> void setParameter(String name,
                      T value)
                  throws RuntimeCamelException

Sets the value of a particular parameter.

Parameters:

name - the parameter name

value - the parameter value

Throws:

RuntimeCamelException - is thrown if error setting the parameter

toUriString

String toUriString(EndpointConfiguration.UriFormat format)

Returns the formatted configuration string of an Endpoint.

Parameters:

format - the format

Returns:

the configuration URI in String format.