org.apache.camel.component.cassandra

Class CassandraEndpoint

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.impl.DefaultEndpoint

org.apache.camel.component.cassandra.CassandraEndpoint

All Implemented Interfaces:

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

@UriEndpoint(scheme="cql",
             title="Cassandra CQL",
             syntax="cql:beanRef:hosts:port/keyspace",
             consumerClass=CassandraConsumer.class,
             label="database,nosql")
public class CassandraEndpoint
extends DefaultEndpoint

The cql component aims at integrating Cassandra 2.0+ using the CQL3 API (not the Thrift API). It's based on Cassandra Java Driver provided by DataStax.

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
CassandraEndpoint(String uri, CassandraComponent component, com.datastax.driver.core.Cluster cluster, com.datastax.driver.core.Session session, String keyspace)
CassandraEndpoint(String endpointUri, Component component)

Method Summary

Modifier and Type	Method and Description
protected com.datastax.driver.core.Cluster.Builder	createClusterBuilder()
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
protected void	doStart() Implementations override this method to support customized start/stop.
protected void	doStop() Implementations override this method to support customized start/stop.
protected void	fillMessage(com.datastax.driver.core.ResultSet resultSet, Message message) Copy ResultSet into Message.
String	getBean()
String	getBeanRef() Deprecated.
com.datastax.driver.core.Cluster	getCluster()
String	getClusterName()
com.datastax.driver.core.ConsistencyLevel	getConsistencyLevel()
String	getCql()
String	getHosts()
String	getKeyspace()
String	getLoadBalancingPolicy() To use a specific LoadBalancingPolicy
String	getPassword()
Integer	getPort()
ResultSetConversionStrategy	getResultSetConversionStrategy()
com.datastax.driver.core.Session	getSession()
protected CassandraSessionHolder	getSessionHolder()
String	getUsername()
boolean	isPrepareStatements()
boolean	isSingleton() Whether this class supports being singleton or not.
protected com.datastax.driver.core.PreparedStatement	prepareStatement() Create and configure a Prepared CQL statement
protected com.datastax.driver.core.PreparedStatement	prepareStatement(String cql) Create and configure a Prepared CQL statement
void	setBean(String beanRef) Instead of using a hostname:port, refer to an existing configured Session or Cluster from the Camel registry to be used.
void	setBeanRef(String beanRef) Deprecated.
void	setCluster(com.datastax.driver.core.Cluster cluster) To use the Cluster instance (you would normally not use this option)
void	setClusterName(String clusterName) Cluster name
void	setConsistencyLevel(com.datastax.driver.core.ConsistencyLevel consistencyLevel) Consistency level to use
void	setCql(String cql) CQL query to perform.
void	setHosts(String hosts) Hostname(s) cassansdra server(s).
void	setKeyspace(String keyspace) Keyspace to use
void	setLoadBalancingPolicy(String loadBalancingPolicy)
void	setPassword(String password) Password for session authentication
void	setPort(Integer port) Port number of cassansdra server(s)
void	setPrepareStatements(boolean prepareStatements) Whether to use PreparedStatements or regular Statements
void	setResultSetConversionStrategy(ResultSetConversionStrategy resultSetConversionStrategy) To use a custom class that implements logic for converting ResultSet into message body ALL, ONE, LIMIT_10, LIMIT_100...
void	setSession(com.datastax.driver.core.Session session) To use the Session instance (you would normally not use this option)
void	setUsername(String username) Username for session authentication

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

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

CassandraEndpoint

public CassandraEndpoint(String endpointUri,
                         Component component)

CassandraEndpoint

public CassandraEndpoint(String uri,
                         CassandraComponent component,
                         com.datastax.driver.core.Cluster cluster,
                         com.datastax.driver.core.Session session,
                         String keyspace)

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.

doStart

protected void doStart()
                throws Exception

Description copied from class: ServiceSupport

Implementations override this method to support customized start/stop.

Important: See ServiceSupport.doStop() for more details.

Overrides:

doStart in class DefaultEndpoint

Throws:

Exception

See Also:

ServiceSupport.doStop()

doStop

protected void doStop()
               throws Exception

Description copied from class: ServiceSupport

Implementations override this method to support customized start/stop.

Important: Camel will invoke this ServiceSupport.doStop() method when the service is being stopped. This method will also be invoked if the service is still in uninitialized state (eg has not been started). The method is always called to allow the service to do custom logic when the service is being stopped, such as when CamelContext is shutting down.

Overrides:

doStop in class DefaultEndpoint

Throws:

Exception

See Also:

ServiceSupport.doStart()

getSessionHolder

protected CassandraSessionHolder getSessionHolder()

createClusterBuilder

protected com.datastax.driver.core.Cluster.Builder createClusterBuilder()
                                                                 throws Exception

Throws:

Exception

prepareStatement

protected com.datastax.driver.core.PreparedStatement prepareStatement(String cql)

Create and configure a Prepared CQL statement

prepareStatement

protected com.datastax.driver.core.PreparedStatement prepareStatement()

Create and configure a Prepared CQL statement

fillMessage

protected void fillMessage(com.datastax.driver.core.ResultSet resultSet,
                           Message message)

Copy ResultSet into Message.

getBean

public String getBean()

setBean

public void setBean(String beanRef)

Instead of using a hostname:port, refer to an existing configured Session or Cluster from the Camel registry to be used.

getBeanRef

@Deprecated
public String getBeanRef()

Deprecated.

setBeanRef

@Deprecated
public void setBeanRef(String beanRef)

Deprecated.

getHosts

public String getHosts()

setHosts

public void setHosts(String hosts)

Hostname(s) cassansdra server(s). Multiple hosts can be separated by comma.

getPort

public Integer getPort()

setPort

public void setPort(Integer port)

Port number of cassansdra server(s)

getKeyspace

public String getKeyspace()

setKeyspace

public void setKeyspace(String keyspace)

Keyspace to use

getCql

public String getCql()

setCql

public void setCql(String cql)

CQL query to perform. Can be overridden with the message header with key CamelCqlQuery.

getCluster

public com.datastax.driver.core.Cluster getCluster()

setCluster

public void setCluster(com.datastax.driver.core.Cluster cluster)

To use the Cluster instance (you would normally not use this option)

getSession

public com.datastax.driver.core.Session getSession()

setSession

public void setSession(com.datastax.driver.core.Session session)

To use the Session instance (you would normally not use this option)

getClusterName

public String getClusterName()

setClusterName

public void setClusterName(String clusterName)

Cluster name

getUsername

public String getUsername()

setUsername

public void setUsername(String username)

Username for session authentication

getPassword

public String getPassword()

setPassword

public void setPassword(String password)

Password for session authentication

getConsistencyLevel

public com.datastax.driver.core.ConsistencyLevel getConsistencyLevel()

setConsistencyLevel

public void setConsistencyLevel(com.datastax.driver.core.ConsistencyLevel consistencyLevel)

Consistency level to use

getResultSetConversionStrategy

public ResultSetConversionStrategy getResultSetConversionStrategy()

setResultSetConversionStrategy

public void setResultSetConversionStrategy(ResultSetConversionStrategy resultSetConversionStrategy)

To use a custom class that implements logic for converting ResultSet into message body ALL, ONE, LIMIT_10, LIMIT_100...

isPrepareStatements

public boolean isPrepareStatements()

setPrepareStatements

public void setPrepareStatements(boolean prepareStatements)

Whether to use PreparedStatements or regular Statements

getLoadBalancingPolicy

public String getLoadBalancingPolicy()

To use a specific LoadBalancingPolicy

setLoadBalancingPolicy

public void setLoadBalancingPolicy(String loadBalancingPolicy)