You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@jclouds.apache.org by ga...@apache.org on 2013/12/02 06:03:37 UTC
svn commit: r1546899 - in /jclouds/site-content/documentation/userguide:
blobstore-guide/index.html compute/index.html
Author: gaul
Date: Mon Dec 2 05:03:37 2013
New Revision: 1546899
URL: http://svn.apache.org/r1546899
Log:
deploy jclouds site content
Modified:
jclouds/site-content/documentation/userguide/blobstore-guide/index.html
jclouds/site-content/documentation/userguide/compute/index.html
Modified: jclouds/site-content/documentation/userguide/blobstore-guide/index.html
URL: http://svn.apache.org/viewvc/jclouds/site-content/documentation/userguide/blobstore-guide/index.html?rev=1546899&r1=1546898&r2=1546899&view=diff
==============================================================================
--- jclouds/site-content/documentation/userguide/blobstore-guide/index.html (original)
+++ jclouds/site-content/documentation/userguide/blobstore-guide/index.html Mon Dec 2 05:03:37 2013
@@ -199,84 +199,7 @@ for detailed description.</p>
<h3>APIs</h3>
-<p>You can choose from four APIs in increasing complexity: Map, BlobMap, BlobStore, and AsyncBlobStore.<br/>
-For simple applications, you may find the most basic <code>Map<String,InputStream></code> interface most appropriate.<br/>
-As complexity increases, you are also able to use the AsyncBlobStore interface: <code>FutureCommand</code>. Let's review the <code>Map</code> APIs first.</p>
-
-<h4>InputStreamMap</h4>
-
-<p>If you don't want to be bothered with the details of a BlobStore like Amazon S3, you may consider just accessing containers
- as a plain <code>Map<String, InputStream></code> object. Just create your context to to the BlobStore, choose the container of the stuff
- you want to manage, and get to work:</p>
-
-<div class="highlight"><pre><code class="java"><span class="n">BlobStoreContext</span> <span class="n">context</span> <span class="o">=</span> <span class="n">ContextBuilder</span><span class="o">.</span><span class="na">newBuilder</span><span class="o">(</span><span class="s">"aws-s3"</span><span class="o">)</span>
- <span class="o">.</span><span class="na">credentials</span><span class="o">(</span><span class="n">identity</span><span class="o">,</span> <span class="n">credential</span><span class="o">)</span>
- <span class="o">.</span><span class="na">buildView</span><span class="o">(</span><span class="n">BlobStoreContext</span><span class="o">.</span><span class="na">class</span><span class="o">);</span>
-<span class="n">Map</span><span class="o"><</span><span class="n">String</span><span class="o">,</span> <span class="n">InputStream</span><span class="o">></span> <span class="n">map</span> <span class="o">=</span> <span class="n">context</span><span class="o">.</span><span class="na">createInputStreamMap</span><span class="o">(</span><span class="s">"adrian.photos"</span><span class="o">);</span>
-<span class="c1">// do work</span>
-<span class="n">context</span><span class="o">.</span><span class="na">close</span><span class="o">();</span>
-</code></pre></div>
-
-
-<h5>Tips</h5>
-
-<ul>
-<li>Always close your InputStreams
-When you do something like this, the <code>InputStream</code> returned may be holding a connection to the provider.<br/>
-Be sure to close your <code>InputStream</code> promptly.</li>
-</ul>
-
-
-<div class="highlight"><pre><code class="java"><span class="n">InputStream</span> <span class="n">aGreatMovie</span> <span class="o">=</span> <span class="n">map</span><span class="o">.</span><span class="na">get</span><span class="o">(</span><span class="s">"theshining.mpg"</span><span class="o">);</span>
-<span class="k">try</span> <span class="o">{</span>
- <span class="c1">//watch</span>
-<span class="o">}</span> <span class="k">finally</span> <span class="o">{</span>
-<span class="k">if</span> <span class="o">(</span><span class="n">aGreatMovie</span> <span class="o">!=</span> <span class="kc">null</span><span class="o">)</span> <span class="n">aGreatMovie</span><span class="o">.</span><span class="na">close</span><span class="o">();</span>
-<span class="o">}</span>
-</code></pre></div>
-
-
-<ul>
-<li>Extra put methods
-While you can feel free to use <code>map.put("stuff", new FileInputStream("stuff.txt")</code>, jclouds does provide some extra goodies.<br/>
-To use these, use the <code>InputStreamMap</code> class as opposed to <code>Map<String,InputStream></code> when creating you Map view.</li>
-</ul>
-
-
-<div class="highlight"><pre><code class="java"><span class="n">InputStreamMap</span> <span class="n">map</span> <span class="o">=</span> <span class="n">context</span><span class="o">.</span><span class="na">createInputStreamMap</span><span class="o">(</span><span class="s">"adrian.photos"</span><span class="o">);</span>
-<span class="n">map</span><span class="o">.</span><span class="na">putFile</span><span class="o">(</span><span class="s">"stuff"</span><span class="o">,</span> <span class="k">new</span> <span class="n">File</span><span class="o">(</span><span class="s">"stuff.txt"</span><span class="o">));</span>
-<span class="n">map</span><span class="o">.</span><span class="na">putBytes</span><span class="o">(</span><span class="s">"secrets"</span><span class="o">,</span> <span class="n">Util</span><span class="o">.</span><span class="na">encrypt</span><span class="o">(</span><span class="s">"secrets.txt"</span><span class="o">));</span>
-<span class="n">map</span><span class="o">.</span><span class="na">putString</span><span class="o">(</span><span class="s">"index.html"</span><span class="o">,</span> <span class="s">"<html><body>hello world</body></html>"</span><span class="o">);</span>
-</code></pre></div>
-
-
-<p>There are also corresponding <code>putAllFiles</code>, <code>Bytes</code>, <code>Strings</code> methods if you have bulk stuff to store.</p>
-
-<h4>BlobMap</h4>
-
-<p>There are some limitations when using the <code>Map<String, InputStream></code> API. For starters, you cannot pass any extra data
- to the provider. For example, if you want to pass a default filename via the <code>Content-Disposition</code> group,
-it cannot be done this way. <code>BlobMap</code> allows you do customize the data you are sending at the cost of coding to a <code>jclouds</code> API.
-Considering it is only one class at this point, this is a decent tradeoff for many.</p>
-
-<p>Here is an example that shows how to use the <code>BlobMap</code> API:</p>
-
-<div class="highlight"><pre><code class="java"><span class="n">BlobStoreContext</span> <span class="n">context</span> <span class="o">=</span> <span class="n">ContextBuilder</span><span class="o">.</span><span class="na">newBuilder</span><span class="o">(</span><span class="s">"aws-s3"</span><span class="o">)</span>
- <span class="o">.</span><span class="na">credentials</span><span class="o">(</span><span class="n">identity</span><span class="o">,</span> <span class="n">credential</span><span class="o">)</span>
- <span class="o">.</span><span class="na">buildView</span><span class="o">(</span><span class="n">BlobStoreContext</span><span class="o">.</span><span class="na">class</span><span class="o">);</span>
-<span class="n">BlobMap</span> <span class="n">map</span> <span class="o">=</span> <span class="n">context</span><span class="o">.</span><span class="na">createBlobMap</span><span class="o">(</span><span class="s">"adrian.photos"</span><span class="o">);</span>
-
-<span class="n">Blob</span> <span class="n">blob</span> <span class="o">=</span> <span class="n">map</span><span class="o">.</span><span class="na">blobBuilder</span><span class="o">(</span><span class="s">"sushi.jpg"</span><span class="o">)</span>
- <span class="o">.</span><span class="na">payload</span><span class="o">(</span><span class="k">new</span> <span class="n">File</span><span class="o">(</span><span class="s">"sushi.jpg"</span><span class="o">))</span><span class="c1">// or byte[]. InputStream, etc. </span>
- <span class="o">.</span><span class="na">contentDisposition</span><span class="o">(</span><span class="s">"attachment; filename=sushi.jpg"</span><span class="o">)</span>
- <span class="o">.</span><span class="na">contentType</span><span class="o">(</span><span class="s">"image/jpeg"</span><span class="o">)</span>
- <span class="o">.</span><span class="na">calculateMD5</span><span class="o">().</span><span class="na">build</span><span class="o">();</span>
-
-<span class="n">map</span><span class="o">.</span><span class="na">put</span><span class="o">(</span><span class="n">blob</span><span class="o">.</span><span class="na">getName</span><span class="o">(),</span> <span class="n">blob</span><span class="o">);</span>
-
-<span class="n">context</span><span class="o">.</span><span class="na">close</span><span class="o">();</span>
-</code></pre></div>
-
+<p>You can choose from two APIs: BlobStore and AsyncBlobStore.</p>
<h4>BlobStore (Synchronous)</h4>
Modified: jclouds/site-content/documentation/userguide/compute/index.html
URL: http://svn.apache.org/viewvc/jclouds/site-content/documentation/userguide/compute/index.html?rev=1546899&r1=1546898&r2=1546899&view=diff
==============================================================================
--- jclouds/site-content/documentation/userguide/compute/index.html (original)
+++ jclouds/site-content/documentation/userguide/compute/index.html Mon Dec 2 05:03:37 2013
@@ -340,31 +340,6 @@ sudo-able login user on the nodes, simpl
</code></pre></div>
-<h5>Working with credentials</h5>
-
-<p>Note that by default, jclouds stores credentials in a static member.<br/>
-If you close and reopen your compute context, your credentials will still be accessible.<br/>
-If you'd like to have credentials persist across compute service contexts, then supply a backing map like below:</p>
-
-<div class="highlight"><pre><code class="java"><span class="c1">// set the location of the filesystem you wish to persist credentials to</span>
-<span class="n">props</span><span class="o">.</span><span class="na">setProperty</span><span class="o">(</span><span class="n">FilesystemConstants</span><span class="o">.</span><span class="na">PROPERTY_BASEDIR</span><span class="o">,</span> <span class="s">"/var/gogrid"</span><span class="o">);</span>
-
-<span class="n">blobContext</span> <span class="o">=</span> <span class="n">ContextBuilder</span><span class="o">.</span><span class="na">newBuilder</span><span class="o">(</span><span class="s">"filesystem"</span><span class="o">)</span>
- <span class="o">.</span><span class="na">credentials</span><span class="o">(</span><span class="s">"foo"</span><span class="o">,</span> <span class="s">"bar"</span><span class="o">)</span>
- <span class="o">.</span><span class="na">overrides</span><span class="o">(</span><span class="n">props</span><span class="o">)</span>
- <span class="o">.</span><span class="na">buildView</span><span class="o">(</span><span class="n">BlobStoreContext</span><span class="o">.</span><span class="na">class</span><span class="o">);</span>
-
-<span class="n">credentialsMap</span> <span class="o">=</span> <span class="n">blobContext</span><span class="o">.</span><span class="na">createInputStreamMap</span><span class="o">(</span><span class="s">"credentials"</span><span class="o">);</span>
-
-<span class="n">computeContext</span> <span class="o">=</span> <span class="n">ContextBuilder</span><span class="o">.</span><span class="na">newBuilder</span><span class="o">(</span><span class="s">"gogrid"</span><span class="o">)</span>
- <span class="o">.</span><span class="na">credentials</span><span class="o">(</span><span class="n">apiKey</span><span class="o">,</span> <span class="n">secret</span><span class="o">)</span>
- <span class="o">.</span><span class="na">modules</span><span class="o">(</span><span class="n">ImmutableSet</span><span class="o">.<</span><span class="n">Module</span><span class="o">></span> <span class="n">of</span><span class="o">(</span><span class="k">new</span> <span class="n">Log4JLoggingModule</span><span class="o">(),</span>
- <span class="k">new</span> <span class="nf">CredentialStoreModule</span><span class="o">(</span><span class="n">credentialsMap</span><span class="o">),</span>
- <span class="k">new</span> <span class="nf">SshjSshClientModule</span><span class="o">()))</span>
- <span class="o">.</span><span class="na">buildView</span><span class="o">(</span><span class="n">ComputeServiceContext</span><span class="o">.</span><span class="na">class</span><span class="o">);</span>
-</code></pre></div>
-
-
<h3>Individual Node Commands</h3>
<p>Individual commands are executed against a specific node's <code>id</code> (not <code>providerId</code>!).<br/>