Contact Us 1-800-596-4880
  1. Homepage
  2. Apache Cassandra Connector (5.0)

  3. Using Anypoint Studio to Configure Cassandra Connector

All Connectors

Using Anypoint Studio to Configure Apache Cassandra Connector 5.0

Anypoint Studio (Studio) editors help you design and update your Mule applications, properties, and configuration files.

To add and configure a connector in Studio:

When you run the connector, you can view the app log to check for problems, as described in View the App Log.

If you are new to configuring connectors in Studio, see Using Anypoint Studio to Configure a Connector. If, after reading this topic, you need additional information about the connector fields, see the Reference.

Create a Mule Project

In Studio, create a new Mule project in which to add and configure the connector:

  1. In Studio, select File > New > Mule Project.

  2. Enter a name for your Mule project and click Finish.

Add the Connector to Your Mule Project

Add Apache Cassandra Connector to your Mule project to automatically populate the XML code with the connector’s namespace and schema location and to add the required dependencies to the project’s pom.xml file:

  1. In the Mule Palette view, click (X) Search in Exchange.

  2. In the Add Dependencies to Project window, type cassandra in the search field.

  3. Click CassandraDB in Available modules.

  4. Click Add.

  5. Click Finish.

Adding a connector to a Mule project in Studio does not make that connector available to other projects in your Studio workspace.

Configure a Source

A source initiates a flow when a specified condition is met. You can configure one of these sources to use with Apache Cassandra Connector:

  • HTTP Listener

    Initiates a flow each time it receives a request on the configured host and port

  • Scheduler

    Initiates a flow when a time-based condition is met

For example, to configure an HTTP listener, follow these steps:

  1. In the Mule Palette view, select HTTP > Listener.

  2. Drag Listener to the Studio canvas.

  3. On the Listener configuration screen, optionally change the value of the Display Name field.

  4. Specify a value for the Path field.

  5. Click the plus sign (+) next to the Connector configuration field to configure a global element that can be used by all instances of the HTTP listener in the app.

  6. On the General tab, specify the connection information for the listener.

  7. On the TLS tab, optionally specify the TLS information for the listener.

  8. On the Advanced tab, optionally specify reconnection information, including a reconnection strategy.

  9. Click Test Connection to confirm that Mule can connect with the specified server.

  10. Click OK.

Add a Connector Operation to the Flow

When you add a connector operation to your flow, you immediately define a specific operation for that connector to perform.

To add an operation for Apache Cassandra Connector, follow these steps:

  1. In the Mule Palette view, select CassandraDB and then select the desired operation.

  2. Drag the operation onto the Studio canvas and to the right of the source.

Configure a Global Element for the Connector

When you configure a connector, it’s best to configure a global element that all instances of that connector in the app can use. If an Apache Cassandra database has authentication enabled, you must provide credentials when accessing it from the connector. Apache Cassandra supports basic authentication only. To provide credentials to an Apache Cassandra database, enter the corresponding values in the Apache Cassandra Connector global element.

To configure the global element for Apache Cassandra Connector, follow these steps:

  1. Select the operation in the Studio canvas.

  2. In the configuration screen for the operation, click the plus sign (+) next to the Connector configuration field to access the global element configuration fields.

  3. On the General tab, complete the following fields:

    Field Description

    Host

    Host name or IP address of an Apache Cassandra node

    Port

    Port number. The default port is 9042.

    If the target database has authentication enabled, you must also complete these fields:

    Field Description

    Cassandra Keyspace

    Apache Cassandra keyspace

    Username

    Username for authentication

    Password

    Password for authentication

    You can reference a configuration file that contains ANT-style property placeholders (recommended), or you can enter your authorization credentials in the global configuration properties. For information about the benefits of using property placeholders and how to configure them, see Anypoint Connector Configuration.

  4. On the Advanced Settings tab, complete these fields when required:

    Field Description

    Cassandra Cluster Nodes

    Contact points that select the cluster.

    Protocol Version

    Native protocol version that the driver uses. Don’t select V1 or V2. Leave this field unset to let the driver negotiate, including native protocol V5 on Apache Cassandra 5.x. See Configure the Protocol Version.

    Request Timeout (ms)

    Per-request timeout for CQL operations, in milliseconds. The default is 12000. See Configure the Request Timeout.

    Local Datacenter

    Local datacenter for the driver’s load-balancing policy. Set this field when contact points don’t share one datacenter, such as in a multi-DC cluster. You can omit it for single-DC clusters. See Configure the Local Datacenter.

    The Advanced Settings tab also includes Max Schema Agreement Wait Seconds, Compression, and Prepared Statements Cache Size. For field details, see Connection.

  5. Optionally, configure a connection that uses TLS by completing these fields on the Security tab:

    Field Description

    Endpoint identification algorithm

    Algorithm that clients use to validate the server host name against the server certificate. The default is DISABLED. Set HTTPS or LDAPS to require the certificate to match the host.

    TLS Configuration

    TLS context for the Cassandra connection. Version 5.0 applies the keystore, truststore, and hostname validation settings to the driver.

  6. On the Advanced tab, optionally specify reconnection information, including a reconnection strategy.

  7. Click Test Connection to confirm that Mule can connect with the specified server.

  8. Click OK.

Configure Additional Connector Fields

After you configure a global element for Apache Cassandra Connector, configure the other required fields for the connector. The required fields vary depending on which connector operation you use.

View the App Log

To check for problems, you can view the app log as follows:

  • If you’re running the app from Anypoint Platform, the output is visible in the Anypoint Studio console window.

  • If you’re running the app using Mule from the command line, the app log is visible in your OS console.

Unless the log file path is customized in the app’s log file (log4j2.xml), you can also view the app log in the default location MULE_HOME/logs/<app-name>.log.

See Also

Back to top