http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/2a55601f/content/docs/installation/ug1-deploy-to-tomcat.html ---------------------------------------------------------------------- diff --git a/content/docs/installation/ug1-deploy-to-tomcat.html b/content/docs/installation/ug1-deploy-to-tomcat.html new file mode 100644 index 0000000..5a13447 --- /dev/null +++ b/content/docs/installation/ug1-deploy-to-tomcat.html @@ -0,0 +1,506 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>Usegrid 1: Deploying to Tomcat — Apache Usergrid 1.0 documentation</title> + + + + + + + + + + + + + + + + <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> + + + + + + <link rel="top" title="Apache Usergrid 1.0 documentation" href="../index.html"/> + <link rel="next" title="Usegrid 1: Launcher Quick-start" href="ug1-launcher-quick-start.html"/> + <link rel="prev" title="COMING SOON..." href="../sdks/tbd.html"/> + + + <script src="../_static/js/modernizr.min.js"></script> + +</head> + +<body class="wy-body-for-nav" role="document"> + + <div class="wy-grid-for-nav"> + + + <nav data-toggle="wy-nav-shift" class="wy-nav-side"> + <div class="wy-side-nav-search"> + + + + <a href="../index.html" class="icon icon-home"> Apache Usergrid + + + + </a> + + + + + <div class="version"> + 1.0 + </div> + + + + +<div role="search"> + <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> + <input type="text" name="q" placeholder="Search docs" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> +</div> + + + </div> + + <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> + + + + <p class="caption"><span class="caption-text">Introduction</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../introduction/usergrid-features.html">Usergrid Features</a></li> +<li class="toctree-l1"><a class="reference internal" href="../introduction/data-model.html">Usergrid Data model</a></li> +<li class="toctree-l1"><a class="reference internal" href="../introduction/async-vs-sync.html">Async vs. sync calls</a></li> +</ul> +<p class="caption"><span class="caption-text">Getting Started</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li> +<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-account.html">Creating an Usergrid Account</a></li> +<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-a-sandbox-app.html">Using a Sandbox Application</a></li> +<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-the-api.html">Using the API</a></li> +</ul> +<p class="caption"><span class="caption-text">Data Storage</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../data-storage/data-store-dbms.html">The Usergrid Data Store</a></li> +<li class="toctree-l1"><a class="reference internal" href="../data-storage/optimizing-access.html">Data Store Best Practices</a></li> +<li class="toctree-l1"><a class="reference internal" href="../data-storage/collections.html">Collections</a></li> +<li class="toctree-l1"><a class="reference internal" href="../data-storage/entities.html">Entities</a></li> +</ul> +<p class="caption"><span class="caption-text">Data Queries</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../data-queries/querying-your-data.html">Querying your data</a></li> +<li class="toctree-l1"><a class="reference internal" href="../data-queries/query-parameters.html">Query parameters & clauses</a></li> +<li class="toctree-l1"><a class="reference internal" href="../data-queries/operators-and-types.html">Query operators & data types</a></li> +<li class="toctree-l1"><a class="reference internal" href="../data-queries/advanced-query-usage.html">Advanced query usage</a></li> +</ul> +<p class="caption"><span class="caption-text">Entity Connections</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../entity-connections/connecting-entities.html">Connecting entities</a></li> +<li class="toctree-l1"><a class="reference internal" href="../entity-connections/retrieving-entities.html">Retrieving connections</a></li> +<li class="toctree-l1"><a class="reference internal" href="../entity-connections/disconnecting-entities.html">Disconnecting entities</a></li> +</ul> +<p class="caption"><span class="caption-text">Security & Authentication</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/app-security.html">Security & token authentication</a></li> +<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-permissions.html">Using permissions</a></li> +<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-users-and-application-clients.html">Authenticating users & app clients</a></li> +<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/user-authentication-types.html">Authentication levels</a></li> +<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/changing-token-time-live-ttl.html">Changing token expiration (time-to-live)</a></li> +<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-api-requests.html">Authenticating API requests</a></li> +<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/revoking-tokens-logout.html">Revoking tokens (logout)</a></li> +<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/facebook-sign.html">Facebook sign in</a></li> +<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/securing-your-app.html">Security best practices</a></li> +</ul> +<p class="caption"><span class="caption-text">User Management & Social Graph</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../user-management/user-management.html">User management & social graph</a></li> +<li class="toctree-l1"><a class="reference internal" href="../user-management/working-user-data.html">Working with User Data</a></li> +<li class="toctree-l1"><a class="reference internal" href="../user-management/group.html">Working with group data</a></li> +<li class="toctree-l1"><a class="reference internal" href="../user-management/activity.html">Activity</a></li> +<li class="toctree-l1"><a class="reference internal" href="../user-management/user-connections.html">Social Graph Connections</a></li> +<li class="toctree-l1"><a class="reference internal" href="../user-management/user-connections.html#creating-other-connections">Creating other connections</a></li> +<li class="toctree-l1"><a class="reference internal" href="../user-management/messagee-example.html">App Example - Messagee</a></li> +</ul> +<p class="caption"><span class="caption-text">Geo-location</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../geolocation/geolocation.html">Geolocating your Entities</a></li> +</ul> +<p class="caption"><span class="caption-text">Assets & Files</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/uploading-assets.html">Uploading assets</a></li> +<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/retrieving-assets.html">Retrieving assets</a></li> +<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/folders.html">Folders</a></li> +</ul> +<p class="caption"><span class="caption-text">Counters & Events</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/events-and-counters.html">Counters & events</a></li> +<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/creating-and-incrementing-counters.html">Creating & incrementing counters</a></li> +<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/creating-and-incrementing-counters.html#decrementing-resetting-counters">Decrementing/resetting counters</a></li> +<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/creating-and-incrementing-counters.html#using-counters-hierarchically">Using counters hierarchically</a></li> +<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/retrieving-counters.html">Retrieving counters</a></li> +</ul> +<p class="caption"><span class="caption-text">Organizations & Applications</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/managing.html">Organization & application management</a></li> +<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/organization.html">Organization</a></li> +<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/application.html">Application</a></li> +</ul> +<p class="caption"><span class="caption-text">API Reference</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../rest-endpoints/api-docs.html">Methods</a></li> +<li class="toctree-l1"><a class="reference internal" href="../rest-endpoints/api-docs.html#models">Models</a></li> +</ul> +<p class="caption"><span class="caption-text">Client SDKs</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../sdks/tbd.html">COMING SOON...</a></li> +</ul> +<p class="caption"><span class="caption-text">Installing the Stack</span></p> +<ul class="current"> +<li class="toctree-l1 current"><a class="current reference internal" href="">Usegrid 1: Deploying to Tomcat</a><ul> +<li class="toctree-l2"><a class="reference internal" href="#requirements">Requirements</a></li> +<li class="toctree-l2"><a class="reference internal" href="#download">Download</a></li> +<li class="toctree-l2"><a class="reference internal" href="#building">Building</a></li> +<li class="toctree-l2"><a class="reference internal" href="#install-and-configure-cassandra">Install and configure Cassandra</a></li> +<li class="toctree-l2"><a class="reference internal" href="#install-and-configure-tomcat">Install and configure Tomcat</a></li> +<li class="toctree-l2"><a class="reference internal" href="#add-usergrid-war-to-tomcat">Add Usergrid WAR to Tomcat</a></li> +<li class="toctree-l2"><a class="reference internal" href="#add-usergrid-configuration-file-to-tomcat">Add Usergrid configuration file to Tomcat</a></li> +<li class="toctree-l2"><a class="reference internal" href="#run-usergrid-database-super-user-setup">Run Usergrid Database & Super User Setup</a></li> +<li class="toctree-l2"><a class="reference internal" href="#build-the-usergrid-console">Build the Usergrid Console</a></li> +<li class="toctree-l2"><a class="reference internal" href="#login-to-the-usergrid-console-get-started">Login to the Usergrid Console & get started</a></li> +<li class="toctree-l2"><a class="reference internal" href="#example-usergrid-custom-properties-file">Example <strong>usergrid-custom.properties</strong> file</a></li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="ug1-launcher-quick-start.html">Usegrid 1: Launcher Quick-start</a></li> +<li class="toctree-l1"><a class="reference internal" href="ug2-deploy-to-tomcat.html">Usergrid 2: Deploy to Tomcat</a></li> +</ul> +<p class="caption"><span class="caption-text">More about Usergrid</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../reference/presos-and-videos.html">Presentations & Videos</a></li> +<li class="toctree-l1"><a class="reference internal" href="../reference/contribute-code.html">How to Contribute Code & Docs</a></li> +</ul> + + + + </div> + + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../index.html">Apache Usergrid</a> + </nav> + + + + <div class="wy-nav-content"> + <div class="rst-content"> + <div role="navigation" aria-label="breadcrumbs navigation"> + <ul class="wy-breadcrumbs"> + <li><a href="../index.html">Docs</a> »</li> + + <li>Usegrid 1: Deploying to Tomcat</li> + <li class="wy-breadcrumbs-aside"> + + + <a href="../_sources/installation/ug1-deploy-to-tomcat.txt" rel="nofollow"> View page source</a> + + + </li> + </ul> + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article";> + <div itemprop="articleBody"> + + <div class="section" id="usegrid-1-deploying-to-tomcat"> +<h1>Usegrid 1: Deploying to Tomcat<a class="headerlink" href="#usegrid-1-deploying-to-tomcat" title="Permalink to this headline">¶</a></h1> +<p>This is a guide that explains how to install and run Usergrid using +stock Tomcat and Cassandra on a single computer.</p> +<p>NOTE: running Cassandra on a single computer is something you should do +ONLY for testing purposes. You don’t want to run one node in production +even just to start out. To get the benefit of Cassandra’s architecture, +which is designed to support linear scalability. You should be running a +Cassandra cluster with at least three nodes.</p> +<p>For more information:</p> +<ul class="simple"> +<li><a class="reference external" href="http://planetcassandra.org/blog/post/cassandra-faq-can-i-start-with-a-single-node/";>Cassandra FAQ: Can I Start With a Single +Node?</a></li> +<li><a class="reference external" href="http://stackoverflow.com/questions/18462530/why-dont-you-start-off-with-a-single-small-cassandra-server-as-you-usually";>Why don’t you start off with a âsingle & smallâ Cassandra +server</a></li> +</ul> +<div class="section" id="requirements"> +<h2>Requirements<a class="headerlink" href="#requirements" title="Permalink to this headline">¶</a></h2> +<ul class="simple"> +<li><a class="reference external" href="http://www.oracle.com/technetwork/java/javase/downloads/index.html";>JDK +1.7</a></li> +<li><a class="reference external" href="http://maven.apache.org/";>Maven</a></li> +</ul> +</div> +<div class="section" id="download"> +<h2>Download<a class="headerlink" href="#download" title="Permalink to this headline">¶</a></h2> +<p>Use GitHub to clone the +<a class="reference external" href="https://github.com/apache/incubator-usergrid";>apache/incubator-usergrid</a> +repo.</p> +<p>Or you can start by <a class="reference external" href="https://github.com/apache/incubator-usergrid/archive/master.zip";>downloading our latest +code</a> +and extract it.</p> +</div> +<div class="section" id="building"> +<h2>Building<a class="headerlink" href="#building" title="Permalink to this headline">¶</a></h2> +<p>From the command line, navigate to <code class="docutils literal"><span class="pre">stack</span></code> directory and type the +following:</p> +<div class="highlight-python"><div class="highlight"><pre>mvn clean package -DskipTests=true +</pre></div> +</div> +<p>Once you are done the Usergrid application will be package as a Java EE +WAR file at the location <strong>stack/rest/target/ROOT.war</strong>.</p> +</div> +<div class="section" id="install-and-configure-cassandra"> +<h2>Install and configure Cassandra<a class="headerlink" href="#install-and-configure-cassandra" title="Permalink to this headline">¶</a></h2> +<p>Install Cassandra, don’t edit configuration files as we just want +default values for this simple setup. Here are the <a class="reference external" href="http://wiki.apache.org/cassandra/GettingStarted";>instructions for +installing +Cassandra</a></p> +</div> +<div class="section" id="install-and-configure-tomcat"> +<h2>Install and configure Tomcat<a class="headerlink" href="#install-and-configure-tomcat" title="Permalink to this headline">¶</a></h2> +<p>Follow instructions, don’t edit configuration files as we just want +default values for this simple setup. Here are the <a class="reference external" href="http://tomcat.apache.org/tomcat-7.0-doc/setup.html";>instructions for +installing Tomcat +7</a></p> +</div> +<div class="section" id="add-usergrid-war-to-tomcat"> +<h2>Add Usergrid WAR to Tomcat<a class="headerlink" href="#add-usergrid-war-to-tomcat" title="Permalink to this headline">¶</a></h2> +<p>Remove the existing <code class="docutils literal"><span class="pre">tomcat/webapps/ROOT</span></code> directory.</p> +<p>Place the Usergrid <code class="docutils literal"><span class="pre">ROOT.war</span></code> file into the <code class="docutils literal"><span class="pre">tomcat/webapps</span></code> +directory</p> +</div> +<div class="section" id="add-usergrid-configuration-file-to-tomcat"> +<h2>Add Usergrid configuration file to Tomcat<a class="headerlink" href="#add-usergrid-configuration-file-to-tomcat" title="Permalink to this headline">¶</a></h2> +<p>Create a ____usergrid-custom.properties____ file and place it in +Tomcat’s <strong>lib</strong> directory. You can find an example properties file +below that should work well for a local Tomcat & Cassandra setup. You +will probably only need to change the properties below to use your email +address and preferred password for the install.</p> +<div class="highlight-python"><div class="highlight"><pre>usergrid.sysadmin.login.allowed=true +usergrid.sysadmin.login.name=superuser +usergrid.sysadmin.login.password=pw123 +usergrid.sysadmin.email=m...@example.com +usergrid.sysadmin.login.email=mys...@example.com +usergrid.management.mailer=Myself<mys...@example.com> +usergrid.test-account.admin-user.email=mys...@example.com +usergrid.test-account.admin-user.password=test +</pre></div> +</div> +</div> +<div class="section" id="run-usergrid-database-super-user-setup"> +<h2>Run Usergrid Database & Super User Setup<a class="headerlink" href="#run-usergrid-database-super-user-setup" title="Permalink to this headline">¶</a></h2> +<p>Start Tomcat and use your web browser to visit the URLs below. While you +do this you might want to watch the logs under tomcat/logs for clues, +just in case anything goes wrong.</p> +<p>Database setup URL - <a class="reference external" href="http://localhost:8080/system/database/setup";>http://localhost:8080/system/database/setup</a></p> +<p>When prompted to login use the sysadmin credentials that you specified +in your <strong>usergrid-custom.properties</strong> file. Based on the example above +that would be superuser and pw123. If the operation is successful you +should a message like the one below in your browser. If not, check your +logs for clues about what went wrong.</p> +<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span> + <span class="s">"action"</span> <span class="p">:</span> <span class="s">"cassandra setup"</span><span class="p">,</span> + <span class="s">"status"</span> <span class="p">:</span> <span class="s">"ok"</span><span class="p">,</span> + <span class="s">"timestamp"</span> <span class="p">:</span> <span class="mi">1379424622947</span><span class="p">,</span> + <span class="s">"duration"</span> <span class="p">:</span> <span class="mi">76</span> +<span class="p">}</span> +</pre></div> +</div> +<p>Superuser setup URL - <a class="reference external" href="http://localhost:8080/system/superuser/setup";>http://localhost:8080/system/superuser/setup</a></p> +<p>You should not be prompted for login because you already logged into for +the Database Setup. If setup works, you should see a message like this:</p> +<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span> + <span class="s">"action"</span> <span class="p">:</span> <span class="s">"superuser setup"</span><span class="p">,</span> + <span class="s">"status"</span> <span class="p">:</span> <span class="s">"ok"</span><span class="p">,</span> + <span class="s">"timestamp"</span> <span class="p">:</span> <span class="mi">1379424667936</span><span class="p">,</span> + <span class="s">"duration"</span> <span class="p">:</span> <span class="mi">2</span> +<span class="p">}</span> +</pre></div> +</div> +</div> +<div class="section" id="build-the-usergrid-console"> +<h2>Build the Usergrid Console<a class="headerlink" href="#build-the-usergrid-console" title="Permalink to this headline">¶</a></h2> +<p>The Usergrid Console is an admin interface written in JavaScript that +connects to your running Usergrid instance. For evaluation purposes, you +can run it within Tomcat. Build it by following the steps +<a class="reference external" href="https://github.com/apache/incubator-usergrid/blob/master/portal/README.md";>here</a>. +Once built, copy the directory <em>portal/build/usergrid-portal</em> to +<em>tomcat/webapps</em>.</p> +</div> +<div class="section" id="login-to-the-usergrid-console-get-started"> +<h2>Login to the Usergrid Console & get started<a class="headerlink" href="#login-to-the-usergrid-console-get-started" title="Permalink to this headline">¶</a></h2> +<p>You should now be able to login to the Usergrid console and start +configuring applications, users and more.</p> +<p>You can use an static version of the portal to get started:</p> +<p><a class="reference external" href="http://localhost:8080/usergrid-portal/(http://localhost:8080/usergrid-portal";>http://localhost:8080/usergrid-portal/(http://localhost:8080/usergrid-portal</a>)</p> +</div> +<div class="section" id="example-usergrid-custom-properties-file"> +<h2>Example <strong>usergrid-custom.properties</strong> file<a class="headerlink" href="#example-usergrid-custom-properties-file" title="Permalink to this headline">¶</a></h2> +<p>Here’s a complete example properties file to get you started.</p> +<div class="highlight-python"><div class="highlight"><pre># Minimal Usergrid configuration properties for local Tomcat and Cassandra +# +# The cassandra configuration options. + +# The cassandra host to use +cassandra.url=localhost:9160 + +# if your cassandra instance requires username/password +cassandra.username=someuser +cassandra.password=somepassword + +# The strategy to use when creating the keyspace. This is the default. +# We recommend creating the keyspace with this default, then editing it +# via the cassandra CLI to meet the client's needs. +cassandra.keyspace.strategy=org.apache.cassandra.locator.SimpleStrategy + +# The default replication factor for the simple strategy. Again, leave the +# default, create the app, then use the cassandra cli to set the replication +# factor options. This can become complicated with different topologies and +# is more a Cassandra administration issue than a UG issue. +cassandra.keyspace.strategy.options.replication_factor=1 + +###################################################### +# Custom mail transport. Not usually used for local testing + +#mail.transport.protocol=smtps +#mail.smtps.host=email-smtp.us-east-1.amazonaws.com +#mail.smtps.port=465 +#mail.smtps.auth=true +#mail.smtps.quitwait=false +#mail.smtps.username= +#mail.smtps.password= + +###################################################### +# Admin and test user setup (change these to be their super user + +usergrid.sysadmin.login.name=superuser +usergrid.sysadmin.login.email=mys...@example.com <--- Change this +usergrid.sysadmin.login.password=pw123 <--- Change this +usergrid.sysadmin.login.allowed=true +usergrid.sysadmin.email=mys...@example.com <--- Change this + +# Enable or disable this to require superadmin approval of users +usergrid.sysadmin.approve.users=false + +###################################################### +# Auto-confirm and sign-up notifications settings + +usergrid.management.admin_users_require_confirmation=false +usergrid.management.admin_users_require_activation=false +usergrid.management.organizations_require_activation=false +usergrid.management.notify_sysadmin_of_new_organizations=false +usergrid.management.notify_sysadmin_of_new_admin_users=false + +###################################################### +# URLs +# Redirect path when request come in for TLD + +usergrid.redirect_root=https://localhost:8080/status +usergrid.view.management.organizations.organization.activate=https://localhost:8080/accounts/welcome +usergrid.view.management.organizations.organization.confirm=https://localhost:8080/accounts/welcome +usergrid.view.management.users.user.activate=https://localhost:8080/accounts/welcome +usergrid.view.management.users.user.confirm=https://localhost:8080/accounts/welcome +usergrid.organization.activation.url=https://localhost:8080/management/organizations/%s/activate +usergrid.admin.activation.url=https://localhost:8080/management/users/%s/activate +usergrid.admin.resetpw.url=https://localhost:8080/management/users/%s/resetpw +usergrid.admin.confirmation.url=https://localhost:8080/management/users/%s/confirm +usergrid.user.activation.url=https://localhost:8080%s/%s/users/%s/activate +usergrid.user.confirmation.url=https://localhost:8080/%s/%s/users/%s/confirm +usergrid.user.resetpw.url=https://localhost:8080/%s/%s/users/%s/resetpw +</pre></div> +</div> +</div> +</div> + + + </div> + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="ug1-launcher-quick-start.html" class="btn btn-neutral float-right" title="Usegrid 1: Launcher Quick-start" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="../sdks/tbd.html" class="btn btn-neutral" title="COMING SOON..." accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2013-2015, Apache Usergrid. + + </p> + </div> + Built with <a href="http://sphinx-doc.org/";>Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme";>theme</a> provided by <a href="https://readthedocs.org";>Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + + + <script type="text/javascript"> + var DOCUMENTATION_OPTIONS = { + URL_ROOT:'../', + VERSION:'1.0', + COLLAPSE_INDEX:false, + FILE_SUFFIX:'.html', + HAS_SOURCE: true + }; + </script> + <script type="text/javascript" src="../_static/jquery.js"></script> + <script type="text/javascript" src="../_static/underscore.js"></script> + <script type="text/javascript" src="../_static/doctools.js"></script> + + + + + + <script type="text/javascript" src="../_static/js/theme.js"></script> + + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.StickyNav.enable(); + }); + </script> + + +</body> +</html> \ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/2a55601f/content/docs/installation/ug1-launcher-quick-start.html ---------------------------------------------------------------------- diff --git a/content/docs/installation/ug1-launcher-quick-start.html b/content/docs/installation/ug1-launcher-quick-start.html new file mode 100644 index 0000000..5ae2501 --- /dev/null +++ b/content/docs/installation/ug1-launcher-quick-start.html @@ -0,0 +1,388 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>Usegrid 1: Launcher Quick-start — Apache Usergrid 1.0 documentation</title> + + + + + + + + + + + + + + + + <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> + + + + + + <link rel="top" title="Apache Usergrid 1.0 documentation" href="../index.html"/> + <link rel="next" title="Usergrid 2: Deploy to Tomcat" href="ug2-deploy-to-tomcat.html"/> + <link rel="prev" title="Usegrid 1: Deploying to Tomcat" href="ug1-deploy-to-tomcat.html"/> + + + <script src="../_static/js/modernizr.min.js"></script> + +</head> + +<body class="wy-body-for-nav" role="document"> + + <div class="wy-grid-for-nav"> + + + <nav data-toggle="wy-nav-shift" class="wy-nav-side"> + <div class="wy-side-nav-search"> + + + + <a href="../index.html" class="icon icon-home"> Apache Usergrid + + + + </a> + + + + + <div class="version"> + 1.0 + </div> + + + + +<div role="search"> + <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> + <input type="text" name="q" placeholder="Search docs" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> +</div> + + + </div> + + <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> + + + + <p class="caption"><span class="caption-text">Introduction</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../introduction/usergrid-features.html">Usergrid Features</a></li> +<li class="toctree-l1"><a class="reference internal" href="../introduction/data-model.html">Usergrid Data model</a></li> +<li class="toctree-l1"><a class="reference internal" href="../introduction/async-vs-sync.html">Async vs. sync calls</a></li> +</ul> +<p class="caption"><span class="caption-text">Getting Started</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li> +<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-account.html">Creating an Usergrid Account</a></li> +<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-a-sandbox-app.html">Using a Sandbox Application</a></li> +<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-the-api.html">Using the API</a></li> +</ul> +<p class="caption"><span class="caption-text">Data Storage</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../data-storage/data-store-dbms.html">The Usergrid Data Store</a></li> +<li class="toctree-l1"><a class="reference internal" href="../data-storage/optimizing-access.html">Data Store Best Practices</a></li> +<li class="toctree-l1"><a class="reference internal" href="../data-storage/collections.html">Collections</a></li> +<li class="toctree-l1"><a class="reference internal" href="../data-storage/entities.html">Entities</a></li> +</ul> +<p class="caption"><span class="caption-text">Data Queries</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../data-queries/querying-your-data.html">Querying your data</a></li> +<li class="toctree-l1"><a class="reference internal" href="../data-queries/query-parameters.html">Query parameters & clauses</a></li> +<li class="toctree-l1"><a class="reference internal" href="../data-queries/operators-and-types.html">Query operators & data types</a></li> +<li class="toctree-l1"><a class="reference internal" href="../data-queries/advanced-query-usage.html">Advanced query usage</a></li> +</ul> +<p class="caption"><span class="caption-text">Entity Connections</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../entity-connections/connecting-entities.html">Connecting entities</a></li> +<li class="toctree-l1"><a class="reference internal" href="../entity-connections/retrieving-entities.html">Retrieving connections</a></li> +<li class="toctree-l1"><a class="reference internal" href="../entity-connections/disconnecting-entities.html">Disconnecting entities</a></li> +</ul> +<p class="caption"><span class="caption-text">Security & Authentication</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/app-security.html">Security & token authentication</a></li> +<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-permissions.html">Using permissions</a></li> +<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-users-and-application-clients.html">Authenticating users & app clients</a></li> +<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/user-authentication-types.html">Authentication levels</a></li> +<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/changing-token-time-live-ttl.html">Changing token expiration (time-to-live)</a></li> +<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-api-requests.html">Authenticating API requests</a></li> +<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/revoking-tokens-logout.html">Revoking tokens (logout)</a></li> +<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/facebook-sign.html">Facebook sign in</a></li> +<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/securing-your-app.html">Security best practices</a></li> +</ul> +<p class="caption"><span class="caption-text">User Management & Social Graph</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../user-management/user-management.html">User management & social graph</a></li> +<li class="toctree-l1"><a class="reference internal" href="../user-management/working-user-data.html">Working with User Data</a></li> +<li class="toctree-l1"><a class="reference internal" href="../user-management/group.html">Working with group data</a></li> +<li class="toctree-l1"><a class="reference internal" href="../user-management/activity.html">Activity</a></li> +<li class="toctree-l1"><a class="reference internal" href="../user-management/user-connections.html">Social Graph Connections</a></li> +<li class="toctree-l1"><a class="reference internal" href="../user-management/user-connections.html#creating-other-connections">Creating other connections</a></li> +<li class="toctree-l1"><a class="reference internal" href="../user-management/messagee-example.html">App Example - Messagee</a></li> +</ul> +<p class="caption"><span class="caption-text">Geo-location</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../geolocation/geolocation.html">Geolocating your Entities</a></li> +</ul> +<p class="caption"><span class="caption-text">Assets & Files</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/uploading-assets.html">Uploading assets</a></li> +<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/retrieving-assets.html">Retrieving assets</a></li> +<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/folders.html">Folders</a></li> +</ul> +<p class="caption"><span class="caption-text">Counters & Events</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/events-and-counters.html">Counters & events</a></li> +<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/creating-and-incrementing-counters.html">Creating & incrementing counters</a></li> +<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/creating-and-incrementing-counters.html#decrementing-resetting-counters">Decrementing/resetting counters</a></li> +<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/creating-and-incrementing-counters.html#using-counters-hierarchically">Using counters hierarchically</a></li> +<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/retrieving-counters.html">Retrieving counters</a></li> +</ul> +<p class="caption"><span class="caption-text">Organizations & Applications</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/managing.html">Organization & application management</a></li> +<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/organization.html">Organization</a></li> +<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/application.html">Application</a></li> +</ul> +<p class="caption"><span class="caption-text">API Reference</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../rest-endpoints/api-docs.html">Methods</a></li> +<li class="toctree-l1"><a class="reference internal" href="../rest-endpoints/api-docs.html#models">Models</a></li> +</ul> +<p class="caption"><span class="caption-text">Client SDKs</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../sdks/tbd.html">COMING SOON...</a></li> +</ul> +<p class="caption"><span class="caption-text">Installing the Stack</span></p> +<ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="ug1-deploy-to-tomcat.html">Usegrid 1: Deploying to Tomcat</a></li> +<li class="toctree-l1 current"><a class="current reference internal" href="">Usegrid 1: Launcher Quick-start</a><ul> +<li class="toctree-l2"><a class="reference internal" href="#requirements">Requirements</a></li> +<li class="toctree-l2"><a class="reference internal" href="#download">Download</a><ul> +<li class="toctree-l3"><a class="reference internal" href="#download2">Download2</a><ul> +<li class="toctree-l4"><a class="reference internal" href="#building-3">Building 3</a></li> +</ul> +</li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="#running">Running</a></li> +<li class="toctree-l2"><a class="reference internal" href="#getting-started-with-the-http-api">Getting Started with the HTTP API</a></li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="ug2-deploy-to-tomcat.html">Usergrid 2: Deploy to Tomcat</a></li> +</ul> +<p class="caption"><span class="caption-text">More about Usergrid</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../reference/presos-and-videos.html">Presentations & Videos</a></li> +<li class="toctree-l1"><a class="reference internal" href="../reference/contribute-code.html">How to Contribute Code & Docs</a></li> +</ul> + + + + </div> + + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../index.html">Apache Usergrid</a> + </nav> + + + + <div class="wy-nav-content"> + <div class="rst-content"> + <div role="navigation" aria-label="breadcrumbs navigation"> + <ul class="wy-breadcrumbs"> + <li><a href="../index.html">Docs</a> »</li> + + <li>Usegrid 1: Launcher Quick-start</li> + <li class="wy-breadcrumbs-aside"> + + + <a href="../_sources/installation/ug1-launcher-quick-start.txt" rel="nofollow"> View page source</a> + + + </li> + </ul> + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article";> + <div itemprop="articleBody"> + + <div class="section" id="usegrid-1-launcher-quick-start"> +<h1>Usegrid 1: Launcher Quick-start<a class="headerlink" href="#usegrid-1-launcher-quick-start" title="Permalink to this headline">¶</a></h1> +<div class="section" id="requirements"> +<h2>Requirements<a class="headerlink" href="#requirements" title="Permalink to this headline">¶</a></h2> +<ul class="simple"> +<li><a class="reference external" href="http://www.oracle.com/technetwork/java/javase/downloads/index.html";>JDK +1.7</a></li> +<li><a class="reference external" href="http://maven.apache.org/";>Maven</a></li> +</ul> +</div> +<div class="section" id="download"> +<h2>Download<a class="headerlink" href="#download" title="Permalink to this headline">¶</a></h2> +<div class="section" id="download2"> +<h3>Download2<a class="headerlink" href="#download2" title="Permalink to this headline">¶</a></h3> +<p>Start by <a class="reference external" href="https://github.com/apache/incubator-usergrid/archive/master.zip";>downloading our latest +code</a> +and extract it.</p> +<div class="section" id="building-3"> +<h4>Building 3<a class="headerlink" href="#building-3" title="Permalink to this headline">¶</a></h4> +<p>From the command line, navigate to stack directory and type the +following:</p> +<div class="highlight-python"><div class="highlight"><pre>mvn clean install -DskipTests=true +</pre></div> +</div> +</div> +</div> +</div> +<div class="section" id="running"> +<h2>Running<a class="headerlink" href="#running" title="Permalink to this headline">¶</a></h2> +<p>Usergrid-core contains the persistence layer and shared utilities for +powering the Usergrid service. The services layer is contained in +usergrid-services and exposes a higher-level API that’s used by the +usergrid-rest web services tier.</p> +<p>You can run Usergrid from the command-line from the jar in the +usergrid/standalone project:</p> +<div class="highlight-python"><div class="highlight"><pre>cd launcher; java -jar target/usergrid-launcher-*.jar +</pre></div> +</div> +<p>After startup, your instance will be available on localhost, port 8080. +To check itâs running properly, you can try loading our status page:</p> +<div class="highlight-python"><div class="highlight"><pre>curl http://localhost:8080/status +</pre></div> +</div> +<p>You can also run it as a webapp in Tomcat, by deploying the ROOT.war +file generated in the usergrid/rest project.</p> +</div> +<div class="section" id="getting-started-with-the-http-api"> +<h2>Getting Started with the HTTP API<a class="headerlink" href="#getting-started-with-the-http-api" title="Permalink to this headline">¶</a></h2> +<p>Start by creating an Organization. Itâs the top-level structure in +Usergrid: all Apps and Administrators must belong to an Organization. +Hereâs how you create one:</p> +<div class="highlight-python"><div class="highlight"><pre>curl -X POST \ + -d 'organization=myfirstorg&username=myadmin&name=Admin&email=ad...@example.com&password=password' \ + http://localhost:8080/management/organizations +</pre></div> +</div> +<p>You can see that creating an Organization creates an Administrator in +the process. Letâs authenticate as him:</p> +<div class="highlight-python"><div class="highlight"><pre>curl 'http://localhost:8080/management/token?grant_type=password&username=myadmin&password=password' +</pre></div> +</div> +<p>This will return an access_token. Weâll use this to authenticate the +next two calls. Next, letâs create an Application:</p> +<div class="highlight-python"><div class="highlight"><pre>curl -H "Authorization: Bearer [the management token from above]" \ + -H "Content-Type: application/json" \ + -X POST -d '{ "name":"myapp" }' \ + http://localhost:8080/management/orgs/myfirstorg/apps +</pre></div> +</div> +<p>⦠And a User for the Application:</p> +<div class="highlight-python"><div class="highlight"><pre>curl -H "Authorization: Bearer [the management token from above]" \ + -X POST "http://localhost:8080/myfirstorg/myapp/users" \ + -d '{ "username":"myuser", "password":"mypassword", "email":"u...@example.com" }' +</pre></div> +</div> +<p>Letâs now generate an access token for this Application User:</p> +<div class="highlight-python"><div class="highlight"><pre>curl 'http://localhost:8080/myfirstorg/myapp/token?grant_type=password&username=myuser&password=mypassword' +</pre></div> +</div> +<p>This will also send back an access_token, but limited in scope. Letâs +use it to create a collection with some data in it:</p> +<div class="highlight-python"><div class="highlight"><pre>curl -H "Authorization: Bearer [the user token]" \ + -X POST -d '[ { "cat":"fluffy" }, { "fish": { "gold":2, "oscar":1 } } ]' \ + http://localhost:8080/myfirstorg/myapp/pets +</pre></div> +</div> +</div> +</div> + + + </div> + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="ug2-deploy-to-tomcat.html" class="btn btn-neutral float-right" title="Usergrid 2: Deploy to Tomcat" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="ug1-deploy-to-tomcat.html" class="btn btn-neutral" title="Usegrid 1: Deploying to Tomcat" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2013-2015, Apache Usergrid. + + </p> + </div> + Built with <a href="http://sphinx-doc.org/";>Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme";>theme</a> provided by <a href="https://readthedocs.org";>Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + + + <script type="text/javascript"> + var DOCUMENTATION_OPTIONS = { + URL_ROOT:'../', + VERSION:'1.0', + COLLAPSE_INDEX:false, + FILE_SUFFIX:'.html', + HAS_SOURCE: true + }; + </script> + <script type="text/javascript" src="../_static/jquery.js"></script> + <script type="text/javascript" src="../_static/underscore.js"></script> + <script type="text/javascript" src="../_static/doctools.js"></script> + + + + + + <script type="text/javascript" src="../_static/js/theme.js"></script> + + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.StickyNav.enable(); + }); + </script> + + +</body> +</html> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/2a55601f/content/docs/installation/ug2-deploy-to-tomcat.html ---------------------------------------------------------------------- diff --git a/content/docs/installation/ug2-deploy-to-tomcat.html b/content/docs/installation/ug2-deploy-to-tomcat.html new file mode 100644 index 0000000..1557115 --- /dev/null +++ b/content/docs/installation/ug2-deploy-to-tomcat.html @@ -0,0 +1,509 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>Usergrid 2: Deploy to Tomcat — Apache Usergrid 1.0 documentation</title> + + + + + + + + + + + + + + + + <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> + + + + + + <link rel="top" title="Apache Usergrid 1.0 documentation" href="../index.html"/> + <link rel="next" title="Presentations & Videos" href="../reference/presos-and-videos.html"/> + <link rel="prev" title="Usegrid 1: Launcher Quick-start" href="ug1-launcher-quick-start.html"/> + + + <script src="../_static/js/modernizr.min.js"></script> + +</head> + +<body class="wy-body-for-nav" role="document"> + + <div class="wy-grid-for-nav"> + + + <nav data-toggle="wy-nav-shift" class="wy-nav-side"> + <div class="wy-side-nav-search"> + + + + <a href="../index.html" class="icon icon-home"> Apache Usergrid + + + + </a> + + + + + <div class="version"> + 1.0 + </div> + + + + +<div role="search"> + <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> + <input type="text" name="q" placeholder="Search docs" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> +</div> + + + </div> + + <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> + + + + <p class="caption"><span class="caption-text">Introduction</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../introduction/usergrid-features.html">Usergrid Features</a></li> +<li class="toctree-l1"><a class="reference internal" href="../introduction/data-model.html">Usergrid Data model</a></li> +<li class="toctree-l1"><a class="reference internal" href="../introduction/async-vs-sync.html">Async vs. sync calls</a></li> +</ul> +<p class="caption"><span class="caption-text">Getting Started</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li> +<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-account.html">Creating an Usergrid Account</a></li> +<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-a-sandbox-app.html">Using a Sandbox Application</a></li> +<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-the-api.html">Using the API</a></li> +</ul> +<p class="caption"><span class="caption-text">Data Storage</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../data-storage/data-store-dbms.html">The Usergrid Data Store</a></li> +<li class="toctree-l1"><a class="reference internal" href="../data-storage/optimizing-access.html">Data Store Best Practices</a></li> +<li class="toctree-l1"><a class="reference internal" href="../data-storage/collections.html">Collections</a></li> +<li class="toctree-l1"><a class="reference internal" href="../data-storage/entities.html">Entities</a></li> +</ul> +<p class="caption"><span class="caption-text">Data Queries</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../data-queries/querying-your-data.html">Querying your data</a></li> +<li class="toctree-l1"><a class="reference internal" href="../data-queries/query-parameters.html">Query parameters & clauses</a></li> +<li class="toctree-l1"><a class="reference internal" href="../data-queries/operators-and-types.html">Query operators & data types</a></li> +<li class="toctree-l1"><a class="reference internal" href="../data-queries/advanced-query-usage.html">Advanced query usage</a></li> +</ul> +<p class="caption"><span class="caption-text">Entity Connections</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../entity-connections/connecting-entities.html">Connecting entities</a></li> +<li class="toctree-l1"><a class="reference internal" href="../entity-connections/retrieving-entities.html">Retrieving connections</a></li> +<li class="toctree-l1"><a class="reference internal" href="../entity-connections/disconnecting-entities.html">Disconnecting entities</a></li> +</ul> +<p class="caption"><span class="caption-text">Security & Authentication</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/app-security.html">Security & token authentication</a></li> +<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-permissions.html">Using permissions</a></li> +<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-users-and-application-clients.html">Authenticating users & app clients</a></li> +<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/user-authentication-types.html">Authentication levels</a></li> +<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/changing-token-time-live-ttl.html">Changing token expiration (time-to-live)</a></li> +<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-api-requests.html">Authenticating API requests</a></li> +<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/revoking-tokens-logout.html">Revoking tokens (logout)</a></li> +<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/facebook-sign.html">Facebook sign in</a></li> +<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/securing-your-app.html">Security best practices</a></li> +</ul> +<p class="caption"><span class="caption-text">User Management & Social Graph</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../user-management/user-management.html">User management & social graph</a></li> +<li class="toctree-l1"><a class="reference internal" href="../user-management/working-user-data.html">Working with User Data</a></li> +<li class="toctree-l1"><a class="reference internal" href="../user-management/group.html">Working with group data</a></li> +<li class="toctree-l1"><a class="reference internal" href="../user-management/activity.html">Activity</a></li> +<li class="toctree-l1"><a class="reference internal" href="../user-management/user-connections.html">Social Graph Connections</a></li> +<li class="toctree-l1"><a class="reference internal" href="../user-management/user-connections.html#creating-other-connections">Creating other connections</a></li> +<li class="toctree-l1"><a class="reference internal" href="../user-management/messagee-example.html">App Example - Messagee</a></li> +</ul> +<p class="caption"><span class="caption-text">Geo-location</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../geolocation/geolocation.html">Geolocating your Entities</a></li> +</ul> +<p class="caption"><span class="caption-text">Assets & Files</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/uploading-assets.html">Uploading assets</a></li> +<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/retrieving-assets.html">Retrieving assets</a></li> +<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/folders.html">Folders</a></li> +</ul> +<p class="caption"><span class="caption-text">Counters & Events</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/events-and-counters.html">Counters & events</a></li> +<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/creating-and-incrementing-counters.html">Creating & incrementing counters</a></li> +<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/creating-and-incrementing-counters.html#decrementing-resetting-counters">Decrementing/resetting counters</a></li> +<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/creating-and-incrementing-counters.html#using-counters-hierarchically">Using counters hierarchically</a></li> +<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/retrieving-counters.html">Retrieving counters</a></li> +</ul> +<p class="caption"><span class="caption-text">Organizations & Applications</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/managing.html">Organization & application management</a></li> +<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/organization.html">Organization</a></li> +<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/application.html">Application</a></li> +</ul> +<p class="caption"><span class="caption-text">API Reference</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../rest-endpoints/api-docs.html">Methods</a></li> +<li class="toctree-l1"><a class="reference internal" href="../rest-endpoints/api-docs.html#models">Models</a></li> +</ul> +<p class="caption"><span class="caption-text">Client SDKs</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../sdks/tbd.html">COMING SOON...</a></li> +</ul> +<p class="caption"><span class="caption-text">Installing the Stack</span></p> +<ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="ug1-deploy-to-tomcat.html">Usegrid 1: Deploying to Tomcat</a></li> +<li class="toctree-l1"><a class="reference internal" href="ug1-launcher-quick-start.html">Usegrid 1: Launcher Quick-start</a></li> +<li class="toctree-l1 current"><a class="current reference internal" href="">Usergrid 2: Deploy to Tomcat</a><ul> +<li class="toctree-l2"><a class="reference internal" href="#requirements">Requirements</a></li> +<li class="toctree-l2"><a class="reference internal" href="#running">Running</a><ul> +<li class="toctree-l3"><a class="reference internal" href="#running-usergrid">Running Usergrid</a><ul> +<li class="toctree-l4"><a class="reference internal" href="#build-the-java-sdk">Build The Java Sdk</a></li> +<li class="toctree-l4"><a class="reference internal" href="#build-the-stack-itself">Build The Stack Itself</a></li> +<li class="toctree-l4"><a class="reference internal" href="#deploying-the-stack-locally">Deploying the Stack Locally</a></li> +<li class="toctree-l4"><a class="reference internal" href="#running-the-portal-locally">Running The Portal Locally</a></li> +</ul> +</li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="#example-usergrid-deployment-properties-file">Example <strong>usergrid-deployment.properties</strong> file</a></li> +</ul> +</li> +</ul> +<p class="caption"><span class="caption-text">More about Usergrid</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../reference/presos-and-videos.html">Presentations & Videos</a></li> +<li class="toctree-l1"><a class="reference internal" href="../reference/contribute-code.html">How to Contribute Code & Docs</a></li> +</ul> + + + + </div> + + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../index.html">Apache Usergrid</a> + </nav> + + + + <div class="wy-nav-content"> + <div class="rst-content"> + <div role="navigation" aria-label="breadcrumbs navigation"> + <ul class="wy-breadcrumbs"> + <li><a href="../index.html">Docs</a> »</li> + + <li>Usergrid 2: Deploy to Tomcat</li> + <li class="wy-breadcrumbs-aside"> + + + <a href="../_sources/installation/ug2-deploy-to-tomcat.txt" rel="nofollow"> View page source</a> + + + </li> + </ul> + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article";> + <div itemprop="articleBody"> + + <div class="section" id="usergrid-2-deploy-to-tomcat"> +<h1>Usergrid 2: Deploy to Tomcat<a class="headerlink" href="#usergrid-2-deploy-to-tomcat" title="Permalink to this headline">¶</a></h1> +<p><strong>NOTE</strong>: Beware that Usergrid 2 is UNRELEASED SOFTWARE</p> +<div class="section" id="requirements"> +<h2>Requirements<a class="headerlink" href="#requirements" title="Permalink to this headline">¶</a></h2> +<ul class="simple"> +<li><a class="reference external" href="http://www.oracle.com/technetwork/java/javase/downloads/index.html";>JDK +1.8</a></li> +<li><a class="reference external" href="http://maven.apache.org/";>Maven 3.2+</a></li> +<li><a class="reference external" href="https://tomcat.apache.org/download-70.cgi";>Tomcat 7+</a></li> +<li><a class="reference external" href="http://cassandra.apache.org/download/";>Cassandra 1.2.1*</a></li> +<li><a class="reference external" href="https://www.elastic.co/downloads/elasticsearch";>ElasticSearch +1.4+</a></li> +<li><a class="reference external" href="https://github.com/apache/incubator-usergrid/tree/two-dot-o";>Usergrid +2.0</a></li> +</ul> +</div> +<div class="section" id="running"> +<h2>Running<a class="headerlink" href="#running" title="Permalink to this headline">¶</a></h2> +<ol class="arabic simple"> +<li>Start up Cassandra <a class="footnote-reference" href="#id2" id="id1">[1]</a><ol class="loweralpha"> +<li>To do this you can navigate to the cassandra folder and run +<code class="docutils literal"><span class="pre">./bin/cassandra</span></code></li> +</ol> +</li> +<li>Start up Elasticsearch<ol class="loweralpha"> +<li>To do this you can navigate to the folder where you extracted +elasticsearch and run <code class="docutils literal"><span class="pre">/bin/elasticsearch</span></code></li> +</ol> +</li> +</ol> +<div class="section" id="running-usergrid"> +<h3>Running Usergrid<a class="headerlink" href="#running-usergrid" title="Permalink to this headline">¶</a></h3> +<div class="section" id="build-the-java-sdk"> +<h4>Build The Java Sdk<a class="headerlink" href="#build-the-java-sdk" title="Permalink to this headline">¶</a></h4> +<ol class="arabic simple"> +<li>Navigate to where you cloned the usergrid repo</li> +<li>Navigate to the <code class="docutils literal"><span class="pre">sdks/java</span></code> directory</li> +<li>Run <code class="docutils literal"><span class="pre">mvn</span> <span class="pre">clean</span> <span class="pre">install</span></code></li> +</ol> +</div> +<div class="section" id="build-the-stack-itself"> +<h4>Build The Stack Itself<a class="headerlink" href="#build-the-stack-itself" title="Permalink to this headline">¶</a></h4> +<ol class="arabic simple"> +<li>Navigate to the <code class="docutils literal"><span class="pre">stack</span></code> directory.</li> +<li>Run <code class="docutils literal"><span class="pre">mvn</span> <span class="pre">clean</span> <span class="pre">install</span> <span class="pre">-DskipTests</span></code></li> +<li>This will generate a war at <code class="docutils literal"><span class="pre">rest/target/ROOT.war</span></code></li> +</ol> +</div> +<div class="section" id="deploying-the-stack-locally"> +<h4>Deploying the Stack Locally<a class="headerlink" href="#deploying-the-stack-locally" title="Permalink to this headline">¶</a></h4> +<ol class="arabic simple"> +<li>Take this war and deploy it on downloaded tomcat.</li> +<li>In the lib directory of the tomcat you must also put +usergrid-deployment.properties. ( An example file is provided below)</li> +<li>Start up Tomcat<ol class="loweralpha"> +<li>To do this you can navigate to folder where Tomcat is install and +run <code class="docutils literal"><span class="pre">./bin/catalina.sh</span> <span class="pre">start</span></code></li> +</ol> +</li> +<li>Go to a web browser and input the following to initilizing the +database <code class="docutils literal"><span class="pre">localhost:8080/system/database/setup</span></code>.<ol class="loweralpha"> +<li>The credentials it asks for are the admin credentialls and +password as defined in the usergrid-deployment.properties.</li> +<li>You can also do a curl call with basic auth to automatically +authenticate the call instead of using the web browser.</li> +</ol> +</li> +<li>Then using the same steps as before call +<code class="docutils literal"><span class="pre">localhost:8080/system/superuser/setup</span></code></li> +</ol> +<p>The stack is now ready to be queried against, but to get the most out of +it you’ll need to initilize and use our portal!</p> +</div> +<div class="section" id="running-the-portal-locally"> +<h4>Running The Portal Locally<a class="headerlink" href="#running-the-portal-locally" title="Permalink to this headline">¶</a></h4> +<div class="section" id="requirments"> +<h5>Requirments<a class="headerlink" href="#requirments" title="Permalink to this headline">¶</a></h5> +<p><a class="reference external" href="https://nodejs.org/download/";>nodejs 0.10+</a></p> +<ol class="arabic simple"> +<li>Make sure you’ve installed node.js above. Any version above .10 or +.10 should work fine.</li> +<li>Navigate to <code class="docutils literal"><span class="pre">incubator-usergrid/portal</span></code>.</li> +<li>Open config.js and make sure the override URL is pointing to your +local tomcat.</li> +<li>Now in the portal folder run the following command <code class="docutils literal"><span class="pre">./build.sh</span> <span class="pre">dev</span></code></li> +<li>The portal should automatically open ready for use!</li> +</ol> +<p>Now usergrid is fully ready to use! Feel free to query against it or use +it however you like!</p> +</div> +</div> +</div> +</div> +<div class="section" id="example-usergrid-deployment-properties-file"> +<h2>Example <strong>usergrid-deployment.properties</strong> file<a class="headerlink" href="#example-usergrid-deployment-properties-file" title="Permalink to this headline">¶</a></h2> +<div class="highlight-python"><div class="highlight"><pre># core persistence properties + +cassandra.embedded=false +cassandra.version=1.2.18 +cassandra.timeout=2000 + +collections.keyspace=Usergrid_Applications +collections.keyspace.strategy.options=replication_factor:1 +collections.keyspace.strategy.class=org.apache.cassandra.locator.SimpleStrategy + +collection.stage.transient.timeout=60 + +hystrix.threadpool.graph_user.coreSize=40 +hystrix.threadpool.graph_async.coreSize=40 + +elasticsearch.embedded=false +elasticsearch.cluster_name=elasticsearch +elasticsearch.index_prefix=usergrid +elasticsearch.hosts=127.0.0.1 +elasticsearch.port=9300 + +elasticsearch.force_refresh=true + +index.query.limit.default=100 + +# Max Cassandra connections, applies to both CP and EM +cassandra.connections=600 + +###################################################### +# Minimal Usergrid configuration properties for local Tomcat and Cassandra +# + +cassandra.url=127.0.0.1:9160 + +cassandra.keyspace.strategy=org.apache.cassandra.locator.SimpleStrategy +cassandra.keyspace.strategy.options.replication_factor=1 + +###################################################### +# Custom mail transport + +mail.transport.protocol=smtps +mail.smtps.host=smtp.gmail.com +mail.smtps.port=465 +mail.smtps.auth=true +mail.smtps.username= +mail.smtps.password= +mail.smtps.quitwait=false + + +###################################################### +# Admin and test user setup + +usergrid.sysadmin.login.name=superuser +usergrid.sysadmin.login.email=mys...@example.com <--- Change this +usergrid.sysadmin.login.password=pwHERE <--- Change this +usergrid.sysadmin.login.allowed=true +usergrid.sysadmin.email=mys...@example.com <--- Change this + +usergrid.sysadmin.approve.users=false +usergrid.sysadmin.approve.organizations=false + +# Base mailer account - default for all outgoing messages +usergrid.management.mailer=User <mys...@example.com> <--- Change this + +usergrid.setup-test-account=true + +usergrid.test-account.app=test-app +usergrid.test-account.organization=test-organization +usergrid.test-account.admin-user.username=test +usergrid.test-account.admin-user.name=Test User +usergrid.test-account.admin-user.email=mys...@example.com <---Change this +usergrid.test-account.admin-user.password=test + +###################################################### +# Auto-confirm and sign-up notifications settings + +usergrid.management.admin_users_require_confirmation=false +usergrid.management.admin_users_require_activation=false + +usergrid.management.organizations_require_activation=false +usergrid.management.notify_sysadmin_of_new_organizations=true +usergrid.management.notify_sysadmin_of_new_admin_users=true +###################################################### +# URLs + +# Redirect path when request come in for TLD +usergrid.redirect_root=http://localhost:8080/status + +usergrid.view.management.organizations.organization.activate=http://localhost:8080/accounts/welcome +usergrid.view.management.organizations.organization.confirm=http://localhost:8080/accounts/welcome +usergrid.view.management.users.user.activate=http://localhost:8080/accounts/welcome +usergrid.view.management.users.user.confirm=http://localhost:8080/accounts/welcome + +usergrid.organization.activation.url=http://localhost:8080/management/organizations/%s/activate +usergrid.admin.activation.url=http://localhost:8080/management/users/%s/activate +usergrid.admin.resetpw.url=http://localhost:8080/management/users/%s/resetpw +usergrid.admin.confirmation.url=http://localhost:8080/management/users/%s/confirm +usergrid.user.activation.url=http://localhost:8080%s/%s/users/%s/activate +usergrid.user.confirmation.url=http://localhost:8080/%s/%s/users/%s/confirm +usergrid.user.resetpw.url=http://localhost:8080/%s/%s/users/%s/resetpw +</pre></div> +</div> +<table class="docutils footnote" frame="void" id="id2" rules="none"> +<colgroup><col class="label" /><col /></colgroup> +<tbody valign="top"> +<tr><td class="label"><a class="fn-backref" href="#id1">[1]</a></td><td>You can start up cassandra and elasticsearch in any order but for the +sake of ordered lists I put Cassandra first.</td></tr> +</tbody> +</table> +</div> +</div> + + + </div> + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="../reference/presos-and-videos.html" class="btn btn-neutral float-right" title="Presentations & Videos" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="ug1-launcher-quick-start.html" class="btn btn-neutral" title="Usegrid 1: Launcher Quick-start" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2013-2015, Apache Usergrid. + + </p> + </div> + Built with <a href="http://sphinx-doc.org/";>Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme";>theme</a> provided by <a href="https://readthedocs.org";>Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + + + <script type="text/javascript"> + var DOCUMENTATION_OPTIONS = { + URL_ROOT:'../', + VERSION:'1.0', + COLLAPSE_INDEX:false, + FILE_SUFFIX:'.html', + HAS_SOURCE: true + }; + </script> + <script type="text/javascript" src="../_static/jquery.js"></script> + <script type="text/javascript" src="../_static/underscore.js"></script> + <script type="text/javascript" src="../_static/doctools.js"></script> + + + + + + <script type="text/javascript" src="../_static/js/theme.js"></script> + + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.StickyNav.enable(); + }); + </script> + + +</body> +</html> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/2a55601f/content/docs/introduction/async-vs-sync.html ---------------------------------------------------------------------- diff --git a/content/docs/introduction/async-vs-sync.html b/content/docs/introduction/async-vs-sync.html new file mode 100644 index 0000000..caf0163 --- /dev/null +++ b/content/docs/introduction/async-vs-sync.html @@ -0,0 +1,341 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>Async vs. sync calls — Apache Usergrid 1.0 documentation</title> + + + + + + + + + + + + + + + + <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> + + + + + + <link rel="top" title="Apache Usergrid 1.0 documentation" href="../index.html"/> + <link rel="next" title="Creating a new application" href="../getting-started/creating-a-new-application.html"/> + <link rel="prev" title="Usergrid Data model" href="data-model.html"/> + + + <script src="../_static/js/modernizr.min.js"></script> + +</head> + +<body class="wy-body-for-nav" role="document"> + + <div class="wy-grid-for-nav"> + + + <nav data-toggle="wy-nav-shift" class="wy-nav-side"> + <div class="wy-side-nav-search"> + + + + <a href="../index.html" class="icon icon-home"> Apache Usergrid + + + + </a> + + + + + <div class="version"> + 1.0 + </div> + + + + +<div role="search"> + <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> + <input type="text" name="q" placeholder="Search docs" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> +</div> + + + </div> + + <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> + + + + <p class="caption"><span class="caption-text">Introduction</span></p> +<ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="usergrid-features.html">Usergrid Features</a></li> +<li class="toctree-l1"><a class="reference internal" href="data-model.html">Usergrid Data model</a></li> +<li class="toctree-l1 current"><a class="current reference internal" href="">Async vs. sync calls</a><ul> +<li class="toctree-l2"><a class="reference internal" href="#synchronous">Synchronous</a></li> +<li class="toctree-l2"><a class="reference internal" href="#asynchronous">Asynchronous</a></li> +</ul> +</li> +</ul> +<p class="caption"><span class="caption-text">Getting Started</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-a-new-application.html">Creating a new application</a></li> +<li class="toctree-l1"><a class="reference internal" href="../getting-started/creating-account.html">Creating an Usergrid Account</a></li> +<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-a-sandbox-app.html">Using a Sandbox Application</a></li> +<li class="toctree-l1"><a class="reference internal" href="../getting-started/using-the-api.html">Using the API</a></li> +</ul> +<p class="caption"><span class="caption-text">Data Storage</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../data-storage/data-store-dbms.html">The Usergrid Data Store</a></li> +<li class="toctree-l1"><a class="reference internal" href="../data-storage/optimizing-access.html">Data Store Best Practices</a></li> +<li class="toctree-l1"><a class="reference internal" href="../data-storage/collections.html">Collections</a></li> +<li class="toctree-l1"><a class="reference internal" href="../data-storage/entities.html">Entities</a></li> +</ul> +<p class="caption"><span class="caption-text">Data Queries</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../data-queries/querying-your-data.html">Querying your data</a></li> +<li class="toctree-l1"><a class="reference internal" href="../data-queries/query-parameters.html">Query parameters & clauses</a></li> +<li class="toctree-l1"><a class="reference internal" href="../data-queries/operators-and-types.html">Query operators & data types</a></li> +<li class="toctree-l1"><a class="reference internal" href="../data-queries/advanced-query-usage.html">Advanced query usage</a></li> +</ul> +<p class="caption"><span class="caption-text">Entity Connections</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../entity-connections/connecting-entities.html">Connecting entities</a></li> +<li class="toctree-l1"><a class="reference internal" href="../entity-connections/retrieving-entities.html">Retrieving connections</a></li> +<li class="toctree-l1"><a class="reference internal" href="../entity-connections/disconnecting-entities.html">Disconnecting entities</a></li> +</ul> +<p class="caption"><span class="caption-text">Security & Authentication</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/app-security.html">Security & token authentication</a></li> +<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/using-permissions.html">Using permissions</a></li> +<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-users-and-application-clients.html">Authenticating users & app clients</a></li> +<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/user-authentication-types.html">Authentication levels</a></li> +<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/changing-token-time-live-ttl.html">Changing token expiration (time-to-live)</a></li> +<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/authenticating-api-requests.html">Authenticating API requests</a></li> +<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/revoking-tokens-logout.html">Revoking tokens (logout)</a></li> +<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/facebook-sign.html">Facebook sign in</a></li> +<li class="toctree-l1"><a class="reference internal" href="../security-and-auth/securing-your-app.html">Security best practices</a></li> +</ul> +<p class="caption"><span class="caption-text">User Management & Social Graph</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../user-management/user-management.html">User management & social graph</a></li> +<li class="toctree-l1"><a class="reference internal" href="../user-management/working-user-data.html">Working with User Data</a></li> +<li class="toctree-l1"><a class="reference internal" href="../user-management/group.html">Working with group data</a></li> +<li class="toctree-l1"><a class="reference internal" href="../user-management/activity.html">Activity</a></li> +<li class="toctree-l1"><a class="reference internal" href="../user-management/user-connections.html">Social Graph Connections</a></li> +<li class="toctree-l1"><a class="reference internal" href="../user-management/user-connections.html#creating-other-connections">Creating other connections</a></li> +<li class="toctree-l1"><a class="reference internal" href="../user-management/messagee-example.html">App Example - Messagee</a></li> +</ul> +<p class="caption"><span class="caption-text">Geo-location</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../geolocation/geolocation.html">Geolocating your Entities</a></li> +</ul> +<p class="caption"><span class="caption-text">Assets & Files</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/uploading-assets.html">Uploading assets</a></li> +<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/retrieving-assets.html">Retrieving assets</a></li> +<li class="toctree-l1"><a class="reference internal" href="../asset-and-files/folders.html">Folders</a></li> +</ul> +<p class="caption"><span class="caption-text">Counters & Events</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/events-and-counters.html">Counters & events</a></li> +<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/creating-and-incrementing-counters.html">Creating & incrementing counters</a></li> +<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/creating-and-incrementing-counters.html#decrementing-resetting-counters">Decrementing/resetting counters</a></li> +<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/creating-and-incrementing-counters.html#using-counters-hierarchically">Using counters hierarchically</a></li> +<li class="toctree-l1"><a class="reference internal" href="../counters-and-events/retrieving-counters.html">Retrieving counters</a></li> +</ul> +<p class="caption"><span class="caption-text">Organizations & Applications</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/managing.html">Organization & application management</a></li> +<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/organization.html">Organization</a></li> +<li class="toctree-l1"><a class="reference internal" href="../orgs-and-apps/application.html">Application</a></li> +</ul> +<p class="caption"><span class="caption-text">API Reference</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../rest-endpoints/api-docs.html">Methods</a></li> +<li class="toctree-l1"><a class="reference internal" href="../rest-endpoints/api-docs.html#models">Models</a></li> +</ul> +<p class="caption"><span class="caption-text">Client SDKs</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../sdks/tbd.html">COMING SOON...</a></li> +</ul> +<p class="caption"><span class="caption-text">Installing the Stack</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../installation/ug1-deploy-to-tomcat.html">Usegrid 1: Deploying to Tomcat</a></li> +<li class="toctree-l1"><a class="reference internal" href="../installation/ug1-launcher-quick-start.html">Usegrid 1: Launcher Quick-start</a></li> +<li class="toctree-l1"><a class="reference internal" href="../installation/ug2-deploy-to-tomcat.html">Usergrid 2: Deploy to Tomcat</a></li> +</ul> +<p class="caption"><span class="caption-text">More about Usergrid</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../reference/presos-and-videos.html">Presentations & Videos</a></li> +<li class="toctree-l1"><a class="reference internal" href="../reference/contribute-code.html">How to Contribute Code & Docs</a></li> +</ul> + + + + </div> + + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../index.html">Apache Usergrid</a> + </nav> + + + + <div class="wy-nav-content"> + <div class="rst-content"> + <div role="navigation" aria-label="breadcrumbs navigation"> + <ul class="wy-breadcrumbs"> + <li><a href="../index.html">Docs</a> »</li> + + <li>Async vs. sync calls</li> + <li class="wy-breadcrumbs-aside"> + + + <a href="../_sources/introduction/async-vs-sync.txt" rel="nofollow"> View page source</a> + + + </li> + </ul> + <hr/> +</div> + <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article";> + <div itemprop="articleBody"> + + <div class="section" id="async-vs-sync-calls"> +<h1>Async vs. sync calls<a class="headerlink" href="#async-vs-sync-calls" title="Permalink to this headline">¶</a></h1> +<p>The Usergrid SDKs work by making RESTful API calls from your application +to the API. In some cases, both synchronous and asynchronous calls are +supported for most methods, as in the case of the Usergrid Android SDK, +while in others only asynchronous calls are supported, as in the +Usergrid JavaScript SDK. The following is a brief explanation of +synchronous vs. asynchronous API calls.</p> +<div class="section" id="synchronous"> +<h2>Synchronous<a class="headerlink" href="#synchronous" title="Permalink to this headline">¶</a></h2> +<p>If an API call is synchronous, it means that code execution will block +(or wait) for the API call to return before continuing. This means that +until a response is returned by the API, your application will not +execute any further, which could be perceived by the user as latency or +performance lag in your app. Making an API call synchronously can be +beneficial, however, if there if code in your app that will only execute +properly once the API response is received.</p> +</div> +<div class="section" id="asynchronous"> +<h2>Asynchronous<a class="headerlink" href="#asynchronous" title="Permalink to this headline">¶</a></h2> +<p>Asynchronous calls do not block (or wait) for the API call to return +from the server. Execution continues on in your program, and when the +call returns from the server, a “callback” function is executed. For +example, in the following code using the Usergrid JavScript SDK, the +function called dogCreateCallback will be called when the create dog API +call returns from the server. Meanwhile, execution will continue:</p> +<div class="highlight-python"><div class="highlight"><pre>function dogCreateCallback(err, dog) { + alert('I will probably be called second'); + if (err) { + //Error - Dog not created + } else { + //Success - Dog was created + + } +} + +client.createEntity({type:'dogs'}, dogCreateCallback); +alert('I will probably be called first'); +</pre></div> +</div> +<p>The result of this is that we cannot guarantee the order of the two +alert statements. Most likely, the alert right after the createEntity +function call will be called first since the API call will take a second +or so to complete.</p> +<p>The important point is that program execution will continue, and +asynchronously, the callback function will be called once program +execution completes.</p> +</div> +</div> + + + </div> + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="../getting-started/creating-a-new-application.html" class="btn btn-neutral float-right" title="Creating a new application" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="data-model.html" class="btn btn-neutral" title="Usergrid Data model" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + © Copyright 2013-2015, Apache Usergrid. + + </p> + </div> + Built with <a href="http://sphinx-doc.org/";>Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme";>theme</a> provided by <a href="https://readthedocs.org";>Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + + + <script type="text/javascript"> + var DOCUMENTATION_OPTIONS = { + URL_ROOT:'../', + VERSION:'1.0', + COLLAPSE_INDEX:false, + FILE_SUFFIX:'.html', + HAS_SOURCE: true + }; + </script> + <script type="text/javascript" src="../_static/jquery.js"></script> + <script type="text/javascript" src="../_static/underscore.js"></script> + <script type="text/javascript" src="../_static/doctools.js"></script> + + + + + + <script type="text/javascript" src="../_static/js/theme.js"></script> + + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.StickyNav.enable(); + }); + </script> + + +</body> +</html> \ No newline at end of file
