com.basho.riak.client.api

Class RiakClient

java.lang.Object

com.basho.riak.client.api.RiakClient

public class RiakClient
extends Object

The client used to perform operations on Riak. The easiest way to get started with the client is using one of the static methods provided to instantiate and start the client:

 
 List addresses = new LinkedList();
 addresses.add("192.168.1.1");
 addresses.add("192.168.1.2");
 addresses.add("192.168.1.3");
 RiakClient client = RiakClient.newClient(addresses);
 
 

For more complex configurations, you can instantiate a RiakCluster from the core packages and supply it to the RiakClient constructor. Once you have a client, commands from the com.basho.riak.client.api.commands.* packages are built then executed by the client:

 
 Namespace ns = new Namespace("default","my_bucket");
 Location loc = new Location(ns, "my_key");
 FetchValue fv = new FetchValue.Builder(loc).build();
 FetchValue.Response response = client.execute(fv);
 RiakObject obj = response.getValue(RiakObject.class);
 
 

Since:

2.0

Author:

Dave Rusek

Constructor Summary

Constructors

Constructor and Description
RiakClient(RiakCluster cluster) Create a new RiakClient to perform operations on the given cluster.

Method Summary

Methods

Modifier and Type	Method and Description
<T,S> T	execute(RiakCommand<T,S> command) Execute a command against Riak
<T,S> RiakFuture<T,S>	executeAsync(RiakCommand<T,S> command) Execute a command asynchronously against Riak.
static RiakClient	newClient() Static factory method to create a new client instance.
static RiakClient	newClient(int port, List<String> remoteAddresses) Static factory method to create a new client instance.
static RiakClient	newClient(List<String> remoteAddresses) Static factory method to create a new client instance.
Future<Boolean>	shutdown() Shutdown the client and the underlying cluster.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RiakClient

public RiakClient(RiakCluster cluster)

Create a new RiakClient to perform operations on the given cluster.

The RiakClient provides a user API on top of the client core. Once instantiated, commands are submitted to it for execution on Riak.

 RiakClient client = RiakClient.newClient();
 Namespace ns = new Namespace("default","my_bucket");
 Location loc = new Location(ns, "my_key");
 FetchValue fv = new FetchValue.Builder(loc).build();
 FetchValue.Response response = client.execute(fv);
 RiakObject obj = response.getValue(RiakObject.class);
 client.shutdown();
 

Parameters:

cluster - the started RiakCluster to use.

Method Detail

newClient

public static RiakClient newClient()
                            throws UnknownHostException

Static factory method to create a new client instance. This method produces a client that connects to 127.0.0.1.

Returns:

a new client instance.

Throws:

UnknownHostException

newClient

public static RiakClient newClient(List<String> remoteAddresses)
                            throws UnknownHostException

Static factory method to create a new client instance. This method produces a client connected to the supplied addresses on the default port.

Parameters:

remoteAddresses - a list of IP addresses or hostnames

Returns:

a new client instance

Throws:

UnknownHostException - if a supplied hostname cannot be resolved.

newClient

public static RiakClient newClient(int port,
                   List<String> remoteAddresses)
                            throws UnknownHostException

Static factory method to create a new client instance. This method produces a client connected to the supplied addresses on the supplied port.

Parameters:

remoteAddresses - a list of IP addresses or hostnames

port - the port to connect to on the supplied hosts.

Returns:

a new client instance

Throws:

UnknownHostException - if a supplied hostname cannot be resolved.

execute

public <T,S> T execute(RiakCommand<T,S> command)
          throws ExecutionException,
                 InterruptedException

Execute a command against Riak

Type Parameters:

T - The command's return type

Parameters:

command - The command

Returns:

a response from Riak

Throws:

ExecutionException

InterruptedException

executeAsync

public <T,S> RiakFuture<T,S> executeAsync(RiakCommand<T,S> command)

Execute a command asynchronously against Riak.

Parameters:

command - The command to execute.

Returns:

a future for the operation.

shutdown

public Future<Boolean> shutdown()

Shutdown the client and the underlying cluster.

Returns:

a future that will complete when shutdown