Author: apurtell
Date: Sun Jul 26 22:30:28 2009
New Revision: 797995
URL: http://svn.apache.org/viewvc?rev=797995&view=rev
Log:
finished package javadoc
Modified:
hadoop/hbase/trunk/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/package.html
Modified:
hadoop/hbase/trunk/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/package.html
URL:
http://svn.apache.org/viewvc/hadoop/hbase/trunk/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/package.html?rev=797995&r1=797994&r2=797995&view=diff
==============================================================================
---
hadoop/hbase/trunk/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/package.html
(original)
+++
hadoop/hbase/trunk/src/contrib/stargate/src/java/org/apache/hadoop/hbase/stargate/package.html
Sun Jul 26 22:30:28 2009
@@ -28,6 +28,7 @@
<h2>Table Of Contents</h2>
<ol>
+<li><a href="#status">Status</a></li>
<li><a href="#deployment">Deployment</a></li>
<ol type="a">
<li><a href="#deployment_daemon">Daemon</a></li>
@@ -59,6 +60,21 @@
</ol>
<p>
+<a name="status">
+<h2>Status</h2>
+</a>
+<p>
+Stargate is alpha quality software. It has received testing under controlled
+conditions and functions correctly given well formed input. It is bundled with
+a suite of unit tests which form the basis for correctness and regression
+testing but the coverage of this suite is basic. Stargate has not yet been
+tested under high load conditions. No comprehensive performance measurements
+have been made.
+<p>
+Performance testing and tuning, and increased test suite coverage including
+deliberately corrupted inputs are both on the roadmap toward beta quality.
+
+<p>
<a name="deployment">
<h2>Deployment</h2>
</a>
@@ -69,12 +85,142 @@
<h3>Daemon</h3>
</a>
<p>
+Stargate can run as a daemon which starts an embedded Jetty servlet container
+and deploys the servlet into it.
+<p>
+<ol>
+<li>Place the Stargate jar in either the HBase installation root directory or
+<tt>lib/</tt> directories.</li><p>
+<li>Copy the jars from <tt>contrib/stargate/lib/</tt> into the <tt>lib/</tt>
+directory of the HBase installation.</li><p>
+<li>Start the embedded Jetty servlet container:
+ <p>
+ <ul>
+ <li>In the foreground:
+ <blockquote>
+ <tt>
+ % ./bin/hbase org.apache.hadoop.hbase.stargate.Main -p <<i>port</i>>
+ </tt>
+ </blockquote>
+ <p>
+ where <<i>port</i>> is optional, and is the port the connector should
+ listen on. (Default is 8080.)
+ </li>
+ <p>
+ <li>In the background:
+ <blockquote>
+ <tt>
+ % ./bin/hbase-daemon.sh start org.apache.hadoop.hbase.stargate.Main -p
<<i>port</i>>
+ </tt>
+ </blockquote>
+ <p>
+ where <<i>port</i>> is optional, and is the port the connector should
+ listen on. (Default is 8080.)
+ </li>
+ </ul>
+</li>
+</ol>
<p>
<a name=deployment_servlet">
<h3>Servlet</h3>
</a>
<p>
+Stargate is also packaged as a Java web application (WAR) which can be
+deployed into any servlet API compliant container, such as Tomcat, Jetty,
+Glassfish, etc.
+<p>
+<ol>
+<li>Copy the HBase jar from the HBase installation root directory and all jars
+from the HBase <tt>lib/</tt> and <tt>contrib/stargate/lib/</tt> directories to
+somewhere on the servlet container's classpath, into a shared deployment lib
+directory for example.</li><p>
+<li>Drop the Stargate WAR where container expects it.</li><p>
+<li>Configure the servlet. An example for Jetty follows:
+<p>
+<blockquote>
+<b>web.xml</b><p>
+<pre>
+<!DOCTYPE web-app PUBLIC
+"-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
+"http://java.sun.com/dtd/web-app_2_3.dtd">
+
+<web-app>
+ <display-name>
+ HBase Stargate
+ </display-name>
+
+ <servlet>
+ <servlet-name>api</servlet-name>
+
<servlet-class>org.apache.hadoop.hbase.stargate.RESTServlet</servlet-class>
+ <load-on-startup>1</load-on-startup>
+
+ <init-param>
+
<param-name>com.sun.jersey.config.property.packages</param-name>
+
<param-value>org.apache.hadoop.hbase.stargate</param-value>
+ </init-param>
+ <init-param>
+
<param-name>com.sun.jersey.config.property.resourceConfigClass</param-name>
+
<param-value>com.sun.jersey.api.core.PackagesResourceConfig</param-value>
+ </init-param>
+ </servlet>
+
+ <servlet-mapping>
+ <servlet-name>api</servlet-name>
+ <url-pattern>/*</url-pattern>
+ </servlet-mapping>
+</web-app>
+</pre>
+</blockquote>
+<p>
+<blockquote>
+<b>jetty.xml</b><br>
+<pre>
+<!DOCTYPE Configure PUBLIC "-//Mort Bay Consulting//DTD Configure//EN"
+ "http://jetty.mortbay.org/configure.dtd">
+
+<Configure id="Server" class="org.mortbay.jetty.Server">
+ <Call name="addConnector">
+ <Arg>
+ <New class="org.mortbay.jetty.nio.SelectChannelConnector">
+ <Set name="port">
+ 8080
+ </Set>
+ </New>
+ </Arg>
+ </Call>
+
+ <Set name="handler">
+ <New id="Handlers"
class="org.mortbay.jetty.handler.HandlerCollection">
+ <Array type="org.mortbay.jetty.Handler">
+ <Set name="handlers">
+ <Item>
+ <New id="Contexts"
class="org.mortbay.jetty.handler.ContextHandlerCollection"/>
+ </Item>
+ </Set>
+ </Array>
+ </New>
+ </Set>
+
+ <Call name="addLifeCycle">
+ <Arg>
+ <New class="org.mortbay.jetty.deployer.WebAppDeployer">
+ <Set name="contexts">
+ <Ref id="Contexts"/>
+ </Set>
+ <Set name="webAppDir">
+ <SystemProperty name="jetty.home"
default="."/>/webapps
+ </Set>
+ </New>
+ </Arg>
+ </Call>
+</Configure>
+</pre>
+</blockquote>
+
+</li><p>
+</ol>
+<p>
<p>
<a name="rest">
