|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.datastax.driver.core.Cluster.Builder
public static class Cluster.Builder
Helper class to build Cluster
instances.
Constructor Summary | |
---|---|
Cluster.Builder()
|
Method Summary | |
---|---|
Cluster.Builder |
addContactPoint(String address)
Adds a contact point. |
Cluster.Builder |
addContactPoints(InetAddress... addresses)
Adds contact points. |
Cluster.Builder |
addContactPoints(String... addresses)
Adds contact points. |
Cluster |
build()
Builds the cluster with the configured set of initial contact points and policies. |
Configuration |
getConfiguration()
The configuration that will be used for the new cluster. |
List<InetAddress> |
getContactPoints()
Returns the initial Cassandra hosts to connect to. |
PoolingOptions |
poolingOptions()
Return the pooling options used by this builder. |
SocketOptions |
socketOptions()
Returns the socket options used by this builder. |
Cluster.Builder |
withAuthProvider(AuthProvider authProvider)
Use the specified AuthProvider when connecting to Cassandra hosts. |
Cluster.Builder |
withCompression(ProtocolOptions.Compression compression)
Sets the compression to use for the transport. |
Cluster.Builder |
withCredentials(String username,
String password)
Uses the provided credentials when connecting to Cassandra hosts. |
Cluster.Builder |
withLoadBalancingPolicy(LoadBalancingPolicy policy)
Configures the load balancing policy to use for the new cluster. |
Cluster.Builder |
withoutJMXReporting()
Disables JMX reporting of the metrics. |
Cluster.Builder |
withoutMetrics()
Disables metrics collection for the created cluster (metrics are enabled by default otherwise). |
Cluster.Builder |
withPort(int port)
The port to use to connect to the Cassandra host. |
Cluster.Builder |
withReconnectionPolicy(ReconnectionPolicy policy)
Configures the reconnection policy to use for the new cluster. |
Cluster.Builder |
withRetryPolicy(RetryPolicy policy)
Configures the retry policy to use for the new cluster. |
Cluster.Builder |
withSSL()
Enables the use of SSL for the created Cluster . |
Cluster.Builder |
withSSL(SSLOptions sslOptions)
Enable the use of SSL for the created Cluster using the provided options. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public Cluster.Builder()
Method Detail |
---|
public List<InetAddress> getContactPoints()
Cluster.Initializer
getContactPoints
in interface Cluster.Initializer
addContactPoint(java.lang.String)
for more details on contact points.public Cluster.Builder withPort(int port)
port
- the port to set.
public Cluster.Builder addContactPoint(String address)
address
- the address of the node to connect to
IllegalArgumentException
- if no IP address for address
could be found
SecurityException
- if a security manager is present and
permission to resolve the host name is denied.public Cluster.Builder addContactPoints(String... addresses)
addContactPoint(java.lang.String)
for more details on contact
points.
addresses
- addresses of the nodes to add as contact point
IllegalArgumentException
- if no IP address for at least one
of addresses
could be found
SecurityException
- if a security manager is present and
permission to resolve the host name is denied.addContactPoint(java.lang.String)
public Cluster.Builder addContactPoints(InetAddress... addresses)
addContactPoint(java.lang.String)
for more details on contact
points.
addresses
- addresses of the nodes to add as contact point
addContactPoint(java.lang.String)
public Cluster.Builder withLoadBalancingPolicy(LoadBalancingPolicy policy)
If no load balancing policy is set through this method,
Policies.defaultLoadBalancingPolicy()
will be used instead.
policy
- the load balancing policy to use
public Cluster.Builder withReconnectionPolicy(ReconnectionPolicy policy)
If no reconnection policy is set through this method,
Policies.DEFAULT_RECONNECTION_POLICY
will be used instead.
policy
- the reconnection policy to use
public Cluster.Builder withRetryPolicy(RetryPolicy policy)
If no retry policy is set through this method,
Policies.DEFAULT_RETRY_POLICY
will be used instead.
policy
- the retry policy to use
public Cluster.Builder withCredentials(String username, String password)
This should be used if the Cassandra cluster has been configured to
use the PasswordAuthenticator
. If the the default AllowAllAuthenticator
is used instead, using this method has no
effect.
username
- the username to use to login to Cassandra hosts.password
- the password corresponding to username
.
public Cluster.Builder withAuthProvider(AuthProvider authProvider)
Use this method when a custom authentication scheme is in place.
You shouldn't call both this method and withCredentials
on the same Builder
instance as one will supercede the
other
authProvider
- the AuthProvider
to use to login to
Cassandra hosts.
public Cluster.Builder withCompression(ProtocolOptions.Compression compression)
compression
- the compression to set
ProtocolOptions.Compression
public Cluster.Builder withoutMetrics()
public Cluster.Builder withSSL()
Cluster
.
Calling this method will use default SSL options (see SSLOptions.SSLOptions()
).
This is thus a shortcut for withSSL(new SSLOptions())
.
Note that if SSL is enabled, the driver will not connect to any
Cassandra nodes that doesn't have SSL enabled and it is strongly
advised to enable SSL on every Cassandra node if you plan on using
SSL in the driver.
public Cluster.Builder withSSL(SSLOptions sslOptions)
Cluster
using the provided options.
sslOptions
- the SSL options to use.
public Cluster.Builder withoutJMXReporting()
JMX reporting is enabled by default (see Metrics
) but can be
disabled using this option. If metrics are disabled, this is a
no-op.
public PoolingOptions poolingOptions()
public SocketOptions socketOptions()
public Configuration getConfiguration()
You should not modify this object directly because changes made
to the returned object may not be used by the cluster build.
Instead, you should use the other methods of this Builder
.
getConfiguration
in interface Cluster.Initializer
public Cluster build()
Cluster.buildFrom(this)
.
NoHostAvailableException
- if none of the contact points
provided can be reached.
AuthenticationException
- if an authentication error occurs.
while contacting the initial contact points
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |