());
+ /**
+ * @return the RESTServlet singleton instance
+ * @throws IOException
+ */
public synchronized static RESTServlet getInstance() throws IOException {
if (instance == null) {
instance = new RESTServlet();
@@ -53,21 +59,33 @@ public class RESTServlet extends ServletAdaptor {
return instance;
}
+ /**
+ * Constructor
+ * @throws IOException
+ */
public RESTServlet() throws IOException {
this.conf = new HBaseConfiguration();
}
+ /**
+ * Get or create a table pool for the given table.
+ * @param name the table name
+ * @return the table pool
+ */
protected HTablePool getTablePool(String name) {
return HTablePool.getPool(conf, Bytes.toBytes(name));
}
+ /**
+ * @return the servlet's global HBase configuration
+ */
protected HBaseConfiguration getConfiguration() {
return conf;
}
/**
- * @param tableName
+ * @param tableName the table name
* @return the maximum cache age suitable for use with this table, in
* seconds
* @throws IOException
@@ -97,30 +115,12 @@ public class RESTServlet extends ServletAdaptor {
return DEFAULT_MAX_AGE;
}
+ /**
+ * Signal that a previously calculated maximum cache age has been
+ * invalidated by a schema change.
+ * @param tableName the table name
+ */
public void invalidateMaxAge(String tableName) {
maxAgeMap.remove(tableName);
}
-
- public static final String getVersion() {
- StringBuilder version = new StringBuilder();
- version.append("Stargate ");
- version.append(VERSION_STRING);
- version.append(" [JVM: ");
- version.append(System.getProperty("java.vm.vendor"));
- version.append(' ');
- version.append(System.getProperty("java.version"));
- version.append('-');
- version.append(System.getProperty("java.vm.version"));
- version.append("] [OS: ");
- version.append(System.getProperty("os.name"));
- version.append(' ');
- version.append(System.getProperty("os.version"));
- version.append(' ');
- version.append(System.getProperty("os.arch"));
- version.append("] [Jersey: ");
- version.append(ServletContainer.class.getPackage()
- .getImplementationVersion());
- version.append(']');
- return version.toString();
- }
}
diff --git a/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/RowSpec.java b/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/RowSpec.java
index cbaac22ec99..557f11a5abd 100644
--- a/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/RowSpec.java
+++ b/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/RowSpec.java
@@ -27,6 +27,12 @@ import org.apache.hadoop.hbase.HColumnDescriptor;
import org.apache.hadoop.hbase.HConstants;
import org.apache.hadoop.hbase.util.Bytes;
+/**
+ * Parses a path based row/column/timestamp specification into its component
+ * elements.
+ *
+ *
+ */
public class RowSpec {
public static final long DEFAULT_START_TIMESTAMP = 0;
public static final long DEFAULT_END_TIMESTAMP = Long.MAX_VALUE;
diff --git a/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/VersionResource.java b/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/VersionResource.java
index 798f94564c0..ba2c4933de8 100644
--- a/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/VersionResource.java
+++ b/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/VersionResource.java
@@ -34,6 +34,13 @@ import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.hadoop.hbase.stargate.model.VersionModel;
+/**
+ * Implements Stargate software version reporting via
+ *
+ * /version/stargate
+ *
+ * /version (alias for /version/stargate)
+ */
@Path(Constants.PATH_VERSION)
public class VersionResource implements Constants {
private static final Log LOG = LogFactory.getLog(VersionResource.class);
@@ -46,6 +53,12 @@ public class VersionResource implements Constants {
cacheControl.setNoTransform(false);
}
+ /**
+ * Build a response for a version request.
+ * @param context servlet context
+ * @param uriInfo (JAX-RS context variable) request URL
+ * @return a response for a version request
+ */
@GET
@Produces({MIMETYPE_TEXT, MIMETYPE_XML, MIMETYPE_JSON, MIMETYPE_JAVASCRIPT,
MIMETYPE_PROTOBUF})
@@ -57,7 +70,10 @@ public class VersionResource implements Constants {
response.cacheControl(cacheControl);
return response.build();
}
-
+
+ /**
+ * Dispatch /version/stargate to self.
+ */
// "/version/stargate" is an alias for "/version"
@Path("stargate")
public VersionResource getVersionResource() {
diff --git a/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/client/Client.java b/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/client/Client.java
index 73695c9e6ed..01c0c19e804 100644
--- a/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/client/Client.java
+++ b/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/client/Client.java
@@ -39,6 +39,10 @@ import org.apache.commons.httpclient.params.HttpConnectionManagerParams;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
+/**
+ * A wrapper around HttpClient which provides some useful function and
+ * semantics for interacting with the Stargate REST gateway.
+ */
public class Client {
public static final Header[] EMPTY_HEADER_ARRAY = new Header[0];
@@ -47,10 +51,17 @@ public class Client {
private HttpClient httpClient;
private Cluster cluster;
+ /**
+ * Default Constructor
+ */
public Client() {
this(null);
}
+ /**
+ * Constructor
+ * @param cluster the cluster definition
+ */
public Client(Cluster cluster) {
this.cluster = cluster;
httpClient = new HttpClient(new MultiThreadedHttpConnectionManager());
@@ -61,37 +72,61 @@ public class Client {
clientParams.setVersion(HttpVersion.HTTP_1_1);
}
+ /**
+ * Shut down the client. Close any open persistent connections.
+ */
public void shutdown() {
MultiThreadedHttpConnectionManager manager =
(MultiThreadedHttpConnectionManager) httpClient.getHttpConnectionManager();
manager.shutdown();
}
+ /**
+ * Execute a transaction method given only the path. Will select at random
+ * one of the members of the supplied cluster definition and iterate through
+ * the list until a transaction can be successfully completed. The
+ * definition of success here is a complete HTTP transaction, irrespective
+ * of result code.
+ * @param cluster the cluster definition
+ * @param method the transaction method
+ * @param headers HTTP header values to send
+ * @param path the path
+ * @return the HTTP response code
+ * @throws IOException
+ */
@SuppressWarnings("deprecation")
- public int executePathOnly(Cluster c, HttpMethod method, Header[] headers,
- String path) throws IOException {
+ public int executePathOnly(Cluster cluster, HttpMethod method,
+ Header[] headers, String path) throws IOException {
IOException lastException;
- if (c.nodes.size() < 1) {
+ if (cluster.nodes.size() < 1) {
throw new IOException("Cluster is empty");
}
- int start = (int)Math.round((c.nodes.size() - 1) * Math.random());
+ int start = (int)Math.round((cluster.nodes.size() - 1) * Math.random());
int i = start;
do {
- c.lastHost = c.nodes.get(i);
+ cluster.lastHost = cluster.nodes.get(i);
try {
StringBuffer sb = new StringBuffer();
sb.append("http://");
- sb.append(c.lastHost);
+ sb.append(cluster.lastHost);
sb.append(path);
URI uri = new URI(sb.toString());
return executeURI(method, headers, uri.toString());
} catch (IOException e) {
lastException = e;
}
- } while (++i != start && i < c.nodes.size());
+ } while (++i != start && i < cluster.nodes.size());
throw lastException;
}
+ /**
+ * Execute a transaction method given a complete URI.
+ * @param method the transaction method
+ * @param headers HTTP header values to send
+ * @param uri the URI
+ * @return the HTTP response code
+ * @throws IOException
+ */
@SuppressWarnings("deprecation")
public int executeURI(HttpMethod method, Header[] headers, String uri)
throws IOException {
@@ -111,57 +146,133 @@ public class Client {
return code;
}
- public int execute(Cluster c, HttpMethod method, Header[] headers,
+ /**
+ * Execute a transaction method. Will call either executePathOnly
+ * or executeURI depending on whether a path only is supplied in
+ * 'path', or if a complete URI is passed instead, respectively.
+ * @param cluster the cluster definition
+ * @param method the HTTP method
+ * @param headers HTTP header values to send
+ * @param path the path or URI
+ * @return the HTTP response code
+ * @throws IOException
+ */
+ public int execute(Cluster cluster, HttpMethod method, Header[] headers,
String path) throws IOException {
if (path.startsWith("/")) {
- return executePathOnly(c, method, headers, path);
+ return executePathOnly(cluster, method, headers, path);
}
return executeURI(method, headers, path);
}
+ /**
+ * @return the cluster definition
+ */
public Cluster getCluster() {
return cluster;
}
+ /**
+ * @param cluster the cluster definition
+ */
public void setCluster(Cluster cluster) {
this.cluster = cluster;
}
+ /**
+ * Send a HEAD request
+ * @param path the path or URI
+ * @return a Response object with response detail
+ * @throws IOException
+ */
public Response head(String path) throws IOException {
- return head(cluster, path);
+ return head(cluster, path, null);
}
- public Response head(Cluster c, String path) throws IOException {
+ /**
+ * Send a HEAD request
+ * @param cluster the cluster definition
+ * @param path the path or URI
+ * @param headers the HTTP headers to include in the request
+ * @return a Response object with response detail
+ * @throws IOException
+ */
+ public Response head(Cluster cluster, String path, Header[] headers)
+ throws IOException {
HeadMethod method = new HeadMethod();
- int code = execute(c, method, null, path);
- Header[] headers = method.getResponseHeaders();
+ int code = execute(cluster, method, null, path);
+ headers = method.getResponseHeaders();
method.releaseConnection();
return new Response(code, headers, null);
}
+ /**
+ * Send a GET request
+ * @param path the path or URI
+ * @return a Response object with response detail
+ * @throws IOException
+ */
public Response get(String path) throws IOException {
return get(cluster, path);
}
- public Response get(Cluster c, String path) throws IOException {
- return get(c, path, EMPTY_HEADER_ARRAY);
+ /**
+ * Send a GET request
+ * @param cluster the cluster definition
+ * @param path the path or URI
+ * @return a Response object with response detail
+ * @throws IOException
+ */
+ public Response get(Cluster cluster, String path) throws IOException {
+ return get(cluster, path, EMPTY_HEADER_ARRAY);
}
+ /**
+ * Send a GET request
+ * @param path the path or URI
+ * @param accept Accept header value
+ * @return a Response object with response detail
+ * @throws IOException
+ */
public Response get(String path, String accept) throws IOException {
return get(cluster, path, accept);
}
- public Response get(Cluster c, String path, String accept)
+ /**
+ * Send a GET request
+ * @param cluster the cluster definition
+ * @param path the path or URI
+ * @param accept Accept header value
+ * @return a Response object with response detail
+ * @throws IOException
+ */
+ public Response get(Cluster cluster, String path, String accept)
throws IOException {
Header[] headers = new Header[1];
headers[0] = new Header("Accept", accept);
- return get(c, path, headers);
+ return get(cluster, path, headers);
}
+ /**
+ * Send a GET request
+ * @param path the path or URI
+ * @param headers the HTTP headers to include in the request,
+ * Accept must be supplied
+ * @return a Response object with response detail
+ * @throws IOException
+ */
public Response get(String path, Header[] headers) throws IOException {
return get(cluster, path, headers);
}
+ /**
+ * Send a GET request
+ * @param cluster the cluster definition
+ * @param path the path or URI
+ * @param headers the HTTP headers to include in the request
+ * @return a Response object with response detail
+ * @throws IOException
+ */
public Response get(Cluster c, String path, Header[] headers)
throws IOException {
GetMethod method = new GetMethod();
@@ -172,69 +283,154 @@ public class Client {
return new Response(code, headers, body);
}
+ /**
+ * Send a PUT request
+ * @param path the path or URI
+ * @param contentType the content MIME type
+ * @param content the content bytes
+ * @return a Response object with response detail
+ * @throws IOException
+ */
public Response put(String path, String contentType, byte[] content)
throws IOException {
return put(cluster, path, contentType, content);
}
- public Response put(Cluster c, String path, String contentType,
+ /**
+ * Send a PUT request
+ * @param cluster the cluster definition
+ * @param path the path or URI
+ * @param contentType the content MIME type
+ * @param content the content bytes
+ * @return a Response object with response detail
+ * @throws IOException
+ */
+ public Response put(Cluster cluster, String path, String contentType,
byte[] content) throws IOException {
Header[] headers = new Header[1];
headers[0] = new Header("Content-Type", contentType);
- return put(c, path, headers, content);
+ return put(cluster, path, headers, content);
}
- public Response put(String path, Header[] headers, byte[] body)
+ /**
+ * Send a PUT request
+ * @param path the path or URI
+ * @param headers the HTTP headers to include, Content-Type must be
+ * supplied
+ * @param content the content bytes
+ * @return a Response object with response detail
+ * @throws IOException
+ */
+ public Response put(String path, Header[] headers, byte[] content)
throws IOException {
- return put(cluster, path, headers, body);
+ return put(cluster, path, headers, content);
}
- public Response put(Cluster c, String path, Header[] headers,
- byte[] body) throws IOException {
+ /**
+ * Send a PUT request
+ * @param cluster the cluster definition
+ * @param path the path or URI
+ * @param headers the HTTP headers to include, Content-Type must be
+ * supplied
+ * @param content the content bytes
+ * @return a Response object with response detail
+ * @throws IOException
+ */
+ public Response put(Cluster cluster, String path, Header[] headers,
+ byte[] content) throws IOException {
PutMethod method = new PutMethod();
- method.setRequestEntity(new ByteArrayRequestEntity(body));
- int code = execute(c, method, headers, path);
- headers = method.getResponseHeaders();
- body = method.getResponseBody();
- method.releaseConnection();
- return new Response(code, headers, body);
- }
-
- public Response post(String path, String contentType, byte[] content)
- throws IOException {
- return post(cluster, path, contentType, content);
- }
-
- public Response post(Cluster c, String path, String contentType,
- byte[] content) throws IOException {
- Header[] headers = new Header[1];
- headers[0] = new Header("Content-Type", contentType);
- return post(c, path, headers, content);
- }
-
- public Response post(String path, Header[] headers, byte[] content)
- throws IOException {
- return post(cluster, path, headers, content);
- }
-
- public Response post(Cluster c, String path, Header[] headers,
- byte[] content) throws IOException {
- PostMethod method = new PostMethod();
method.setRequestEntity(new ByteArrayRequestEntity(content));
- int code = execute(c, method, headers, path);
+ int code = execute(cluster, method, headers, path);
headers = method.getResponseHeaders();
content = method.getResponseBody();
method.releaseConnection();
return new Response(code, headers, content);
}
+ /**
+ * Send a POST request
+ * @param path the path or URI
+ * @param contentType the content MIME type
+ * @param content the content bytes
+ * @return a Response object with response detail
+ * @throws IOException
+ */
+ public Response post(String path, String contentType, byte[] content)
+ throws IOException {
+ return post(cluster, path, contentType, content);
+ }
+
+ /**
+ * Send a POST request
+ * @param cluster the cluster definition
+ * @param path the path or URI
+ * @param contentType the content MIME type
+ * @param content the content bytes
+ * @return a Response object with response detail
+ * @throws IOException
+ */
+ public Response post(Cluster cluster, String path, String contentType,
+ byte[] content) throws IOException {
+ Header[] headers = new Header[1];
+ headers[0] = new Header("Content-Type", contentType);
+ return post(cluster, path, headers, content);
+ }
+
+ /**
+ * Send a POST request
+ * @param path the path or URI
+ * @param headers the HTTP headers to include, Content-Type must be
+ * supplied
+ * @param content the content bytes
+ * @return a Response object with response detail
+ * @throws IOException
+ */
+ public Response post(String path, Header[] headers, byte[] content)
+ throws IOException {
+ return post(cluster, path, headers, content);
+ }
+
+ /**
+ * Send a POST request
+ * @param cluster the cluster definition
+ * @param path the path or URI
+ * @param headers the HTTP headers to include, Content-Type must be
+ * supplied
+ * @param content the content bytes
+ * @return a Response object with response detail
+ * @throws IOException
+ */
+ public Response post(Cluster cluster, String path, Header[] headers,
+ byte[] content) throws IOException {
+ PostMethod method = new PostMethod();
+ method.setRequestEntity(new ByteArrayRequestEntity(content));
+ int code = execute(cluster, method, headers, path);
+ headers = method.getResponseHeaders();
+ content = method.getResponseBody();
+ method.releaseConnection();
+ return new Response(code, headers, content);
+ }
+
+ /**
+ * Send a DELETE request
+ * @param path the path or URI
+ * @return a Response object with response detail
+ * @throws IOException
+ */
public Response delete(String path) throws IOException {
return delete(cluster, path);
}
- public Response delete(Cluster c, String path) throws IOException {
+ /**
+ * Send a DELETE request
+ * @param cluster the cluster definition
+ * @param path the path or URI
+ * @return a Response object with response detail
+ * @throws IOException
+ */
+ public Response delete(Cluster cluster, String path) throws IOException {
DeleteMethod method = new DeleteMethod();
- int code = execute(c, method, null, path);
+ int code = execute(cluster, method, null, path);
Header[] headers = method.getResponseHeaders();
method.releaseConnection();
return new Response(code, headers);
diff --git a/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/client/Cluster.java b/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/client/Cluster.java
index 5f7f44d8c5e..9fd9ef6fd47 100644
--- a/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/client/Cluster.java
+++ b/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/client/Cluster.java
@@ -24,6 +24,10 @@ import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
+/**
+ * A list of 'host:port' addresses of HTTP servers operating as a single
+ * entity, for example multiple redundant web service gateways.
+ */
public class Cluster {
protected List nodes =
Collections.synchronizedList(new ArrayList());
diff --git a/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/client/Response.java b/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/client/Response.java
index b537918031e..9e2675e4bc8 100644
--- a/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/client/Response.java
+++ b/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/client/Response.java
@@ -22,6 +22,9 @@ package org.apache.hadoop.hbase.stargate.client;
import org.apache.commons.httpclient.Header;
+/**
+ * The HTTP result code, response headers, and body of a HTTP response.
+ */
public class Response {
private int code;
private Header[] headers;
diff --git a/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/model/CellModel.java b/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/model/CellModel.java
index db6c509cc54..d498ece8359 100644
--- a/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/model/CellModel.java
+++ b/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/model/CellModel.java
@@ -33,34 +33,41 @@ import org.apache.hadoop.hbase.stargate.protobuf.generated.CellMessage.Cell;
import com.google.protobuf.ByteString;
+/**
+ * Representation of a cell. A cell is a single value associated a column and
+ * optional qualifier, and either the timestamp when it was stored or the user-
+ * provided timestamp if one was explicitly supplied.
+ */
@XmlRootElement(name="Cell")
@XmlType(propOrder={"column","timestamp"})
public class CellModel implements IProtobufWrapper, Serializable {
private static final long serialVersionUID = 1L;
- private long timestamp = HConstants.LATEST_TIMESTAMP;
+ private long timestamp;
private byte[] column;
private byte[] value;
+ /**
+ * Default constructor
+ */
public CellModel() {}
/**
+ * Constructor
* @param column
* @param value
*/
public CellModel(byte[] column, byte[] value) {
- super();
- this.column = column;
- this.value = value;
+ this(column, HConstants.LATEST_TIMESTAMP, value);
}
/**
+ * Constructor
* @param column
* @param timestamp
* @param value
*/
public CellModel(byte[] column, long timestamp, byte[] value) {
- super();
this.column = column;
this.timestamp = timestamp;
this.value = value;
diff --git a/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/model/CellSetModel.java b/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/model/CellSetModel.java
index 55d28f8bc1a..ed55f31b032 100644
--- a/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/model/CellSetModel.java
+++ b/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/model/CellSetModel.java
@@ -34,22 +34,27 @@ import org.apache.hadoop.hbase.stargate.protobuf.generated.CellSetMessage.CellSe
import com.google.protobuf.ByteString;
+/**
+ * Representation of a grouping of cells. May contain cells from more than
+ * one row. Encapsulates RowModel and CellModel models.
+ */
@XmlRootElement(name="CellSet")
public class CellSetModel implements Serializable, IProtobufWrapper {
private static final long serialVersionUID = 1L;
private List rows;
-
-
+
+ /**
+ * Constructor
+ */
public CellSetModel() {
this.rows = new ArrayList();
}
/**
- * @param rows
+ * @param rows the rows
*/
-
public CellSetModel(List rows) {
super();
this.rows = rows;
@@ -57,8 +62,7 @@ public class CellSetModel implements Serializable, IProtobufWrapper {
/**
* Add a row to this cell set
- *
- * @param row
+ * @param row the row
*/
public void addRow(RowModel row) {
rows.add(row);
diff --git a/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/model/ColumnSchemaModel.java b/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/model/ColumnSchemaModel.java
index ea027681be5..4db4908435b 100644
--- a/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/model/ColumnSchemaModel.java
+++ b/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/model/ColumnSchemaModel.java
@@ -33,6 +33,9 @@ import javax.xml.namespace.QName;
import org.apache.hadoop.hbase.HColumnDescriptor;
import org.apache.hadoop.hbase.HConstants;
+/**
+ * Representation of a column family schema.
+ */
@XmlRootElement(name="ColumnSchema")
@XmlType(propOrder = {"name"})
public class ColumnSchemaModel implements Serializable {
@@ -48,14 +51,27 @@ public class ColumnSchemaModel implements Serializable {
private String name;
private Map attrs = new HashMap();
+ /**
+ * Default constructor
+ */
public ColumnSchemaModel() {}
+ /**
+ * Add an attribute to the column family schema
+ * @param name the attribute name
+ * @param value the attribute value
+ */
public void addAttribute(String name, Object value) {
attrs.put(new QName(name), value);
}
+ /**
+ * @param name the attribute name
+ * @return the attribute value
+ */
public String getAttribute(String name) {
- return attrs.get(new QName(name)).toString();
+ Object o = attrs.get(new QName(name));
+ return o != null ? o.toString(): null;
}
/**
@@ -106,51 +122,78 @@ public class ColumnSchemaModel implements Serializable {
// cannot be standard bean type getters and setters, otherwise this would
// confuse JAXB
+ /**
+ * @return true if the BLOCKCACHE attribute is present and true
+ */
public boolean __getBlockcache() {
Object o = attrs.get(BLOCKCACHE);
return o != null ?
Boolean.valueOf(o.toString()) : HColumnDescriptor.DEFAULT_BLOCKCACHE;
}
+ /**
+ * @return the value of the BLOCKSIZE attribute or its default if it is unset
+ */
public int __getBlocksize() {
Object o = attrs.get(BLOCKSIZE);
return o != null ?
Integer.valueOf(o.toString()) : HColumnDescriptor.DEFAULT_BLOCKSIZE;
}
+ /**
+ * @return true if the BLOOMFILTER attribute is present and true
+ */
public boolean __getBloomfilter() {
Object o = attrs.get(BLOOMFILTER);
return o != null ?
Boolean.valueOf(o.toString()) : HColumnDescriptor.DEFAULT_BLOOMFILTER;
}
+ /**
+ * @return the value of the COMPRESSION attribute or its default if it is unset
+ */
public String __getCompression() {
Object o = attrs.get(COMPRESSION);
return o != null ? o.toString() : HColumnDescriptor.DEFAULT_COMPRESSION;
}
+ /**
+ * @return true if the IN_MEMORY attribute is present and true
+ */
public boolean __getInMemory() {
Object o = attrs.get(IN_MEMORY);
return o != null ?
Boolean.valueOf(o.toString()) : HColumnDescriptor.DEFAULT_IN_MEMORY;
}
+ /**
+ * @return the value of the TTL attribute or its default if it is unset
+ */
public int __getTTL() {
Object o = attrs.get(TTL);
return o != null ?
Integer.valueOf(o.toString()) : HColumnDescriptor.DEFAULT_TTL;
}
+ /**
+ * @return the value of the VERSIONS attribute or its default if it is unset
+ */
public int __getVersions() {
Object o = attrs.get(VERSIONS);
return o != null ?
Integer.valueOf(o.toString()) : HColumnDescriptor.DEFAULT_VERSIONS;
}
+ /**
+ * @param value the desired value of the BLOCKSIZE attribute
+ */
public void __setBlocksize(int value) {
attrs.put(BLOCKSIZE, Integer.toString(value));
}
+ /**
+ * @param value the desired value of the BLOCKCACHE attribute
+ */
public void __setBlockcache(boolean value) {
attrs.put(BLOCKCACHE, Boolean.toString(value));
}
@@ -159,18 +202,30 @@ public class ColumnSchemaModel implements Serializable {
attrs.put(BLOOMFILTER, Boolean.toString(value));
}
+ /**
+ * @param value the desired value of the COMPRESSION attribute
+ */
public void __setCompression(String value) {
attrs.put(COMPRESSION, value);
}
+ /**
+ * @param value the desired value of the IN_MEMORY attribute
+ */
public void __setInMemory(boolean value) {
attrs.put(IN_MEMORY, Boolean.toString(value));
}
+ /**
+ * @param value the desired value of the TTL attribute
+ */
public void __setTTL(int value) {
attrs.put(TTL, Integer.toString(value));
}
+ /**
+ * @param value the desired value of the VERSIONS attribute
+ */
public void __setVersions(int value) {
attrs.put(VERSIONS, Integer.toString(value));
}
diff --git a/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/model/IProtobufWrapper.java b/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/model/IProtobufWrapper.java
index 14d2dc5c73b..049f253acfd 100644
--- a/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/model/IProtobufWrapper.java
+++ b/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/model/IProtobufWrapper.java
@@ -22,8 +22,23 @@ package org.apache.hadoop.hbase.stargate.model;
import java.io.IOException;
+/**
+ * Common interface for models capable of supporting protobuf marshalling
+ * and unmarshalling. Hooks up to the ProtobufMessageBodyConsumer and
+ * ProtobufMessageBodyProducer adapters.
+ */
public abstract interface IProtobufWrapper {
+ /**
+ * @return the protobuf represention of the model
+ */
public byte[] createProtobufOutput();
+
+ /**
+ * Initialize the model from a protobuf representation.
+ * @param message the raw bytes of the protobuf message
+ * @return reference to self for convenience
+ * @throws IOException
+ */
public IProtobufWrapper getObjectFromMessage(byte[] message)
throws IOException;
}
diff --git a/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/model/RowModel.java b/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/model/RowModel.java
index 29c2d00d6f5..a33678fecbd 100644
--- a/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/model/RowModel.java
+++ b/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/model/RowModel.java
@@ -29,60 +29,69 @@ import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;
+/**
+ * Representation of a row. A row is a related set of cells, grouped by common
+ * row key. RowModels do not appear in results by themselves. They are always
+ * encapsulated within CellSetModels.
+ */
@XmlRootElement(name="Row")
public class RowModel implements IProtobufWrapper, Serializable {
private static final long serialVersionUID = 1L;
- private byte[] key;
- private List cells = new ArrayList();
+ private byte[] key;
+ private List cells = new ArrayList();
+ /**
+ * Default constructor
+ */
public RowModel() { }
/**
- * @param key
+ * Constructor
+ * @param key the row key
*/
public RowModel(final String key) {
this(key.getBytes());
}
/**
- * @param key
+ * Constructor
+ * @param key the row key
*/
public RowModel(final byte[] key) {
- super();
this.key = key;
cells = new ArrayList();
}
/**
- * @param key
- * @param cells
+ * Constructor
+ * @param key the row key
+ * @param cells the cells
*/
public RowModel(final String key, final List cells) {
this(key.getBytes(), cells);
}
/**
- * @param key
- * @param cells
+ * Constructor
+ * @param key the row key
+ * @param cells the cells
*/
public RowModel(final byte[] key, final List cells) {
- super();
this.key = key;
this.cells = cells;
}
/**
* Adds a cell to the list of cells for this row
- *
- * @param cell
+ * @param cell the cell
*/
public void addCell(CellModel cell) {
cells.add(cell);
}
/**
- * @return the key
+ * @return the row key
*/
@XmlAttribute
public byte[] getKey() {
@@ -90,7 +99,7 @@ public class RowModel implements IProtobufWrapper, Serializable {
}
/**
- * @param key the key to set
+ * @param key the row key
*/
public void setKey(byte[] key) {
this.key = key;
@@ -118,5 +127,4 @@ public class RowModel implements IProtobufWrapper, Serializable {
throw new UnsupportedOperationException(
"no protobuf equivalent to RowModel");
}
-
}
diff --git a/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/model/ScannerModel.java b/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/model/ScannerModel.java
index 4e09754b262..f53a3555262 100644
--- a/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/model/ScannerModel.java
+++ b/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/model/ScannerModel.java
@@ -34,6 +34,9 @@ import org.apache.hadoop.hbase.util.Bytes;
import com.google.protobuf.ByteString;
+/**
+ * A representation of Scanner parameters.
+ */
@XmlRootElement(name="Scanner")
public class ScannerModel implements IProtobufWrapper, Serializable {
private static final long serialVersionUID = 1L;
@@ -45,8 +48,20 @@ public class ScannerModel implements IProtobufWrapper, Serializable {
private long startTime = 0;
private long endTime = Long.MAX_VALUE;
+ /**
+ * Default constructor
+ */
public ScannerModel() {}
+ /**
+ * Constructor
+ * @param startRow the start key of the row-range
+ * @param endRow the end key of the row-range
+ * @param columns the columns to scan
+ * @param batch the number of values to return in batch
+ * @param endTime the upper bound on timestamps of values of interest
+ * (values with timestamps later than this are excluded)
+ */
public ScannerModel(byte[] startRow, byte[] endRow, List columns,
int batch, long endTime) {
super();
@@ -57,6 +72,17 @@ public class ScannerModel implements IProtobufWrapper, Serializable {
this.endTime = endTime;
}
+ /**
+ * Constructor
+ * @param startRow the start key of the row-range
+ * @param endRow the end key of the row-range
+ * @param columns the columns to scan
+ * @param batch the number of values to return in batch
+ * @param startTime the lower bound on timestamps of values of interest
+ * (values with timestamps earlier than this are excluded)
+ * @param endTime the upper bound on timestamps of values of interest
+ * (values with timestamps later than this are excluded)
+ */
public ScannerModel(byte[] startRow, byte[] endRow, List columns,
int batch, long startTime, long endTime) {
super();
@@ -68,6 +94,10 @@ public class ScannerModel implements IProtobufWrapper, Serializable {
this.endTime = endTime;
}
+ /**
+ * Add a column to the column set
+ * @param column the column name, as <column>(:<qualifier>)?
+ */
public void addColumn(byte[] column) {
columns.add(column);
}
@@ -156,14 +186,14 @@ public class ScannerModel implements IProtobufWrapper, Serializable {
}
/**
- * @param startTime the lower bound on timestamps of items of interest
+ * @param startTime the lower bound on timestamps of values of interest
*/
public void setStartTime(long startTime) {
this.startTime = startTime;
}
/**
- * @param endTime the upper bound on timestamps of items of interest
+ * @param endTime the upper bound on timestamps of values of interest
*/
public void setEndTime(long endTime) {
this.endTime = endTime;
diff --git a/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/model/StorageClusterStatusModel.java b/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/model/StorageClusterStatusModel.java
index 7dbf842e4ee..b6409be8c9b 100644
--- a/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/model/StorageClusterStatusModel.java
+++ b/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/model/StorageClusterStatusModel.java
@@ -35,27 +35,58 @@ import org.apache.hadoop.hbase.util.Bytes;
import com.google.protobuf.ByteString;
+/**
+ * Representation of the status of a storage cluster:
+ *
+ *
+ * - regions: the total number of regions served by the cluster
+ * - requests: the total number of requests per second handled by the
+ * cluster in the last reporting interval
+ * - averageLoad: the average load of the region servers in the cluster
+ * - liveNodes: detailed status of the live region servers
+ * - deadNodes: the names of region servers declared dead
+ *
+ */
@XmlRootElement(name="ClusterStatus")
public class StorageClusterStatusModel
implements Serializable, IProtobufWrapper {
private static final long serialVersionUID = 1L;
+ /**
+ * Represents a region server.
+ */
public static class Node {
+ /**
+ * Represents a region hosted on a region server.
+ */
public static class Region {
private byte[] name;
+ /**
+ * Default constructor
+ */
public Region() {}
+ /**
+ * Constructor
+ * @param name the region name
+ */
public Region(byte[] name) {
this.name = name;
}
+ /**
+ * @return the region name
+ */
@XmlAttribute
public byte[] getName() {
return name;
}
+ /**
+ * @param name the region name
+ */
public void setName(byte[] name) {
this.name = name;
}
@@ -66,53 +97,94 @@ public class StorageClusterStatusModel
private int requests;
private List regions = new ArrayList();
+ /**
+ * Add a region name to the list
+ * @param name the region name
+ */
public void addRegion(byte[] name) {
regions.add(new Region(name));
}
- public Region getRegion(int i) {
- return regions.get(i);
+ /**
+ * @param index the index
+ * @return the region name
+ */
+ public Region getRegion(int index) {
+ return regions.get(index);
}
+ /**
+ * Default constructor
+ */
public Node() {}
+ /**
+ * Constructor
+ * @param name the region server name
+ * @param startCode the region server's start code
+ */
public Node(String name, long startCode) {
this.name = name;
this.startCode = startCode;
}
+ /**
+ * @return the region server's name
+ */
@XmlAttribute
public String getName() {
return name;
}
+ /**
+ * @return the region server's start code
+ */
@XmlAttribute
public long getStartCode() {
return startCode;
}
+ /**
+ * @return the list of regions served by the region server
+ */
@XmlElement(name="Region")
public List getRegions() {
return regions;
}
+ /**
+ * @return the number of requests per second processed by the region server
+ */
@XmlAttribute
public int getRequests() {
return requests;
}
+ /**
+ * @param name the region server's hostname
+ */
public void setName(String name) {
this.name = name;
}
+ /**
+ * @param startCode the region server's start code
+ */
public void setStartCode(long startCode) {
this.startCode = startCode;
}
+ /**
+ * @param regions a list of regions served by the region server
+ */
public void setRegions(List regions) {
this.regions = regions;
}
+ /**
+ * @param requests the number of requests per second processed by the
+ * region server
+ */
public void setRequests(int requests) {
this.requests = requests;
}
@@ -124,69 +196,121 @@ public class StorageClusterStatusModel
private int requests;
private double averageLoad;
+ /**
+ * Add a live node to the cluster representation.
+ * @param name the region server name
+ * @param startCode the region server's start code
+ */
public Node addLiveNode(String name, long startCode) {
Node node = new Node(name, startCode);
liveNodes.add(node);
return node;
}
- public Node getLiveNode(int i) {
- return liveNodes.get(i);
+ /**
+ * @param index the index
+ * @return the region server model
+ */
+ public Node getLiveNode(int index) {
+ return liveNodes.get(index);
}
+ /**
+ * Add a dead node to the cluster representation.
+ * @param node the dead region server's name
+ */
public void addDeadNode(String node) {
deadNodes.add(node);
}
- public String getDeadNode(int i) {
- return deadNodes.get(i);
+ /**
+ * @param index the index
+ * @return the dead region server's name
+ */
+ public String getDeadNode(int index) {
+ return deadNodes.get(index);
}
+ /**
+ * Default constructor
+ */
public StorageClusterStatusModel() {}
+ /**
+ * @return the list of live nodes
+ */
@XmlElement(name="Node")
@XmlElementWrapper(name="LiveNodes")
public List getLiveNodes() {
return liveNodes;
}
+ /**
+ * @return the list of dead nodes
+ */
@XmlElement(name="Node")
@XmlElementWrapper(name="DeadNodes")
public List getDeadNodes() {
return deadNodes;
}
+ /**
+ * @return the total number of regions served by the cluster
+ */
@XmlAttribute
public int getRegions() {
return regions;
}
-
+
+ /**
+ * @return the total number of requests per second handled by the cluster in
+ * the last reporting interval
+ */
@XmlAttribute
public int getRequests() {
return requests;
}
+ /**
+ * @return the average load of the region servers in the cluster
+ */
@XmlAttribute
public double getAverageLoad() {
return averageLoad;
}
+ /**
+ * @param nodes the list of live node models
+ */
public void setLiveNodes(List nodes) {
this.liveNodes = nodes;
}
+ /**
+ * @param nodes the list of dead node names
+ */
public void setDeadNodes(List nodes) {
this.deadNodes = nodes;
}
+ /**
+ * @param regions the total number of regions served by the cluster
+ */
public void setRegions(int regions) {
this.regions = regions;
}
-
+
+ /**
+ * @param requests the total number of requests per second handled by the
+ * cluster
+ */
public void setRequests(int requests) {
this.requests = requests;
}
+ /**
+ * @param averageLoad the average load of region servers in the cluster
+ */
public void setAverageLoad(double averageLoad) {
this.averageLoad = averageLoad;
}
diff --git a/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/model/StorageClusterVersionModel.java b/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/model/StorageClusterVersionModel.java
index 81200e7ae43..5083ec38b7e 100644
--- a/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/model/StorageClusterVersionModel.java
+++ b/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/model/StorageClusterVersionModel.java
@@ -25,17 +25,26 @@ import java.io.Serializable;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlValue;
+/**
+ * Simple representation of the version of the storage cluster (HBase)
+ */
@XmlRootElement(name="ClusterVersion")
public class StorageClusterVersionModel implements Serializable {
private static final long serialVersionUID = 1L;
private String version;
+ /**
+ * @return the storage cluster version
+ */
@XmlValue
public String getVersion() {
return version;
}
-
+
+ /**
+ * @param version the storage cluster version
+ */
public void setVersion(String version) {
this.version = version;
}
diff --git a/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/model/TableInfoModel.java b/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/model/TableInfoModel.java
index 5e7c2bb2d89..5d7a880d46e 100644
--- a/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/model/TableInfoModel.java
+++ b/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/model/TableInfoModel.java
@@ -34,6 +34,9 @@ import org.apache.hadoop.hbase.stargate.protobuf.generated.TableInfoMessage.Tabl
import com.google.protobuf.ByteString;
+/**
+ * Representation of a list of table regions.
+ */
@XmlRootElement(name="TableInfo")
@XmlType(propOrder = {"name","regions"})
public class TableInfoModel implements Serializable, IProtobufWrapper {
@@ -42,16 +45,31 @@ public class TableInfoModel implements Serializable, IProtobufWrapper {
private String name;
private List regions = new ArrayList();
+ /**
+ * Default constructor
+ */
public TableInfoModel() {}
+ /**
+ * Constructor
+ * @param name
+ */
public TableInfoModel(String name) {
this.name = name;
}
- public void add(TableRegionModel object) {
- regions.add(object);
+ /**
+ * Add a region model to the list
+ * @param region the region
+ */
+ public void add(TableRegionModel region) {
+ regions.add(region);
}
-
+
+ /**
+ * @param index the index
+ * @return the region model
+ */
public TableRegionModel get(int index) {
return regions.get(index);
}
diff --git a/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/model/TableListModel.java b/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/model/TableListModel.java
index 187ba375989..86b3f4dec8b 100644
--- a/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/model/TableListModel.java
+++ b/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/model/TableListModel.java
@@ -30,6 +30,9 @@ import javax.xml.bind.annotation.XmlRootElement;
import org.apache.hadoop.hbase.stargate.protobuf.generated.TableListMessage.TableList;
+/**
+ * Simple representation of a list of table names.
+ */
@XmlRootElement(name="TableList")
public class TableListModel implements Serializable, IProtobufWrapper {
@@ -37,12 +40,23 @@ public class TableListModel implements Serializable, IProtobufWrapper {
private List tables = new ArrayList();
+ /**
+ * Default constructor
+ */
public TableListModel() {}
-
- public void add(TableModel object) {
- tables.add(object);
+
+ /**
+ * Add the table name model to the list
+ * @param table the table model
+ */
+ public void add(TableModel table) {
+ tables.add(table);
}
+ /**
+ * @param index the index
+ * @return the table model
+ */
public TableModel get(int index) {
return tables.get(index);
}
diff --git a/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/model/TableModel.java b/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/model/TableModel.java
index 7edbd76d96f..90bfd0c9eaf 100644
--- a/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/model/TableModel.java
+++ b/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/model/TableModel.java
@@ -25,6 +25,9 @@ import java.io.Serializable;
import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlRootElement;
+/**
+ * Simple representation of a table name.
+ */
@XmlRootElement(name="table")
public class TableModel implements Serializable {
@@ -32,9 +35,13 @@ public class TableModel implements Serializable {
private String name;
+ /**
+ * Default constructor
+ */
public TableModel() {}
/**
+ * Constructor
* @param name
*/
public TableModel(String name) {
diff --git a/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/model/TableRegionModel.java b/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/model/TableRegionModel.java
index 8dc5254047a..1d16ec95ec6 100644
--- a/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/model/TableRegionModel.java
+++ b/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/model/TableRegionModel.java
@@ -28,6 +28,10 @@ import javax.xml.bind.annotation.XmlType;
import org.apache.hadoop.hbase.util.Bytes;
+/**
+ * Representation of a region of a table and its current location on the
+ * storage cluster.
+ */
@XmlRootElement(name="Region")
@XmlType(propOrder = {"name","id","startKey","endKey","location"})
public class TableRegionModel implements Serializable {
diff --git a/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/model/TableSchemaModel.java b/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/model/TableSchemaModel.java
index 3d7f937d3c9..495fa9b9fa9 100644
--- a/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/model/TableSchemaModel.java
+++ b/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/model/TableSchemaModel.java
@@ -41,6 +41,9 @@ import org.apache.hadoop.hbase.HTableDescriptor;
import org.apache.hadoop.hbase.stargate.protobuf.generated.ColumnSchemaMessage.ColumnSchema;
import org.apache.hadoop.hbase.stargate.protobuf.generated.TableSchemaMessage.TableSchema;
+/**
+ * A representation of HBase table descriptors.
+ */
@XmlRootElement(name="TableSchema")
@XmlType(propOrder = {"name","columns"})
public class TableSchemaModel implements Serializable, IProtobufWrapper {
@@ -58,20 +61,44 @@ public class TableSchemaModel implements Serializable, IProtobufWrapper {
private Map attrs = new HashMap();
private List columns = new ArrayList();
+ /**
+ * Default constructor.
+ */
public TableSchemaModel() {}
-
+
+ /**
+ * Add an attribute to the table descriptor
+ * @param name attribute name
+ * @param value attribute value
+ */
public void addAttribute(String name, Object value) {
attrs.put(new QName(name), value);
}
+ /**
+ * Return a table descriptor value as a string. Calls toString() on the
+ * object stored in the descriptor value map.
+ * @param name the attribute name
+ * @return the attribute value
+ */
public String getAttribute(String name) {
- return attrs.get(new QName(name)).toString();
+ Object o = attrs.get(new QName(name));
+ return o != null ? o.toString() : null;
}
- public void addColumnFamily(ColumnSchemaModel object) {
- columns.add(object);
+ /**
+ * Add a column family to the table descriptor
+ * @param object the column family model
+ */
+ public void addColumnFamily(ColumnSchemaModel family) {
+ columns.add(family);
}
-
+
+ /**
+ * Retrieve the column family at the given index from the table descriptor
+ * @param index the index
+ * @return the column family model
+ */
public ColumnSchemaModel getColumnFamily(int index) {
return columns.get(index);
}
@@ -149,40 +176,64 @@ public class TableSchemaModel implements Serializable, IProtobufWrapper {
// cannot be standard bean type getters and setters, otherwise this would
// confuse JAXB
+ /**
+ * @return true if IN_MEMORY attribute exists and is true
+ */
public boolean __getInMemory() {
Object o = attrs.get(IN_MEMORY);
return o != null ?
Boolean.valueOf(o.toString()) : HTableDescriptor.DEFAULT_IN_MEMORY;
}
+ /**
+ * @return true if IS_META attribute exists and is truel
+ */
public boolean __getIsMeta() {
Object o = attrs.get(IS_META);
return o != null ? Boolean.valueOf(o.toString()) : false;
}
+ /**
+ * @return true if IS_ROOT attribute exists and is truel
+ */
public boolean __getIsRoot() {
Object o = attrs.get(IS_ROOT);
return o != null ? Boolean.valueOf(o.toString()) : false;
}
+ /**
+ * @return true if READONLY attribute exists and is truel
+ */
public boolean __getReadOnly() {
Object o = attrs.get(READONLY);
return o != null ?
Boolean.valueOf(o.toString()) : HTableDescriptor.DEFAULT_READONLY;
}
+ /**
+ * @param value desired value of IN_MEMORY attribute
+ */
public void __setInMemory(boolean value) {
attrs.put(IN_MEMORY, Boolean.toString(value));
}
+ /**
+ * @param value desired value of IS_META attribute
+ */
public void __setIsMeta(boolean value) {
attrs.put(IS_META, Boolean.toString(value));
}
+ /**
+ * @param value desired value of IS_ROOT attribute
+ */
public void __setIsRoot(boolean value) {
attrs.put(IS_ROOT, Boolean.toString(value));
}
+ /**
+ * @param value desired value of READONLY attribute
+ */
public void __setReadOnly(boolean value) {
attrs.put(READONLY, Boolean.toString(value));
}
diff --git a/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/model/VersionModel.java b/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/model/VersionModel.java
index 5d99574fa29..8138fb72b15 100644
--- a/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/model/VersionModel.java
+++ b/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/model/VersionModel.java
@@ -32,6 +32,17 @@ import org.apache.hadoop.hbase.stargate.protobuf.generated.VersionMessage.Versio
import com.sun.jersey.spi.container.servlet.ServletContainer;
+/**
+ * A representation of the collection of versions of the Stargate software
+ * components.
+ *
+ * - stargateVersion: Stargate revision
+ * - jvmVersion: the JVM vendor and version information
+ * - osVersion: the OS type, version, and hardware architecture
+ * - serverVersion: the name and version of the servlet container
+ * - jerseyVersion: the version of the embedded Jersey framework
+ *
+ */
@XmlRootElement(name="Version")
public class VersionModel implements Serializable, IProtobufWrapper {
@@ -43,8 +54,15 @@ public class VersionModel implements Serializable, IProtobufWrapper {
private String serverVersion;
private String jerseyVersion;
+ /**
+ * Default constructor. Do not use.
+ */
public VersionModel() {}
+ /**
+ * Constructor
+ * @param context the servlet context
+ */
public VersionModel(ServletContext context) {
stargateVersion = RESTServlet.VERSION_STRING;
jvmVersion = System.getProperty("java.vm.vendor") + ' ' +
@@ -58,47 +76,77 @@ public class VersionModel implements Serializable, IProtobufWrapper {
.getImplementationVersion();
}
+ /**
+ * @return the Stargate version
+ */
@XmlAttribute(name="Stargate")
public String getStargateVersion() {
return stargateVersion;
}
+ /**
+ * @return the JVM vendor and version
+ */
@XmlAttribute(name="JVM")
public String getJvmVersion() {
return jvmVersion;
}
+ /**
+ * @return the OS name, version, and hardware architecture
+ */
@XmlAttribute(name="OS")
public String getOsVersion() {
return osVersion;
}
+ /**
+ * @return the servlet container version
+ */
@XmlAttribute(name="Server")
public String getServerVersion() {
return serverVersion;
}
+ /**
+ * @return the version of the embedded Jersey framework
+ */
@XmlAttribute(name="Jersey")
public String getJerseyVersion() {
return jerseyVersion;
}
+ /**
+ * @param version the Stargate version string
+ */
public void setStargateVersion(String version) {
this.stargateVersion = version;
}
+ /**
+ * @param version the OS version string
+ */
public void setOsVersion(String version) {
this.osVersion = version;
}
+ /**
+ * @param version the JVM version string
+ */
public void setJvmVersion(String version) {
this.jvmVersion = version;
}
+ /**
+ * @param version the servlet container version string
+ */
public void setServerVersion(String version) {
this.serverVersion = version;
}
+ /**
+ * @param version the Jersey framework version string
+ */
public void setJerseyVersion(String version) {
this.jerseyVersion = version;
}
diff --git a/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/provider/JAXBContextResolver.java b/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/provider/JAXBContextResolver.java
index c4946380012..51037ad6f21 100644
--- a/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/provider/JAXBContextResolver.java
+++ b/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/provider/JAXBContextResolver.java
@@ -45,6 +45,12 @@ import org.apache.hadoop.hbase.stargate.model.VersionModel;
import com.sun.jersey.api.json.JSONConfiguration;
import com.sun.jersey.api.json.JSONJAXBContext;
+/**
+ * Plumbing for hooking up Jersey's JSON entity body encoding and decoding
+ * support to JAXB. Modify how the context is created (by using e.g. a
+ * different configuration builder) to control how JSON is processed and
+ * created.
+ */
@Provider
public class JAXBContextResolver implements ContextResolver {
@@ -72,7 +78,7 @@ public class JAXBContextResolver implements ContextResolver {
public JAXBContextResolver() throws Exception {
this.types = new HashSet(Arrays.asList(cTypes));
this.context = new JSONJAXBContext(JSONConfiguration.natural().build(),
- cTypes);
+ cTypes);
}
@Override
diff --git a/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/provider/consumer/ProtobufMessageBodyConsumer.java b/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/provider/consumer/ProtobufMessageBodyConsumer.java
index 44be5813bad..f25203168a4 100644
--- a/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/provider/consumer/ProtobufMessageBodyConsumer.java
+++ b/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/provider/consumer/ProtobufMessageBodyConsumer.java
@@ -38,9 +38,14 @@ import org.apache.commons.logging.LogFactory;
import org.apache.hadoop.hbase.stargate.Constants;
import org.apache.hadoop.hbase.stargate.model.IProtobufWrapper;
+/**
+ * Adapter for hooking up Jersey content processing dispatch to
+ * IProtobufWrapper interface capable handlers for decoding protobuf input.
+ */
@Provider
@Consumes(Constants.MIMETYPE_PROTOBUF)
-public class ProtobufMessageBodyConsumer implements MessageBodyReader {
+public class ProtobufMessageBodyConsumer
+ implements MessageBodyReader {
private static final Log LOG =
LogFactory.getLog(ProtobufMessageBodyConsumer.class);
@@ -79,5 +84,4 @@ public class ProtobufMessageBodyConsumer implements MessageBodyReader {
+public class ProtobufMessageBodyProducer
+ implements MessageBodyWriter {
+
+ private Map buffer = new WeakHashMap();
@Override
- public boolean isWriteable(Class type, Type genericType, Annotation[] annotations, MediaType mediaType) {
- return IProtobufWrapper.class.isAssignableFrom(type);
- }
-
- private Map buffer = new WeakHashMap();
-
- @Override
- public long getSize(IProtobufWrapper m, Class type, Type genericType, Annotation[] annotations, MediaType mediaType) {
- ByteArrayOutputStream baos = new ByteArrayOutputStream();
- try {
- baos.write(m.createProtobufOutput());
- } catch (IOException e) {
- return -1;
- }
- byte[] bytes = baos.toByteArray();
- buffer.put(m, bytes);
- return bytes.length;
- }
-
- public void writeTo(IProtobufWrapper m, Class type, Type genericType, Annotation[] annotations,
- MediaType mediaType, MultivaluedMap httpHeaders,
- OutputStream entityStream) throws IOException, WebApplicationException {
- entityStream.write(buffer.remove(m));
- }
+ public boolean isWriteable(Class type, Type genericType,
+ Annotation[] annotations, MediaType mediaType) {
+ return IProtobufWrapper.class.isAssignableFrom(type);
+ }
+ @Override
+ public long getSize(IProtobufWrapper m, Class type, Type genericType,
+ Annotation[] annotations, MediaType mediaType) {
+ ByteArrayOutputStream baos = new ByteArrayOutputStream();
+ try {
+ baos.write(m.createProtobufOutput());
+ } catch (IOException e) {
+ return -1;
+ }
+ byte[] bytes = baos.toByteArray();
+ buffer.put(m, bytes);
+ return bytes.length;
+ }
+ public void writeTo(IProtobufWrapper m, Class type, Type genericType,
+ Annotation[] annotations, MediaType mediaType,
+ MultivaluedMap httpHeaders, OutputStream entityStream)
+ throws IOException, WebApplicationException {
+ entityStream.write(buffer.remove(m));
+ }
}
diff --git a/src/contrib/stargate/src/test/org/apache/hadoop/hbase/stargate/TestVersionResource.java b/src/contrib/stargate/src/test/org/apache/hadoop/hbase/stargate/TestVersionResource.java
index 68c1b3b8d49..ba4fc973900 100644
--- a/src/contrib/stargate/src/test/org/apache/hadoop/hbase/stargate/TestVersionResource.java
+++ b/src/contrib/stargate/src/test/org/apache/hadoop/hbase/stargate/TestVersionResource.java
@@ -33,6 +33,9 @@ import org.apache.hadoop.hbase.stargate.client.Cluster;
import org.apache.hadoop.hbase.stargate.client.Response;
import org.apache.hadoop.hbase.stargate.model.StorageClusterVersionModel;
import org.apache.hadoop.hbase.stargate.model.VersionModel;
+import org.apache.hadoop.hbase.util.Bytes;
+
+import com.sun.jersey.spi.container.servlet.ServletContainer;
public class TestVersionResource extends MiniClusterTestCase {
private static final Log LOG =
@@ -63,15 +66,38 @@ public class TestVersionResource extends MiniClusterTestCase {
private static void validate(VersionModel model) {
assertNotNull(model);
assertNotNull(model.getStargateVersion());
- assertNotNull(model.getOsVersion());
- assertNotNull(model.getJvmVersion());
+ assertEquals(model.getStargateVersion(), RESTServlet.VERSION_STRING);
+ String osVersion = model.getOsVersion();
+ assertNotNull(osVersion);
+ assertTrue(osVersion.contains(System.getProperty("os.name")));
+ assertTrue(osVersion.contains(System.getProperty("os.version")));
+ assertTrue(osVersion.contains(System.getProperty("os.arch")));
+ String jvmVersion = model.getJvmVersion();
+ assertNotNull(jvmVersion);
+ assertTrue(jvmVersion.contains(System.getProperty("java.vm.vendor")));
+ assertTrue(jvmVersion.contains(System.getProperty("java.version")));
+ assertTrue(jvmVersion.contains(System.getProperty("java.vm.version")));
assertNotNull(model.getServerVersion());
- assertNotNull(model.getJerseyVersion());
+ String jerseyVersion = model.getJerseyVersion();
+ assertNotNull(jerseyVersion);
+ assertEquals(jerseyVersion, ServletContainer.class.getPackage()
+ .getImplementationVersion());
}
public void testGetStargateVersionText() throws IOException {
Response response = client.get(Constants.PATH_VERSION, MIMETYPE_PLAIN);
assertTrue(response.getCode() == 200);
+ String body = Bytes.toString(response.getBody());
+ assertTrue(body.length() > 0);
+ assertTrue(body.contains(RESTServlet.VERSION_STRING));
+ assertTrue(body.contains(System.getProperty("java.vm.vendor")));
+ assertTrue(body.contains(System.getProperty("java.version")));
+ assertTrue(body.contains(System.getProperty("java.vm.version")));
+ assertTrue(body.contains(System.getProperty("os.name")));
+ assertTrue(body.contains(System.getProperty("os.version")));
+ assertTrue(body.contains(System.getProperty("os.arch")));
+ assertTrue(body.contains(ServletContainer.class.getPackage()
+ .getImplementationVersion()));
}
public void testGetStargateVersionXML() throws IOException, JAXBException {