Package org.apache.camel.component.pgevent

Class PgEventEndpoint

java.lang.Object
org.apache.camel.support.service.BaseService
org.apache.camel.support.service.ServiceSupport
org.apache.camel.support.DefaultEndpoint
org.apache.camel.component.pgevent.PgEventEndpoint
All Implemented Interfaces:
AutoCloseable, org.apache.camel.CamelContextAware, org.apache.camel.ComponentAware, org.apache.camel.Endpoint, org.apache.camel.IsSingleton, org.apache.camel.Service, org.apache.camel.ShutdownableService, org.apache.camel.spi.EndpointServiceLocation, org.apache.camel.spi.HasCamelContext, org.apache.camel.spi.HasId, org.apache.camel.StatefulService, org.apache.camel.SuspendableService
@UriEndpoint(firstVersion="2.15.0", scheme="pgevent", title="PostgresSQL Event", syntax="pgevent:host:port/database/channel", category=DATABASE, headersClass=PgEventConstants.class) public class PgEventEndpoint extends org.apache.camel.support.DefaultEndpoint implements org.apache.camel.spi.EndpointServiceLocation
Send and receive PostgreSQL events via LISTEN and NOTIFY commands.

This requires using PostgreSQL 8.3 or newer.

  • 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

  • Constructor Summary

    Constructors
    Constructor
    Description
    PgEventEndpoint(String uri, PgEventComponent component)
     
    PgEventEndpoint(String uri, PgEventComponent component, DataSource dataSource)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    org.apache.camel.Consumer
    createConsumer(org.apache.camel.Processor processor)
     
    org.apache.camel.Producer
    createProducer()
     
    String
    getChannel()
     
    String
    getDatabase()
     
    DataSource
    getDatasource()
     
    String
    getHost()
     
    String
    getPass()
     
    Integer
    getPort()
     
    int
    getReconnectDelay()
     
    Map<String,String>
    getServiceMetadata()
     
    String
    getServiceProtocol()
     
    String
    getServiceUrl()
     
    String
    getUser()
     
    ExecutorService
    getWorkerPool()
     
    int
    getWorkerPoolCoreSize()
     
    int
    getWorkerPoolMaxSize()
     
    final com.impossibl.postgres.api.jdbc.PGConnection
    initJdbc()
     
    protected final void
    parseUri()
    Parse the provided URI and extract available parameters
    void
    setChannel(String channel)
    The channel name
    void
    setDatabase(String database)
    The database name.
    void
    setDatasource(DataSource datasource)
    To connect using the given DataSource instead of using hostname and port.
    void
    setHost(String host)
    To connect using hostname and port to the database.
    void
    setPass(String pass)
    Password for login
    void
    setPort(Integer port)
    To connect using hostname and port to the database.
    void
    setReconnectDelay(int reconnectDelay)
    When the consumer unexpected lose connection to the database, then this specifies the interval (millis) between re-connection attempts to establish a new connection.
    void
    setUser(String user)
    Username for login
    void
    setWorkerPool(ExecutorService workerPool)
    To use a custom worker pool for processing the events from the database.
    void
    setWorkerPoolCoreSize(int workerPoolCoreSize)
    Number of core threads in the worker pool for processing the events from the database.
    void
    setWorkerPoolMaxSize(int workerPoolMaxSize)
    Maximum number of threads in the worker pool for processing the events from the database.

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

    configureConsumer, configureExchange, configurePollingConsumer, configureProperties, createAsyncProducer, createEndpointUri, createExchange, createExchange, createPollingConsumer, doInit, 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, doStart, doStop, doSuspend, fail, getInternalLock, getStatus, init, isBuild, isInit, isNew, isRunAllowed, isShutdown, isStarted, isStarting, isStartingOrStarted, 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.ComponentAware

    getComponent

    Methods inherited from interface org.apache.camel.Endpoint

    getEndpointBaseUri, isRemote, 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 Details

  • Method Details

    • getServiceUrl

      public String getServiceUrl()
      Specified by:
      getServiceUrl in interface org.apache.camel.spi.EndpointServiceLocation

    • getServiceMetadata

      public Map<String,String> getServiceMetadata()
      Specified by:
      getServiceMetadata in interface org.apache.camel.spi.EndpointServiceLocation

    • getServiceProtocol

      public String getServiceProtocol()
      Specified by:
      getServiceProtocol in interface org.apache.camel.spi.EndpointServiceLocation

    • initJdbc

      public final com.impossibl.postgres.api.jdbc.PGConnection initJdbc() throws Exception
      Throws:
      Exception

    • parseUri

      protected final void parseUri() throws IllegalArgumentException
      Parse the provided URI and extract available parameters
      Throws:
      IllegalArgumentException - if there is an error in the parameters

    • createProducer

      public org.apache.camel.Producer createProducer() throws Exception
      Specified by:
      createProducer in interface org.apache.camel.Endpoint
      Throws:
      Exception

    • createConsumer

      public org.apache.camel.Consumer createConsumer(org.apache.camel.Processor processor) throws Exception
      Specified by:
      createConsumer in interface org.apache.camel.Endpoint
      Throws:
      Exception

    • getHost

      public String getHost()

    • setHost

      public void setHost(String host)
      To connect using hostname and port to the database.

    • getPort

      public Integer getPort()

    • setPort

      public void setPort(Integer port)
      To connect using hostname and port to the database.

    • getDatabase

      public String getDatabase()

    • setDatabase

      public void setDatabase(String database)
      The database name. The database name can take any characters because it is sent as a quoted identifier. It is part of the endpoint URI, so diacritical marks and non-Latin letters have to be URL encoded.

    • getChannel

      public String getChannel()

    • setChannel

      public void setChannel(String channel)
      The channel name

    • getUser

      public String getUser()

    • setUser

      public void setUser(String user)
      Username for login

    • getPass

      public String getPass()

    • setPass

      public void setPass(String pass)
      Password for login

    • getDatasource

      public DataSource getDatasource()

    • setDatasource

      public void setDatasource(DataSource datasource)
      To connect using the given DataSource instead of using hostname and port.

    • getReconnectDelay

      public int getReconnectDelay()

    • setReconnectDelay

      public void setReconnectDelay(int reconnectDelay)
      When the consumer unexpected lose connection to the database, then this specifies the interval (millis) between re-connection attempts to establish a new connection.

    • getWorkerPool

      public ExecutorService getWorkerPool()

    • setWorkerPool

      public void setWorkerPool(ExecutorService workerPool)
      To use a custom worker pool for processing the events from the database.

    • getWorkerPoolCoreSize

      public int getWorkerPoolCoreSize()

    • setWorkerPoolCoreSize

      public void setWorkerPoolCoreSize(int workerPoolCoreSize)
      Number of core threads in the worker pool for processing the events from the database.

    • getWorkerPoolMaxSize

      public int getWorkerPoolMaxSize()

    • setWorkerPoolMaxSize

      public void setWorkerPoolMaxSize(int workerPoolMaxSize)
      Maximum number of threads in the worker pool for processing the events from the database.