org.apache.camel.component.geocoder

Class GeoCoderEndpoint

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.impl.DefaultEndpoint

org.apache.camel.component.geocoder.GeoCoderEndpoint

All Implemented Interfaces:

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

@UriEndpoint(scheme="geocoder",
             title="Geocoder",
             syntax="geocoder:address:latlng",
             producerOnly=true,
             label="api,location")
public class GeoCoderEndpoint
extends DefaultEndpoint

The geocoder component is used for looking up geocodes (latitude and longitude) for a given address, or reverse lookup.

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
GeoCoderEndpoint()
GeoCoderEndpoint(String uri, GeoCoderComponent component)

Method Summary

Modifier and Type	Method and Description
protected CompositeHttpConfigurer	configureProxyAuth(CompositeHttpConfigurer configurer, String authMethod, String username, String password, String domain, String host) Configures the proxy authentication method to be used
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
String	getAddress()
String	getClientId()
String	getClientKey()
HttpClientConfigurer	getHttpClientConfigurer()
org.apache.commons.httpclient.HttpConnectionManager	getHttpConnectionManager()
String	getLanguage()
String	getLatlng()
String	getProxyAuthDomain()
String	getProxyAuthHost()
String	getProxyAuthMethod()
String	getProxyAuthPassword()
String	getProxyAuthUsername()
int	getProxyPort()
boolean	isHeadersOnly()
boolean	isSingleton() Whether this class supports being singleton or not.
void	setAddress(String address) The geo address which should be prefixed with address:
void	setClientId(String clientId) To use google premium with this client id
void	setClientKey(String clientKey) To use google premium with this client key
void	setHeadersOnly(boolean headersOnly) Whether to only enrich the Exchange with headers, and leave the body as-is.
void	setHttpClientConfigurer(HttpClientConfigurer httpClientConfigurer) Register a custom configuration strategy for new HttpClient instances created by producers or consumers such as to configure authentication mechanisms etc
void	setHttpConnectionManager(org.apache.commons.httpclient.HttpConnectionManager httpConnectionManager) To use a custom HttpConnectionManager to manage connections
void	setLanguage(String language) The language to use.
void	setLatlng(String latlng) The geo latitude and longitude which should be prefixed with latlng:
void	setProxyAuthDomain(String proxyAuthDomain) Domain for proxy NTML authentication
void	setProxyAuthHost(String proxyAuthHost) Optional host for proxy NTML authentication
void	setProxyAuthMethod(String proxyAuthMethod) Authentication method for proxy, either as Basic, Digest or NTLM.
void	setProxyAuthPassword(String proxyAuthPassword) Password for proxy authentication
void	setProxyAuthUsername(String proxyAuthUsername) Username for proxy authentication
void	setProxyHost(String proxyHost) The proxy host name
void	setProxyPort(int proxyPort) The proxy port number

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

configureConsumer, configurePollingConsumer, configureProperties, createEndpointConfiguration, createEndpointUri, createExchange, createExchange, createExchange, createPollingConsumer, doStart, doStop, 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.Service

start, stop

Constructor Detail

GeoCoderEndpoint

public GeoCoderEndpoint()

GeoCoderEndpoint

public GeoCoderEndpoint(String uri,
                        GeoCoderComponent component)

Method Detail

createProducer

public Producer createProducer()
                        throws Exception

Description copied from interface: Endpoint

Creates a new producer which is used send messages into the 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

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.

Returns:

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

getLanguage

public String getLanguage()

setLanguage

public void setLanguage(String language)

The language to use.

getAddress

public String getAddress()

setAddress

public void setAddress(String address)

The geo address which should be prefixed with address:

getLatlng

public String getLatlng()

setLatlng

public void setLatlng(String latlng)

The geo latitude and longitude which should be prefixed with latlng:

isHeadersOnly

public boolean isHeadersOnly()

setHeadersOnly

public void setHeadersOnly(boolean headersOnly)

Whether to only enrich the Exchange with headers, and leave the body as-is.

getClientId

public String getClientId()

setClientId

public void setClientId(String clientId)

To use google premium with this client id

getClientKey

public String getClientKey()

setClientKey

public void setClientKey(String clientKey)

To use google premium with this client key

setProxyHost

public void setProxyHost(String proxyHost)

The proxy host name

getProxyPort

public int getProxyPort()

setProxyPort

public void setProxyPort(int proxyPort)

The proxy port number

getProxyAuthMethod

public String getProxyAuthMethod()

setProxyAuthMethod

public void setProxyAuthMethod(String proxyAuthMethod)

Authentication method for proxy, either as Basic, Digest or NTLM.

getProxyAuthUsername

public String getProxyAuthUsername()

setProxyAuthUsername

public void setProxyAuthUsername(String proxyAuthUsername)

Username for proxy authentication

getProxyAuthPassword

public String getProxyAuthPassword()

setProxyAuthPassword

public void setProxyAuthPassword(String proxyAuthPassword)

Password for proxy authentication

getProxyAuthDomain

public String getProxyAuthDomain()

setProxyAuthDomain

public void setProxyAuthDomain(String proxyAuthDomain)

Domain for proxy NTML authentication

getProxyAuthHost

public String getProxyAuthHost()

setProxyAuthHost

public void setProxyAuthHost(String proxyAuthHost)

Optional host for proxy NTML authentication

getHttpClientConfigurer

public HttpClientConfigurer getHttpClientConfigurer()

setHttpClientConfigurer

public void setHttpClientConfigurer(HttpClientConfigurer httpClientConfigurer)

Register a custom configuration strategy for new HttpClient instances created by producers or consumers such as to configure authentication mechanisms etc

Parameters:

httpClientConfigurer - the strategy for configuring new HttpClient instances

getHttpConnectionManager

public org.apache.commons.httpclient.HttpConnectionManager getHttpConnectionManager()

setHttpConnectionManager

public void setHttpConnectionManager(org.apache.commons.httpclient.HttpConnectionManager httpConnectionManager)

To use a custom HttpConnectionManager to manage connections

configureProxyAuth

protected CompositeHttpConfigurer configureProxyAuth(CompositeHttpConfigurer configurer,
                                                     String authMethod,
                                                     String username,
                                                     String password,
                                                     String domain,
                                                     String host)

Configures the proxy authentication method to be used

Returns:

configurer to used