Package org.apache.camel.component.geocoder

Class GeoCoderEndpoint

  • All Implemented Interfaces:
    AutoCloseable, org.apache.camel.CamelContextAware, 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.12.0",
             scheme="geocoder",
             title="Geocoder",
             syntax="geocoder:address:latlng",
             producerOnly=true,
             category={API,LOCATION},
             headersClass=GeoCoderConstants.class)
public class GeoCoderEndpoint
extends org.apache.camel.support.DefaultEndpoint
    Find geocodes (latitude and longitude) for a given address or the other way round.

    • Field Summary

      • Fields inherited from class org.apache.camel.support.service.BaseService

        BUILT, FAILED, INITIALIZED, INITIALIZING, lock, NEW, SHUTDOWN, SHUTTING_DOWN, STARTED, STARTING, status, STOPPED, STOPPING, SUSPENDED, SUSPENDING

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      org.apache.camel.Consumer createConsumer​(org.apache.camel.Processor processor)  
      protected com.google.maps.GeoApiContext createGeoApiContext()
      Specific Google required
      org.apache.camel.Producer createProducer()  
      String getAddress()  
      String getApiKey()  
      String getClientId()  
      String getClientKey()  
      String getLanguage()  
      String getLatlng()  
      String getProxyAuthDomain()  
      String getProxyAuthHost()  
      String getProxyAuthMethod()  
      String getProxyAuthPassword()  
      String getProxyAuthUsername()  
      String getProxyHost()  
      int getProxyPort()  
      String getServerUrl()  
      GeoCoderType getType()  
      boolean isHeadersOnly()  
      void setAddress​(String address)
      The geo address which should be prefixed with address:
      void setApiKey​(String apiKey)
      To use google apiKey
      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 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
      void setServerUrl​(String serverUrl)  
      void setType​(String type)  
      void setType​(GeoCoderType type)  

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

        configureConsumer, configureExchange, configurePollingConsumer, configureProperties, createAsyncProducer, createEndpointUri, createExchange, createExchange, createPollingConsumer, doInit, doStart, doStop, equals, getCamelContext, getComponent, getEndpointKey, getEndpointUri, getExceptionHandler, getExchangePattern, getId, getPollingConsumerBlockTimeout, getPollingConsumerQueueSize, hashCode, isAutowiredEnabled, isBridgeErrorHandler, isLazyStartProducer, isLenientProperties, isPollingConsumerBlockWhenFull, isPollingConsumerCopy, isSingleton, setAutowiredEnabled, setBridgeErrorHandler, setCamelContext, setComponent, setEndpointUri, setEndpointUriIfNotSpecified, setExceptionHandler, setExchangePattern, setLazyStartProducer, setPollingConsumerBlockTimeout, setPollingConsumerBlockWhenFull, setPollingConsumerCopy, setPollingConsumerQueueSize, setProperties, toString

      • Methods inherited from class org.apache.camel.support.service.BaseService

        build, doBuild, doFail, doLifecycleChange, doResume, doShutdown, doSuspend, fail, getStatus, init, isBuild, isInit, isNew, isRunAllowed, isShutdown, isStarted, isStarting, isStartingOrStarted, isStopped, isStopping, isStoppingOrStopped, isSuspended, isSuspending, isSuspendingOrSuspended, resume, shutdown, start, stop, suspend

      • Methods inherited from interface org.apache.camel.Endpoint

        getEndpointBaseUri, isSingletonProducer

      • Methods inherited from interface org.apache.camel.Service

        build, close, init, start, stop

      • Methods inherited from interface org.apache.camel.ShutdownableService

        shutdown

      • Methods inherited from interface org.apache.camel.StatefulService

        getStatus, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isSuspending

      • Methods inherited from interface org.apache.camel.SuspendableService

        isSuspended, resume, suspend

    • Constructor Detail

      • GeoCoderEndpoint

        public GeoCoderEndpoint()

    • Method Detail

      • createProducer

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

      • createConsumer

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

      • 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

      • getApiKey

        public String getApiKey()

      • setApiKey

        public void setApiKey​(String apiKey)
        To use google apiKey

      • getProxyHost

        public String getProxyHost()

      • 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

      • setType

        public void setType​(String type)

      • getServerUrl

        public String getServerUrl()

      • setServerUrl

        public void setServerUrl​(String serverUrl)

      • createGeoApiContext

        protected com.google.maps.GeoApiContext createGeoApiContext()
        Specific Google required
        Returns: