Modified: websites/staging/rave/trunk/content/documentation/configure-ssl.html ============================================================================== --- websites/staging/rave/trunk/content/documentation/configure-ssl.html (original) +++ websites/staging/rave/trunk/content/documentation/configure-ssl.html Sun Feb 7 21:02:46 2016 @@ -29,6 +29,7 @@ </head> <body> + <div style="background: red"><h1>2016/02/07 - Apache Rave has been retired. </h1><h2>For more information, please explore the <a href="http://attic.apache.org/";>Attic</a>. </h2></div> <div class="navbar navbar-inverse navbar-fixed-top"> <div class="navbar-inner"> @@ -87,40 +88,51 @@ </header> <section id="content" class="row"> <article class="span12"> - <h2 id="prerequisites">Prerequisites</h2> + <style type="text/css"> +/* The following code is added by mdx_elementid.py + It was originally lifted from http://subversion.apache.org/style/site.css */ +/* + * Hide class="elementid-permalink", except when an enclosing heading + * has the :hover property. + */ +.headerlink, .elementid-permalink { + visibility: hidden; +} +h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style> +<h2 id="prerequisites">Prerequisites<a class="headerlink" href="#prerequisites" title="Permanent link">¶</a></h2> <p>To follow these instructions you'll need a working copy of Apache Rave up and running under Tomcat 6. Please see the <a href="installing.html">Installing Rave</a> page for instructions on how to get up and running.</p> <p>These instructions are written assuming a Tomcat installation path of /temp/tomcat so you may want to use that path for testing while you follow these instructions.</p> <p>Also note that these instructions were written and tested using Tomcat running on Windows. Tomcat on other platforms <em>should</em> be exaclty the same except for startup scripts (.bat vs .sh) and file locations (c:\ vs /).</p> -<h2 id="enabling-ssl-in-tomcat">Enabling SSL in Tomcat</h2> +<h2 id="enabling-ssl-in-tomcat">Enabling SSL in Tomcat<a class="headerlink" href="#enabling-ssl-in-tomcat" title="Permanent link">¶</a></h2> <p>These instructions demonstrate how to get Tomcat 6 running over SSL using a self signed certificate.</p> <ul> <li> <p>Copy the default cacerts file to /temp/tomcat (this allows you to not have to pollute your real cacerts file with test certs).</p> -<div class="codehilite"><pre><span class="n">cp</span> <span class="s">"%JAVA_HOME%/jre/lib/security/cacerts"</span> <span class="s">"/temp/tomcat/custom-cacerts"</span> +<div class="codehilite"><pre><span class="n">cp</span> "<span class="c">%JAVA_HOME%/jre/lib/security/cacerts" "/temp/tomcat/custom-cacerts"</span> </pre></div> </li> <li> <p>Generate a self signed certificate that you'll use with Tomcat.</p> -<div class="codehilite"><pre><span class="s">"%JAVA_HOME%\bin\keytool"</span> <span class="o">-</span><span class="n">genkey</span> <span class="o">-</span><span class="n">alias</span> <span class="n">tomcat</span> <span class="o">-</span><span class="n">keyalg</span> <span class="n">RSA</span> <span class="o">-</span><span class="n">validity</span> <span class="mi">365</span> <span class="o">-</span><span class="n">storepass</span> <span class="n">changeit</span> <span class="o">-</span><span class="n">keystore</span> <span class="sr">/temp/</span><span class="n">tomcat</span><span class="o">/</span><span class="n">custom</span><span class="o">-</span><span class="n">cacerts</span> +<div class="codehilite"><pre>"<span class="c">%JAVA_HOME%\bin\keytool" -genkey -alias tomcat -keyalg RSA -validity 365 -storepass changeit -keystore /temp/tomcat/custom-cacerts</span> -<span class="n">What</span> <span class="n">is</span> <span class="n">your</span> <span class="n">first</span> <span class="ow">and</span> <span class="k">last</span> <span class="n">name</span><span class="p">?</span> - <span class="p">[</span><span class="n">Unknown</span><span class="p">]:</span> <span class="n">rave</span><span class="o">-</span><span class="n">server</span><span class="o">.</span><span class="n">example</span><span class="o">.</span><span class="n">com</span> -<span class="n">What</span> <span class="n">is</span> <span class="n">the</span> <span class="n">name</span> <span class="n">of</span> <span class="n">your</span> <span class="n">organizational</span> <span class="n">unit</span><span class="p">?</span> +<span class="n">What</span> <span class="n">is</span> <span class="n">your</span> <span class="n">first</span> <span class="n">and</span> <span class="n">last</span> <span class="n">name</span>? + <span class="p">[</span><span class="n">Unknown</span><span class="p">]:</span> <span class="n">rave</span><span class="o">-</span><span class="n">server</span><span class="p">.</span><span class="n">example</span><span class="p">.</span><span class="n">com</span> +<span class="n">What</span> <span class="n">is</span> <span class="n">the</span> <span class="n">name</span> <span class="n">of</span> <span class="n">your</span> <span class="n">organizational</span> <span class="n">unit</span>? <span class="p">[</span><span class="n">Unknown</span><span class="p">]:</span> <span class="n">example</span> <span class="n">unit</span> -<span class="n">What</span> <span class="n">is</span> <span class="n">the</span> <span class="n">name</span> <span class="n">of</span> <span class="n">your</span> <span class="n">organization</span><span class="p">?</span> +<span class="n">What</span> <span class="n">is</span> <span class="n">the</span> <span class="n">name</span> <span class="n">of</span> <span class="n">your</span> <span class="n">organization</span>? <span class="p">[</span><span class="n">Unknown</span><span class="p">]:</span> <span class="n">example</span> <span class="n">organization</span> -<span class="n">What</span> <span class="n">is</span> <span class="n">the</span> <span class="n">name</span> <span class="n">of</span> <span class="n">your</span> <span class="n">City</span> <span class="ow">or</span> <span class="n">Locality</span><span class="p">?</span> +<span class="n">What</span> <span class="n">is</span> <span class="n">the</span> <span class="n">name</span> <span class="n">of</span> <span class="n">your</span> <span class="n">City</span> <span class="n">or</span> <span class="n">Locality</span>? <span class="p">[</span><span class="n">Unknown</span><span class="p">]:</span> <span class="n">example</span> <span class="n">city</span> -<span class="n">What</span> <span class="n">is</span> <span class="n">the</span> <span class="n">name</span> <span class="n">of</span> <span class="n">your</span> <span class="n">State</span> <span class="ow">or</span> <span class="n">Province</span><span class="p">?</span> +<span class="n">What</span> <span class="n">is</span> <span class="n">the</span> <span class="n">name</span> <span class="n">of</span> <span class="n">your</span> <span class="n">State</span> <span class="n">or</span> <span class="n">Province</span>? <span class="p">[</span><span class="n">Unknown</span><span class="p">]:</span> <span class="n">example</span> <span class="n">state</span> -<span class="n">What</span> <span class="n">is</span> <span class="n">the</span> <span class="n">two</span><span class="o">-</span><span class="n">letter</span> <span class="n">country</span> <span class="n">code</span> <span class="k">for</span> <span class="n">this</span> <span class="n">unit</span><span class="p">?</span> +<span class="n">What</span> <span class="n">is</span> <span class="n">the</span> <span class="n">two</span><span class="o">-</span><span class="n">letter</span> <span class="n">country</span> <span class="n">code</span> <span class="k">for</span> <span class="n">this</span> <span class="n">unit</span>? <span class="p">[</span><span class="n">Unknown</span><span class="p">]:</span> <span class="n">US</span> -<span class="n">Is</span> <span class="n">CN</span><span class="o">=</span><span class="n">rave</span><span class="o">-</span><span class="n">server</span><span class="o">.</span><span class="n">example</span><span class="o">.</span><span class="n">com</span><span class="p">,</span> <span class="n">OU</span><span class="o">=</span><span class="n">example</span> <span class="n">unit</span><span class="p">,</span> <span class="n">O</span><span class="o">=</span><span class="n">example</span> <span class="n">organization</span><span class="p">,</span> <span class="n">L</span><span class="o">=</span><span class="n">example</span> <span class="n">city</span><span class="p">,</span> <span class="n">ST</span><span class="o">=</span><span class="n">example</span> <span class="n">state</span><span class="p">,</span> <span class="n">C</span><span class="o">=</span><span class="n">US</span> <span class="n">correct</span><span class="p">?</span> - <span class="p">[</span><span class="nb">no</span><span class="p">]:</span> <span class="n">yes</span> +<span class="n">Is</span> <span class="n">CN</span><span class="p">=</span><span class="n">rave</span><span class="o">-</span><span class="n">server</span><span class="p">.</span><span class="n">example</span><span class="p">.</span><span class="n">com</span><span class="p">,</span> <span class="n">OU</span><span class="p">=</span><span class="n">example</span> <span class="n">unit</span><span class="p">,</span> <span class="n">O</span><span class="p">=</span><span class="n">example</span> <span class="n">organization</span><span class="p">,</span> <span class="n">L</span><span class="p">=</span><span class="n">example</span> <span class="n">city</span><span class="p">,</span> <span class="n">ST</span><span class="p">=</span><span class="n">example</span> <span class="n">state</span><span class="p">,</span> <span class="n">C</span><span class="p">=</span><span class="n">US</span> <span class="n">correct</span>? + <span class="p">[</span><span class="n">no</span><span class="p">]:</span> <span class="n">yes</span> -<span class="n">Enter</span> <span class="n">key</span> <span class="n">password</span> <span class="k">for</span> <span class="sr"><tomcat></span> +<span class="n">Enter</span> <span class="n">key</span> <span class="n">password</span> <span class="k">for</span> <span class="o"><</span><span class="n">tomcat</span><span class="o">></span> <span class="p">(</span><span class="n">RETURN</span> <span class="k">if</span> <span class="n">same</span> <span class="n">as</span> <span class="n">keystore</span> <span class="n">password</span><span class="p">):</span> </pre></div> @@ -129,7 +141,7 @@ <li> <p>Edit Tomcats startup.bat file to get the JVM to use our alternate cacerts file. It is important for the JVM to trust our self signed certificate because Apache Rave makes HTTP requests to Shindig to fetch gadget metadata, and if those requests are over SSL then the JVM must trust the certificate being used for the SSL communication.</p> <p>(added the following line above the "call "%EXECUTABLE%" start ..." line)</p> -<div class="codehilite"><pre><span class="n">set</span> <span class="n">JAVA_OPTS</span><span class="o">=</span><span class="nv">%JAVA_OPTS%</span> <span class="err">-</span><span class="nv">Djavax</span><span class="o">.</span><span class="n">net</span><span class="o">.</span><span class="n">ssl</span><span class="o">.</span><span class="n">trustStore</span><span class="o">=</span><span class="n">c:</span><span class="o">\</span><span class="n">temp</span><span class="o">\</span><span class="n">tomcat</span><span class="o">\</span><span class="n">custom</span><span class="o">-</span><span class="n">cacerts</span> +<div class="codehilite"><pre><span class="n">set</span> <span class="n">JAVA_OPTS</span><span class="p">=</span><span class="c">%JAVA_OPTS% -Djavax.net.ssl.trustStore=c:\temp\tomcat\custom-cacerts</span> </pre></div> @@ -138,10 +150,10 @@ <p>Edit Tomcats server.xml to enable an SSL listener on port 443 using our alternate cacerts file. By default Tomcat looks for a certificate with the alias "tomcat" which is what we used to create our self signed certificate.</p> <p>(did a search and replace of 8443 with 443) <br /> (uncommented the HTTPS connector and configured it to use our custom cacerts file)</p> -<div class="codehilite"><pre><span class="o"><</span><span class="n">Connector</span> <span class="n">port</span><span class="o">=</span><span class="s">"443"</span> <span class="n">protocol</span><span class="o">=</span><span class="s">"HTTP/1.1"</span> <span class="n">SSLEnabled</span><span class="o">=</span><span class="s">"true"</span> - <span class="n">maxThreads</span><span class="o">=</span><span class="s">"150"</span> <span class="n">scheme</span><span class="o">=</span><span class="s">"https"</span> <span class="n">secure</span><span class="o">=</span><span class="s">"true"</span> - <span class="n">keystoreFile</span><span class="o">=</span><span class="s">"c:\temp\tomcat\custom-cacerts"</span> <span class="n">keystorePass</span><span class="o">=</span><span class="s">"changeit"</span> - <span class="n">clientAuth</span><span class="o">=</span><span class="s">"false"</span> <span class="n">sslProtocol</span><span class="o">=</span><span class="s">"TLS"</span> <span class="o">/></span> +<div class="codehilite"><pre><span class="o"><</span><span class="n">Connector</span> <span class="n">port</span><span class="p">=</span>"443" <span class="n">protocol</span><span class="p">=</span>"<span class="n">HTTP</span><span class="o">/</span>1<span class="p">.</span>1" <span class="n">SSLEnabled</span><span class="p">=</span>"<span class="n">true</span>" + <span class="n">maxThreads</span><span class="p">=</span>"150" <span class="n">scheme</span><span class="p">=</span>"<span class="n">https</span>" <span class="n">secure</span><span class="p">=</span>"<span class="n">true</span>" + <span class="n">keystoreFile</span><span class="p">=</span>"<span class="n">c</span><span class="p">:</span><span class="o">\</span><span class="n">temp</span><span class="o">\</span><span class="n">tomcat</span><span class="o">\</span><span class="n">custom</span><span class="o">-</span><span class="n">cacerts</span>" <span class="n">keystorePass</span><span class="p">=</span>"<span class="n">changeit</span>" + <span class="n">clientAuth</span><span class="p">=</span>"<span class="n">false</span>" <span class="n">sslProtocol</span><span class="p">=</span>"<span class="n">TLS</span>" <span class="o">/></span> </pre></div> @@ -155,14 +167,14 @@ Also note that the rest of Apache Rave wont work over SSL yet.</p> </li> </ul> -<h2 id="configure-apache-rave-and-shindig-to-run-over-ssl">Configure Apache Rave and Shindig to run over SSL.</h2> +<h2 id="configure-apache-rave-and-shindig-to-run-over-ssl">Configure Apache Rave and Shindig to run over SSL.<a class="headerlink" href="#configure-apache-rave-and-shindig-to-run-over-ssl" title="Permanent link">¶</a></h2> <ul> <li> <p>Edit the /temp/tomcat/webapps/portal/WEB-INF/classes/portal.properties file to configure Apache Rave to use SSL.</p> <p>(updated the following values at the top of the portal.properties config file with)</p> -<div class="codehilite"><pre><span class="n">portal</span><span class="o">.</span><span class="n">opensocial_engine</span><span class="o">.</span><span class="n">protocol</span><span class="o">=</span><span class="n">https</span> -<span class="n">portal</span><span class="o">.</span><span class="n">opensocial_engine</span><span class="o">.</span><span class="n">root</span><span class="o">=</span><span class="n">rave</span><span class="o">-</span><span class="n">server</span><span class="o">.</span><span class="n">example</span><span class="o">.</span><span class="n">com</span> -<span class="n">portal</span><span class="o">.</span><span class="n">opensocial_engine</span><span class="o">.</span><span class="n">gadget_path</span><span class="o">=/</span><span class="n">gadgets</span> +<div class="codehilite"><pre><span class="n">portal</span><span class="p">.</span><span class="n">opensocial_engine</span><span class="p">.</span><span class="n">protocol</span><span class="p">=</span><span class="n">https</span> +<span class="n">portal</span><span class="p">.</span><span class="n">opensocial_engine</span><span class="p">.</span><span class="n">root</span><span class="p">=</span><span class="n">rave</span><span class="o">-</span><span class="n">server</span><span class="p">.</span><span class="n">example</span><span class="p">.</span><span class="n">com</span> +<span class="n">portal</span><span class="p">.</span><span class="n">opensocial_engine</span><span class="p">.</span><span class="n">gadget_path</span><span class="p">=</span><span class="o">/</span><span class="n">gadgets</span> </pre></div> @@ -172,9 +184,9 @@ Also note that the rest of Apache Rave w <p>Note - there may be other ways to get Shindig to use SSL but this method does work. Also note - the changes to container.js are a search and replace of http:// with https://</p> <p>(updated the following values at the top of the rave.shindig.properties config file with)</p> -<div class="codehilite"><pre><span class="n">shindig</span><span class="o">.</span><span class="n">host</span><span class="o">=</span><span class="n">rave</span><span class="o">-</span><span class="n">server</span><span class="o">.</span><span class="n">example</span><span class="o">.</span><span class="n">com</span> -<span class="n">shindig</span><span class="o">.</span><span class="n">port</span><span class="o">=</span> -<span class="n">shindig</span><span class="o">.</span><span class="n">contextroot</span><span class="o">=</span> +<div class="codehilite"><pre><span class="n">shindig</span><span class="p">.</span><span class="n">host</span><span class="p">=</span><span class="n">rave</span><span class="o">-</span><span class="n">server</span><span class="p">.</span><span class="n">example</span><span class="p">.</span><span class="n">com</span> +<span class="n">shindig</span><span class="p">.</span><span class="n">port</span><span class="p">=</span> +<span class="n">shindig</span><span class="p">.</span><span class="n">contextroot</span><span class="p">=</span> </pre></div> @@ -183,7 +195,7 @@ Also note - the changes to container.js <p>Startup Tomcat and verify that Rave runs properly on https://rave-server.example.com/portal</p> </li> </ul> -<h2 id="complete-diff-of-modified-files-follows">Complete diff of modified files follows</h2> +<h2 id="complete-diff-of-modified-files-follows">Complete diff of modified files follows<a class="headerlink" href="#complete-diff-of-modified-files-follows" title="Permanent link">¶</a></h2> <blockquote> diff -r tomcat-vanilla\bin\startup.bat tomcat\bin\startup.bat <br>56c56,57
Modified: websites/staging/rave/trunk/content/documentation/custom-app-context.html ============================================================================== --- websites/staging/rave/trunk/content/documentation/custom-app-context.html (original) +++ websites/staging/rave/trunk/content/documentation/custom-app-context.html Sun Feb 7 21:02:46 2016 @@ -29,6 +29,7 @@ </head> <body> + <div style="background: red"><h1>2016/02/07 - Apache Rave has been retired. </h1><h2>For more information, please explore the <a href="http://attic.apache.org/";>Attic</a>. </h2></div> <div class="navbar navbar-inverse navbar-fixed-top"> <div class="navbar-inner"> @@ -87,15 +88,26 @@ </header> <section id="content" class="row"> <article class="span12"> - <p>In order for custom components to participate in or replace Apache Rave implementations, they must be made available to the Spring Application Context during application initialization. The simplest way to do this is to define a Spring context XML file that defines the custom beans to use.</p> + <style type="text/css"> +/* The following code is added by mdx_elementid.py + It was originally lifted from http://subversion.apache.org/style/site.css */ +/* + * Hide class="elementid-permalink", except when an enclosing heading + * has the :hover property. + */ +.headerlink, .elementid-permalink { + visibility: hidden; +} +h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style> +<p>In order for custom components to participate in or replace Apache Rave implementations, they must be made available to the Spring Application Context during application initialization. The simplest way to do this is to define a Spring context XML file that defines the custom beans to use.</p> <p>Follow the steps below to create and add additional application contexts to Apache Rave:</p> -<h2 id="1-get-apache-rave">1) Get Apache Rave</h2> +<h2 id="1-get-apache-rave">1) Get Apache Rave<a class="headerlink" href="#1-get-apache-rave" title="Permanent link">¶</a></h2> <p>There are multiple ways to build your custom Apache Rave instance, but the quickest is to use a Maven WAR overlay. See <a href="rave-extensions.html">Extending Rave</a> for an example overlay.</p> -<h2 id="2-create-a-new-spring-context-xml-file">2) Create a new Spring context XML file</h2> +<h2 id="2-create-a-new-spring-context-xml-file">2) Create a new Spring context XML file<a class="headerlink" href="#2-create-a-new-spring-context-xml-file" title="Permanent link">¶</a></h2> <p>Define a Spring context file in accordance with the <a href="http://static.springsource.org/spring/docs/3.0.x/spring-framework-reference/html/beans.html";>Spring Documentation</a>. Place the file in src/main/webapp/WEB-INF</p> -<h2 id="3-override-webxml">3) Override web.xml</h2> +<h2 id="3-override-webxml">3) Override web.xml<a class="headerlink" href="#3-override-webxml" title="Permanent link">¶</a></h2> <p>Copy the web.xml file from the Apache Rave source distribution (or exploded war) and place it in your overlay's src/main/webapp/WEB-INF directory.</p> -<h2 id="4-update-webxml">4) Update web.xml</h2> +<h2 id="4-update-webxml">4) Update web.xml<a class="headerlink" href="#4-update-webxml" title="Permanent link">¶</a></h2> <p>Add the location of your context XML file to the top of the <code><param-value></code> element in the <code>contextConfigLocation</code> context param in the now overridden web.xml.</p> <div class="codehilite"><pre><span class="nt"><context-param></span> <span class="nt"><param-name></span>contextConfigLocation<span class="nt"></param-name></span> @@ -108,8 +120,8 @@ </pre></div> -<h2 id="5-build-and-deploy-your-new-apache-rave-war">5) Build and deploy your new Apache Rave war</h2> -<h1 id="notes-and-concerns">Notes and concerns</h1> +<h2 id="5-build-and-deploy-your-new-apache-rave-war">5) Build and deploy your new Apache Rave war<a class="headerlink" href="#5-build-and-deploy-your-new-apache-rave-war" title="Permanent link">¶</a></h2> +<h1 id="notes-and-concerns">Notes and concerns<a class="headerlink" href="#notes-and-concerns" title="Permanent link">¶</a></h1> <p>This approach will work for overlays of rave-portal, rave-shindig or rave-wookie.</p> <p>IF overriding a bean implementation with your own, the bean must be marked as primary. See the Spring documentation for discussion on primary beans.</p> </article> Modified: websites/staging/rave/trunk/content/documentation/custom-gui.html ============================================================================== --- websites/staging/rave/trunk/content/documentation/custom-gui.html (original) +++ websites/staging/rave/trunk/content/documentation/custom-gui.html Sun Feb 7 21:02:46 2016 @@ -29,6 +29,7 @@ </head> <body> + <div style="background: red"><h1>2016/02/07 - Apache Rave has been retired. </h1><h2>For more information, please explore the <a href="http://attic.apache.org/";>Attic</a>. </h2></div> <div class="navbar navbar-inverse navbar-fixed-top"> <div class="navbar-inner"> @@ -87,24 +88,33 @@ </header> <section id="content" class="row"> <article class="span12"> - <p>The look and feel (GUI) of the Apache Rave Portal can be customized to your own preference. The Apache Rave Portal contains a mechanism to easily add your own CSS file(s) which are called after the default.css file.</p> -<h2 id="1-get-apache-rave">1) Get Apache Rave</h2> + <style type="text/css"> +/* The following code is added by mdx_elementid.py + It was originally lifted from http://subversion.apache.org/style/site.css */ +/* + * Hide class="elementid-permalink", except when an enclosing heading + * has the :hover property. + */ +.headerlink, .elementid-permalink { + visibility: hidden; +} +h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style> +<p>The look and feel (GUI) of the Apache Rave Portal can be customized to your own preference. The Apache Rave Portal contains a mechanism to easily add your own CSS file(s) which are called after the default.css file.</p> +<h2 id="1-get-apache-rave">1) Get Apache Rave<a class="headerlink" href="#1-get-apache-rave" title="Permanent link">¶</a></h2> <p>There are multiple ways to build your custom Apache Rave instance, but the quickest is to use a Maven WAR overlay. See <a href="rave-extensions.html">Extending Rave</a> for an example overlay.</p> -<h2 id="2-add-css-files">2) Add CSS file(s)</h2> +<h2 id="2-add-css-files">2) Add CSS file(s)<a class="headerlink" href="#2-add-css-files" title="Permanent link">¶</a></h2> <p>Add you own CSS file(s) to the <code>src/main/webapp/css</code> folder of your extension portal module.</p> -<h2 id="3-refer-to-the-new-css-files">3) Refer to the new CSS file(s)</h2> +<h2 id="3-refer-to-the-new-css-files">3) Refer to the new CSS file(s)<a class="headerlink" href="#3-refer-to-the-new-css-files" title="Permanent link">¶</a></h2> <ul> <li>Create a JSP tag file: <code>src/main/webapp/WEB-INF/tags/custom_css.tag</code></li> -<li> -<p>Add a link to the stylesheet(s) in the custom_css.tag:</p> -<div class="codehilite"><pre><span class="o"><</span><span class="nv">%@</span> <span class="nv">taglib</span> <span class="n">uri</span><span class="o">=</span><span class="s">"http://java.sun.com/jstl/core_rt"</span> <span class="n">prefix</span><span class="o">=</span><span class="s">"c"</span><span class="o">></span> -<span class="o"><</span><span class="nb">link</span> <span class="n">rel</span><span class="o">=</span><span class="s">"stylesheet"</span> <span class="n">href</span><span class="o">=</span><span class="s">"<c:url value="</span><span class="sr">/css/m</span><span class="n">y_custom</span><span class="o">.</span><span class="n">css</span><span class="s">"/>"</span><span class="o">/></span> +<li>Add a link to the stylesheet(s) in the custom_css.tag:<div class="codehilite"><pre><span class="o"><</span><span class="c">%@ taglib uri="http://java.sun.com/jstl/core_rt" prefix="c"></span> +<span class="o"><</span><span class="n">link</span> <span class="n">rel</span><span class="p">=</span>"<span class="n">stylesheet</span>" <span class="n">href</span><span class="p">=</span>"<span class="o"><</span><span class="n">c</span><span class="p">:</span><span class="n">url</span> <span class="n">value</span><span class="p">=</span>"<span class="o">/</span><span class="n">css</span><span class="o">/</span><span class="n">my_custom</span><span class="p">.</span><span class="n">css</span>"<span class="o">/></span>"<span class="o">/></span> </pre></div> </li> </ul> -<h2 id="4-change-default-settings">4) Change default settings</h2> +<h2 id="4-change-default-settings">4) Change default settings<a class="headerlink" href="#4-change-default-settings" title="Permanent link">¶</a></h2> <p>A portal administrator can change default settings such as the page title in the browser's title bar. This is described on the <a href="admin-interface-preferences.html">Portal preferences</a> help page.</p> </article> Modified: websites/staging/rave/trunk/content/documentation/custom-widget-renderer.html ============================================================================== --- websites/staging/rave/trunk/content/documentation/custom-widget-renderer.html (original) +++ websites/staging/rave/trunk/content/documentation/custom-widget-renderer.html Sun Feb 7 21:02:46 2016 @@ -29,6 +29,7 @@ </head> <body> + <div style="background: red"><h1>2016/02/07 - Apache Rave has been retired. </h1><h2>For more information, please explore the <a href="http://attic.apache.org/";>Attic</a>. </h2></div> <div class="navbar navbar-inverse navbar-fixed-top"> <div class="navbar-inner"> @@ -87,17 +88,27 @@ </header> <section id="content" class="row"> <article class="span12"> - <p>The Apache Rave development team is striving to build rave-portal as a widget-agnostic mash-up engine. This means that a new widget provider can be added to Apache Rave with a few simple steps.</p> -<h2 id="1-get-apache-rave">1) Get Apache Rave</h2> + <style type="text/css"> +/* The following code is added by mdx_elementid.py + It was originally lifted from http://subversion.apache.org/style/site.css */ +/* + * Hide class="elementid-permalink", except when an enclosing heading + * has the :hover property. + */ +.headerlink, .elementid-permalink { + visibility: hidden; +} +h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style> +<p>The Apache Rave development team is striving to build rave-portal as a widget-agnostic mash-up engine. This means that a new widget provider can be added to Apache Rave with a few simple steps.</p> +<h2 id="1-get-apache-rave">1) Get Apache Rave<a class="headerlink" href="#1-get-apache-rave" title="Permanent link">¶</a></h2> <p>There are multiple ways to build your custom Apache Rave instance, but the simplest is to use a Maven WAR overlay. See <a href="rave-extensions.html">Extending Rave</a> for an example overlay.</p> -<h2 id="2-define-a-custom-web-application-context">2) Define a custom web application context</h2> +<h2 id="2-define-a-custom-web-application-context">2) Define a custom web application context<a class="headerlink" href="#2-define-a-custom-web-application-context" title="Permanent link">¶</a></h2> <p>See <a href="custom-app-context.html">Adding a custom Application Context</a></p> -<h2 id="3-add-a-widget-renderer">3) Add a widget renderer</h2> +<h2 id="3-add-a-widget-renderer">3) Add a widget renderer<a class="headerlink" href="#3-add-a-widget-renderer" title="Permanent link">¶</a></h2> <p>Add an implementation of org.apache.rave.portal.web.renderer.RegionWidgetRenderer to your custom application context. This renderer will get called during the page render process at the point in the page where the HTML markup for the widget is to be output. If your provider needs to add a script block to the render process, you can autowire in a reference to the <a href="script-manager.html">ScriptManager</a>.</p> -<h2 id="4-add-a-widget-provider-js-file">4) Add a widget provider js file</h2> +<h2 id="4-add-a-widget-provider-js-file">4) Add a widget provider js file<a class="headerlink" href="#4-add-a-widget-provider-js-file" title="Permanent link">¶</a></h2> <p>If your widget provider has any javascript that needs to be executed to initialize the widget, you can define a widget provider javascript object. The javascript widget provider must have a TYPE property and an initWidget function as documented in rave.js's registerProvider function.</p> -<p>The easiest way to add a new widget provider javascript file is to create a separate include file in src/main/webapp/script and add a bean with a dependency on the ScriptManager that registers the Global script block. If you are overriding any of the JSPs or adding your own front end, you can obviously add the script include at any point on the page after rave.js.<br /> -</p> +<p>The easiest way to add a new widget provider javascript file is to create a separate include file in src/main/webapp/script and add a bean with a dependency on the ScriptManager that registers the Global script block. If you are overriding any of the JSPs or adding your own front end, you can obviously add the script include at any point on the page after rave.js. </p> </article> </section> </div> Modified: websites/staging/rave/trunk/content/documentation/customizing.html ============================================================================== --- websites/staging/rave/trunk/content/documentation/customizing.html (original) +++ websites/staging/rave/trunk/content/documentation/customizing.html Sun Feb 7 21:02:46 2016 @@ -29,6 +29,7 @@ </head> <body> + <div style="background: red"><h1>2016/02/07 - Apache Rave has been retired. </h1><h2>For more information, please explore the <a href="http://attic.apache.org/";>Attic</a>. </h2></div> <div class="navbar navbar-inverse navbar-fixed-top"> <div class="navbar-inner"> @@ -87,9 +88,20 @@ </header> <section id="content" class="row"> <article class="span12"> - <p>Apache Rave has been designed with extension in mind and provides many different ways to override, supplement or modify out of the box components. Apache Rave leverages a combination of well defined interfaces and the <a href="http://www.springsource.org";>Spring Framework</a> as a mechanism of extensibility. This powerful approach gives developers the ability to override Apache Rave bean implementations, inject Apache Rave beans into custom code and wire additional components into Apache Rave beans that depend on lists.</p> + <style type="text/css"> +/* The following code is added by mdx_elementid.py + It was originally lifted from http://subversion.apache.org/style/site.css */ +/* + * Hide class="elementid-permalink", except when an enclosing heading + * has the :hover property. + */ +.headerlink, .elementid-permalink { + visibility: hidden; +} +h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style> +<p>Apache Rave has been designed with extension in mind and provides many different ways to override, supplement or modify out of the box components. Apache Rave leverages a combination of well defined interfaces and the <a href="http://www.springsource.org";>Spring Framework</a> as a mechanism of extensibility. This powerful approach gives developers the ability to override Apache Rave bean implementations, inject Apache Rave beans into custom code and wire additional components into Apache Rave beans that depend on lists.</p> <p>You will find guides for extending Apache Rave in common ways below, but if you are unfamiliar with Spring's inversion of control (IoC), it is recommended that you read the Overview of the Spring Framework <a href="http://static.springsource.org/spring/docs/3.0.x/spring-framework-reference/html/spring-introduction.html";>here</a>.</p> -<h2 id="customization-guides">Customization Guides</h2> +<h2 id="customization-guides">Customization Guides<a class="headerlink" href="#customization-guides" title="Permanent link">¶</a></h2> <ul> <li><a href="rave-extensions.html">Extend Rave to build your own portal</a></li> <li><a href="custom-app-context.html">Adding a custom application context</a></li> Modified: websites/staging/rave/trunk/content/documentation/host-configuration.html ============================================================================== --- websites/staging/rave/trunk/content/documentation/host-configuration.html (original) +++ websites/staging/rave/trunk/content/documentation/host-configuration.html Sun Feb 7 21:02:46 2016 @@ -29,6 +29,7 @@ </head> <body> + <div style="background: red"><h1>2016/02/07 - Apache Rave has been retired. </h1><h2>For more information, please explore the <a href="http://attic.apache.org/";>Attic</a>. </h2></div> <div class="navbar navbar-inverse navbar-fixed-top"> <div class="navbar-inner"> @@ -87,12 +88,23 @@ </header> <section id="content" class="row"> <article class="span12"> - <p>The default configuration uses the following URL's:</p> + <style type="text/css"> +/* The following code is added by mdx_elementid.py + It was originally lifted from http://subversion.apache.org/style/site.css */ +/* + * Hide class="elementid-permalink", except when an enclosing heading + * has the :hover property. + */ +.headerlink, .elementid-permalink { + visibility: hidden; +} +h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style> +<p>The default configuration uses the following URL's:</p> <ul> <li>Portal: <a href="http://localhost:8080/portal";>http://localhost:8080/portal</a></li> <li>Base URL for rendering OpenSocial gadgets http://localhost:8080/gadgets</li> </ul> -<h2 id="override-portal-configuration">Override portal configuration</h2> +<h2 id="override-portal-configuration">Override portal configuration<a class="headerlink" href="#override-portal-configuration" title="Permanent link">¶</a></h2> <p>First configure the portal to call a different URL for the OpenSocial engine:</p> <ul> <li>Make a copy of <a href="http://svn.apache.org/repos/asf/rave/trunk/rave-portal-resources/src/main/resources/portal.properties";>portal.properties</a></li> @@ -104,7 +116,7 @@ </li> </ul> <p>After a (re)start of Tomcat, the portal will now try to fetch gadget rendering data from your configured location.</p> -<h2 id="override-opensocial-engine-configuration">Override OpenSocial engine configuration</h2> +<h2 id="override-opensocial-engine-configuration">Override OpenSocial engine configuration<a class="headerlink" href="#override-opensocial-engine-configuration" title="Permanent link">¶</a></h2> <ul> <li>Make a copy of <a href="http://svn.apache.org/repos/asf/rave/trunk/rave-providers/rave-opensocial-provider/rave-opensocial-server/rave-shindig-resources/src/main/webapp/WEB-INF/classes/containers/default/container.js";>container.js</a> (check if this version is still valid for your release)</li> <li>Make a copy of <a href="http://svn.apache.org/repos/asf/rave/trunk/rave-providers/rave-opensocial-provider/rave-opensocial-server/rave-shindig-resources/src/main/resources/rave.shindig.properties";>rave.shindig.properties</a></li> @@ -117,8 +129,8 @@ </li> </ul> <p>Note: Although <code>shindig.host</code>, <code>shindig.port</code> and <code>shindig.contextroot</code> can also be overridden by setting them as individual system properties, <code>container.js</code> contains hard coded values with <code>localhost</code></p> -<h2 id="setting-the-system-properties">Setting the system properties</h2> -<h3 id="running-cargo">Running Cargo</h3> +<h2 id="setting-the-system-properties">Setting the system properties<a class="headerlink" href="#setting-the-system-properties" title="Permanent link">¶</a></h2> +<h3 id="running-cargo">Running Cargo<a class="headerlink" href="#running-cargo" title="Permanent link">¶</a></h3> <p>The Cargo Maven plugin is configured in <code>rave-portal/pom.xml</code>. Go to the element <code>systemProperties</code> and enable the elements <code>portal.override.properties</code> and <code>rave-shindig.override.properties</code> (also modify its paths).</p> <div class="codehilite"><pre><span class="nt"><systemProperties></span> @@ -129,10 +141,10 @@ </pre></div> -<h3 id="running-a-stand-alone-tomcat-server">Running a stand alone Tomcat server</h3> +<h3 id="running-a-stand-alone-tomcat-server">Running a stand alone Tomcat server<a class="headerlink" href="#running-a-stand-alone-tomcat-server" title="Permanent link">¶</a></h3> <p>A common location to set the system properties is in tomcat/bin/setenv.sh. Add a variable <code>RAVE_OPTS</code></p> -<div class="codehilite"><pre><span class="n">RAVE_OPTS</span><span class="o">=</span><span class="s">"-Dportal.override.properties=/path/to/custom.portal.properties</span> -<span class="s"> -Drave-shindig.override.properties=/path/to/custom.rave.shindig.properties"</span> +<div class="codehilite"><pre><span class="n">RAVE_OPTS</span><span class="p">=</span>"<span class="o">-</span><span class="n">Dportal</span><span class="p">.</span><span class="n">override</span><span class="p">.</span><span class="k">properties</span><span class="p">=</span><span class="o">/</span><span class="n">path</span><span class="o">/</span><span class="n">to</span><span class="o">/</span><span class="n">custom</span><span class="p">.</span><span class="n">portal</span><span class="p">.</span><span class="k">properties</span> + <span class="o">-</span><span class="n">Drave</span><span class="o">-</span><span class="n">shindig</span><span class="p">.</span><span class="n">override</span><span class="p">.</span><span class="k">properties</span><span class="p">=</span><span class="o">/</span><span class="n">path</span><span class="o">/</span><span class="n">to</span><span class="o">/</span><span class="n">custom</span><span class="p">.</span><span class="n">rave</span><span class="p">.</span><span class="n">shindig</span><span class="p">.</span><span class="k">properties</span>" </pre></div> Modified: websites/staging/rave/trunk/content/documentation/index.html ============================================================================== --- websites/staging/rave/trunk/content/documentation/index.html (original) +++ websites/staging/rave/trunk/content/documentation/index.html Sun Feb 7 21:02:46 2016 @@ -29,6 +29,7 @@ </head> <body> + <div style="background: red"><h1>2016/02/07 - Apache Rave has been retired. </h1><h2>For more information, please explore the <a href="http://attic.apache.org/";>Attic</a>. </h2></div> <div class="navbar navbar-inverse navbar-fixed-top"> <div class="navbar-inner"> @@ -87,7 +88,18 @@ </header> <section id="content" class="row"> <article class="span12"> - <h2 id="deployments">Deployments</h2> + <style type="text/css"> +/* The following code is added by mdx_elementid.py + It was originally lifted from http://subversion.apache.org/style/site.css */ +/* + * Hide class="elementid-permalink", except when an enclosing heading + * has the :hover property. + */ +.headerlink, .elementid-permalink { + visibility: hidden; +} +h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style> +<h2 id="deployments">Deployments<a class="headerlink" href="#deployments" title="Permanent link">¶</a></h2> <ul> <li><a href="installing.html">Installing</a><ul> <li><a href="host-configuration.html">Host and port configuration</a></li> @@ -99,14 +111,14 @@ </ul> </li> </ul> -<h2 id="customizing"><a href="customizing.html">Customizing</a></h2> +<h2 id="customizing"><a href="customizing.html">Customizing</a><a class="headerlink" href="#customizing" title="Permanent link">¶</a></h2> <ul> <li><a href="rave-extensions.html">Extend Rave to build your own portal</a></li> <li><a href="custom-app-context.html">Adding a custom application context</a></li> <li><a href="custom-widget-renderer.html">Adding a new Widget Renderer</a></li> <li><a href="script-manager.html">Working with the Script Manager</a></li> </ul> -<h2 id="security">Security</h2> +<h2 id="security">Security<a class="headerlink" href="#security" title="Permanent link">¶</a></h2> <ul> <li><a href="security-model-permission.html">Security Model Permission Overview</a></li> <li><a href="new-model-permission-impl.html">How to Implement Permission Security for a New Rave Model Object</a></li> @@ -114,7 +126,7 @@ <li><a href="sso-login.html">How to configure Single Sign-On</a></li> <li><a href="ldap-authentication.html">LDAP Authentication</a></li> </ul> -<h2 id="howto">Howto</h2> +<h2 id="howto">Howto<a class="headerlink" href="#howto" title="Permanent link">¶</a></h2> <ul> <li><a href="oauth-consumer.html">Use Rave as OAuth consumer (OpenSocial)</a></li> <li><a href="custom-gui.html">Customize the look and feel</a></li> @@ -124,7 +136,7 @@ <li><a href="add-page-template.html">Add a New Page Layout</a></li> <li><a href="omdl-import-export.html">Import and Export pages using the OMDL format</a></li> </ul> -<h2 id="portal-administration">Portal administration</h2> +<h2 id="portal-administration">Portal administration<a class="headerlink" href="#portal-administration" title="Permanent link">¶</a></h2> <ul> <li><a href="admin-interface.html">Portal admin interface</a><ul> <li><a href="admin-interface-users.html">Users</a></li> @@ -133,7 +145,7 @@ </ul> </li> </ul> -<h2 id="architecture">Architecture</h2> +<h2 id="architecture">Architecture<a class="headerlink" href="#architecture" title="Permanent link">¶</a></h2> <ul> <li><a href="components.html">Components</a></li> </ul> Modified: websites/staging/rave/trunk/content/documentation/installing.html ============================================================================== --- websites/staging/rave/trunk/content/documentation/installing.html (original) +++ websites/staging/rave/trunk/content/documentation/installing.html Sun Feb 7 21:02:46 2016 @@ -29,6 +29,7 @@ </head> <body> + <div style="background: red"><h1>2016/02/07 - Apache Rave has been retired. </h1><h2>For more information, please explore the <a href="http://attic.apache.org/";>Attic</a>. </h2></div> <div class="navbar navbar-inverse navbar-fixed-top"> <div class="navbar-inner"> @@ -87,9 +88,20 @@ </header> <section id="content" class="row"> <article class="span12"> - <h2 id="download-a-distribution-package">Download a distribution package</h2> + <style type="text/css"> +/* The following code is added by mdx_elementid.py + It was originally lifted from http://subversion.apache.org/style/site.css */ +/* + * Hide class="elementid-permalink", except when an enclosing heading + * has the :hover property. + */ +.headerlink, .elementid-permalink { + visibility: hidden; +} +h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style> +<h2 id="download-a-distribution-package">Download a distribution package<a class="headerlink" href="#download-a-distribution-package" title="Permanent link">¶</a></h2> <p>Releases of Apache Rave are available for <a href="../downloads.html">download</a>. </p> -<h2 id="build-a-distribution-package">Build a distribution package</h2> +<h2 id="build-a-distribution-package">Build a distribution package<a class="headerlink" href="#build-a-distribution-package" title="Permanent link">¶</a></h2> <p>To build your own distribution with default settings follow these steps:</p> <ul> <li>Get the <a href="../source.html">source</a></li> @@ -98,32 +110,32 @@ <p><code>$ mvn -Pdist</code></p> </li> </ul> -<h2 id="deploy-the-distribution">Deploy the distribution</h2> +<h2 id="deploy-the-distribution">Deploy the distribution<a class="headerlink" href="#deploy-the-distribution" title="Permanent link">¶</a></h2> <p>In the directory rave-portal/target you can find the rave-<version>-bin.tar.gz and rave-<version>-bin.zip file that contains the full Apache Tomcat 6 installation. The contents of these archives are identical. Unpack one of these archives on your server and go to the Tomcat directory in the console or command prompt.</p> -<h3 id="start-tomcat">Start Tomcat</h3> +<h3 id="start-tomcat">Start Tomcat<a class="headerlink" href="#start-tomcat" title="Permanent link">¶</a></h3> <p>Unix</p> -<div class="codehilite"><pre><span class="nv">$</span> <span class="err">./</span><span class="nv">bin</span><span class="o">/</span><span class="n">startup</span><span class="o">.</span><span class="n">sh</span> +<div class="codehilite"><pre>$ <span class="o">./</span><span class="n">bin</span><span class="o">/</span><span class="n">startup</span><span class="p">.</span><span class="n">sh</span> </pre></div> <p>Windows</p> -<div class="codehilite"><pre><span class="o">></span> <span class="n">bin</span><span class="o">\</span><span class="n">startup</span><span class="o">.</span><span class="n">bat</span> +<div class="codehilite"><pre><span class="o">></span> <span class="n">bin</span><span class="o">\</span><span class="n">startup</span><span class="p">.</span><span class="n">bat</span> </pre></div> -<h2 id="visit-the-portal">Visit the portal</h2> +<h2 id="visit-the-portal">Visit the portal<a class="headerlink" href="#visit-the-portal" title="Permanent link">¶</a></h2> <p>Open url <a href="http://localhost:8080/portal";>http://localhost:8080/portal</a> in a browser.</p> -<h3 id="stop-tomcat">Stop Tomcat</h3> +<h3 id="stop-tomcat">Stop Tomcat<a class="headerlink" href="#stop-tomcat" title="Permanent link">¶</a></h3> <p>Unix</p> -<div class="codehilite"><pre><span class="nv">$</span> <span class="err">./</span><span class="nv">bin</span><span class="o">/</span><span class="nb">shutdown</span><span class="o">.</span><span class="n">sh</span> +<div class="codehilite"><pre>$ <span class="o">./</span><span class="n">bin</span><span class="o">/</span><span class="n">shutdown</span><span class="p">.</span><span class="n">sh</span> </pre></div> <p>Windows</p> -<div class="codehilite"><pre><span class="o">></span> <span class="n">bin</span><span class="o">\</span><span class="nb">shutdown</span><span class="o">.</span><span class="n">bat</span> +<div class="codehilite"><pre><span class="o">></span> <span class="n">bin</span><span class="o">\</span><span class="n">shutdown</span><span class="p">.</span><span class="n">bat</span> </pre></div> Modified: websites/staging/rave/trunk/content/documentation/ldap-authentication.html ============================================================================== --- websites/staging/rave/trunk/content/documentation/ldap-authentication.html (original) +++ websites/staging/rave/trunk/content/documentation/ldap-authentication.html Sun Feb 7 21:02:46 2016 @@ -29,6 +29,7 @@ </head> <body> + <div style="background: red"><h1>2016/02/07 - Apache Rave has been retired. </h1><h2>For more information, please explore the <a href="http://attic.apache.org/";>Attic</a>. </h2></div> <div class="navbar navbar-inverse navbar-fixed-top"> <div class="navbar-inner"> @@ -87,22 +88,33 @@ </header> <section id="content" class="row"> <article class="span12"> - <p>The authentication in the Apache Rave portal is handled through Spring Security. + <style type="text/css"> +/* The following code is added by mdx_elementid.py + It was originally lifted from http://subversion.apache.org/style/site.css */ +/* + * Hide class="elementid-permalink", except when an enclosing heading + * has the :hover property. + */ +.headerlink, .elementid-permalink { + visibility: hidden; +} +h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style> +<p>The authentication in the Apache Rave portal is handled through Spring Security. The supported login mechanisms are currently basic authentication with users stored in the database, OpenId and, since version 0.8-incubating, LDAP.</p> <p>When an LDAP user logs in for the first time in the Apache Rave portal, a user profile in the portal is created with the same username, email address and display name as in the LDAP. When this user logs in again, he is still authenticated against the LDAP server.</p> -<h2 id="demo-login">Demo login</h2> +<h2 id="demo-login">Demo login<a class="headerlink" href="#demo-login" title="Permanent link">¶</a></h2> <p>For the LDAP authentication the demo setup comes with an embedded ApacheDS. To login with the demo setup the following credentials can be used:</p> <ul> <li>johnldap/johnldap</li> <li>janeldap/janeldap</li> </ul> -<h2 id="ldap-configuration">LDAP configuration</h2> +<h2 id="ldap-configuration">LDAP configuration<a class="headerlink" href="#ldap-configuration" title="Permanent link">¶</a></h2> <p>The demo setup of the Apache Rave portal is configured to use an embedded ApacheDS, populated by a users.ldiff file:</p> -<div class="codehilite"><pre><span class="o"><</span><span class="n">security:ldap</span><span class="o">-</span><span class="n">server</span> <span class="n">ldif</span><span class="o">=</span><span class="s">"classpath:users.ldiff"</span> <span class="n">root</span><span class="o">=</span><span class="s">"dc=rave,dc=apache,dc=org"</span> <span class="o">/></span> +<div class="codehilite"><pre><span class="o"><</span><span class="n">security</span><span class="p">:</span><span class="n">ldap</span><span class="o">-</span><span class="n">server</span> <span class="n">ldif</span><span class="p">=</span>"<span class="n">classpath</span><span class="p">:</span><span class="n">users</span><span class="p">.</span><span class="n">ldiff</span>" <span class="n">root</span><span class="p">=</span>"<span class="n">dc</span><span class="p">=</span><span class="n">rave</span><span class="p">,</span><span class="n">dc</span><span class="p">=</span><span class="n">apache</span><span class="p">,</span><span class="n">dc</span><span class="p">=</span><span class="n">org</span>" <span class="o">/></span> </pre></div> @@ -138,11 +150,11 @@ database:</p> <p>With "mailAttributeName" and "displayNameAttributeName" you can configure the names of the attributes from your own LDAP that contain the mail address and display name for a user. When the LdapUserDetailsContextMapper create a user profile, the user gets access to the portal and gets the layout configured in "pageLayoutCode".</p> -<h2 id="customizing-the-ldap-setup">Customizing the LDAP setup</h2> +<h2 id="customizing-the-ldap-setup">Customizing the LDAP setup<a class="headerlink" href="#customizing-the-ldap-setup" title="Permanent link">¶</a></h2> <p>First create a custom portal project. There are multiple ways to build your custom Apache Rave instance, but the quickest is to use a Maven WAR overlay. See <a href="rave-extensions.html">Extending Rave</a> for an example overlay.</p> <p>For the LDAP configuration, the default applicationContext-security.xml needs to be overridden.</p> -<h3 id="ldap-as-only-authentication-provider">LDAP as only authentication provider</h3> +<h3 id="ldap-as-only-authentication-provider">LDAP as only authentication provider<a class="headerlink" href="#ldap-as-only-authentication-provider" title="Permanent link">¶</a></h3> <p>If you don't want the fallback to the database for authentication, remove:</p> <div class="codehilite"><pre><span class="nt"><security:authentication-provider</span> <span class="na">user-service-ref=</span><span class="s">"userService"</span><span class="nt">></span> <span class="nt"><security:password-encoder</span> <span class="na">ref=</span><span class="s">"passwordEncoder"</span><span class="nt">/></span> @@ -150,16 +162,16 @@ use a Maven WAR overlay. See <a href="ra </pre></div> -<h3 id="external-ldap-server">External LDAP server</h3> +<h3 id="external-ldap-server">External LDAP server<a class="headerlink" href="#external-ldap-server" title="Permanent link">¶</a></h3> <p>The following line is configured to use the embedded ApacheDS:</p> -<div class="codehilite"><pre><span class="o"><</span><span class="n">security:ldap</span><span class="o">-</span><span class="n">server</span> <span class="n">ldif</span><span class="o">=</span><span class="s">"classpath:users.ldiff"</span> <span class="n">root</span><span class="o">=</span><span class="s">"dc=rave,dc=apache,dc=org"</span> <span class="o">/></span> +<div class="codehilite"><pre><span class="o"><</span><span class="n">security</span><span class="p">:</span><span class="n">ldap</span><span class="o">-</span><span class="n">server</span> <span class="n">ldif</span><span class="p">=</span>"<span class="n">classpath</span><span class="p">:</span><span class="n">users</span><span class="p">.</span><span class="n">ldiff</span>" <span class="n">root</span><span class="p">=</span>"<span class="n">dc</span><span class="p">=</span><span class="n">rave</span><span class="p">,</span><span class="n">dc</span><span class="p">=</span><span class="n">apache</span><span class="p">,</span><span class="n">dc</span><span class="p">=</span><span class="n">org</span>" <span class="o">/></span> </pre></div> <p>To use an external LDAP server, replace it with:</p> -<div class="codehilite"><pre><span class="o"><</span><span class="n">ldap</span><span class="o">-</span><span class="n">server</span> <span class="n">id</span><span class="o">=</span><span class="s">"appLdapServer"</span> - <span class="n">url</span><span class="o">=</span><span class="s">"ldap://myldap.example.com:389/dc=example,dc=com"</span> - <span class="n">manager</span><span class="o">-</span><span class="n">dn</span><span class="o">=</span><span class="s">"uid=admin,ou=system"</span> <span class="n">manager</span><span class="o">-</span><span class="n">password</span><span class="o">=</span><span class="s">"secret"</span> <span class="o">/></span> +<div class="codehilite"><pre><span class="o"><</span><span class="n">ldap</span><span class="o">-</span><span class="n">server</span> <span class="n">id</span><span class="p">=</span>"<span class="n">appLdapServer</span>" + <span class="n">url</span><span class="p">=</span>"<span class="n">ldap</span><span class="p">:</span><span class="o">//</span><span class="n">myldap</span><span class="p">.</span><span class="n">example</span><span class="p">.</span><span class="n">com</span><span class="p">:</span>389<span class="o">/</span><span class="n">dc</span><span class="p">=</span><span class="n">example</span><span class="p">,</span><span class="n">dc</span><span class="p">=</span><span class="n">com</span>" + <span class="n">manager</span><span class="o">-</span><span class="n">dn</span><span class="p">=</span>"<span class="n">uid</span><span class="p">=</span><span class="n">admin</span><span class="p">,</span><span class="n">ou</span><span class="p">=</span><span class="n">system</span>" <span class="n">manager</span><span class="o">-</span><span class="n">password</span><span class="p">=</span>"<span class="n">secret</span>" <span class="o">/></span> </pre></div> @@ -189,7 +201,7 @@ Add a a bean for the configuration of Ac </bean> --> -<h2 id="reference">Reference</h2> +<h2 id="reference">Reference<a class="headerlink" href="#reference" title="Permanent link">¶</a></h2> <ul> <li><a href="http://static.springsource.org/spring-security/site/docs/3.1.x/reference/ldap.html";>Spring Security LDAP documentation</a></li> <li><a href="http://directory.apache.org/apacheds/1.5/";>ApacheDS</a> Modified: websites/staging/rave/trunk/content/documentation/manage-static-resources.html ============================================================================== --- websites/staging/rave/trunk/content/documentation/manage-static-resources.html (original) +++ websites/staging/rave/trunk/content/documentation/manage-static-resources.html Sun Feb 7 21:02:46 2016 @@ -29,6 +29,7 @@ </head> <body> + <div style="background: red"><h1>2016/02/07 - Apache Rave has been retired. </h1><h2>For more information, please explore the <a href="http://attic.apache.org/";>Attic</a>. </h2></div> <div class="navbar navbar-inverse navbar-fixed-top"> <div class="navbar-inner"> @@ -87,9 +88,19 @@ </header> <section id="content" class="row"> <article class="span12"> - <p>Apache Rave uses <a href="http://code.google.com/p/wro4j/";>wro4j</a>, specifically the wro4j-maven-plugin, to optimize JavaScript. At build time it uses Google Closure Compiler to concatenate and minify all of the individual Rave javascript files into one file called rave_all.min.js</p> -<p>All of the original JavaScript files, along with the minified version, are bundled into the WAR. During run-time Rave uses a Portal Preference to determine if it should serve out the individual source files, or the single optimized file. By default, for ease of debugging, Rave serves out the individual scripts. Rave admins can change the Portal Preference, called javaScriptDebugMode, to "Disabled" if they want to serve out the optimized file (recommended for production installations).<br /> -</p> + <style type="text/css"> +/* The following code is added by mdx_elementid.py + It was originally lifted from http://subversion.apache.org/style/site.css */ +/* + * Hide class="elementid-permalink", except when an enclosing heading + * has the :hover property. + */ +.headerlink, .elementid-permalink { + visibility: hidden; +} +h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style> +<p>Apache Rave uses <a href="http://code.google.com/p/wro4j/";>wro4j</a>, specifically the wro4j-maven-plugin, to optimize JavaScript. At build time it uses Google Closure Compiler to concatenate and minify all of the individual Rave javascript files into one file called rave_all.min.js</p> +<p>All of the original JavaScript files, along with the minified version, are bundled into the WAR. During run-time Rave uses a Portal Preference to determine if it should serve out the individual source files, or the single optimized file. By default, for ease of debugging, Rave serves out the individual scripts. Rave admins can change the Portal Preference, called javaScriptDebugMode, to "Disabled" if they want to serve out the optimized file (recommended for production installations). </p> <p>Like all other Portal Preferences, changes are effective immediately, making it useful when you need to debug an issue in a production environment. </p> <p><em>Settings</em></p> <p>Out-of-the box Rave has configured <a href="http://code.google.com/p/wro4j/";>wro4j</a> to use Google Closure Compiler with SIMPLE_OPTIMIZATIONS. If you would like to change the JavaScript Processor to use ADVANCED_OPTIMIZATIONS, or another library all-together (such as YUI Compressor), you can overlay the wro.properties file located in rave-portal-resources and modify the postProcessors. See the <a href="http://code.google.com/p/wro4j/";>wro4j</a> website for more information.</p> Modified: websites/staging/rave/trunk/content/documentation/model-permission-override.html ============================================================================== --- websites/staging/rave/trunk/content/documentation/model-permission-override.html (original) +++ websites/staging/rave/trunk/content/documentation/model-permission-override.html Sun Feb 7 21:02:46 2016 @@ -29,6 +29,7 @@ </head> <body> + <div style="background: red"><h1>2016/02/07 - Apache Rave has been retired. </h1><h2>For more information, please explore the <a href="http://attic.apache.org/";>Attic</a>. </h2></div> <div class="navbar navbar-inverse navbar-fixed-top"> <div class="navbar-inner"> @@ -87,20 +88,31 @@ </header> <section id="content" class="row"> <article class="span12"> - <p>Click <a href="rave-extensions.html">here</a> first on how to extend Rave.</p> + <style type="text/css"> +/* The following code is added by mdx_elementid.py + It was originally lifted from http://subversion.apache.org/style/site.css */ +/* + * Hide class="elementid-permalink", except when an enclosing heading + * has the :hover property. + */ +.headerlink, .elementid-permalink { + visibility: hidden; +} +h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style> +<p>Click <a href="rave-extensions.html">here</a> first on how to extend Rave.</p> <p>If you would like to override any of the various Default[ModelName]PermissionEvaluator classes supplied by Rave, it is easy to do. For example, say you wanted to create your own ModelPermissionEvaluator for Page objects:</p> <p>1) Create a class that extends AbstractModelPermissionEvaluator<Page>, such as CustomPagePermissionEvaluator, and make sure it is annotated as a Spring component:</p> -<div class="codehilite"><pre><span class="nv">@Component</span> -<span class="n">public</span> <span class="n">class</span> <span class="n">CustomPagePermissionEvaluator</span> <span class="n">extends</span> <span class="n">AbstractModelPermissionEvaluator</span><span class="sr"><Page></span> <span class="p">{</span> <span class="o">...</span> <span class="p">}</span> +<div class="codehilite"><pre><span class="p">@</span><span class="n">Component</span> +<span class="n">public</span> <span class="n">class</span> <span class="n">CustomPagePermissionEvaluator</span> <span class="n">extends</span> <span class="n">AbstractModelPermissionEvaluator</span><span class="o"><</span><span class="n">Page</span><span class="o">></span> <span class="p">{</span> <span class="p">...</span> <span class="p">}</span> </pre></div> <p>2) Implement getType() to return Page.class</p> <p>3) Override both hasPermission signature methods with your custom permission logic</p> <p>4) Override the getLoadOrder function to return a larger number than 1. This is important as it will make the RavePermissionEvaluator register your custom implementation for the Page object instead of the default ModelPermissionEvaluator for the Page object.</p> -<div class="codehilite"><pre><span class="nv">@Override</span> -<span class="n">public</span> <span class="nb">int</span> <span class="n">getLoadOrder</span><span class="p">()</span> <span class="p">{</span> - <span class="k">return</span> <span class="n">super</span><span class="o">.</span><span class="n">getLoadOrder</span><span class="p">()</span> <span class="o">+</span> <span class="mi">1</span><span class="p">;</span> +<div class="codehilite"><pre><span class="p">@</span><span class="n">Override</span> +<span class="n">public</span> <span class="n">int</span> <span class="n">getLoadOrder</span><span class="p">()</span> <span class="p">{</span> + <span class="k">return</span> <span class="n">super</span><span class="p">.</span><span class="n">getLoadOrder</span><span class="p">()</span> <span class="o">+</span> 1<span class="p">;</span> <span class="p">}</span> </pre></div> Modified: websites/staging/rave/trunk/content/documentation/mongo-db.html ============================================================================== --- websites/staging/rave/trunk/content/documentation/mongo-db.html (original) +++ websites/staging/rave/trunk/content/documentation/mongo-db.html Sun Feb 7 21:02:46 2016 @@ -29,6 +29,7 @@ </head> <body> + <div style="background: red"><h1>2016/02/07 - Apache Rave has been retired. </h1><h2>For more information, please explore the <a href="http://attic.apache.org/";>Attic</a>. </h2></div> <div class="navbar navbar-inverse navbar-fixed-top"> <div class="navbar-inner"> @@ -87,18 +88,28 @@ </header> <section id="content" class="row"> <article class="span12"> - <p>As of 0.19, Rave has a <a href="http://www.mongodb.org";>MongoDB</a> module that provides implementations for all of Rave's repository interfaces; thus providing support for MongoDB.<br /> -</p> -<h1 id="using-mongodb-for-persistence">Using MongoDB for Persistence</h1> + <style type="text/css"> +/* The following code is added by mdx_elementid.py + It was originally lifted from http://subversion.apache.org/style/site.css */ +/* + * Hide class="elementid-permalink", except when an enclosing heading + * has the :hover property. + */ +.headerlink, .elementid-permalink { + visibility: hidden; +} +h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style> +<p>As of 0.19, Rave has a <a href="http://www.mongodb.org";>MongoDB</a> module that provides implementations for all of Rave's repository interfaces; thus providing support for MongoDB. </p> +<h1 id="using-mongodb-for-persistence">Using MongoDB for Persistence<a class="headerlink" href="#using-mongodb-for-persistence" title="Permanent link">¶</a></h1> <p>JPA remains the primary supported data access method in the rave-portal & rave-portal-resources projects; but can be easily replaced with MongoDB using the following techniques:</p> -<h2 id="build-from-source">Build from source</h2> +<h2 id="build-from-source">Build from source<a class="headerlink" href="#build-from-source" title="Permanent link">¶</a></h2> <p>To build a MongoDB version of the demo binaries follow these steps:</p> <ol> <li>Obtain the source from the <a href="/downloads.html">downloads</a> or from <a href="/source.html">Source Control</a></li> <li>From the project root directory execute: <code>mvn install -Pmongodb</code></li> </ol> <p>The rave-portal, rave-portal-resources & rave-shindig wars created by this process contain everything needed to run Rave with MongoDB persistence. See <a href="#configure">configuring MongoDB</a> for information on how to set the database properties.</p> -<h2 id="custom-rave-extension">Custom Rave Extension</h2> +<h2 id="custom-rave-extension">Custom Rave Extension<a class="headerlink" href="#custom-rave-extension" title="Permanent link">¶</a></h2> <p>In a custom build that depends on rave-jpa directly, the only thing that needs to be done is to replace the rave-jpa dependency with rave-mongodb.</p> <p>If the custom application depends on JPA indirectly, via a dependency on rave-portal-dependencies, add an exclusion of rave-jpa to rave-portal-dependencies as follows:</p> <div class="codehilite"><pre> <span class="nt"><dependency></span> @@ -120,7 +131,7 @@ <p>Configure the properties files for portal & shindig as described in <a href="#configure">configuring MongoDB</a></p> -<h2 id="demo-binaries">Demo Binaries</h2> +<h2 id="demo-binaries">Demo Binaries<a class="headerlink" href="#demo-binaries" title="Permanent link">¶</a></h2> <p>To replace the JPA implementation with Mongo in an extracted demo binary or other packaged Rave instance, take the following steps. This method is <strong>NOT</strong> recommended for production deployments. The preferred method is to modify a custom extension, or build, of Rave to as noted above:</p> <ol> <li>Start the demo binary as normal to allow it to extract the war archives</li> @@ -128,17 +139,17 @@ <li>Configure the properties files located in webapps/portal/WEB-INF/classes & webapps/ROOT/WEB-INF/classes per <a href="#configure">configuring MongoDB</a> </li> </ol> <p><a name="configure"> </a></p> -<h2 id="configuring-mongodb">Configuring MongoDB</h2> +<h2 id="configuring-mongodb">Configuring MongoDB<a class="headerlink" href="#configuring-mongodb" title="Permanent link">¶</a></h2> <p>Both portal.properties & rave.shindig.properties have entries for connecting to MongoDB. </p> -<div class="codehilite"><pre><span class="n">mongo</span><span class="o">.</span><span class="n">host</span><span class="o">=</span><span class="n">localhost</span> -<span class="n">mongo</span><span class="o">.</span><span class="n">port</span><span class="o">=</span><span class="mi">27017</span> -<span class="n">mongo</span><span class="o">.</span><span class="n">database</span><span class="o">=</span><span class="n">rave</span> -<span class="n">mongo</span><span class="o">.</span><span class="n">username</span><span class="o">=</span> -<span class="n">mongo</span><span class="o">.</span><span class="n">password</span><span class="o">=</span> +<div class="codehilite"><pre><span class="n">mongo</span><span class="p">.</span><span class="n">host</span><span class="p">=</span><span class="n">localhost</span> +<span class="n">mongo</span><span class="p">.</span><span class="n">port</span><span class="p">=</span>27017 +<span class="n">mongo</span><span class="p">.</span><span class="n">database</span><span class="p">=</span><span class="n">rave</span> +<span class="n">mongo</span><span class="p">.</span><span class="n">username</span><span class="p">=</span> +<span class="n">mongo</span><span class="p">.</span><span class="n">password</span><span class="p">=</span> </pre></div> -<h1 id="architecture">Architecture</h1> +<h1 id="architecture">Architecture<a class="headerlink" href="#architecture" title="Permanent link">¶</a></h1> <p>Rave leverages Spring Data MongoDB to simplify interactions with the MongoDB database using the <a href="http://static.springsource.org/spring-data/mongodb/docs/current/api/org/springframework/data/mongodb/core/MongoOperations.html";>MongoOperations</a> model serialization pattern. One the the primary benefits of using MongoDB for Rave persistence is that entire object hierarchies can be deserialized from the database in a single call. For example, rather than making a call to the database for a Page object, its Regions and RegionWidgets, we can now just deserialize the entire page in one call. Since Rave currently has repositories for many of the sub-components of a hierarchy, we needed a way to access the same object type from multiple repositories. This lead to the following component architecture:</p> <div class="codehilite"><pre><span class="o">|</span><span class="n">_</span> <span class="n">Rave</span> <span class="n">MongoDB</span> <span class="n">repository</span> <span class="n">implementations</span> <span class="o">|</span> Modified: websites/staging/rave/trunk/content/documentation/new-model-permission-impl.html ============================================================================== --- websites/staging/rave/trunk/content/documentation/new-model-permission-impl.html (original) +++ websites/staging/rave/trunk/content/documentation/new-model-permission-impl.html Sun Feb 7 21:02:46 2016 @@ -29,6 +29,7 @@ </head> <body> + <div style="background: red"><h1>2016/02/07 - Apache Rave has been retired. </h1><h2>For more information, please explore the <a href="http://attic.apache.org/";>Attic</a>. </h2></div> <div class="navbar navbar-inverse navbar-fixed-top"> <div class="navbar-inner"> @@ -87,7 +88,18 @@ </header> <section id="content" class="row"> <article class="span12"> - <p><em>This how-to is targeted to Rave committers/contributors who have created a completely new model object in Rave and want to implement permission security on it. + <style type="text/css"> +/* The following code is added by mdx_elementid.py + It was originally lifted from http://subversion.apache.org/style/site.css */ +/* + * Hide class="elementid-permalink", except when an enclosing heading + * has the :hover property. + */ +.headerlink, .elementid-permalink { + visibility: hidden; +} +h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style> +<p><em>This how-to is targeted to Rave committers/contributors who have created a completely new model object in Rave and want to implement permission security on it. For third-party developers that are customizing Rave and are interested in overriding the default ModelPermissionEvaluator for an existing Rave model, see <a href="model-permission-override.html">this</a></em></p> <p>1) Create a new Default[ModelName]PermissionEvaluator class in org.apache.rave.portal.security.impl under rave-core.</p> <blockquote> Modified: websites/staging/rave/trunk/content/documentation/oauth-consumer.html ============================================================================== --- websites/staging/rave/trunk/content/documentation/oauth-consumer.html (original) +++ websites/staging/rave/trunk/content/documentation/oauth-consumer.html Sun Feb 7 21:02:46 2016 @@ -29,6 +29,7 @@ </head> <body> + <div style="background: red"><h1>2016/02/07 - Apache Rave has been retired. </h1><h2>For more information, please explore the <a href="http://attic.apache.org/";>Attic</a>. </h2></div> <div class="navbar navbar-inverse navbar-fixed-top"> <div class="navbar-inner"> @@ -87,22 +88,33 @@ </header> <section id="content" class="row"> <article class="span12"> - <p>After following the instructions, you will be able to use Rave as an OAuth consumer. You will add an OpenSocial Gadget + <style type="text/css"> +/* The following code is added by mdx_elementid.py + It was originally lifted from http://subversion.apache.org/style/site.css */ +/* + * Hide class="elementid-permalink", except when an enclosing heading + * has the :hover property. + */ +.headerlink, .elementid-permalink { + visibility: hidden; +} +h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style> +<p>After following the instructions, you will be able to use Rave as an OAuth consumer. You will add an OpenSocial Gadget that displays your Google Contacts, using Google as OAuth provider.</p> -<h2 id="place-the-gadget-definition-on-your-server">Place the gadget definition on your server</h2> +<h2 id="place-the-gadget-definition-on-your-server">Place the gadget definition on your server<a class="headerlink" href="#place-the-gadget-definition-on-your-server" title="Permanent link">¶</a></h2> <p>Place the <a href="http://gadget-doc-examples.googlecode.com/svn/trunk/opensocial-gadgets/oauth-contacts.xml";>example OAuth Gadget</a> on your <em>own</em> public server. Make sure that the gadget is accessible without any restrictions.</p> -<h2 id="register-your-web-application">Register your web application</h2> +<h2 id="register-your-web-application">Register your web application<a class="headerlink" href="#register-your-web-application" title="Permanent link">¶</a></h2> <p>Follow <a href="http://code.google.com/apis/accounts/docs/RegistrationForWebAppsAuto.html";>Google's instructions</a> to register your domain for OAuth Authentication. You will create an OAuth consumer key and secret.</p> -<h2 id="add-the-oauth-consumer-key-and-secret-to-the-rave-database">Add the OAuth consumer key and secret to the Rave database</h2> +<h2 id="add-the-oauth-consumer-key-and-secret-to-the-rave-database">Add the OAuth consumer key and secret to the Rave database<a class="headerlink" href="#add-the-oauth-consumer-key-and-secret-to-the-rave-database" title="Permanent link">¶</a></h2> <p>Until there is a web interface to handle the contents of the database, modify and execute the following query:</p> -<div class="codehilite"><pre><span class="n">SET</span> <span class="nv">@consumer_store_id_oauth</span> <span class="o">=</span> <span class="p">(</span><span class="n">SELECT</span> <span class="n">seq_count</span> <span class="n">FROM</span> <span class="n">RAVE_SHINDIG_SEQUENCES</span> <span class="n">WHERE</span> <span class="n">seq_name</span> <span class="o">=</span> <span class="s">'oauth_consumer_store'</span><span class="p">);</span> +<div class="codehilite"><pre><span class="n">SET</span> <span class="p">@</span><span class="n">consumer_store_id_oauth</span> <span class="p">=</span> <span class="p">(</span><span class="n">SELECT</span> <span class="n">seq_count</span> <span class="n">FROM</span> <span class="n">RAVE_SHINDIG_SEQUENCES</span> <span class="n">WHERE</span> <span class="n">seq_name</span> <span class="p">=</span> <span class="s">'oauth_consumer_store'</span><span class="p">);</span> <span class="n">INSERT</span> <span class="n">INTO</span> <span class="n">oauth_consumer_store</span><span class="p">(</span><span class="n">entity_id</span><span class="p">,</span> <span class="n">gadget_uri</span><span class="p">,</span> <span class="n">service_name</span><span class="p">,</span> <span class="n">consumer_key</span><span class="p">,</span> <span class="n">consumer_secret</span><span class="p">,</span> <span class="n">key_type</span><span class="p">)</span> -<span class="n">VALUES</span> <span class="p">(</span><span class="nv">@consumer_store_id_oauth</span><span class="p">,</span> +<span class="n">VALUES</span> <span class="p">(@</span><span class="n">consumer_store_id_oauth</span><span class="p">,</span> <span class="s">'http://example.com/sampleoauth.xml'</span><span class="p">,</span> <span class="s">'google'</span><span class="p">,</span> <span class="s">'gadgetConsumer'</span><span class="p">,</span> <span class="s">'gadgetSecret'</span><span class="p">,</span> <span class="s">'HMAC_SYMMETRIC'</span><span class="p">);</span> -<span class="n">UPDATE</span> <span class="n">RAVE_SHINDIG_SEQUENCES</span> <span class="n">SET</span> <span class="n">seq_count</span> <span class="o">=</span> <span class="p">(</span><span class="n">seq_count</span> <span class="o">+</span> <span class="mi">1</span><span class="p">)</span> <span class="n">WHERE</span> <span class="n">seq_name</span> <span class="o">=</span> <span class="s">'oauth_consumer_store'</span><span class="p">;</span> +<span class="n">UPDATE</span> <span class="n">RAVE_SHINDIG_SEQUENCES</span> <span class="n">SET</span> <span class="n">seq_count</span> <span class="p">=</span> <span class="p">(</span><span class="n">seq_count</span> <span class="o">+</span> 1<span class="p">)</span> <span class="n">WHERE</span> <span class="n">seq_name</span> <span class="p">=</span> <span class="s">'oauth_consumer_store'</span><span class="p">;</span> </pre></div> @@ -113,7 +125,7 @@ your domain for OAuth Authentication. Yo <li>consumer_secret: the shared secret between the OAuth consumer (Apache Rave) and OAuth provider</li> <li>key_type: allowed values are "HMAC_SYMMETRIC", "RSA_PRIVATE" and "PLAINTEXT"</li> </ul> -<h2 id="add-your-widget-to-the-apache-rave-portal">Add your Widget to the Apache Rave portal</h2> +<h2 id="add-your-widget-to-the-apache-rave-portal">Add your Widget to the Apache Rave portal<a class="headerlink" href="#add-your-widget-to-the-apache-rave-portal" title="Permanent link">¶</a></h2> <ul> <li>Go to the widget store</li> <li>Click on "Add new widget"</li> @@ -121,7 +133,7 @@ your domain for OAuth Authentication. Yo <li>Go to the admin interface (in the demo setup the 'canonical' user has admin privileges)</li> <li>Find the new widget and change its status from "preview" to "published"</li> </ul> -<h2 id="use-the-widget">Use the Widget</h2> +<h2 id="use-the-widget">Use the Widget<a class="headerlink" href="#use-the-widget" title="Permanent link">¶</a></h2> <ul> <li>Go to the Widget Store and add the "Google Contacts" gadget.</li> <li>Then go back to your page.<ul> Modified: websites/staging/rave/trunk/content/documentation/omdl-import-export.html ============================================================================== --- websites/staging/rave/trunk/content/documentation/omdl-import-export.html (original) +++ websites/staging/rave/trunk/content/documentation/omdl-import-export.html Sun Feb 7 21:02:46 2016 @@ -29,6 +29,7 @@ </head> <body> + <div style="background: red"><h1>2016/02/07 - Apache Rave has been retired. </h1><h2>For more information, please explore the <a href="http://attic.apache.org/";>Attic</a>. </h2></div> <div class="navbar navbar-inverse navbar-fixed-top"> <div class="navbar-inner"> @@ -87,20 +88,31 @@ </header> <section id="content" class="row"> <article class="span12"> - <p>The <a href="http://omdl.org";>Open Mashup Description Language</a> is a specification designed to allow the import and export of pages, + <style type="text/css"> +/* The following code is added by mdx_elementid.py + It was originally lifted from http://subversion.apache.org/style/site.css */ +/* + * Hide class="elementid-permalink", except when an enclosing heading + * has the :hover property. + */ +.headerlink, .elementid-permalink { + visibility: hidden; +} +h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style> +<p>The <a href="http://omdl.org";>Open Mashup Description Language</a> is a specification designed to allow the import and export of pages, layouts and widgets between different applications. The goal is to be able to export page data from one application (such as Apache Rave) and then import that information into another application or portal. Please read the specification for more information.</p> -<h2 id="enabling-omdl-features-in-raves-user-interface">Enabling OMDL features in Raves user interface</h2> +<h2 id="enabling-omdl-features-in-raves-user-interface">Enabling OMDL features in Raves user interface<a class="headerlink" href="#enabling-omdl-features-in-raves-user-interface" title="Permanent link">¶</a></h2> <p>Rave supports both import and export of OMDL pages in an xml file format. To access the user interface elements for this, you must first update the following setting found in portal.properties, and then restart Rave.</p> -<div class="codehilite"><pre><span class="n">portal</span><span class="o">.</span><span class="n">export</span><span class="o">.</span><span class="n">ui</span><span class="o">.</span><span class="n">enable</span><span class="o">=</span><span class="n">true</span> +<div class="codehilite"><pre><span class="n">portal</span><span class="p">.</span><span class="n">export</span><span class="p">.</span><span class="n">ui</span><span class="p">.</span><span class="n">enable</span><span class="p">=</span><span class="n">true</span> </pre></div> <p>This will add the import and export menu options.</p> -<h2 id="exporting-a-page">Exporting a page</h2> +<h2 id="exporting-a-page">Exporting a page<a class="headerlink" href="#exporting-a-page" title="Permanent link">¶</a></h2> <p>From any existing page in Rave, click the page menu where you should see an "Export page" option. Click this to download the current page as OMDL xml.</p> -<h2 id="importing-a-page">Importing a page</h2> +<h2 id="importing-a-page">Importing a page<a class="headerlink" href="#importing-a-page" title="Permanent link">¶</a></h2> <p>Click the plus icon. (The icon appears next to your list of pages in Rave) This should open a tabbed dialog box where you can add a new page as normal, but also now choose to upload an OMDL xml file. (You can upload the page you previously exported, to see the results) Once the page has been imported, you should see the same page view as the original with all of the widgets also visible.</p>
