+ * @since 2.0
+ */
+@Retention(RetentionPolicy.RUNTIME) @Target({ElementType.FIELD, ElementType.METHOD}) public @interface RiakBucketType
+{
+
+}
diff --git a/src/main/java/com/basho/riak/client/api/annotations/RiakContentType.java b/src/main/java/com/basho/riak/client/api/annotations/RiakContentType.java
new file mode 100644
index 000000000..b63abd015
--- /dev/null
+++ b/src/main/java/com/basho/riak/client/api/annotations/RiakContentType.java
@@ -0,0 +1,65 @@
+/*
+ * Copyright 2014 Basho Technologies Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.basho.riak.client.api.annotations;
+
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+import java.lang.annotation.ElementType;
+
+
+/**
+ * Annotates a field or getter/setter method pair in a class to serve as the content-type.
+ *
+ * The type must be a {@code String}.
+ *
+ *
+ * In most cases this is not needed as the {@link com.basho.riak.client.api.convert.Converter}
+ * will supply the appropriate content-type during serialization.
+ *
+ *
+ * class MyPojo
+ * {
+ * {@literal @}RiakContentType
+ * String contentType;
+ * }
+ *
+ * class MyPojo
+ * {
+ * private String contentType;
+ *
+ * {@literal @}RiakContentType
+ * public void setContentType(String contentType)
+ * {
+ * this.contentType = contentType;
+ * }
+ *
+ * {@literal @}RiakContentType
+ * public String getContentType()
+ * {
+ * return contentType;
+ * }
+ * }
+ *
+ *
+ * @author Brian Roach
+ * @since 2.0
+ */
+@Retention(RetentionPolicy.RUNTIME) @Target({ElementType.FIELD, ElementType.METHOD}) public @interface RiakContentType
+{
+
+}
diff --git a/src/main/java/com/basho/riak/client/api/annotations/RiakIndex.java b/src/main/java/com/basho/riak/client/api/annotations/RiakIndex.java
new file mode 100644
index 000000000..79170c94c
--- /dev/null
+++ b/src/main/java/com/basho/riak/client/api/annotations/RiakIndex.java
@@ -0,0 +1,79 @@
+/*
+ * This file is provided to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations under
+ * the License.
+ */
+package com.basho.riak.client.api.annotations;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * Annotates a field or getter/setter method pair in a class to serve as a RiakIndex.
+ *
+ * You do not need to specify the index type suffix ({@code _bin}/{@code _int}). It will be
+ * inferred from the type of the annotated field except when using {@code byte[]};
+ * in this case the full index name including the suffix must be supplied.
+ *
+ *
+ * For {@code _bin} indexes, {@code String} and {@code byte[]} types are supported.
+ * For {@code _int} indexes, {@code Long}, {@code BigInteger} and {@code byte[]}
+ * are supported. This can either be a single instance or a {@code Set}.
+ *
+ *
+ * Important Note: if there are multiple index keys for the object and the field
+ * is a single value rather than a {@code Set}, only a single index key will be
+ * set (the first returned).
+ *
+ *
+ * public class MyClass
+ * {
+ * {@literal @}RiakKey
+ * private String myKeyString;
+ *
+ * {@literal @}RiakIndex(name="email")
+ * private {@literal Set} emailAddress; // will be indexed in the email_bin index
+ *
+ * {@literal @}RiakIndex(name="age")
+ * private long age; // will be indexed in the age_int index
+ * }
+ *
+ * public class MyClass
+ * {
+ * private {@literal Set} categoryIds;
+ *
+ * {@literal @}RiakIndex(name="category_ids")
+ * public {@literal Set} getCategoryIds()
+ * {
+ * return categoryIds;
+ * }
+ *
+ * {@literal @}RiakIndex(name="category_ids")
+ * public void setCategoryIds({@literal Set} ids)
+ * {
+ * categoryIds = ids;
+ * }
+ * }
+ *
+ *
+ *
+ * @author Russell Brown
+ * @author Brian Roach
+ * @since 1.0
+*/
+@Retention(RetentionPolicy.RUNTIME) @Target({ElementType.FIELD, ElementType.METHOD}) public @interface RiakIndex {
+ /**
+ * @return the index name
+ */
+ String name() default "";
+}
diff --git a/src/main/java/com/basho/riak/client/api/annotations/RiakKey.java b/src/main/java/com/basho/riak/client/api/annotations/RiakKey.java
new file mode 100644
index 000000000..cb0bda717
--- /dev/null
+++ b/src/main/java/com/basho/riak/client/api/annotations/RiakKey.java
@@ -0,0 +1,58 @@
+/*
+ * Copyright 2014 Basho Technologies Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.basho.riak.client.api.annotations;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * Annotates a field or getter/setter method pair in a class to serve as the key.
+ *
+ * The type must be a {@code String}.
+ *
+ *
+ * public class MyPojo
+ * {
+ * {@literal @}RiakKey
+ * public String key;
+ * }
+ *
+ * public class AnotherPojo
+ * {
+ * private String key;
+ *
+ * {@literal @}RiakKey
+ * public String getKey()
+ * {
+ * return key;
+ * }
+ *
+ * {@literal @}RiakKey
+ * public void setKey(String key)
+ * {
+ * this.key = key;
+ * }
+ * }
+ *
+ * @author Russell Brown
+ * @author Brian Roach
+ * @since 1.0
+ */
+@Retention(RetentionPolicy.RUNTIME) @Target({ElementType.FIELD, ElementType.METHOD}) public @interface RiakKey {
+
+}
diff --git a/src/main/java/com/basho/riak/client/api/annotations/RiakLastModified.java b/src/main/java/com/basho/riak/client/api/annotations/RiakLastModified.java
new file mode 100644
index 000000000..78b8c0707
--- /dev/null
+++ b/src/main/java/com/basho/riak/client/api/annotations/RiakLastModified.java
@@ -0,0 +1,56 @@
+/*
+ * Copyright Basho Technologies Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.basho.riak.client.api.annotations;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * Annotates a field or setter method in a class to store last modified.
+ *
+ * This value is only populated when fetching an object from riak. Setting it when
+ * storing an object has no effect. A getter method is not supported; only a setter
+ * method may be annotated. The type must be {@literal long} or {@literal Long}.
+ *
+ *
+ * class MyPojo
+ * {
+ * {@literal @}RiakLastModified
+ * Long lastModified;
+ * }
+ *
+ * class MyPojo
+ * {
+ * private Long lastModified;
+ *
+ * {@literal @}RiakLastModified
+ * public void setLastModified(Long lastModified)
+ * {
+ * this.lastModified = lastModified;
+ * }
+ * }
+ *
+ *
+ * @author Brian Roach
+ * @since 2.0
+ */
+@Retention(RetentionPolicy.RUNTIME) @Target({ElementType.FIELD, ElementType.METHOD}) public @interface RiakLastModified
+{
+
+}
diff --git a/src/main/java/com/basho/riak/client/api/annotations/RiakLinks.java b/src/main/java/com/basho/riak/client/api/annotations/RiakLinks.java
new file mode 100644
index 000000000..e2dadbbcd
--- /dev/null
+++ b/src/main/java/com/basho/riak/client/api/annotations/RiakLinks.java
@@ -0,0 +1,59 @@
+/*
+ * Copyright 2014 Basho Technologies Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.basho.riak.client.api.annotations;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * Annotates a field or getter/setter method pair in a class to serve as a set of links.
+ *
+ * The type must be {@literal Collection}.
+ *
+ * class MyPojo
+ * {
+ * {@literal @}RiakLinks
+ * {@literal Collection} riakLinks;
+ * }
+ *
+ * class MyPojo
+ * {
+ * private {@literal Collection} riakLinks;
+ *
+ * {@literal @}RiakLinks
+ * public void setRiakLinks({@literal Collection} riakLinks)
+ * {
+ * this.riakLinks = riakLinks;
+ * }
+ *
+ * {@literal @}RiakLinks
+ * public {@literal Collection} getRiakLinks()
+ * {
+ * return riakLinks;
+ * }
+ * }
+ *
+ *
+ *
+ *
+ * @author Russell Brown
+ * @author Brian Roach
+ * @since 1.0
+*/
+@Retention(RetentionPolicy.RUNTIME) @Target({ElementType.FIELD, ElementType.METHOD}) public @interface RiakLinks {
+}
diff --git a/src/main/java/com/basho/riak/client/api/annotations/RiakTombstone.java b/src/main/java/com/basho/riak/client/api/annotations/RiakTombstone.java
new file mode 100644
index 000000000..18c03eb20
--- /dev/null
+++ b/src/main/java/com/basho/riak/client/api/annotations/RiakTombstone.java
@@ -0,0 +1,57 @@
+/*Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.basho.riak.client.api.annotations;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * Annotates a field or getter/setter method pair in a class to serve as the tombstone indicator.
+ *
+ * This annotation is used to denote a boolean field or getter/setter pair that will be marked true
+ * if the object is a tombstone (deleted vector clock)
+ *
+ *
+ * public class MyPojo
+ * {
+ * {@literal @}RiakTombstone
+ * public boolean tombstone;
+ * }
+ *
+ * public class AnotherPojo
+ * {
+ * private boolean tombstone;
+ *
+ * {@literal @}RiakTombstone
+ * public boolean getTombstone()
+ * {
+ * return tombstone;
+ * }
+ *
+ * {@literal @}RiakTombstone
+ * public void setTombstone(boolean tombstone)
+ * {
+ * this.tombstone = tombstone;
+ * }
+ * }
+ *
+ *
+ * @author Brian Roach
+ * @since 2.0
+ */
+
+@Retention(RetentionPolicy.RUNTIME) @Target({ElementType.FIELD, ElementType.METHOD}) public @interface RiakTombstone {
+
+}
diff --git a/src/main/java/com/basho/riak/client/api/annotations/RiakUsermeta.java b/src/main/java/com/basho/riak/client/api/annotations/RiakUsermeta.java
new file mode 100644
index 000000000..123328eb9
--- /dev/null
+++ b/src/main/java/com/basho/riak/client/api/annotations/RiakUsermeta.java
@@ -0,0 +1,83 @@
+/*
+ * This file is provided to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations under
+ * the License.
+ */
+package com.basho.riak.client.api.annotations;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * Annotates a field or getter/setter method pair in a class to serve as containing user meta data for a Riak
+ * object.
+ *
+ * If you set the key value (to anything other than the empty string) then you
+ * can use the annotation to map a single key of user meta data to a field.
+ *
+ *
+ *
+ * public class MyClass
+ * {
+ *
+ * {@literal @}RiakUsermeta
+ * private {@literal Map} usermetaData;
+ *
+ * {@literal @}RiakUsermeta("usermeta-data-key1")
+ * private String usermetaDataItem1;
+ * }
+ *
+ * public class MyClass
+ * {
+ * private {@literal Map} usermetaData;
+ * private String usermetaDataItem1;
+ *
+ * {@literal @}RiakUsermeta
+ * public {@literal Map} getMeta()
+ * {
+ * return usermetaData;
+ * }
+ *
+ * {@literal @}RiakUsermeta
+ * public void setMeta({@literal Map} meta)
+ * {
+ * usermetaData = meta;
+ * }
+ *
+ * {@literal @}RiakUsermeta("usermeta-data-key1")
+ * public String getSingleMeta()
+ * {
+ * return usermetaDataItem1;
+ * }
+ *
+ * {@literal @}RiakUsermeta("usermeta-data-key1")
+ * public void setSingleMeta(String meta)
+ * {
+ * usermetaDataItem1 = meta;
+ * }
+ * }
+ *
+ *
+ *
+ *
+ * @author Russel Brown
+ * @author Brian Roach
+ * @since 1.0
+ */
+@Retention(RetentionPolicy.RUNTIME) @Target({ElementType.FIELD, ElementType.METHOD}) public @interface RiakUsermeta {
+ /**
+ * Use a lower case key. The riak HTTP API *will* lower case key names.
+ * @return the key for the user meta item
+ */
+ String key() default "";
+}
diff --git a/src/main/java/com/basho/riak/client/api/annotations/RiakVClock.java b/src/main/java/com/basho/riak/client/api/annotations/RiakVClock.java
new file mode 100644
index 000000000..4c8b43fad
--- /dev/null
+++ b/src/main/java/com/basho/riak/client/api/annotations/RiakVClock.java
@@ -0,0 +1,58 @@
+/*
+ * Copyright 2014 Basho Technologies Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.basho.riak.client.api.annotations;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * Annotates a field or getter/setter method pair in a class to serve as the vector clock.
+ *
+ * This annotation can be used with either {@code byte[]} or {@code VClock} types.
+ *
+ *
+ * public class MyPojo
+ * {
+ * {@literal @}RiakVClock
+ * public VClock vclock;
+ * }
+ *
+ * public class AnotherPojo
+ * {
+ * private VClock vclock;
+ *
+ * {@literal @}RiakVClock
+ * public VClock getVClock()
+ * {
+ * return vclock;
+ * }
+ *
+ * {@literal @}RiakVClock
+ * public void setVClock(VClock vclock)
+ * {
+ * this.vclock = vclock;
+ * }
+ * }
+ *
+ * @author Brian Roach
+ * @since 1.4
+ */
+
+@Retention(RetentionPolicy.RUNTIME) @Target({ElementType.FIELD, ElementType.METHOD}) public @interface RiakVClock {
+
+}
diff --git a/src/main/java/com/basho/riak/client/api/annotations/RiakVTag.java b/src/main/java/com/basho/riak/client/api/annotations/RiakVTag.java
new file mode 100644
index 000000000..5aea1cd52
--- /dev/null
+++ b/src/main/java/com/basho/riak/client/api/annotations/RiakVTag.java
@@ -0,0 +1,56 @@
+/*
+ * Copyright 2014 Basho Technologies Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.basho.riak.client.api.annotations;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * Annotates a field or setter method in a class to store the VTag.
+ *
+ * This value is only populated when fetching an object from riak. Setting it when
+ * storing an object has no effect. A getter method is not supported; only a setter
+ * method may be annotated. The type must be {@literal String}.
+ *
+ *
+ * class MyPojo
+ * {
+ * {@literal @}RiakVTag
+ * String vtag;
+ * }
+ *
+ * class MyPojo
+ * {
+ * private String vtag;
+ *
+ * {@literal @}RiakVTag
+ * public void setVTag(String vtag)
+ * {
+ * this.vtag = vtag;
+ * }
+ * }
+ *
+ *
+ * @author Brian Roach
+ * @since 2.0
+ */
+@Retention(RetentionPolicy.RUNTIME) @Target({ElementType.FIELD, ElementType.METHOD}) public @interface RiakVTag
+{
+
+}
diff --git a/src/main/java/com/basho/riak/client/api/annotations/package-info.java b/src/main/java/com/basho/riak/client/api/annotations/package-info.java
new file mode 100644
index 000000000..b55b4964a
--- /dev/null
+++ b/src/main/java/com/basho/riak/client/api/annotations/package-info.java
@@ -0,0 +1,51 @@
+/**
+ * Annotations to use for ORM.
+ *
+ * Introduction
+ * The Riak Java client provides a full set of annotations to facilitate simply
+ * storing/retrieving your own domain object. All annotations can be applied to
+ * a field or a getter/setter pair of methods.
+ *
+ * In addition, the {@link com.basho.riak.client.api.convert.Converter}
+ * interface allows for serialization/deserialization for the data portion.
+ *
+ *
+ * By annotating your own domain object, you can simply pass an instance of it
+ * to {@link com.basho.riak.client.api.commands.kv.StoreValue}.
+ *
+ *
+ * When fetching data from Riak, the reverse is also true. The {@link com.basho.riak.client.api.commands.kv.FetchValue.Response}
+ * handles injecting your domain object with any of the annotated values.
+ *
+ *
+ * Raw types as well as Generic types are supported. The latter is done via Jackson's
+ * {@code TypeReferece} class.
+ *
+ * OverView
+ * To store an object in Riak there's a minimum of four pieces of information
+ * required; a bucket type, a bucket name, a key, and a vector clock. For an
+ * annotated domain object, only three of these are required as in the absence of
+ * a bucket type, the default "default" type is supplied.
+ *
+ *
+ * public class AnnotatedPojo
+ * {
+ * {@literal @}RiakBucketType
+ * public String bucketType;
+ *
+ * {@literal @}RiakBucketName
+ * public String bucketName;
+ *
+ * {@literal @}RiakKey
+ * public String key;
+ *
+ * {@literal @}RiakVClock
+ * VClock clock;
+ *
+ * public String value;
+ * }
+ *
+ *
+ *
+ */
+package com.basho.riak.client.api.annotations;
diff --git a/src/main/java/com/basho/riak/client/api/cap/BasicVClock.java b/src/main/java/com/basho/riak/client/api/cap/BasicVClock.java
new file mode 100644
index 000000000..77bdfd648
--- /dev/null
+++ b/src/main/java/com/basho/riak/client/api/cap/BasicVClock.java
@@ -0,0 +1,97 @@
+/*
+ * Copyright 2013 Basho Technologies Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.basho.riak.client.api.cap;
+
+import java.io.UnsupportedEncodingException;
+import java.nio.charset.Charset;
+import java.util.Arrays;
+
+/**
+ * Encapsulates a Riak vector clock.
+ * @author Russel Brown
+ * @since 1.0
+ */
+public class BasicVClock implements VClock
+{
+ private final byte[] value;
+
+ /**
+ * Create a BasicVclock.
+ * @param value the vector clock bytes. NOTE: copies the value
+ * @throws IllegalArgumentException if value is null
+ */
+ public BasicVClock(final byte[] value) {
+ if (value == null) {
+ throw new IllegalArgumentException("VClock value cannot be null");
+ }
+ this.value = Arrays.copyOf(value, value.length);
+ }
+
+ /**
+ * Create a BasicVclock from utf8 String.
+ * @param vclock the vector clock.
+ * @throws IllegalArgumentException if {@code vclock} is null
+ */
+ public BasicVClock(String vclock)
+ {
+ if (vclock == null) {
+ throw new IllegalArgumentException("VClock value cannot be null");
+ }
+ this.value = vclock.getBytes(Charset.forName("UTF-8"));
+ }
+
+ @Override
+ public byte[] getBytes()
+ {
+ return Arrays.copyOf(value, value.length);
+ }
+
+ @Override
+ public String asString()
+ {
+ try
+ {
+ return new String(value, "UTF-8");
+ }
+ catch (UnsupportedEncodingException ex)
+ {
+ throw new IllegalStateException(ex);
+ }
+ }
+
+ @Override
+ public boolean equals(Object o)
+ {
+ if (o != null)
+ {
+ if (o instanceof VClock)
+ {
+ VClock other = (VClock)o;
+ return Arrays.equals(other.getBytes(), value);
+ }
+ }
+
+ return false;
+ }
+
+ @Override
+ public int hashCode()
+ {
+ int hash = 3;
+ hash = 67 * hash + Arrays.hashCode(this.value);
+ return hash;
+ }
+}
diff --git a/src/main/java/com/basho/riak/client/api/cap/ConflictResolver.java b/src/main/java/com/basho/riak/client/api/cap/ConflictResolver.java
new file mode 100644
index 000000000..566119aa3
--- /dev/null
+++ b/src/main/java/com/basho/riak/client/api/cap/ConflictResolver.java
@@ -0,0 +1,40 @@
+/*
+ * Copyright 2013 Basho Technologies Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.basho.riak.client.api.cap;
+
+import java.util.List;
+
+/**
+ * Interface used to resolve siblings.
+ *
+ * When you have multiple writers there may be multiple versions of the same
+ * object stored in Riak. When fetching all of these will be returned and you
+ * will need to resolve the conflict.
+ *
+ *
+ * To facilitate this, you can store an instance of the ConflictResolver
+ * in the {@link com.basho.riak.client.api.cap.ConflictResolverFactory} for a class.
+ * It will then be used by the {@link com.basho.riak.client.api.commands.kv.FetchValue.Response}
+ * to resolve a set a of siblings to a single object.
+ *
+ * @author Brian Roach
+ * @since 2.0
+ * @param The type of the objects to be resolved.
+ */
+public interface ConflictResolver
+{
+ T resolve(List objectList) throws UnresolvedConflictException;
+}
diff --git a/src/main/java/com/basho/riak/client/api/cap/ConflictResolverFactory.java b/src/main/java/com/basho/riak/client/api/cap/ConflictResolverFactory.java
new file mode 100644
index 000000000..6ede66272
--- /dev/null
+++ b/src/main/java/com/basho/riak/client/api/cap/ConflictResolverFactory.java
@@ -0,0 +1,139 @@
+/*
+ * Copyright 2014 Basho Technologies Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.basho.riak.client.api.cap;
+
+import com.fasterxml.jackson.core.type.TypeReference;
+import java.lang.reflect.Type;
+import java.util.Map;
+import java.util.concurrent.ConcurrentHashMap;
+
+/**
+ * Simple factory for ConflictResolver objects.
+ *
+ * When you have multiple writers there may be multiple versions of the same
+ * object stored in Riak. When fetching all of these will be returned and you
+ * will need to resolve the conflict.
+ *
+ *
+ * To facilitate this, you can store an instance of the {@link ConflictResolver}
+ * in this factory for a class. It will then be used by the {@link com.basho.riak.client.api.commands.kv.FetchValue.Response}
+ * to resolve a set a of siblings to a single object.
+ *
+ *
+ * @author Brian Roach
+ * @since 2.0
+ */
+public enum ConflictResolverFactory
+{
+ INSTANCE;
+
+ private final Map> resolverInstances =
+ new ConcurrentHashMap>();
+
+ /**
+ * Returns the instance of the ConflictResolverFactory.
+ * @return The ConflictResolverFactory
+ */
+ public static ConflictResolverFactory getInstance()
+ {
+ return INSTANCE;
+ }
+
+ public ConflictResolver getConflictResolver(Class clazz)
+ {
+ if (clazz == null)
+ {
+ throw new IllegalArgumentException("clazz cannot be null");
+ }
+ return getConflictResolver(clazz, null);
+ }
+
+ public ConflictResolver getConflictResolver(TypeReference typeReference)
+ {
+ if (typeReference == null)
+ {
+ throw new IllegalArgumentException("typeReference cannot be null");
+ }
+ return getConflictResolver(null, typeReference);
+ }
+
+
+ /**
+ * Return the ConflictResolver for the given class.
+ *
+ * If no ConflictResolver is registered for the provided class, an instance of the
+ * {@link com.basho.riak.client.cap.DefaultResolver} is returned.
+ *
+ * @param The type being resolved
+ * @param clazz the class of the type being resolved
+ * @return The conflict resolver for the type.
+ * @throws UnresolvedConflictException
+ */
+ @SuppressWarnings("unchecked")
+ private ConflictResolver getConflictResolver(Type type, TypeReference typeReference)
+ {
+
+ type = type != null ? type : typeReference.getType();
+
+ ConflictResolver resolver = (ConflictResolver) resolverInstances.get(type);
+ if (resolver == null)
+ {
+ // Cache this?
+ resolver = (ConflictResolver) new DefaultResolver();
+ }
+
+ return resolver;
+
+
+ }
+
+ /**
+ * Register a ConflictResolver.
+ *
+ * The instance provided will be used to resolve siblings for the given type.
+ *
+ *
+ * @param The type being resolved
+ * @param clazz the class of the type being resolved
+ * @param resolver an instance of a class implementing ConflictResolver.
+ */
+ public void registerConflictResolver(Class clazz, ConflictResolver resolver)
+ {
+ resolverInstances.put(clazz, resolver);
+ }
+
+ public void registerConflictResolver(TypeReference typeReference, ConflictResolver resolver)
+ {
+ resolverInstances.put(typeReference.getType(), resolver);
+ }
+
+
+ /**
+ * Unregister a ConflictResolver.
+ * @param The type being Resolved
+ * @param clazz the class of the type being resolved.
+ */
+ public void unregisterConflictResolver(Class clazz)
+ {
+ resolverInstances.remove(clazz);
+ }
+
+ public void unregisterConflictResolver(TypeReference typeReference)
+ {
+ resolverInstances.remove(typeReference.getType());
+ }
+}
diff --git a/src/main/java/com/basho/riak/client/api/cap/DefaultResolver.java b/src/main/java/com/basho/riak/client/api/cap/DefaultResolver.java
new file mode 100644
index 000000000..7015ed0c1
--- /dev/null
+++ b/src/main/java/com/basho/riak/client/api/cap/DefaultResolver.java
@@ -0,0 +1,60 @@
+/*
+ * Copyright 2013 Basho Technologies Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.basho.riak.client.api.cap;
+
+import java.util.List;
+
+/**
+ * A conflict resolver that doesn't resolve conflict.
+ *
+ * This is the default ConflictResolver used if there is not one registered
+ * in the {@link com.basho.riak.client.api.cap.ConflictResolverFactory} for the
+ * class of object being resolved.
+ *
+ *
+ * If it is presented with a
+ * collection of siblings with more than one entry it throws an Exception.
+ *
+ * @author Russell Brown
+ * @since 1.0
+ */
+public class DefaultResolver implements ConflictResolver
+{
+
+ /**
+ * Detects conflict but does not resolve it.
+ *
+ * @param siblings the list of siblings returned from Riak
+ * @return null or the single value in the collection
+ * @throws UnresolvedConflictException if {@code siblings} has > 1 entry.
+ */
+ @Override
+ public T resolve(List siblings) throws UnresolvedConflictException
+ {
+ if (siblings.size() > 1)
+ {
+ throw new UnresolvedConflictException("Siblings found", siblings);
+ }
+ else if (siblings.size() == 1)
+ {
+ return siblings.get(0);
+ }
+ else
+ {
+ return null;
+ }
+ }
+}
diff --git a/src/main/java/com/basho/riak/client/api/cap/Quorum.java b/src/main/java/com/basho/riak/client/api/cap/Quorum.java
new file mode 100644
index 000000000..9cbe3d89f
--- /dev/null
+++ b/src/main/java/com/basho/riak/client/api/cap/Quorum.java
@@ -0,0 +1,191 @@
+/*
+ * Copyright 2013 Basho Technologies Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.basho.riak.client.api.cap;
+
+/**
+ * Encapsulates a r/w/dw/rw/pr/pw quorum.
+ *
+ * Symbolic Consistency Names
+ * Riak 0.12 introduced “symbolic” consistency options for R and W
+ * that can be easier to use and understand. They are:
+ *
+ *
+ * -
+ * all - All replicas must reply. This is the same as setting R or W equal to N.
+ *
+ * -
+ * one - This is the same as sending 1 as the R or W value.
+ *
+ * -
+ * quorum - A majority of the replicas must respond, that is, “half plus one”.
+ * For the default N value of 3, this calculates to 2.
+ *
+ * -
+ * default - Uses whatever the per-bucket consistency property is for R or W,
+ * which may be any of the above values, or an integer.
+ *
+ *
+ *
+ * Static factory methods are provided as a convenience for using these.
+ *
+ * @author Brian Roach
+ * @since 2.0
+ * @see CAP Controls
+ */
+public final class Quorum {
+
+ public static final String ONE = "one";
+ public static final String QUORUM = "quorum";
+ public static final String ALL = "all";
+ public static final String DEFAULT = "default";
+
+ private final int i;
+
+ /**
+ * Construct an instance using an integer value.
+ *
+ * @param i the quorum value
+ */
+ public Quorum(int i) {
+ if (i < -5 || i == -1)
+ {
+ throw new IllegalArgumentException("Illegal value for quorum: " + i);
+ }
+ this.i = i;
+ }
+
+ /**
+ * Static factory method for a quorum of "one"
+ * @return a new Quorum with an integer value of -2
+ */
+ public static Quorum oneQuorum()
+ {
+ return new Quorum(-2);
+ }
+
+ /**
+ * Static factory method for a quorum of "quorum"
+ * @return a new Quorum with an integer value of -3
+ */
+ public static Quorum quorumQuorum()
+ {
+ return new Quorum(-3);
+ }
+
+ /**
+ * Static factory method for a quorum of "all"
+ * @return a new Quorum with an integer value of -4
+ */
+ public static Quorum allQuorum()
+ {
+ return new Quorum(-4);
+ }
+
+ /**
+ * Static factory method for a quorum of "default"
+ * @return a new Quorum with an integer value of -5
+ */
+ public static Quorum defaultQuorum()
+ {
+ return new Quorum(-5);
+ }
+
+ /**
+ * Determine if the quorum has a symbolic value.
+ * @return true if this Quorum represents a symbolic value, false if literal
+ * integer value
+ */
+ public boolean isSymbolic() {
+ switch(i)
+ {
+ case -2: // "one"
+ case -3: // "quorum"
+ case -4: // "all"
+ case -5: // "default"
+ return true;
+ default:
+ return false;
+ }
+ }
+
+ /**
+ * The int value of the quorum. Call isSymbolic to determine if you should
+ * use this.
+ *
+ * @return the int value. Will be a negative number for symbolic values.
+ */
+ public int getIntValue() {
+ return i;
+ }
+
+ @Override
+ public String toString()
+ {
+ String quorum = null;
+ if (i > 0)
+ {
+ quorum = Integer.toString(i);
+ }
+ else
+ {
+
+ switch(i)
+ {
+ case -2:
+ quorum = ONE;
+ break;
+ case -3:
+ quorum = QUORUM;
+ break;
+ case -4:
+ quorum = ALL;
+ break;
+ case -5:
+ quorum = DEFAULT;
+ break;
+ default:
+ break;
+ }
+ }
+
+ return quorum;
+ }
+
+ @Override public int hashCode() {
+ final int prime = 31;
+ int result = 1;
+ result = prime * result + i;
+ return result;
+ }
+
+ @Override public boolean equals(Object obj) {
+ if (this == obj) {
+ return true;
+ }
+ if (obj == null) {
+ return false;
+ }
+ if (!(obj instanceof Quorum)) {
+ return false;
+ }
+ Quorum other = (Quorum) obj;
+ if (i != other.i) {
+ return false;
+ }
+
+ return true;
+ }
+}
diff --git a/src/main/java/com/basho/riak/client/api/cap/UnresolvedConflictException.java b/src/main/java/com/basho/riak/client/api/cap/UnresolvedConflictException.java
new file mode 100644
index 000000000..1467bbfec
--- /dev/null
+++ b/src/main/java/com/basho/riak/client/api/cap/UnresolvedConflictException.java
@@ -0,0 +1,72 @@
+/*
+ * Copyright 2013 Basho Technologies Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.basho.riak.client.api.cap;
+
+import java.util.List;
+import java.util.concurrent.ExecutionException;
+
+/**
+ *
+ * Holds the Collection of siblings so they can be presented for further resolution attempts.
+ *
+ * @author Russell Brown
+ * @since 1.0
+ */
+public class UnresolvedConflictException extends ExecutionException {
+
+ /**
+ * eclipse generated id
+ */
+ private static final long serialVersionUID = -219858468775752064L;
+
+ private final List siblings;
+
+ /**
+ * For when a list of siblings cannot be whittled down to one.
+ *
+ * @param cause
+ * the exception that broke the camels back
+ * @param message
+ * a String message
+ * @param siblings
+ * the list of siblings
+ */
+ public UnresolvedConflictException(Throwable cause, String message, List siblings) {
+ super(message, cause);
+ this.siblings = siblings;
+ }
+
+ /**
+ * For when a collection of siblings cannot be whittled down to one.
+ *
+ * @param message
+ * a String message
+ * @param siblings
+ * the list of siblings
+ */
+ public UnresolvedConflictException(String message, List siblings) {
+ super(message);
+ this.siblings = siblings;
+ }
+
+ /**
+ * Get the siblings that could not be resolved.
+ * @return the siblings
+ */
+ public List getSiblings() {
+ return siblings;
+ }
+}
\ No newline at end of file
diff --git a/src/main/java/com/basho/riak/client/api/cap/VClock.java b/src/main/java/com/basho/riak/client/api/cap/VClock.java
new file mode 100644
index 000000000..1f10fb127
--- /dev/null
+++ b/src/main/java/com/basho/riak/client/api/cap/VClock.java
@@ -0,0 +1,37 @@
+/*
+ * Copyright 2013 Basho Technologies Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.basho.riak.client.api.cap;
+
+/**
+ * Access the opaque Riak vector clock as either a String or array of bytes.
+ *
+ * @author Russel Brown
+ * @since 1.0
+ */
+public interface VClock
+{
+ /**
+ * Get the bytes that make up this VClock.
+ * @return a copy of this vector clocks bytes
+ */
+ byte[] getBytes();
+
+ /**
+ * Get the string representation of this VClock.
+ * @return a UTF-8 String of this vector clocks bytes
+ */
+ String asString();
+}
diff --git a/src/main/java/com/basho/riak/client/api/cap/package-info.java b/src/main/java/com/basho/riak/client/api/cap/package-info.java
new file mode 100644
index 000000000..4100f40c2
--- /dev/null
+++ b/src/main/java/com/basho/riak/client/api/cap/package-info.java
@@ -0,0 +1,5 @@
+/**
+ * Classes related to eventual consistency in Riak.
+ */
+
+package com.basho.riak.client.api.cap;
\ No newline at end of file
diff --git a/src/main/java/com/basho/riak/client/api/commands/CoreFutureAdapter.java b/src/main/java/com/basho/riak/client/api/commands/CoreFutureAdapter.java
new file mode 100644
index 000000000..ba46b67ca
--- /dev/null
+++ b/src/main/java/com/basho/riak/client/api/commands/CoreFutureAdapter.java
@@ -0,0 +1,125 @@
+/*
+ * Copyright 2014 Brian Roach .
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.basho.riak.client.api.commands;
+
+import com.basho.riak.client.core.RiakFuture;
+import com.basho.riak.client.core.RiakFutureListener;
+import java.util.concurrent.ExecutionException;
+import java.util.concurrent.TimeUnit;
+import java.util.concurrent.TimeoutException;
+
+/**
+ *
+ * @author Brian Roach
+ * @since 2.0
+ * @param The core response type.
+ * @param The core query info type.
+ * @param The converted response type.
+ * @param The converted query info type.
+ */
+public abstract class CoreFutureAdapter extends ListenableFuture implements RiakFutureListener
+{
+ private final RiakFuture coreFuture;
+
+ public CoreFutureAdapter(RiakFuture coreFuture)
+ {
+ this.coreFuture = coreFuture;
+ }
+
+ @Override
+ public boolean cancel(boolean mayInterruptIfRunning)
+ {
+ return coreFuture.cancel(mayInterruptIfRunning);
+ }
+
+ @Override
+ public T2 get() throws InterruptedException, ExecutionException
+ {
+ return convertResponse(coreFuture.get());
+ }
+
+ @Override
+ public T2 get(long timeout, TimeUnit unit) throws InterruptedException, ExecutionException, TimeoutException
+ {
+ T response = coreFuture.get(timeout, unit);
+ return convertResponse(response);
+ }
+
+ @Override
+ public T2 getNow()
+ {
+ if (coreFuture.isDone())
+ {
+ return convertResponse(coreFuture.getNow());
+ }
+ else
+ {
+ return null;
+ }
+ }
+
+ @Override
+ public boolean isCancelled()
+ {
+ return coreFuture.isCancelled();
+ }
+
+ @Override
+ public boolean isDone()
+ {
+ return coreFuture.isDone();
+ }
+
+ @Override
+ public void await() throws InterruptedException
+ {
+ coreFuture.await();
+ }
+
+ @Override
+ public void await(long timeout, TimeUnit unit) throws InterruptedException
+ {
+ coreFuture.await(timeout, unit);
+ }
+
+ @Override
+ public boolean isSuccess()
+ {
+ return coreFuture.isSuccess();
+ }
+
+ @Override
+ public Throwable cause()
+ {
+ return coreFuture.cause();
+ }
+
+ @Override
+ public S2 getQueryInfo()
+ {
+ return convertQueryInfo(coreFuture.getQueryInfo());
+ }
+
+ @Override
+ public void handle(RiakFuture f)
+ {
+ notifyListeners();
+ }
+
+ protected abstract T2 convertResponse(T coreResponse);
+ protected abstract S2 convertQueryInfo(S coreQueryInfo);
+}
diff --git a/src/main/java/com/basho/riak/client/api/commands/ListenableFuture.java b/src/main/java/com/basho/riak/client/api/commands/ListenableFuture.java
new file mode 100644
index 000000000..91c088d8b
--- /dev/null
+++ b/src/main/java/com/basho/riak/client/api/commands/ListenableFuture.java
@@ -0,0 +1,86 @@
+/*
+ * Copyright 2014 Brian Roach .
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.basho.riak.client.api.commands;
+
+import com.basho.riak.client.core.RiakFuture;
+import com.basho.riak.client.core.RiakFutureListener;
+import java.util.HashSet;
+import java.util.Set;
+import java.util.concurrent.locks.ReentrantLock;
+
+/**
+ * The base class for RiakFutures returned to users.
+ * @author Brian Roach
+ * @since 2.0
+ */
+public abstract class ListenableFuture implements RiakFuture
+{
+ private final Set> listeners =
+ new HashSet>();
+ private final ReentrantLock listenersLock = new ReentrantLock();
+
+ @Override
+ public void addListener(RiakFutureListener listener)
+ {
+ listenersLock.lock();
+ try
+ {
+ if (isDone())
+ {
+ listener.handle(this);
+ }
+ else
+ {
+ listeners.add(listener);
+ }
+ }
+ finally
+ {
+ listenersLock.unlock();
+ }
+ }
+
+ @Override
+ public void removeListener(RiakFutureListener listener)
+ {
+ listenersLock.lock();
+ try
+ {
+ listeners.remove(listener);
+ }
+ finally
+ {
+ listenersLock.unlock();
+ }
+ }
+
+ protected void notifyListeners()
+ {
+ listenersLock.lock();
+ try
+ {
+ for (RiakFutureListener listener : listeners)
+ {
+ listener.handle(this);
+ }
+ }
+ finally
+ {
+ listenersLock.unlock();
+ }
+ }
+}
diff --git a/src/main/java/com/basho/riak/client/api/commands/RiakOption.java b/src/main/java/com/basho/riak/client/api/commands/RiakOption.java
new file mode 100644
index 000000000..6e70d62b5
--- /dev/null
+++ b/src/main/java/com/basho/riak/client/api/commands/RiakOption.java
@@ -0,0 +1,42 @@
+/*
+ * Copyright 2013 Basho Technologies Inc
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.basho.riak.client.api.commands;
+
+ /*
+ * @author Dave Rusek
+ * @since 2.0
+ */
+public class RiakOption
+{
+
+ private final String name;
+
+ public RiakOption(String name)
+ {
+ this.name = name;
+ }
+
+ public String getName()
+ {
+ return name;
+ }
+
+ @Override
+ public String toString()
+ {
+ return name;
+ }
+}
diff --git a/src/main/java/com/basho/riak/client/api/commands/buckets/FetchBucketProperties.java b/src/main/java/com/basho/riak/client/api/commands/buckets/FetchBucketProperties.java
new file mode 100644
index 000000000..d9a3c6325
--- /dev/null
+++ b/src/main/java/com/basho/riak/client/api/commands/buckets/FetchBucketProperties.java
@@ -0,0 +1,113 @@
+/*
+ * Copyright 2013 Basho Technologies Inc
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.basho.riak.client.api.commands.buckets;
+
+import com.basho.riak.client.api.RiakCommand;
+import com.basho.riak.client.api.commands.CoreFutureAdapter;
+import com.basho.riak.client.core.RiakCluster;
+import com.basho.riak.client.core.RiakFuture;
+import com.basho.riak.client.core.operations.FetchBucketPropsOperation;
+import com.basho.riak.client.core.query.Namespace;
+
+
+/**
+ * Command used to fetch the properties of a bucket in Riak.
+ *
+ *
+ *
+ * {@code
+ * Namespace ns = new Namespace("my_type", "my_bucket");
+ * FetchBucketProperties fbp = new FetchBucketProperties.Builder(ns).build();
+ * FetchBucketPropsOperation.Response resp = client.execute(fbp);
+ * BucketProperties props = resp.getBucketProperties();}
+ * Note that this simply returns the core response {@link com.basho.riak.client.core.operations.FetchBucketPropsOperation.Response}
+ *
+ *
+ * @author Dave Rusek
+ * @since 2.0
+ */
+public final class FetchBucketProperties extends RiakCommand
+{
+
+ private final Namespace namespace;
+
+ public FetchBucketProperties(Builder builder)
+ {
+ this.namespace = builder.namespace;
+ }
+
+ @Override
+ protected final RiakFuture executeAsync(RiakCluster cluster)
+ {
+ RiakFuture coreFuture =
+ cluster.execute(buildCoreOperation());
+
+ CoreFutureAdapter future =
+ new CoreFutureAdapter(coreFuture)
+ {
+ @Override
+ protected FetchBucketPropsOperation.Response convertResponse(FetchBucketPropsOperation.Response coreResponse)
+ {
+ return coreResponse;
+ }
+
+ @Override
+ protected Namespace convertQueryInfo(Namespace coreQueryInfo)
+ {
+ return coreQueryInfo;
+ }
+ };
+ coreFuture.addListener(future);
+ return future;
+ }
+
+ private FetchBucketPropsOperation buildCoreOperation()
+ {
+ return new FetchBucketPropsOperation.Builder(namespace).build();
+ }
+
+ /**
+ * Builder used to construct a FetchBucketPoperties command.
+ */
+ public static class Builder
+ {
+ private final Namespace namespace;
+
+ /**
+ * Construct a Builder for a FetchBucketProperties command.
+ * @param namespace The namespace for the bucket.
+ */
+ public Builder(Namespace namespace)
+ {
+ if (namespace == null)
+ {
+ throw new IllegalArgumentException("Namespace cannot be null");
+ }
+ this.namespace = namespace;
+ }
+
+ /**
+ * Construct a new FetchBucketProperties command.
+ * @return a new FetchBucketProperties command.
+ */
+ public FetchBucketProperties build()
+ {
+ return new FetchBucketProperties(this);
+ }
+ }
+
+}
diff --git a/src/main/java/com/basho/riak/client/api/commands/buckets/ListBuckets.java b/src/main/java/com/basho/riak/client/api/commands/buckets/ListBuckets.java
new file mode 100644
index 000000000..522e7052a
--- /dev/null
+++ b/src/main/java/com/basho/riak/client/api/commands/buckets/ListBuckets.java
@@ -0,0 +1,205 @@
+/*
+ * Copyright 2013 Basho Technologies Inc
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.basho.riak.client.api.commands.buckets;
+
+import com.basho.riak.client.api.RiakCommand;
+import com.basho.riak.client.api.commands.CoreFutureAdapter;
+import com.basho.riak.client.core.RiakCluster;
+import com.basho.riak.client.core.RiakFuture;
+import com.basho.riak.client.core.operations.ListBucketsOperation;
+import com.basho.riak.client.core.query.Namespace;
+import com.basho.riak.client.core.util.BinaryValue;
+
+import java.util.Iterator;
+import java.util.List;
+
+/**
+ * Command used to list the buckets contained in a bucket type.
+ *
+ *
+ *
+ * {@code
+ * ListBuckets lb = new ListBuckets.Builder("my_type").build();
+ * ListBuckets.Response resp = client.execute(lb);
+ * for (Namespace ns : response)
+ * {
+ * System.out.println(ns.getBucketName());
+ * }}
+ *
+ * @author Dave Rusek
+ * @since 2.0
+ */
+public final class ListBuckets extends RiakCommand
+{
+ private final int timeout;
+ private final BinaryValue type;
+
+ ListBuckets(Builder builder)
+ {
+ this.timeout = builder.timeout;
+ this.type = builder.type;
+ }
+
+ @Override
+ protected RiakFuture executeAsync(RiakCluster cluster)
+ {
+ RiakFuture coreFuture =
+ cluster.execute(buildCoreOperation());
+
+ CoreFutureAdapter future =
+ new CoreFutureAdapter(coreFuture)
+ {
+ @Override
+ protected Response convertResponse(ListBucketsOperation.Response coreResponse)
+ {
+ return new Response(type, coreResponse.getBuckets());
+ }
+
+ @Override
+ protected BinaryValue convertQueryInfo(BinaryValue coreQueryInfo)
+ {
+ return coreQueryInfo;
+ }
+ };
+ coreFuture.addListener(future);
+ return future;
+ }
+
+ private ListBucketsOperation buildCoreOperation()
+ {
+ ListBucketsOperation.Builder builder = new ListBucketsOperation.Builder();
+ if (timeout > 0)
+ {
+ builder.withTimeout(timeout);
+ }
+ return builder.build();
+ }
+
+ /**
+ * A response from a ListBuckets command.
+ * This encapsulates an immutable list of bucket names
+ * and is Iterable:
+ *
+ * {@code
+ * for (Namespace ns : response)
+ * {
+ * System.out.println(ns.getBucketName());
+ * }
+ * }
+ *
+ *
+ */
+ public static class Response implements Iterable {
+
+ private final BinaryValue type;
+ private final List buckets;
+
+ public Response(BinaryValue type, List buckets)
+ {
+ this.type = type;
+ this.buckets = buckets;
+ }
+
+ @Override
+ public Iterator iterator()
+ {
+ return new Itr(buckets.iterator(), type);
+ }
+ }
+
+ private static class Itr implements Iterator
+ {
+ private final Iterator iterator;
+ private final BinaryValue type;
+
+ private Itr(Iterator iterator, BinaryValue type)
+ {
+ this.iterator = iterator;
+ this.type = type;
+ }
+
+ @Override
+ public boolean hasNext()
+ {
+ return iterator.hasNext();
+ }
+
+ @Override
+ public Namespace next()
+ {
+ BinaryValue bucket = iterator.next();
+ return new Namespace(type, bucket);
+ }
+
+ @Override
+ public void remove()
+ {
+ iterator.remove();
+ }
+ }
+
+ /**
+ * Builder for a ListBuckets command.
+ */
+ public static class Builder
+ {
+ private int timeout;
+ private final BinaryValue type;
+
+ /**
+ * Construct a Builder for a ListBuckets command.
+ * @param type the bucket type.
+ */
+ public Builder(String type)
+ {
+ this.type = BinaryValue.create(type);
+ }
+
+ /**
+ * Construct a Builder for a ListBuckets command.
+ * @param type the bucket type.
+ */
+ public Builder(BinaryValue type)
+ {
+ this.type = type;
+ }
+
+ /**
+ * Set the Riak-side timeout value.
+ *
+ * By default, riak has a 60s timeout for operations. Setting
+ * this value will override that default for this operation.
+ *
+ * @param timeout the timeout in milliseconds to be sent to riak.
+ * @return a reference to this object.
+ */
+ public Builder withTimeout(int timeout)
+ {
+ this.timeout = timeout;
+ return this;
+ }
+
+ /**
+ * Construct a new ListBuckets command.
+ * @return a new ListBuckets command.
+ */
+ public ListBuckets build()
+ {
+ return new ListBuckets(this);
+ }
+ }
+
+}
diff --git a/src/main/java/com/basho/riak/client/api/commands/buckets/StoreBucketProperties.java b/src/main/java/com/basho/riak/client/api/commands/buckets/StoreBucketProperties.java
new file mode 100644
index 000000000..aa4631d64
--- /dev/null
+++ b/src/main/java/com/basho/riak/client/api/commands/buckets/StoreBucketProperties.java
@@ -0,0 +1,593 @@
+/*
+ * Copyright 2013 Basho Technologies Inc
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.basho.riak.client.api.commands.buckets;
+
+import com.basho.riak.client.api.RiakCommand;
+import com.basho.riak.client.api.commands.CoreFutureAdapter;
+import com.basho.riak.client.core.RiakCluster;
+import com.basho.riak.client.core.RiakFuture;
+import com.basho.riak.client.core.operations.StoreBucketPropsOperation;
+import com.basho.riak.client.core.query.Namespace;
+import com.basho.riak.client.core.query.functions.Function;
+
+
+/**
+ * Command used to store (modify) the properties of a bucket in Riak.
+ *
+ *
+ * {@code
+ * Namespace ns = new Namespace("my_type", "my_bucket");
+ * StoreBucketProperties sbp =
+ * new StoreBucketProperties.Builder(ns)
+ * .withAllowMulti(true)
+ * .build();
+ * client.execute(sbp);}
+ *
+ * @author Dave Rusek
+ * @since 2.0
+ */
+public final class StoreBucketProperties extends RiakCommand
+{
+
+ private final Namespace namespace;
+ private final Boolean allowMulti;
+ private final String backend;
+ private final Boolean basicQuorum;
+ private final Long bigVClock;
+ private final Function chashkeyFunction;
+ private final Boolean lastWriteWins;
+ private final Function linkWalkFunction;
+ private final Integer rw;
+ private final Integer dw;
+ private final Integer w;
+ private final Integer r;
+ private final Integer pr;
+ private final Integer pw;
+ private final Boolean notFoundOk;
+ private final Function preCommitHook;
+ private final Function postCommitHook;
+ private final Long oldVClock;
+ private final Long youngVClock;
+ private final Long smallVClock;
+ private final Integer nval;
+ private final Boolean legacySearch;
+ private final String searchIndex;
+
+ StoreBucketProperties(Builder builder)
+ {
+
+ this.namespace = builder.namespace;
+ this.allowMulti = builder.allowMulti;
+ this.backend = builder.backend;
+ this.bigVClock = builder.bigVClock;
+ this.chashkeyFunction = builder.chashkeyFunction;
+ this.lastWriteWins = builder.lastWriteWins;
+ this.basicQuorum = builder.basicQuorum;
+ this.linkWalkFunction = builder.linkWalkFunction;
+ this.rw = builder.rw;
+ this.dw = builder.dw;
+ this.w = builder.w;
+ this.pr = builder.pr;
+ this.pw = builder.pw;
+ this.r = builder.r;
+ this.notFoundOk = builder.notFoundOk;
+ this.preCommitHook = builder.preCommitHook;
+ this.postCommitHook = builder.postCommitHook;
+ this.oldVClock = builder.oldVClock;
+ this.youngVClock = builder.youngVClock;
+ this.smallVClock = builder.smallVClock;
+ this.nval = builder.nval;
+ this.legacySearch = builder.legacySearch;
+ this.searchIndex = builder.searchIndex;
+
+ }
+
+ @Override
+ protected final RiakFuture executeAsync(RiakCluster cluster)
+ {
+ RiakFuture coreFuture =
+ cluster.execute(buildCoreOperation());
+
+ CoreFutureAdapter future =
+ new CoreFutureAdapter(coreFuture)
+ {
+ @Override
+ protected Void convertResponse(Void coreResponse)
+ {
+ return coreResponse;
+ }
+
+ @Override
+ protected Namespace convertQueryInfo(Namespace coreQueryInfo)
+ {
+ return coreQueryInfo;
+ }
+ };
+ coreFuture.addListener(future);
+ return future;
+ }
+
+
+ private StoreBucketPropsOperation buildCoreOperation()
+ {
+ StoreBucketPropsOperation.Builder builder =
+ new StoreBucketPropsOperation.Builder(namespace);
+
+ if (allowMulti != null)
+ {
+ builder.withAllowMulti(allowMulti);
+ }
+
+ if (backend != null)
+ {
+ builder.withBackend(backend);
+ }
+
+ if (basicQuorum != null)
+ {
+ builder.withBasicQuorum(basicQuorum);
+ }
+
+ if (bigVClock != null)
+ {
+ builder.withBigVClock(bigVClock);
+ }
+
+ if (chashkeyFunction != null)
+ {
+ builder.withChashkeyFunction(chashkeyFunction);
+ }
+
+ if (lastWriteWins != null)
+ {
+ builder.withLastWriteWins(lastWriteWins);
+ }
+
+ if (linkWalkFunction != null)
+ {
+ builder.withLinkwalkFunction(linkWalkFunction);
+ }
+
+ if (rw != null)
+ {
+ builder.withRw(rw);
+ }
+
+ if (dw != null)
+ {
+ builder.withDw(dw);
+ }
+
+ if (w != null)
+ {
+ builder.withW(w);
+ }
+
+ if (r != null)
+ {
+ builder.withR(r);
+ }
+
+ if (pr != null)
+ {
+ builder.withPr(pr);
+ }
+
+ if (pw != null)
+ {
+ builder.withPw(pw);
+ }
+
+ if (notFoundOk != null)
+ {
+ builder.withNotFoundOk(notFoundOk);
+ }
+
+ if (preCommitHook != null)
+ {
+ builder.withPrecommitHook(preCommitHook);
+ }
+
+ if (postCommitHook != null)
+ {
+ builder.withPostcommitHook(postCommitHook);
+ }
+
+ if (oldVClock != null)
+ {
+ builder.withOldVClock(oldVClock);
+ }
+
+ if (youngVClock != null)
+ {
+ builder.withYoungVClock(youngVClock);
+ }
+
+ if (smallVClock != null)
+ {
+ builder.withSmallVClock(smallVClock);
+ }
+
+ if (nval != null)
+ {
+ builder.withNVal(nval);
+ }
+
+ if (legacySearch != null)
+ {
+ builder.withLegacyRiakSearchEnabled(legacySearch);
+ }
+
+ if (searchIndex != null)
+ {
+ builder.withSearchIndex(searchIndex);
+ }
+
+ return builder.build();
+ }
+
+ public static class Builder
+ {
+
+ private final Namespace namespace;
+ private Boolean allowMulti;
+ private String backend;
+ private Boolean basicQuorum;
+ private Long bigVClock;
+ private Function chashkeyFunction;
+ private Boolean lastWriteWins;
+ private Function linkWalkFunction;
+ private Integer rw;
+ private Integer dw;
+ private Integer w;
+ private Integer r;
+ private Integer pr;
+ private Integer pw;
+ private Boolean notFoundOk;
+ private Function preCommitHook;
+ private Function postCommitHook;
+ private Long oldVClock;
+ private Long youngVClock;
+ private Long smallVClock;
+ private Integer nval;
+ private Boolean legacySearch;
+ private String searchIndex;
+
+
+ public Builder(Namespace namespace)
+ {
+ if (namespace == null)
+ {
+ throw new IllegalArgumentException("Namespace cannot be null");
+ }
+ this.namespace = namespace;
+ }
+
+ /**
+ * Set the allow_multi value.
+ *
+ * @param allow whether to allow sibling objects to be created.
+ * @return a reference to this object.
+ */
+ public Builder withAllowMulti(boolean allow)
+ {
+ this.allowMulti = allow;
+ return this;
+ }
+
+ /**
+ * Set the backend used by this bucket. Only applies when using
+ * {@code riak_kv_multi_backend} in Riak.
+ *
+ * @param backend the name of the backend to use.
+ * @return a reference to this object.
+ */
+ public Builder withBackend(String backend)
+ {
+ if (null == backend || backend.length() == 0)
+ {
+ throw new IllegalArgumentException("Backend can not be null or zero length");
+ }
+ this.backend = backend;
+ return this;
+ }
+
+ /**
+ * Set the basic_quorum value.
+ *
+ * The parameter controls whether a read request should return early in
+ * some fail cases. E.g. If a quorum of nodes has already returned
+ * notfound/error, don't wait around for the rest.
+ *
+ * @param use the basic_quorum value.
+ * @return a reference to this object.
+ */
+ public Builder withBasicQuorum(boolean use)
+ {
+ this.basicQuorum = use;
+ return this;
+ }
+
+ /**
+ * Set the big_vclock value.
+ *
+ * @param bigVClock a long representing a epoch time value.
+ * @return a reference to this object.
+ * @see Vector Clock Pruning
+ */
+ public Builder withBigVClock(Long bigVClock)
+ {
+ this.bigVClock = bigVClock;
+ return this;
+ }
+
+ /**
+ * Set the chash_keyfun value.
+ *
+ * @param func a Function representing the Erlang func to use.
+ * @return a reference to this object.
+ */
+ public Builder withChashkeyFunction(Function func)
+ {
+ this.chashkeyFunction = func;
+ return this;
+ }
+
+ /**
+ * Set the last_write_wins value. Unless you really know what you're
+ * doing, you probably do not want to set this to true.
+ *
+ * @param wins whether to ignore vector clocks when writing.
+ * @return a reference to this object.
+ */
+ public Builder withLastWriteWins(boolean wins)
+ {
+ this.lastWriteWins = wins;
+ return this;
+ }
+
+ /**
+ * Set the linkfun value.
+ *
+ * @param func a Function representing the Erlang func to use.
+ * @return a reference to this object.
+ */
+ public Builder withLinkwalkFunction(Function func)
+ {
+ this.linkWalkFunction = func;
+ return this;
+ }
+
+ /**
+ * Set the rw value. Individual requests (or buckets in a bucket type)
+ * can override this.
+ *
+ * @param rw the rw value as an integer.
+ * @return a reference to this object.
+ */
+ public Builder withRw(int rw)
+ {
+ this.rw = rw;
+ return this;
+ }
+
+ /**
+ * Set the dw value. Individual requests (or buckets in a bucket type)
+ * can override this.
+ *
+ * @param dw the dw value as an integer.
+ * @return a reference to this object.
+ */
+ public Builder withDw(int dw)
+ {
+ this.dw = dw;
+ return this;
+ }
+
+ /**
+ * Set the w value. Individual requests (or buckets in a bucket type)
+ * can override this.
+ *
+ * @param w the w value as an integer.
+ * @return a reference to this object.
+ */
+ public Builder withW(int w)
+ {
+ this.w = w;
+ return this;
+ }
+
+ /**
+ * Set the r value. Individual requests (or buckets in a bucket type)
+ * can override this.
+ *
+ * @param r the r value as an integer.
+ * @return a reference to this object.
+ */
+ public Builder withR(int r)
+ {
+ this.r = r;
+ return this;
+ }
+
+ /**
+ * Set the pr value. Individual requests (or buckets in a bucket type)
+ * can override this.
+ *
+ * @param pr the pr value as an integer.
+ * @return a reference to this object.
+ */
+ public Builder withPr(int pr)
+ {
+ this.pr = pr;
+ return this;
+ }
+
+ /**
+ * Set the pw value. Individual requests (or buckets in a bucket type)
+ * can override this.
+ *
+ * @param pw the pw value as an integer.
+ * @return a reference to this object.
+ */
+ public Builder withPw(int pw)
+ {
+ this.pw = pw;
+ return this;
+ }
+
+ /**
+ * Set the not_found_ok value. If true a vnode returning notfound for a
+ * key increments the r tally. False is higher consistency, true is
+ * higher availability.
+ *
+ * @param ok the not_found_ok value.
+ * @return a reference to this object.
+ */
+ public Builder withNotFoundOk(boolean ok)
+ {
+ this.notFoundOk = ok;
+ return this;
+ }
+
+ /**
+ * Add a pre-commit hook. The supplied Function must be an Erlang or
+ * Named JS function.
+ *
+ * @param hook the Function to add.
+ * @return a reference to this object.
+ * @see Using Commit Hooks
+ */
+ public Builder withPrecommitHook(Function hook)
+ {
+ if (null == hook || !(!hook.isJavascript() || hook.isNamed()))
+ {
+ throw new IllegalArgumentException("Must be a named JS or Erlang function.");
+ }
+ this.preCommitHook = hook;
+ return this;
+ }
+
+ /**
+ * Add a post-commit hook. The supplied Function must be an Erlang or
+ * Named JS function.
+ *
+ * @param hook the Function to add.
+ * @return a reference to this object.
+ * @see Using Commit Hooks
+ */
+ public Builder withPostcommitHook(Function hook)
+ {
+ this.postCommitHook = hook;
+ return this;
+ }
+
+ /**
+ * Set the old_vclock value.
+ *
+ * @param oldVClock an long representing a epoch time value.
+ * @return a reference to this object.
+ * @see Vector Clock Pruning
+ */
+ public Builder withOldVClock(Long oldVClock)
+ {
+ this.oldVClock = oldVClock;
+ return this;
+ }
+
+ /**
+ * Set the young_vclock value.
+ *
+ * @param youngVClock a long representing a epoch time value.
+ * @return a reference to this object.
+ * @see Vector Clock Pruning
+ */
+ public Builder withYoungVClock(Long youngVClock)
+ {
+ this.youngVClock = youngVClock;
+ return this;
+ }
+
+ /**
+ * Set the small_vclock value.
+ *
+ * @param smallVClock a long representing a epoch time value.
+ * @return a reference to this object.
+ * @see Vector Clock Pruning
+ */
+ public Builder withSmallVClock(Long smallVClock)
+ {
+ this.smallVClock = smallVClock;
+ return this;
+ }
+
+ /**
+ * Set the nVal.
+ *
+ * @param nVal the number of replicas.
+ * @return a reference to this object.
+ */
+ public Builder withNVal(int nVal)
+ {
+ if (nVal <= 0)
+ {
+ throw new IllegalArgumentException("nVal must be >= 1");
+ }
+ this.nval = nVal;
+ return this;
+ }
+
+ /**
+ * Enable Legacy Riak Search. Setting this to true causes the search
+ * pre-commit hook to be added.
+ *
+ * Note this is only for legacy Riak (< v2.0) Search support.
+ *
+ * @param enable add/remove (true/false) the pre-commit hook for Legacy
+ * Riak Search.
+ * @return a reference to this object.
+ */
+ public Builder withLegacyRiakSearchEnabled(boolean enable)
+ {
+ this.legacySearch = enable;
+ return this;
+ }
+
+ /**
+ * Associate a Search Index. This only applies if Yokozuna is enabled in
+ * Riak v2.0.
+ *
+ * @param indexName The name of the search index to use.
+ * @return a reference to this object.
+ */
+ public Builder withSearchIndex(String indexName)
+ {
+ if (null == indexName || indexName.length() == 0)
+ {
+ throw new IllegalArgumentException("Index name cannot be null or zero length");
+ }
+ this.searchIndex = indexName;
+ return this;
+ }
+
+ public StoreBucketProperties build()
+ {
+ return new StoreBucketProperties(this);
+ }
+
+ }
+}
diff --git a/src/main/java/com/basho/riak/client/api/commands/buckets/package-info.java b/src/main/java/com/basho/riak/client/api/commands/buckets/package-info.java
new file mode 100644
index 000000000..f2f603830
--- /dev/null
+++ b/src/main/java/com/basho/riak/client/api/commands/buckets/package-info.java
@@ -0,0 +1,10 @@
+/**
+ * Commands used to query and modify buckets in Riak.
+ * Querying and modifying buckets
+ *
+ * - {@link com.basho.riak.client.api.commands.buckets.FetchBucketProperties}
+ * - {@link com.basho.riak.client.api.commands.buckets.StoreBucketProperties}
+ * - {@link com.basho.riak.client.api.commands.buckets.ListBuckets}
+ *
+ */
+package com.basho.riak.client.api.commands.buckets;
\ No newline at end of file
diff --git a/src/main/java/com/basho/riak/client/api/commands/datatypes/Context.java b/src/main/java/com/basho/riak/client/api/commands/datatypes/Context.java
new file mode 100644
index 000000000..02d3113d1
--- /dev/null
+++ b/src/main/java/com/basho/riak/client/api/commands/datatypes/Context.java
@@ -0,0 +1,51 @@
+/*
+ * Copyright 2013 Basho Technologies Inc
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.basho.riak.client.api.commands.datatypes;
+
+import com.basho.riak.client.core.util.BinaryValue;
+
+ /**
+ * Encapsulates a context returned from a datatype fetch command.
+ *
+ * When performing an update to a datatype, the Context from the
+ * previous fetch is used.
+ *
+ * @author Dave Rusek
+ * @since 2.0
+ */
+public class Context
+{
+
+ private final BinaryValue value;
+
+ /**
+ * Construct a new Context.
+ * @param value
+ */
+ public Context(BinaryValue value)
+ {
+ this.value = value;
+ }
+
+ /**
+ * Returns the context as a BinaryValue.
+ * @return the context.
+ */
+ public BinaryValue getValue()
+ {
+ return value;
+ }
+}
diff --git a/src/main/java/com/basho/riak/client/api/commands/datatypes/CounterUpdate.java b/src/main/java/com/basho/riak/client/api/commands/datatypes/CounterUpdate.java
new file mode 100644
index 000000000..77a06dbe0
--- /dev/null
+++ b/src/main/java/com/basho/riak/client/api/commands/datatypes/CounterUpdate.java
@@ -0,0 +1,70 @@
+/*
+ * Copyright 2013 Basho Technologies Inc
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.basho.riak.client.api.commands.datatypes;
+
+import com.basho.riak.client.core.query.crdt.ops.CounterOp;
+
+/**
+ * An update to a Riak counter datatype.
+ *
+ * When building a {@link UpdateCounter} or {@link UpdateMap} command
+ * this class is used to encapsulate the update to be performed on a
+ * Riak counter datatype.
+ *
+ * @author Dave Rusek
+ * @since 2.0
+ */
+public class CounterUpdate implements DatatypeUpdate
+{
+
+ private long delta = 0;
+
+ /**
+ * Constructs a CounterUpdate with a delta of 0 (zero).
+ */
+ public CounterUpdate()
+ {
+ }
+
+ /**
+ * Constructs a CounterUpdate with the supplied delta.
+ * To decrease a counter supply a negative value.
+ * @param delta the value to add to the counter in Riak.
+ */
+ public CounterUpdate(long delta)
+ {
+ this.delta = delta;
+ }
+
+ /**
+ * Get the delta.
+ * @return the value contained in this CounterUpdate.
+ */
+ public long getDelta()
+ {
+ return delta;
+ }
+
+ /**
+ * Returns the core update.
+ * @return the update used by the client core.
+ */
+ @Override
+ public CounterOp getOp()
+ {
+ return new CounterOp(delta);
+ }
+}
diff --git a/src/main/java/com/basho/riak/client/api/commands/datatypes/DatatypeUpdate.java b/src/main/java/com/basho/riak/client/api/commands/datatypes/DatatypeUpdate.java
new file mode 100644
index 000000000..d271a6683
--- /dev/null
+++ b/src/main/java/com/basho/riak/client/api/commands/datatypes/DatatypeUpdate.java
@@ -0,0 +1,29 @@
+/*
+ * Copyright 2013 Basho Technologies Inc
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.basho.riak.client.api.commands.datatypes;
+
+import com.basho.riak.client.core.query.crdt.ops.CrdtOp;
+
+/**
+ * An object that represents an update to a Riak datatype.
+ * @author Dave Rusek
+ * @since 2.0
+ */
+public interface DatatypeUpdate
+{
+ public abstract CrdtOp getOp();
+
+}
diff --git a/src/main/java/com/basho/riak/client/api/commands/datatypes/FetchCounter.java b/src/main/java/com/basho/riak/client/api/commands/datatypes/FetchCounter.java
new file mode 100644
index 000000000..65e14d6d3
--- /dev/null
+++ b/src/main/java/com/basho/riak/client/api/commands/datatypes/FetchCounter.java
@@ -0,0 +1,142 @@
+/*
+ * Copyright 2013 Basho Technologies Inc
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.basho.riak.client.api.commands.datatypes;
+
+import com.basho.riak.client.api.commands.CoreFutureAdapter;
+import com.basho.riak.client.core.RiakCluster;
+import com.basho.riak.client.core.RiakFuture;
+import com.basho.riak.client.core.operations.DtFetchOperation;
+import com.basho.riak.client.core.query.Location;
+import com.basho.riak.client.core.query.crdt.types.RiakCounter;
+import com.basho.riak.client.core.query.crdt.types.RiakDatatype;
+
+ /**
+ * Command used to fetch a counter datatype from Riak.
+ *
+ *
+ *
+ * {@code
+ * Namespace ns = new Namespace("my_type", "my_bucket");
+ * Location loc = new Location(ns, "my_key");
+ * FetchCounter fc = new FetchCounter.Builder(loc).build();
+ * FetchCounter.Response resp = client.execute(fc);
+ * Long counter = resp.getDatatype().view();}
+ *
+ * @author Dave Rusek
+ * @author Brian Roach
+ * @since 2.0
+ */
+public final class FetchCounter extends FetchDatatype
+{
+ private FetchCounter(Builder builder)
+ {
+ super(builder);
+ }
+
+ @Override
+ protected final RiakFuture executeAsync(RiakCluster cluster)
+ {
+ RiakFuture coreFuture =
+ cluster.execute(buildCoreOperation());
+
+ CoreFutureAdapter future =
+ new CoreFutureAdapter(coreFuture) {
+
+ @Override
+ protected FetchCounter.Response convertResponse(DtFetchOperation.Response coreResponse)
+ {
+ RiakDatatype element = coreResponse.getCrdtElement();
+
+ Context context = null;
+ if (coreResponse.hasContext())
+ {
+ context = new Context(coreResponse.getContext());
+ }
+
+ RiakCounter datatype = extractDatatype(element);
+
+ return new Response(datatype, context);
+ }
+
+ @Override
+ protected Location convertQueryInfo(Location coreQueryInfo)
+ {
+ return coreQueryInfo;
+ }
+ };
+ coreFuture.addListener(future);
+ return future;
+ }
+
+ @Override
+ public RiakCounter extractDatatype(RiakDatatype element)
+ {
+ return element.getAsCounter();
+ }
+
+ /**
+ * Builder used to construct a FetchCounter command.
+ */
+ public static class Builder extends FetchDatatype.Builder
+ {
+
+ /**
+ * Construct a builder for a FetchCounter command.
+ * @param location the location of the counter in Riak.
+ */
+ public Builder(Location location)
+ {
+ super(location);
+ }
+
+ @Override
+ protected Builder self()
+ {
+ return this;
+ }
+
+ /**
+ * Build a FetchCounter command.
+ * @return a new FetchCounter command.
+ */
+ public FetchCounter build()
+ {
+ return new FetchCounter(this);
+ }
+ }
+
+ /**
+ * Response from a FetchCounter command.
+ *
+ * Encapsulates a RiakCounter returned from the command.
+ *
+ * {@code
+ * ...
+ * RiakCounter counter = response.getDatatype();
+ * Long value = counter.view();
+ * }
+ *
+ *
+ */
+ public static class Response extends FetchDatatype.Response
+ {
+ Response(RiakCounter counter, Context context)
+ {
+ super(counter, context);
+ }
+ }
+}
diff --git a/src/main/java/com/basho/riak/client/api/commands/datatypes/FetchDatatype.java b/src/main/java/com/basho/riak/client/api/commands/datatypes/FetchDatatype.java
new file mode 100644
index 000000000..abee25ad1
--- /dev/null
+++ b/src/main/java/com/basho/riak/client/api/commands/datatypes/FetchDatatype.java
@@ -0,0 +1,256 @@
+/*
+ * Copyright 2013 Basho Technologies Inc
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.basho.riak.client.api.commands.datatypes;
+
+import com.basho.riak.client.api.RiakCommand;
+import com.basho.riak.client.api.cap.Quorum;
+import com.basho.riak.client.api.commands.RiakOption;
+import com.basho.riak.client.core.operations.DtFetchOperation;
+
+import com.basho.riak.client.core.query.Location;
+import com.basho.riak.client.core.query.crdt.types.RiakDatatype;
+
+import java.util.HashMap;
+import java.util.Map;
+
+ /**
+ * Base abstract class for all CRDT fetch commands.
+ * @author Dave Rusek
+ * @since 2.0
+ */
+public abstract class FetchDatatype extends RiakCommand
+{
+
+ private final Location location;
+ private final Map, Object> options = new HashMap, Object>();
+
+ @SuppressWarnings("unchecked")
+ protected FetchDatatype(Builder builder)
+ {
+ this.location = builder.location;
+ this.options.putAll(builder.options);
+ }
+
+ public FetchDatatype withOption(Option option, V value)
+ {
+ options.put(option, value);
+ return this;
+ }
+
+ public abstract T extractDatatype(RiakDatatype element);
+
+ protected final DtFetchOperation buildCoreOperation()
+ {
+ DtFetchOperation.Builder builder =
+ new DtFetchOperation.Builder(location);
+
+ for (Map.Entry, Object> entry : options.entrySet())
+ {
+ if (entry.getKey() == Option.R)
+ {
+ builder.withR(((Quorum) entry.getValue()).getIntValue());
+ }
+ else if (entry.getKey() == Option.PR)
+ {
+ builder.withPr(((Quorum) entry.getValue()).getIntValue());
+ }
+ else if (entry.getKey() == Option.BASIC_QUORUM)
+ {
+ builder.withBasicQuorum((Boolean) entry.getValue());
+ }
+ else if (entry.getKey() == Option.NOTFOUND_OK)
+ {
+ builder.withNotFoundOK((Boolean) entry.getValue());
+ }
+ else if (entry.getKey() == Option.TIMEOUT)
+ {
+ builder.withTimeout((Integer) entry.getValue());
+ }
+ else if (entry.getKey() == Option.SLOPPY_QUORUM)
+ {
+ builder.withSloppyQuorum((Boolean) entry.getValue());
+ }
+ else if (entry.getKey() == Option.N_VAL)
+ {
+ builder.withNVal((Integer) entry.getValue());
+ }
+ else if (entry.getKey() == Option.INCLUDE_CONTEXT)
+ {
+ builder.includeContext((Boolean) entry.getValue());
+ }
+ }
+
+
+ return builder.build();
+
+ }
+
+ /**
+ * Tuning parameters for all datatype fetch commands.
+ * @author Dave Rusek
+ * @since 2.0
+ */
+ public static final class Option extends RiakOption {
+
+ /**
+ * Read Quorum.
+ * How many replicas need to agree when fetching the object.
+ */
+ public static final Option R = new Option("R");
+
+ /**
+ * Primary Read Quorum.
+ * How many primary replicas need to be available when retrieving the object.
+ */
+ public static final Option PR = new Option("PR");
+
+ /**
+ * Basic Quorum.
+ * Whether to return early in some failure cases (eg. when r=1 and you get
+ * 2 errors and a success basic_quorum=true would return an error)
+ */
+ public static final Option BASIC_QUORUM = new Option("BASIC_QUORUM");
+
+ /**
+ * Not Found OK.
+ * Whether to treat notfounds as successful reads for the purposes of R
+ */
+ public static final Option NOTFOUND_OK = new Option("NOTFOUND_OK");
+
+ /**
+ * Timeout.
+ * Sets the server-side timeout for this operation. The default in Riak is 60 seconds.
+ */
+ public static final Option TIMEOUT = new Option("TIMEOUT");
+ public static final Option SLOPPY_QUORUM = new Option("SLOPPY_QUORUM");
+ public static final Option N_VAL = new Option("N_VAL");
+
+ /**
+ * Whether to return a context.
+ * The default is true. Use this option if you're planning on only reading the datatype.
+ */
+ public static final Option INCLUDE_CONTEXT = new Option("INCLUDE_CONTEXT");
+
+ public Option(String name) {
+ super(name);
+ }
+ }
+
+ /**
+ * Base abstract builder for all datatype fetch command builders.
+ * @param
+ */
+ protected static abstract class Builder>
+ {
+
+ private final Location location;
+ private final Map, Object> options = new HashMap, Object>();
+
+ protected Builder(Location location)
+ {
+ if (location == null)
+ {
+ throw new IllegalArgumentException("Location cannot be null");
+ }
+ this.location = location;
+ }
+
+
+ /**
+ * Set the Riak-side timeout value.
+ *
+ * By default, riak has a 60s timeout for operations. Setting
+ * this value will override that default for this operation.
+ *
+ * @param timeout the timeout in milliseconds to be sent to riak.
+ * @return a reference to this object.
+ */
+ public T withTimeout(int timeout)
+ {
+ return withOption(Option.TIMEOUT, timeout);
+ }
+
+ /**
+ * Add an optional setting for this command.
+ * This will be passed along with the request to Riak to tell it how
+ * to behave when servicing the request.
+ *
+ * @param option the option
+ * @param value the value for the option
+ * @return a reference to this object.
+ * @see Option
+ */
+ public T withOption(Option option, U value)
+ {
+ this.options.put(option, value);
+ return self();
+ }
+
+ protected abstract T self();
+
+ }
+
+ /**
+ * Base response for all CRDT fetch commands.
+ * @param
+ */
+ public static class Response
+ {
+
+ private final T datatype;
+ private final Context context;
+
+ protected Response(T datatype, Context context)
+ {
+ this.datatype = datatype;
+ this.context = context;
+ }
+
+ /**
+ * Get the datatype from this response.
+ * @return the fetched datatype.
+ */
+ public T getDatatype()
+ {
+ return datatype;
+ }
+
+ /**
+ * Check to see if a context is present in this response.
+ * @return true if a context is present, false otherwise.
+ */
+ public boolean hasContext()
+ {
+ return context != null;
+ }
+
+ /**
+ * Get the context from this response.
+ *
+ * The context is used when a subsequent update to the datatype
+ * is performed.
+ *
+ * @return the context if present, null otherwise.
+ */
+ public Context getContext()
+ {
+ return context;
+ }
+ }
+
+
+
+}
diff --git a/src/main/java/com/basho/riak/client/api/commands/datatypes/FetchMap.java b/src/main/java/com/basho/riak/client/api/commands/datatypes/FetchMap.java
new file mode 100644
index 000000000..5386175d8
--- /dev/null
+++ b/src/main/java/com/basho/riak/client/api/commands/datatypes/FetchMap.java
@@ -0,0 +1,147 @@
+/*
+ * Copyright 2013 Basho Technologies Inc
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.basho.riak.client.api.commands.datatypes;
+
+import com.basho.riak.client.api.commands.CoreFutureAdapter;
+import com.basho.riak.client.core.RiakCluster;
+import com.basho.riak.client.core.RiakFuture;
+import com.basho.riak.client.core.operations.DtFetchOperation;
+import com.basho.riak.client.core.query.Location;
+import com.basho.riak.client.core.query.crdt.types.RiakDatatype;
+import com.basho.riak.client.core.query.crdt.types.RiakMap;
+
+/**
+ * Command used to fetch a counter datatype from Riak.
+ *
+ *
+ *
+ * {@code
+ * Namespace ns = new Namespace("my_type", "my_bucket");
+ * Location loc = new Location(ns, "my_key");
+ * FetchMap fm = new FetchMap.Builder(loc).build();
+ * FetchMap.Response resp = client.execute(fm);
+ * RiakMap rMap = resp.getDatatype();
+ * Map> map = rMap.view();
+ * }
+ *
+ *
+ * @author Dave Rusek
+ * @since 2.0
+ */
+public final class FetchMap extends FetchDatatype
+{
+ private FetchMap(Builder builder)
+ {
+ super(builder);
+ }
+
+ @Override
+ public RiakMap extractDatatype(RiakDatatype element)
+ {
+ return element.getAsMap();
+ }
+
+ @Override
+ protected final RiakFuture executeAsync(RiakCluster cluster)
+ {
+ RiakFuture coreFuture =
+ cluster.execute(buildCoreOperation());
+
+ CoreFutureAdapter future =
+ new CoreFutureAdapter(coreFuture) {
+
+ @Override
+ protected FetchMap.Response convertResponse(DtFetchOperation.Response coreResponse)
+ {
+ RiakDatatype element = coreResponse.getCrdtElement();
+
+ Context context = null;
+ if (coreResponse.hasContext())
+ {
+ context = new Context(coreResponse.getContext());
+ }
+
+ RiakMap datatype = extractDatatype(element);
+
+ return new Response(datatype, context);
+ }
+
+ @Override
+ protected Location convertQueryInfo(Location coreQueryInfo)
+ {
+ return coreQueryInfo;
+ }
+ };
+ coreFuture.addListener(future);
+ return future;
+ }
+
+ /**
+ * Builder used to construct a FetchMap command.
+ */
+ public static class Builder extends FetchDatatype.Builder
+ {
+
+ /**
+ * Construct a Builder for a FetchMap command.
+ * @param location the location of the map in Riak.
+ */
+ public Builder(Location location)
+ {
+ super(location);
+ }
+
+ @Override
+ protected Builder self()
+ {
+ return this;
+ }
+
+ /**
+ * Construct a new FetchMap command.
+ * @return a new FetchMap command.
+ */
+ public FetchMap build()
+ {
+ return new FetchMap(this);
+ }
+
+ }
+
+ /**
+ * Response from a FetchMap command.
+ *
+ * Encapsulates a RiakMap returned from the command.
+ *
+ * {@code
+ * ...
+ * RiakMap rMap = response.getDatatype();
+ * Map> map = rMap.view();
+ *
+ * }
+ *
+ *
+ */
+ public static class Response extends FetchDatatype.Response
+ {
+ protected Response(RiakMap datatype, Context context)
+ {
+ super(datatype, context);
+ }
+ }
+
+}
diff --git a/src/main/java/com/basho/riak/client/api/commands/datatypes/FetchSet.java b/src/main/java/com/basho/riak/client/api/commands/datatypes/FetchSet.java
new file mode 100644
index 000000000..ec8c2f5a6
--- /dev/null
+++ b/src/main/java/com/basho/riak/client/api/commands/datatypes/FetchSet.java
@@ -0,0 +1,143 @@
+/*
+ * Copyright 2013 Basho Technologies Inc
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.basho.riak.client.api.commands.datatypes;
+
+import com.basho.riak.client.api.commands.CoreFutureAdapter;
+import com.basho.riak.client.core.RiakCluster;
+import com.basho.riak.client.core.RiakFuture;
+import com.basho.riak.client.core.operations.DtFetchOperation;
+import com.basho.riak.client.core.query.Location;
+import com.basho.riak.client.core.query.crdt.types.RiakDatatype;
+import com.basho.riak.client.core.query.crdt.types.RiakSet;
+
+/**
+ * Command used to fetch a set datatype from Riak.
+ *
+ *
+ *
+ * {@code
+ * Namespace ns = new Namespace("my_type", "my_bucket");
+ * Location loc = new Location(ns, "my_key");
+ * FetchSet fs = new FetchSet.Builder(loc).build();
+ * FetchSet.Response resp = client.execute(fs);
+ * RiakSet rSet = resp.getDatatype();
+ * Set set = rSet.view();
+ * }
+ *
+ * @author Dave Rusek
+ * @since 2.0
+ */
+public final class FetchSet extends FetchDatatype
+{
+ private FetchSet(Builder builder)
+ {
+ super(builder);
+ }
+
+ @Override
+ protected final RiakFuture executeAsync(RiakCluster cluster)
+ {
+ RiakFuture coreFuture =
+ cluster.execute(buildCoreOperation());
+
+ CoreFutureAdapter future =
+ new CoreFutureAdapter(coreFuture) {
+
+ @Override
+ protected FetchSet.Response convertResponse(DtFetchOperation.Response coreResponse)
+ {
+ RiakDatatype element = coreResponse.getCrdtElement();
+
+ Context context = null;
+ if (coreResponse.hasContext())
+ {
+ context = new Context(coreResponse.getContext());
+ }
+
+ RiakSet datatype = extractDatatype(element);
+
+ return new Response(datatype, context);
+ }
+
+ @Override
+ protected Location convertQueryInfo(Location coreQueryInfo)
+ {
+ return coreQueryInfo;
+ }
+ };
+ coreFuture.addListener(future);
+ return future;
+ }
+
+ @Override
+ public RiakSet extractDatatype(RiakDatatype element)
+ {
+ return element.getAsSet();
+ }
+
+ /**
+ * Builder used to construct a FetchSet command.
+ */
+ public static class Builder extends FetchDatatype.Builder
+ {
+
+ /**
+ * Construct a builder for a FetchSet command.
+ * @param location the location of the set in Riak.
+ */
+ public Builder(Location location)
+ {
+ super(location);
+ }
+
+ @Override
+ protected Builder self()
+ {
+ return this;
+ }
+
+ /**
+ * Construct a FetchSet command.
+ * @return a new FetchSet Command.
+ */
+ public FetchSet build()
+ {
+ return new FetchSet(this);
+ }
+ }
+
+ /**
+ * Response from a FetchSet command.
+ *
+ * Encapsulates a RiakSet returned from the FetchSet command.
+ *
+ * {@code
+ * ...
+ * RiakSet rSet = response.getDatatype();
+ * Set set = rSet.view();
+ * }
+ *
+ *
+ */
+ public static class Response extends FetchDatatype.Response
+ {
+ Response(RiakSet set, Context context)
+ {
+ super(set,context);
+ }
+ }
+}
diff --git a/src/main/java/com/basho/riak/client/api/commands/datatypes/FlagUpdate.java b/src/main/java/com/basho/riak/client/api/commands/datatypes/FlagUpdate.java
new file mode 100644
index 000000000..4e422e8f3
--- /dev/null
+++ b/src/main/java/com/basho/riak/client/api/commands/datatypes/FlagUpdate.java
@@ -0,0 +1,70 @@
+/*
+ * Copyright 2013 Basho Technologies Inc
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.basho.riak.client.api.commands.datatypes;
+
+import com.basho.riak.client.core.query.crdt.ops.FlagOp;
+
+/**
+ * An update to a Riak flag datatype.
+ *
+ * When building an {@link UpdateMap} command
+ * this class is used to encapsulate the update to be performed on a
+ * Riak flag datatype contained in the map. It is used in conjunction with the
+ * {@link MapUpdate}.
+ *
+ * @author Dave Rusek
+ * @since 2.0
+ */
+public class FlagUpdate implements DatatypeUpdate
+{
+
+ private boolean flag = false;
+
+ /**
+ * Construct a FlagUpdate.
+ * @param flag true to enable, false to disable.
+ */
+ public FlagUpdate(boolean flag)
+ {
+ this.flag = flag;
+ }
+
+ /**
+ * Construct a FlagUpdate with the default disabled (false) value.
+ */
+ public FlagUpdate()
+ {
+ }
+
+ /**
+ * Return the value of this FlagUpdate.
+ * @return true if enabled, false if disabled.
+ */
+ public boolean isEnabled()
+ {
+ return flag;
+ }
+
+ /**
+ * Returns the core update.
+ * @return the update used by the client core.
+ */
+ @Override
+ public FlagOp getOp()
+ {
+ return new FlagOp(flag);
+ }
+}
diff --git a/src/main/java/com/basho/riak/client/api/commands/datatypes/MapUpdate.java b/src/main/java/com/basho/riak/client/api/commands/datatypes/MapUpdate.java
new file mode 100644
index 000000000..013918338
--- /dev/null
+++ b/src/main/java/com/basho/riak/client/api/commands/datatypes/MapUpdate.java
@@ -0,0 +1,202 @@
+/*
+ * Copyright 2013 Basho Technologies Inc
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.basho.riak.client.api.commands.datatypes;
+
+import com.basho.riak.client.core.query.crdt.ops.MapOp;
+import com.basho.riak.client.core.util.BinaryValue;
+
+import java.util.HashSet;
+import java.util.Set;
+
+/**
+ * An update to a Raik map datatype.
+ *
+ * When building an {@link UpdateMap} command
+ * this class is used to encapsulate the update to be performed on a
+ * Riak map datatype. It is a composition of other updates.
+ *
+ *
+ * @author Dave Rusek
+ * @since 2.0
+ */
+public class MapUpdate implements DatatypeUpdate
+{
+
+ private final Set removes = new HashSet();
+ private final Set updates = new HashSet();
+
+ /**
+ * Construct an empty MapUpdate.
+ */
+ public MapUpdate()
+ {
+ }
+
+ /**
+ * Update the map in Riak by removing the counter mapped to the provided key.
+ * @param key the key the counter is mapped to.
+ * @return a reference to this object.
+ */
+ public MapUpdate removeCounter(String key)
+ {
+ BinaryValue k = BinaryValue.create(key);
+ removes.add(new MapOp.MapField(MapOp.FieldType.COUNTER, k));
+ return this;
+ }
+
+ /**
+ * Update the map in Riak by removing the register mapped to the provided key.
+ * @param key the key the register is mapped to.
+ * @return a reference to this object.
+ */
+ public MapUpdate removeRegister(String key)
+ {
+ BinaryValue k = BinaryValue.create(key);
+ removes.add(new MapOp.MapField(MapOp.FieldType.REGISTER, k));
+ return this;
+ }
+
+ /**
+ * Update the map in Riak by removing the flag mapped to the provided key.
+ * @param key the key the flag is mapped to.
+ * @return a reference to this object.
+ */
+ public MapUpdate removeFlag(String key)
+ {
+ BinaryValue k = BinaryValue.create(key);
+ removes.add(new MapOp.MapField(MapOp.FieldType.FLAG, k));
+ return this;
+ }
+
+ /**
+ * Update the map in Riak by removing the set mapped to the provided key.
+ * @param key the key the set is mapped to.
+ * @return a reference to this object.
+ */
+ public MapUpdate removeSet(String key)
+ {
+ BinaryValue k = BinaryValue.create(key);
+ removes.add(new MapOp.MapField(MapOp.FieldType.SET, k));
+ return this;
+ }
+
+ /**
+ * Update the map in Riak by removing the map mapped to the provided key.
+ * @param key the key the map is mapped to.
+ * @return a reference to this object.
+ */
+ public MapUpdate removeMap(String key)
+ {
+ BinaryValue k = BinaryValue.create(key);
+ removes.add(new MapOp.MapField(MapOp.FieldType.MAP, k));
+ return this;
+ }
+
+ /**
+ * Update the map in Riak by adding/updating the map mapped to the provided key.
+ *
+ * If there is no map referenced by the key, it is created
+ *
+ *
+ * @param key the key the map is mapped to.
+ * @param builder the update to apply to the map the key is mapped to. If none exists it is created.
+ * @return a reference to this object.
+ */
+ public MapUpdate update(String key, MapUpdate builder)
+ {
+ BinaryValue k = BinaryValue.create(key);
+ updates.add(new MapOp.MapUpdate(new MapOp.MapField(MapOp.FieldType.MAP, k), builder.getOp()));
+ return this;
+ }
+
+ /**
+ * Update the map in Riak by adding/updating the set mapped to the provided key.
+ *
+ * If there is no set referenced by the key, it is created
+ *
+ *
+ * @param key the key the set is mapped to.
+ * @param builder the update to apply to the set the key is mapped to. If none exists it is created.
+ * @return a reference to this object.
+ */
+ public MapUpdate update(String key, SetUpdate builder)
+ {
+ BinaryValue k = BinaryValue.create(key);
+ updates.add(new MapOp.MapUpdate(new MapOp.MapField(MapOp.FieldType.SET, k), builder.getOp()));
+ return this;
+ }
+
+ /**
+ * Update the map in Riak by adding/updating the counter mapped to the provided key.
+ *
+ * If there is no counter referenced by the key, it is created
+ *
+ *
+ * @param key the key the set is mapped to.
+ * @param builder the update to apply to the counter the key is mapped to. If none exists it is created.
+ * @return a reference to this object.
+ */
+ public MapUpdate update(String key, CounterUpdate builder)
+ {
+ BinaryValue k = BinaryValue.create(key);
+ updates.add(new MapOp.MapUpdate(new MapOp.MapField(MapOp.FieldType.COUNTER, k), builder.getOp()));
+ return this;
+ }
+
+ /**
+ * Update the map in Riak by adding/updating the register mapped to the provided key.
+ *
+ * If there is no register referenced by the key, it is created
+ *
+ *
+ * @param key the key the register is mapped to.
+ * @param builder the update to apply to the register the key is mapped to. If none exists it is created.
+ * @return a reference to this object.
+ */
+ public MapUpdate update(String key, RegisterUpdate builder)
+ {
+ BinaryValue k = BinaryValue.create(key);
+ updates.add(new MapOp.MapUpdate(new MapOp.MapField(MapOp.FieldType.REGISTER, k), builder.getOp()));
+ return this;
+ }
+
+ /**
+ * Update the map in Riak by adding/updating the flag mapped to the provided key.
+ *
+ * If there is no flag referenced by the key, it is created
+ *
+ *
+ * @param key the key the register is mapped to.
+ * @param builder the update to apply to the flag the key is mapped to. If none exists it is created.
+ * @return a reference to this object.
+ */
+ public MapUpdate update(String key, FlagUpdate builder)
+ {
+ BinaryValue k = BinaryValue.create(key);
+ updates.add(new MapOp.MapUpdate(new MapOp.MapField(MapOp.FieldType.FLAG, k), builder.getOp()));
+ return this;
+ }
+
+ /**
+ * Returns the core update.
+ * @return the update used by the client core.
+ */
+ @Override
+ public MapOp getOp()
+ {
+ return new MapOp(removes, updates);
+ }
+}
diff --git a/src/main/java/com/basho/riak/client/api/commands/datatypes/RegisterUpdate.java b/src/main/java/com/basho/riak/client/api/commands/datatypes/RegisterUpdate.java
new file mode 100644
index 000000000..184c5b23d
--- /dev/null
+++ b/src/main/java/com/basho/riak/client/api/commands/datatypes/RegisterUpdate.java
@@ -0,0 +1,92 @@
+/*
+ * Copyright 2013 Basho Technologies Inc
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.basho.riak.client.api.commands.datatypes;
+
+import com.basho.riak.client.core.query.crdt.ops.RegisterOp;
+import com.basho.riak.client.core.util.BinaryValue;
+
+/**
+ * An update to a Riak register datatype.
+ *
+ * When building an {@link UpdateMap} command
+ * this class is used to encapsulate the update to be performed on a
+ * Riak register datatype contained in the map. It is used in conjunction with the
+ * {@link MapUpdate}.
+ *
+ * @author Dave Rusek
+ * @since 2.0
+ */
+public class RegisterUpdate implements DatatypeUpdate
+{
+
+ private final BinaryValue value;
+
+ /**
+ * Construct a RegisterUpdate with the provided bytes.
+ * @param value the bytes representing the register.
+ */
+ public RegisterUpdate(byte[] value)
+ {
+ this.value = BinaryValue.create(value);
+ }
+
+ /**
+ * Construct a RegisterUpdate with the provided BinaryValue.
+ * @param value the BinaryValue representing the register.
+ */
+ public RegisterUpdate(BinaryValue value)
+ {
+ this.value = value;
+ }
+
+ /**
+ * Construct a RegisterUpdate with the provided String.
+ *
+ * Note the String is converted to bytes using the default Charset.
+ *
+ * @param value the String representing the register.
+ */
+ public RegisterUpdate(String value)
+ {
+ this.value = BinaryValue.create(value);
+ }
+
+ /**
+ * Get the register contained in this update.
+ * @return the register as a BinaryValue.
+ */
+ public BinaryValue get()
+ {
+ return value;
+ }
+
+ /**
+ * Returns the core update.
+ * @return the update used by the client core.
+ */
+ @Override
+ public RegisterOp getOp()
+ {
+ return new RegisterOp(value);
+ }
+
+ @Override
+ public String toString()
+ {
+ return value.toString();
+ }
+
+}
diff --git a/src/main/java/com/basho/riak/client/api/commands/datatypes/SetUpdate.java b/src/main/java/com/basho/riak/client/api/commands/datatypes/SetUpdate.java
new file mode 100644
index 000000000..4f769c93d
--- /dev/null
+++ b/src/main/java/com/basho/riak/client/api/commands/datatypes/SetUpdate.java
@@ -0,0 +1,124 @@
+/*
+ * Copyright 2013 Basho Technologies Inc
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.basho.riak.client.api.commands.datatypes;
+
+import com.basho.riak.client.core.query.crdt.ops.SetOp;
+import com.basho.riak.client.core.util.BinaryValue;
+
+import java.util.HashSet;
+import java.util.Set;
+
+/**
+ * An update to a Riak set datatype.
+ *
+ * When building an {@link UpdateSet} or {@link UpdateMap} command
+ * this class is used to encapsulate the update to be performed on a
+ * Riak set datatype.
+ *
+ * @author Dave Rusek
+ * @since 2.0
+ */
+public class SetUpdate implements DatatypeUpdate
+{
+
+ private final Set adds = new HashSet();
+ private final Set removes = new HashSet();
+
+ /**
+ * Constructs an empty SetUpdate.
+ */
+ public SetUpdate()
+ {
+ }
+
+ /**
+ * Add the provided value to the set in Riak.
+ * @param value the value to be added.
+ * @return a reference to this object.
+ */
+ public SetUpdate add(BinaryValue value)
+ {
+ this.adds.add(value);
+ return this;
+ }
+
+ /**
+ * Add the provided value to the set in Riak.
+ * @param value the value to be added.
+ * @return a reference to this object.
+ */
+ public SetUpdate add(String value)
+ {
+ this.adds.add(BinaryValue.create(value));
+ return this;
+ }
+
+ /**
+ * Remove the provided value from the set in Riak.
+ * @param value the value to be removed.
+ * @return a reference to this object.
+ */
+ public SetUpdate remove(BinaryValue value)
+ {
+ this.removes.add(value);
+ return this;
+ }
+
+ /**
+ * Remove the provided value from the set in Riak.
+ * @param value the value to be removed.
+ * @return a reference to this object.
+ */
+ public SetUpdate remove(String value)
+ {
+ this.removes.add(BinaryValue.create(value));
+ return this;
+ }
+
+ /**
+ * Get the set of additions contained in this update.
+ * @return the set of additions.
+ */
+ public Set getAdds()
+ {
+ return adds;
+ }
+
+ /**
+ * Get the set of removes contained in this update.
+ * @return the set of removes.
+ */
+ public Set getRemoves()
+ {
+ return removes;
+ }
+
+ /**
+ * Returns the core update.
+ * @return the update used by the client core.
+ */
+ @Override
+ public SetOp getOp()
+ {
+ return new SetOp(adds, removes);
+ }
+
+ @Override
+ public String toString()
+ {
+ return "Add: " + adds + " Remove: " + removes;
+ }
+}
diff --git a/src/main/java/com/basho/riak/client/api/commands/datatypes/UpdateCounter.java b/src/main/java/com/basho/riak/client/api/commands/datatypes/UpdateCounter.java
new file mode 100644
index 000000000..062736fda
--- /dev/null
+++ b/src/main/java/com/basho/riak/client/api/commands/datatypes/UpdateCounter.java
@@ -0,0 +1,176 @@
+/*
+ * Copyright 2013 Basho Technologies Inc
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.basho.riak.client.api.commands.datatypes;
+
+import com.basho.riak.client.api.commands.CoreFutureAdapter;
+import com.basho.riak.client.core.RiakCluster;
+import com.basho.riak.client.core.RiakFuture;
+import com.basho.riak.client.core.operations.DtUpdateOperation;
+import com.basho.riak.client.core.query.Location;
+import com.basho.riak.client.core.query.Namespace;
+import com.basho.riak.client.core.query.crdt.types.RiakCounter;
+import com.basho.riak.client.core.query.crdt.types.RiakDatatype;
+import com.basho.riak.client.core.util.BinaryValue;
+
+/**
+ * Command used to update or create a counter datatype in Riak.
+ *
+ *
+ * To update or create a counter in Riak you construct a {@link CounterUpdate} and use
+ * this command to send it to Riak.
+ *
+ * {@code
+ * Namespace ns = new Namespace("my_type", "my_bucket");
+ * Location loc = new Location(ns, "my_key");
+ * CounterUpdate update = new CounterUpdate(10L);
+ *
+ * UpdateCounter uc = new UpdateCounter.Builder(loc, update).withReturnDatatype(true).build();
+ * UpdateCounter.Response resp = client.execute(uc);
+ * RiakCounter counter = resp.getDatatype();
+ *
+ * }
+ *
+ *
+ * @author Dave Rusek
+ * @author Brian Roach
+ * @since 2.0
+ */
+public class UpdateCounter extends UpdateDatatype
+{
+ private final CounterUpdate update;
+
+ private UpdateCounter(Builder builder)
+ {
+ super(builder);
+ this.update = builder.update;
+ }
+
+ @Override
+ protected RiakFuture executeAsync(RiakCluster cluster)
+ {
+ RiakFuture
+ *
+ *