Author: jasha
Date: Mon Mar 26 18:46:51 2012
New Revision: 1305487
URL: http://svn.apache.org/viewvc?rev=1305487&view=rev
Log:
RAVE-527 Rave -> Apache Rave
Modified:
rave/site/trunk/content/rave/documentation/admin-interface.mdtext
rave/site/trunk/content/rave/documentation/captcha-enabling.mdtext
rave/site/trunk/content/rave/documentation/configure-database.mdtext
rave/site/trunk/content/rave/documentation/configure-locked-domain.mdtext
rave/site/trunk/content/rave/documentation/configure-ssl.mdtext
rave/site/trunk/content/rave/documentation/custom-app-context.mdtext
rave/site/trunk/content/rave/documentation/custom-gui.mdtext
rave/site/trunk/content/rave/documentation/custom-widget-renderer.mdtext
rave/site/trunk/content/rave/documentation/customizing.mdtext
rave/site/trunk/content/rave/documentation/index.mdtext
rave/site/trunk/content/rave/documentation/installing.mdtext
rave/site/trunk/content/rave/documentation/ldap-authentication.mdtext
rave/site/trunk/content/rave/documentation/model-permission-override.mdtext
rave/site/trunk/content/rave/documentation/new-model-permission-impl.mdtext
rave/site/trunk/content/rave/documentation/oauth-consumer.mdtext
rave/site/trunk/content/rave/documentation/rave-extensions.mdtext
rave/site/trunk/content/rave/documentation/script-manager.mdtext
rave/site/trunk/content/rave/documentation/security-model-permission.mdtext
rave/site/trunk/content/rave/documentation/sso-login.mdtext
rave/site/trunk/content/rave/documentation/translate-portal.mdtext
Modified: rave/site/trunk/content/rave/documentation/admin-interface.mdtext
URL:
http://svn.apache.org/viewvc/rave/site/trunk/content/rave/documentation/admin-interface.mdtext?rev=1305487&r1=1305486&r2=1305487&view=diff
==============================================================================
--- rave/site/trunk/content/rave/documentation/admin-interface.mdtext (original)
+++ rave/site/trunk/content/rave/documentation/admin-interface.mdtext Mon Mar
26 18:46:51 2012
@@ -16,7 +16,7 @@ Notice: Licensed to the Apache Softwa
specific language governing permissions and limitations
under the License.
-The Rave Portal has an admin interface to manage data from [users][1] and
[widgets][2] (version 0.5-INCUBATING).
+The Apache Rave Portal has an admin interface to manage data from [users][1]
and [widgets][2] (version 0.5-INCUBATING).
In the future it may also support manage group data, show portal usage
statistics or change the look and feel of the portal.
## Access the admin interface
Modified: rave/site/trunk/content/rave/documentation/captcha-enabling.mdtext
URL:
http://svn.apache.org/viewvc/rave/site/trunk/content/rave/documentation/captcha-enabling.mdtext?rev=1305487&r1=1305486&r2=1305487&view=diff
==============================================================================
--- rave/site/trunk/content/rave/documentation/captcha-enabling.mdtext
(original)
+++ rave/site/trunk/content/rave/documentation/captcha-enabling.mdtext Mon Mar
26 18:46:51 2012
@@ -16,26 +16,26 @@ Notice: Licensed to the Apache Softwa
specific language governing permissions and limitations
under the License.
-RAVE administrators can optionally enable CAPTCHA protection on the new
account creation page. The steps for doing this in
+Portal administrators can optionally enable CAPTCHA protection on the new
account creation page. The steps for doing this in
the source release are the following:
##1) Get reCAPTCHA Public and Private Keys
You must sign up at the [reCAPTCHA][1] site to obtain public and private key
strings for your host domain. For testing purpose, you
-use ''localhost'' as your domain.
+use `localhost` as your domain.
-##2) Add Keys to RAVE
-Modify the file
''rave-portal-resources/src/main/resources/portal.properties''. Change the
portal.captcha.* properties to
+##2) Add Keys to Apache Rave
+Modify the file `rave-portal-resources/src/main/resources/portal.properties`.
Change the portal.captcha.* properties to
portal.captcha.enabled=true
portal.captcha.key.private=YOUR_PRIVATE_KEY_STRING
portal.captcha.key.public=YOUR_PUBLIC_KEY_STRING
-When building RAVE from source, you should also similarly modify the test
property files
-''rave-components/rave-core/src/test/resources/portal.properties'' and
''rave-portal/src/test/resources/portal.properties'' for
+When building Apache Rave from source, you should also similarly modify the
test property files
+`rave-components/rave-core/src/test/resources/portal.properties` and
`rave-portal/src/test/resources/portal.properties` for
proper build testing.
-##3) Build and Deploy RAVE
-Use ''mvn clean install'' as usual.
+##3) Build and Deploy Apache Rave
+Use `mvn clean install` as usual.
[1]: http://www.google.com/recaptcha/whyrecaptcha
\ No newline at end of file
Modified: rave/site/trunk/content/rave/documentation/configure-database.mdtext
URL:
http://svn.apache.org/viewvc/rave/site/trunk/content/rave/documentation/configure-database.mdtext?rev=1305487&r1=1305486&r2=1305487&view=diff
==============================================================================
--- rave/site/trunk/content/rave/documentation/configure-database.mdtext
(original)
+++ rave/site/trunk/content/rave/documentation/configure-database.mdtext Mon
Mar 26 18:46:51 2012
@@ -17,7 +17,7 @@ Notice: Licensed to the Apache Softwa
under the License.
## Default setup
-In the default setup, Rave uses a file-based [H2 database][1]. Rave and
Shindig run in the same Tomcat server as
+In the default setup, Apache Rave uses a file-based [H2 database][1]. Apache
Rave and Apache Shindig run in the same Apache Tomcat server as
separate web applications but share data, so we use H2's [Automatic Mixed
Mode][2].
### Filling the default database
@@ -43,10 +43,10 @@ When the application is running, the H2
<constructor-arg value="-web,-webPort,11111"/>
</bean>
-Both Rave and Shindig are accessible from the database:
[http://localhost:11111][3]. The default
+Both Apache Rave and Apache Shindig are accessible from the database:
[http://localhost:11111][3]. The default
username is `sa`, password is `local`, and JDBC URL is
`jdbc:h2:file:///tmp/rave_db`. In Windows the JDBC URL is
`jdbc:h2:file://c:/tmp/rave_db` if you run Apache Rave from the c: drive.
-You can change the file location for both databases by editing Rave's top
level pom.xml file. Change the property `rave.database.location` to the desired
+You can change the file location for both databases by editing Apache Rave's
top level pom.xml file. Change the property `rave.database.location` to the
desired
value.
## Setup a different database
@@ -71,7 +71,7 @@ The default portal properties can be fou
</dependency>
#### Properties
-Rave portal:
+Apache Rave portal:
portal.dataSource.url=jdbc:mysql://localhost:3306/rave-portal
portal.dataSource.driver=com.mysql.jdbc.Driver
@@ -82,7 +82,7 @@ Rave portal:
portal.jpaVendorAdapter.databasePlatform=org.apache.openjpa.jdbc.sql.MySQLDictionary
portal.jpaVendorAdapter.database=MYSQL
-Rave Shindig:
+OpenSocial container (Apache Shindig):
rave-shindig.dataSource.url=jdbc:mysql://localhost:3306/rave-shindig
rave-shindig.dataSource.driver=com.mysql.jdbc.Driver
@@ -106,7 +106,7 @@ The DataSourcePopulator uses a single st
</dependency>
#### Properties
-Rave portal:
+Apache Rave portal:
portal.dataSource.url=jdbc:postgresql://localhost:5432/rave-portal
portal.dataSource.driver=org.postgresql.Driver
@@ -117,7 +117,7 @@ Rave portal:
portal.jpaVendorAdapter.databasePlatform=org.apache.openjpa.jdbc.sql.PostgresDictionary
portal.jpaVendorAdapter.database=POSTGRESQL
-Rave Shindig:
+OpenSocial container (Apache Shindig):
rave-shindig.dataSource.url=jdbc:postgresql://localhost:5432/rave-portal
rave-shindig.dataSource.driver=org.postgresql.Driver
@@ -138,7 +138,7 @@ Rave Shindig:
Install the [Oracle JDBC driver][5] in the lib directory of your Apache Tomcat
instance. This driver is not available in a public Maven repository.
#### Properties
-Rave portal:
+Apache Rave portal:
portal.dataSource.url=jdbc:oracle:thin:@localhost:1521:raveportal
portal.dataSource.driver=oracle.jdbc.OracleDriver
@@ -149,7 +149,7 @@ Rave portal:
portal.jpaVendorAdapter.databasePlatform=org.apache.openjpa.jdbc.sql.OracleDictionary
portal.jpaVendorAdapter.database=ORACLE
-Rave Shindig:
+OpenSocial container (Apache Shindig):
rave-shindig.dataSource.url=jdbc:oracle:thin:@localhost:1521:raveportal
rave-shindig.dataSource.driver=oracle.jdbc.OracleDriver
@@ -187,7 +187,7 @@ OpenJPA can create the schema. With help
user_authority_id NUMBER;
col_id NUMBER;
BEGIN
- dbms_output.put_line('RAVE Initialisation script starting');
+ dbms_output.put_line('Apache Rave Initialisation script starting');
BEGIN
dbms_output.put_line('Dropping table RAVE_PORTAL_SEQUENCES');
EXECUTE IMMEDIATE 'DROP TABLE RAVE_PORTAL_SEQUENCES';
Modified:
rave/site/trunk/content/rave/documentation/configure-locked-domain.mdtext
URL:
http://svn.apache.org/viewvc/rave/site/trunk/content/rave/documentation/configure-locked-domain.mdtext?rev=1305487&r1=1305486&r2=1305487&view=diff
==============================================================================
--- rave/site/trunk/content/rave/documentation/configure-locked-domain.mdtext
(original)
+++ rave/site/trunk/content/rave/documentation/configure-locked-domain.mdtext
Mon Mar 26 18:46:51 2012
@@ -1,4 +1,4 @@
-Title: Configuring Shindig Locked Domain Support in Rave
+Title: Configuring Shindig Locked Domain Support in Apache Rave
Notice: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -14,28 +14,28 @@ Notice: Licensed to the Apache Softwa
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
- under the License.Get default Tomcat based Rave installation up and
running.
+ under the License.
## Prerequisites
-To follow these instructions you'll need a working copy of Rave up and running
under Tomcat 6. Please see the [Installing Rave][1] page for instructions on
how to get up and running.
+To follow these instructions you'll need a working copy of Apache Rave up and
running under Tomcat 6. Please see the [Installing Rave][1] page for
instructions on how to get up and running.
-## Enabling Locked Domain Support in Rave
+## Enabling Locked Domain Support in Apache Rave
-These instructions demonstrate how to get Shindig locked domain support up and
running in Rave. Locked domains take advantage of the web browsers
domain-based sandboxing policies to isolate gadgets from each other and the
main container page. The Shindig mailing list is a good source of information
for more details regarding locked domains.
+These instructions demonstrate how to get Apache Shindig locked domain support
up and running in Apache Rave. Locked domains take advantage of the web
browsers domain-based sandboxing policies to isolate gadgets from each other
and the main container page. The Shindig mailing list is a good source of
information for more details regarding locked domains.
-Enabling locked domain support within Rave is achieved via a combination of
DNS and Shindig configuration changes. To fully support locked domain in a
production environment you'll likely need to setup and configure your locked
domain with wildcard DNS (otherwise you'd have to create manual DNS entries for
every single gadget that you want to run on a locked domain). For the purposes
of experimenting with locked domain however just adding entries to the "hosts"
file for the gadgets on a default Rave page should be sufficient. The Shindig
configuration changes required are enabling locked domain support in the top
level Shindig configuration and then configuring the individual Shindig
container via the container.js file.
+Enabling locked domain support within Apache Rave is achieved via a
combination of DNS and Shindig configuration changes. To fully support locked
domain in a production environment you'll likely need to setup and configure
your locked domain with wildcard DNS (otherwise you'd have to create manual DNS
entries for every single gadget that you want to run on a locked domain). For
the purposes of experimenting with locked domain however just adding entries to
the "hosts" file for the gadgets on a default Apache Rave page should be
sufficient. The Shindig configuration changes required are enabling locked
domain support in the top level Shindig configuration and then configuring the
individual Shindig container via the container.js file.
The sample locked domain we'll use here will be "-locked.gadgets.example.com".
-The default locked domain implementation within Shindig generates locked
domain URL's by taking a hash of the gadget specification URL and pre-pending
it onto the configured locked domain suffix. Here are the locked domain
entries that were added to my local "hosts" file to support the default gadgets
on a Rave page at the time this documentation was written:
+The default locked domain implementation within Shindig generates locked
domain URL's by taking a hash of the gadget specification URL and pre-pending
it onto the configured locked domain suffix. Here are the locked domain
entries that were added to my local "hosts" file to support the default gadgets
on an Apache Rave page at the time this documentation was written:
127.0.0.1
v6fvvlv3hm7kt7oj96mug1uvrdke6kpg-locked.gadgets.example.com
127.0.0.1
76r748j1k68i8t7v35r0oakjtb0uvpr3-locked.gadgets.example.com
127.0.0.1
tqfbbnhq7v3nah5ifshpfrg5i9elegum-locked.gadgets.example.com
127.0.0.1
fdtj4i7cslo8149tjpt9778jodkds1is-locked.gadgets.example.com
-For the Shindig configuration changes please refer to the patch generated from
my local changes below. With these changes in place you should be able to fire
up Rave, access the default page as one of the sample users and see the locked
domains being utilized in the gadget iframe URL's.
+For the Shindig configuration changes please refer to the patch generated from
my local changes below. With these changes in place you should be able to fire
up Apache Rave, access the default page as one of the sample users and see the
locked domains being utilized in the gadget iframe URL's.
## Complete diff of modified files follows
Modified: rave/site/trunk/content/rave/documentation/configure-ssl.mdtext
URL:
http://svn.apache.org/viewvc/rave/site/trunk/content/rave/documentation/configure-ssl.mdtext?rev=1305487&r1=1305486&r2=1305487&view=diff
==============================================================================
--- rave/site/trunk/content/rave/documentation/configure-ssl.mdtext (original)
+++ rave/site/trunk/content/rave/documentation/configure-ssl.mdtext Mon Mar 26
18:46:51 2012
@@ -1,4 +1,4 @@
-Title: Configuring Rave for SSL
+Title: Configuring Apache Rave for SSL
Notice: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -14,11 +14,11 @@ Notice: Licensed to the Apache Softwa
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
- under the License.Get default Tomcat based Rave installation up and
running.
+ under the License.
## Prerequisites
-To follow these instructions you'll need a working copy of Rave up and running
under Tomcat 6. Please see the [Installing Rave][1] page for instructions on
how to get up and running.
+To follow these instructions you'll need a working copy of Apache Rave up and
running under Tomcat 6. Please see the [Installing Rave][1] page for
instructions on how to get up and running.
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.
@@ -54,7 +54,7 @@ These instructions demonstrate how to ge
Enter key password for <tomcat>
(RETURN if same as keystore password):
- - 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
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.
+ - 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.
(added the following line above the "call "%EXECUTABLE%" start ..." line)
@@ -70,16 +70,16 @@ These instructions demonstrate how to ge
keystoreFile="c:\temp\tomcat\custom-cacerts"
keystorePass="changeit"
clientAuth="false" sslProtocol="TLS" />
- - Startup Tomcat and verify that Rave still runs properly on
http://localhost:8080/portal/
+ - Startup Tomcat and verify that Apache Rave still runs properly on
http://localhost:8080/portal/
- - Make sure you can access the Rave login page at
https://rave-server.example.com/portal
+ - Make sure you can access the portal login page at
https://rave-server.example.com/portal
Note - if you already have an authenticated session open in your browser
you'll probably need to close and re-open your browser to access the login page.
- Also note that the rest of Rave wont work over SSL yet.
+ Also note that the rest of Apache Rave wont work over SSL yet.
-## Configure Rave and Shindig to run over SSL.
+## Configure Apache Rave and Shindig to run over SSL.
- - Edit the /temp/tomcat/webapps/portal/WEB-INF/classes/portal.properties file
to configure Rave to use SSL.
+ - Edit the /temp/tomcat/webapps/portal/WEB-INF/classes/portal.properties file
to configure Apache Rave to use SSL.
(updated the following values at the top of the portal.properties config
file with)
Modified: rave/site/trunk/content/rave/documentation/custom-app-context.mdtext
URL:
http://svn.apache.org/viewvc/rave/site/trunk/content/rave/documentation/custom-app-context.mdtext?rev=1305487&r1=1305486&r2=1305487&view=diff
==============================================================================
--- rave/site/trunk/content/rave/documentation/custom-app-context.mdtext
(original)
+++ rave/site/trunk/content/rave/documentation/custom-app-context.mdtext Mon
Mar 26 18:46:51 2012
@@ -16,21 +16,21 @@ Notice: Licensed to the Apache Softwa
specific language governing permissions and limitations
under the License.
-In order for custom components to participate in or replace 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.
+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.
-Follow the steps below to create and add additional application contexts to
Rave:
+Follow the steps below to create and add additional application contexts to
Apache Rave:
-##1) Get Rave
+##1) Get Apache Rave
-There are multiple ways to build your custom Rave instance, but the quickest
is to use a Maven WAR overlay. See [Extending Rave](rave-extensions.html) for
an example overlay.
+There are multiple ways to build your custom Apache Rave instance, but the
quickest is to use a Maven WAR overlay. See [Extending
Rave](rave-extensions.html) for an example overlay.
##2) Create a new Spring context XML file
Define a Spring context file in accordance with the [Spring
Documentation](http://static.springsource.org/spring/docs/3.0.x/spring-framework-reference/html/beans.html).
Place the file in src/main/webapp/WEB-INF
-##3) Override Rave web.xml
+##3) Override web.xml
-Copy the Rave web.xml file from the Rave source distribution (or exploded war)
and place it in your overlay's src/main/webapp/WEB-INF directory.
+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.
##4) Update web.xml
@@ -45,7 +45,7 @@ Add the location of your context XML fil
</param-value>
</context-param>
-##5) Build and deploy your new Rave war
+##5) Build and deploy your new Apache Rave war
#Notes and concerns
Modified: rave/site/trunk/content/rave/documentation/custom-gui.mdtext
URL:
http://svn.apache.org/viewvc/rave/site/trunk/content/rave/documentation/custom-gui.mdtext?rev=1305487&r1=1305486&r2=1305487&view=diff
==============================================================================
--- rave/site/trunk/content/rave/documentation/custom-gui.mdtext (original)
+++ rave/site/trunk/content/rave/documentation/custom-gui.mdtext Mon Mar 26
18:46:51 2012
@@ -16,11 +16,11 @@ Notice: Licensed to the Apache Softwa
specific language governing permissions and limitations
under the License.
-The look and feel (GUI) of the Rave Portal can be customized to your own
preference. The Rave Portal contains a mechanism to easily add your own CSS
file(s) which are called after the default.css file.
+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.
-##1) Get Rave
+##1) Get Apache Rave
-There are multiple ways to build your custom Rave instance, but the quickest
is to use a Maven WAR overlay. See [Extending Rave](rave-extensions.html) for
an example overlay.
+There are multiple ways to build your custom Apache Rave instance, but the
quickest is to use a Maven WAR overlay. See [Extending
Rave](rave-extensions.html) for an example overlay.
##2) Add CSS file(s)
Modified:
rave/site/trunk/content/rave/documentation/custom-widget-renderer.mdtext
URL:
http://svn.apache.org/viewvc/rave/site/trunk/content/rave/documentation/custom-widget-renderer.mdtext?rev=1305487&r1=1305486&r2=1305487&view=diff
==============================================================================
--- rave/site/trunk/content/rave/documentation/custom-widget-renderer.mdtext
(original)
+++ rave/site/trunk/content/rave/documentation/custom-widget-renderer.mdtext
Mon Mar 26 18:46:51 2012
@@ -16,11 +16,11 @@ Notice: Licensed to the Apache Softwa
specific language governing permissions and limitations
under the License.
-The 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 Rave with a few simple steps.
+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.
-##1) Get Rave
+##1) Get Apache Rave
-There are multiple ways to build your custom Rave instance, but the simplest
is to use a Maven WAR overlay. See [Extending Rave](rave-extensions.html) for
an example overlay.
+There are multiple ways to build your custom Apache Rave instance, but the
simplest is to use a Maven WAR overlay. See [Extending
Rave](rave-extensions.html) for an example overlay.
##2) Define a custom web application context
Modified: rave/site/trunk/content/rave/documentation/customizing.mdtext
URL:
http://svn.apache.org/viewvc/rave/site/trunk/content/rave/documentation/customizing.mdtext?rev=1305487&r1=1305486&r2=1305487&view=diff
==============================================================================
--- rave/site/trunk/content/rave/documentation/customizing.mdtext (original)
+++ rave/site/trunk/content/rave/documentation/customizing.mdtext Mon Mar 26
18:46:51 2012
@@ -1,4 +1,4 @@
-Title: Customizing Rave
+Title: Customizing Apache Rave
Notice: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -16,9 +16,9 @@ Notice: Licensed to the Apache Softwa
specific language governing permissions and limitations
under the License.
-Rave has been designed with extension in mind and provides many different ways
to override, supplement or modify out of the box components. Rave leverages a
combination of well defined interfaces and the [Spring
Framework](http://www.springsource.org) as a mechanism of extensibility. This
powerful approach gives developers the ability to override Rave bean
implementations, inject Rave beans into custom code and wire additional
components into Rave beans that depend on lists.
+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 [Spring
Framework](http://www.springsource.org) 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.
-You will find guides for extending 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
[here](http://static.springsource.org/spring/docs/3.0.x/spring-framework-reference/html/spring-introduction.html).
+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
[here](http://static.springsource.org/spring/docs/3.0.x/spring-framework-reference/html/spring-introduction.html).
##Customization Guides
Modified: rave/site/trunk/content/rave/documentation/index.mdtext
URL:
http://svn.apache.org/viewvc/rave/site/trunk/content/rave/documentation/index.mdtext?rev=1305487&r1=1305486&r2=1305487&view=diff
==============================================================================
--- rave/site/trunk/content/rave/documentation/index.mdtext (original)
+++ rave/site/trunk/content/rave/documentation/index.mdtext Mon Mar 26 18:46:51
2012
@@ -29,7 +29,7 @@ Notice: Licensed to the Apache Softwa
- [Working with the Script Manager](script-manager.html)
## Security
- - [Rave Model Permission Overview](security-model-permission.html)
+ - [Security Model Permission Overview](security-model-permission.html)
- [How to Implement Permission Security for a New Rave Model
Object](new-model-permission-impl.html)
- [How to Override the Default Permission Security for and Existing Rave
Model Object](model-permission-override.html)
- [How to configure Single Sign-On](sso-login.html)
Modified: rave/site/trunk/content/rave/documentation/installing.mdtext
URL:
http://svn.apache.org/viewvc/rave/site/trunk/content/rave/documentation/installing.mdtext?rev=1305487&r1=1305486&r2=1305487&view=diff
==============================================================================
--- rave/site/trunk/content/rave/documentation/installing.mdtext (original)
+++ rave/site/trunk/content/rave/documentation/installing.mdtext Mon Mar 26
18:46:51 2012
@@ -1,4 +1,4 @@
-Title: Installing Rave
+Title: Installing Apache Rave
Notice: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
Modified: rave/site/trunk/content/rave/documentation/ldap-authentication.mdtext
URL:
http://svn.apache.org/viewvc/rave/site/trunk/content/rave/documentation/ldap-authentication.mdtext?rev=1305487&r1=1305486&r2=1305487&view=diff
==============================================================================
--- rave/site/trunk/content/rave/documentation/ldap-authentication.mdtext
(original)
+++ rave/site/trunk/content/rave/documentation/ldap-authentication.mdtext Mon
Mar 26 18:46:51 2012
@@ -71,7 +71,7 @@ the user gets access to the portal and g
## Customizing the LDAP setup
-First create a custom portal project. There are multiple ways to build your
custom Rave instance, but the quickest is to
+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 [Extending Rave](rave-extensions.html) for an
example overlay.
For the LDAP configuration, the default applicationContext-security.xml needs
to be overridden.
Modified:
rave/site/trunk/content/rave/documentation/model-permission-override.mdtext
URL:
http://svn.apache.org/viewvc/rave/site/trunk/content/rave/documentation/model-permission-override.mdtext?rev=1305487&r1=1305486&r2=1305487&view=diff
==============================================================================
--- rave/site/trunk/content/rave/documentation/model-permission-override.mdtext
(original)
+++ rave/site/trunk/content/rave/documentation/model-permission-override.mdtext
Mon Mar 26 18:46:51 2012
@@ -1,4 +1,4 @@
-Title:
+Title: How to Override the Default Permission Security for an Existing Rave
Model Object
Notice: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -16,8 +16,6 @@ Notice: Licensed to the Apache Softwa
specific language governing permissions and limitations
under the License.
-How to Override the Default Permission Security for an Existing Rave Model
Object
-------------------------------------------------------------------------
Click [here][1] first on how to extend Rave.
@@ -42,5 +40,5 @@ If you would like to override any of the
5) Ensure your new class gets component scanned by Spring upon application
startup. Click [here][2] to read about how to override the application
context.
- [1]: http://incubator.apache.org/rave/documentation/rave-extensions.html
- [2]:
http://rave.staging.apache.org/rave/documentation/custom-app-context.html
\ No newline at end of file
+ [1]: rave-extensions.html
+ [2]: custom-app-context.html
\ No newline at end of file
Modified:
rave/site/trunk/content/rave/documentation/new-model-permission-impl.mdtext
URL:
http://svn.apache.org/viewvc/rave/site/trunk/content/rave/documentation/new-model-permission-impl.mdtext?rev=1305487&r1=1305486&r2=1305487&view=diff
==============================================================================
--- rave/site/trunk/content/rave/documentation/new-model-permission-impl.mdtext
(original)
+++ rave/site/trunk/content/rave/documentation/new-model-permission-impl.mdtext
Mon Mar 26 18:46:51 2012
@@ -1,4 +1,4 @@
-Title:
+Title: How to Implement Permission Security for a new Rave Model Object
Notice: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -16,9 +16,6 @@ Notice: Licensed to the Apache Softwa
specific language governing permissions and limitations
under the License.
-How to Implement Permission Security for a new Rave Model Object
-----------------------------------------------------------------
-
*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
[this][1]*
Modified: rave/site/trunk/content/rave/documentation/oauth-consumer.mdtext
URL:
http://svn.apache.org/viewvc/rave/site/trunk/content/rave/documentation/oauth-consumer.mdtext?rev=1305487&r1=1305486&r2=1305487&view=diff
==============================================================================
--- rave/site/trunk/content/rave/documentation/oauth-consumer.mdtext (original)
+++ rave/site/trunk/content/rave/documentation/oauth-consumer.mdtext Mon Mar 26
18:46:51 2012
@@ -1,4 +1,4 @@
-Title: Use Rave as OAuth consumer
+Title: Use Apache Rave as OAuth consumer
Notice: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
Modified: rave/site/trunk/content/rave/documentation/rave-extensions.mdtext
URL:
http://svn.apache.org/viewvc/rave/site/trunk/content/rave/documentation/rave-extensions.mdtext?rev=1305487&r1=1305486&r2=1305487&view=diff
==============================================================================
--- rave/site/trunk/content/rave/documentation/rave-extensions.mdtext (original)
+++ rave/site/trunk/content/rave/documentation/rave-extensions.mdtext Mon Mar
26 18:46:51 2012
@@ -1,4 +1,4 @@
-Title: Extend Rave to build your own portal
+Title: Extend Apache Rave to build your own portal
Notice: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -16,17 +16,17 @@ Notice: Licensed to the Apache Softwa
specific language governing permissions and limitations
under the License.
-One of the (main) goals of Rave is to create an extendible platform. This
document is to help Rave users (developers) to customize Rave based on needs.
+One of the (main) goals of Apache Rave is to create an extendible platform.
This document is to help Apache Rave users (developers) to customize Apache
Rave based on needs.
-To get you started we have created a Rave Sandbox and created a vanilla
extension that shows how to implement CustomUserService and to personalize
login page look and feel.
+To get you started we have created a Sandbox and created a vanilla extension
that shows how to implement CustomUserService and to personalize login page
look and feel.
The main objective of the vanilla extension is to provide reusable build
environment with minimal required dependencies.
Extension developers will be able to use the POM file provide and add
additional project dependencies.
## Prerequisites
-The current version of Rave must be in your local Maven repository. To do
this, [check out Rave from SVN][1] and build with "mvn clean install".
+The current version of Apache Rave must be in your local Maven repository. To
do this, [check out Apache Rave from SVN][1] and build with "mvn clean install".
-## Rave Vanilla Extension Location
+## Vanilla Extension Location
svn co
http://svn.apache.org/repos/asf/rave/sandbox/rave-extensions/rave-vanilla-extension
cd rave-vanilla-extension
@@ -36,8 +36,8 @@ The current version of Rave must be in y
## Best Practices
- Add new javascript functions to new file or copy existing functions to new
file and customize them and change imports based on your need. Reason is,
changes/fixes in rave libraries should come to your project.
-- If you are are customizing css or adding new css methods add new files so
that changes in default rave css files will come to your portal
-- Report any bug or issue to Rave Jira [Rave JIRA][2]
+- If you are are customizing css or adding new css methods add new files so
that changes in default css files will come to your portal
+- Report any bug or issue to [Apache Rave JIRA][2]
## Customizations
@@ -45,7 +45,7 @@ The current version of Rave must be in y
Application Security context provided in
~/src/main/webapp/WEB-INF/applicationContext-security.xml and add name for
customUserService.
- Login page : This is just to demonstrate that if you have your own login
page and style sheets you can copy them to right location and they will be
-included in portal war along with other rave files. If you will have the same
files name as in Rave war, they will be replaced with your version of files.
+included in portal war along with other portal files. If you will have the
same files name as in portal war, they will be replaced with your version of
files.
Modified: rave/site/trunk/content/rave/documentation/script-manager.mdtext
URL:
http://svn.apache.org/viewvc/rave/site/trunk/content/rave/documentation/script-manager.mdtext?rev=1305487&r1=1305486&r2=1305487&view=diff
==============================================================================
--- rave/site/trunk/content/rave/documentation/script-manager.mdtext (original)
+++ rave/site/trunk/content/rave/documentation/script-manager.mdtext Mon Mar 26
18:46:51 2012
@@ -16,11 +16,11 @@ Notice: Licensed to the Apache Softwa
specific language governing permissions and limitations
under the License.
-The Script Manager is a Rave bean that allows developers to register script
blocks for inclusion in the bottom of the page. The bean is designed to manage
the registration of scripts that should be rendered on every page (Global) and
within the current context. Additionally, it tracks the requested position of
the scripts relative to included libraries and out of the box Rave scripts.
+The Script Manager is an Apache Rave bean that allows developers to register
script blocks for inclusion in the bottom of the page. The bean is designed to
manage the registration of scripts that should be rendered on every page
(Global) and within the current context. Additionally, it tracks the requested
position of the scripts relative to included libraries and out of the box
Apache Rave scripts.
##Getting the ScriptManager
-The ScriptManager is a Spring bean defined by Rave and can be injected into
any class via standard Spring autowiring mechanisms. If your component is not
managed by Rave's Spring Application Context, you can retrieve the bean from
the Application Context manually.
+The ScriptManager is a Spring bean defined by Rave and can be injected into
any class via standard Spring autowiring mechanisms. If your component is not
managed by Apache Rave's Spring Application Context, you can retrieve the bean
from the Application Context manually.
##Registering a Script
@@ -32,10 +32,10 @@ There potential values for the scope of
###Script Location
-Scripts can be rendered at various points relative to Rave default includes
and out of the box scripts. The potential values are defined and document in
the org.apache.rave.renderer.ScriptLocation enumeration.
+Scripts can be rendered at various points relative to Apache Rave default
includes and out of the box scripts. The potential values are defined and
document in the org.apache.rave.renderer.ScriptLocation enumeration.
###Render Context
-The render context represents the environment under which the script is to be
rendered. The context contains a set of key/value pairs that provide important
context information to various components involved in the render process. The
developers interacting with the script manager are responsible for passing the
Render Context to the ScriptManager. Most often, the developer interacting
with the ScriptManager will be doing so from within a Rave render extension
point, which will have a RenderContext passed to it. If this isn't the case,
the developer will need to retrieve the RenderContext object from the current
HttpServletRequest prior to calling the script manager.
+The render context represents the environment under which the script is to be
rendered. The context contains a set of key/value pairs that provide important
context information to various components involved in the render process. The
developers interacting with the script manager are responsible for passing the
Render Context to the ScriptManager. Most often, the developer interacting
with the ScriptManager will be doing so from within an Apache Rave render
extension point, which will have a RenderContext passed to it. If this isn't
the case, the developer will need to retrieve the RenderContext object from the
current HttpServletRequest prior to calling the script manager.
Modified:
rave/site/trunk/content/rave/documentation/security-model-permission.mdtext
URL:
http://svn.apache.org/viewvc/rave/site/trunk/content/rave/documentation/security-model-permission.mdtext?rev=1305487&r1=1305486&r2=1305487&view=diff
==============================================================================
--- rave/site/trunk/content/rave/documentation/security-model-permission.mdtext
(original)
+++ rave/site/trunk/content/rave/documentation/security-model-permission.mdtext
Mon Mar 26 18:46:51 2012
@@ -1,4 +1,4 @@
-Title:
+Title: How Apache Rave Model Permission Security Works
Notice: Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
@@ -16,9 +16,7 @@ Notice: Licensed to the Apache Softwa
specific language governing permissions and limitations
under the License.
-**How Rave Model Permission Security Works**
-
-In a nutshell, Rave uses Spring Security annotations to protect the service
layer methods. Below is an overview of the permission related classes in
rave-core and what each is used for:
+In a nutshell, Apache Rave uses Spring Security annotations to protect the
service layer methods. Below is an overview of the permission related classes
in rave-core and what each is used for:
*org.apache.rave.portal.security*
@@ -26,19 +24,19 @@ ModelPermissionEvaluator
- Interface that defines the various model Permission functions that need to
be implemented. Also defines a Permission enum to standardize the possible
permission values across the model security code.
-- Each model class in Rave will have an associated default implementation of
this interface. For example, there is a DefaultPagePermissionEvaluator class
in the org.apache.rave.portal.security.impl package that defines all of the
permission logic for Page model objects.
+- Each model class in Apache Rave will have an associated default
implementation of this interface. For example, there is a
DefaultPagePermissionEvaluator class in the
org.apache.rave.portal.security.impl package that defines all of the permission
logic for Page model objects.
*org.apache.rave.portal.security.impl*
RaveMethodSecurityExpressionHandler
-- Extension of the
org.springframework.security.access.expression.method.DefaultMethodSecurityExpressionHandler
class which handles the logic for expression language security annotations.
The filter method needed to be overridden because the default implementation
tries to modify the filterTarget parameter passed in, which can be a Collection
or Array object. Certain implementations of JPA (such as the default OpenJPA
used by Rave) create unmodifiable Collection types which cause exceptions to be
thrown. The Rave implementation makes a copy of the Collection and passes it
to the super method so it can be modified (filtered).
+- Extension of the
org.springframework.security.access.expression.method.DefaultMethodSecurityExpressionHandler
class which handles the logic for expression language security annotations.
The filter method needed to be overridden because the default implementation
tries to modify the filterTarget parameter passed in, which can be a Collection
or Array object. Certain implementations of JPA (such as the default OpenJPA
used by Apache Rave) create unmodifiable Collection types which cause
exceptions to be thrown. The Apache Rave implementation makes a copy of the
Collection and passes it to the super method so it can be modified (filtered).
- This class is wired into Rave as the âexpressionHandlerâ bean in the
applicationContext-security.xml file under rave-portal-resources
RavePermissionEvaluator
-- Implements the org.springframework.security.access.PermissionEvaluator
interface which allows us to inject our custom model permission logic into the
Spring Security stack. This class will be autowired with a List of
ModelPermissionEvaluator implementation classes for each of the Rave model
classes and stored internally. The overridden hasPermission functions of this
classs inspect the type (class) of targetDomainObject being passed in via the
security annotation and use the appropriate ModelPermissionEvalutor to check
for permissions.
+- Implements the org.springframework.security.access.PermissionEvaluator
interface which allows us to inject our custom model permission logic into the
Spring Security stack. This class will be autowired with a List of
ModelPermissionEvaluator implementation classes for each of the Apache Rave
model classes and stored internally. The overridden hasPermission functions of
this classs inspect the type (class) of targetDomainObject being passed in via
the security annotation and use the appropriate ModelPermissionEvalutor to
check for permissions.
- this class is wired into Rave as a property to the
RaveMethodSecurityExpressionHandler in the applicationContext-security.xml file
under rave-portal-resources
@@ -49,7 +47,7 @@ RaveSecurityContext
AbstractModelPermissionEvaluator
- an abstract implementation of the ModelPermissionEvaluator interface to
define common functionality that should be shared across all
ModelPermissionEvaluator implementations:
- a) hasPermission: checks to see if the user is a Rave administrator, which
trumps all other granular permission checks
+ a) hasPermission: checks to see if the user is a portal administrator,
which trumps all other granular permission checks
b) getLoadOrder: returns the integer 1. This function is used by the
RavePermissionEvaluator constructor to sort all of the component scanned
ModelPermissionEvaluators before building its internal map. This allows an
easy way to override any of the default ModelPermissionEvaluator classes by
third parties. Overridden classes just need to override getLoadOrder() and
return a number greater than 1 to ensure it gets put into the map after the
default implementation. A best practice could be to return
super.getLoadOrder() + 1 which would allow an infinite number of overrides for
a given ModelPermissionEvaluator.
Default[Model]PermissionEvaluator classes
Modified: rave/site/trunk/content/rave/documentation/sso-login.mdtext
URL:
http://svn.apache.org/viewvc/rave/site/trunk/content/rave/documentation/sso-login.mdtext?rev=1305487&r1=1305486&r2=1305487&view=diff
==============================================================================
--- rave/site/trunk/content/rave/documentation/sso-login.mdtext (original)
+++ rave/site/trunk/content/rave/documentation/sso-login.mdtext Mon Mar 26
18:46:51 2012
@@ -17,17 +17,17 @@ Notice: Licensed to the Apache Softwa
under the License.
The default login mechanism relies on predefined users in the database with
basic authentication or OpenId.
-With a different [Spring security][1] configuration Rave supports login based
on request headers.
+With a different [Spring security][1] configuration Apache Rave supports login
based on request headers.
The following instructions assume there is already an SSO authentication
service running in your network like [Shibboleth®][2]
-##1) Get Rave
+##1) Get Apache Rave
-There are multiple ways to build your custom Rave instance, but the quickest
is to use a Maven WAR overlay. See [Extending Rave](rave-extensions.html) for
an example overlay.
+There are multiple ways to build your custom Apache Rave instance, but the
quickest is to use a Maven WAR overlay. See [Extending Apache
Rave](rave-extensions.html) for an example overlay.
##2) Build the Rave SSO extension
-Run the following commands in your shell/terminal/command to build the Single
Sign-On extension from the Rave Sandbox:
+Run the following commands in your shell/terminal/command to build the Single
Sign-On extension from the Sandbox:
svn co
http://svn.apache.org/repos/asf/rave/sandbox/rave-extensions/rave-extension-sso
cd rave-extension-sso
Modified: rave/site/trunk/content/rave/documentation/translate-portal.mdtext
URL:
http://svn.apache.org/viewvc/rave/site/trunk/content/rave/documentation/translate-portal.mdtext?rev=1305487&r1=1305486&r2=1305487&view=diff
==============================================================================
--- rave/site/trunk/content/rave/documentation/translate-portal.mdtext
(original)
+++ rave/site/trunk/content/rave/documentation/translate-portal.mdtext Mon Mar
26 18:46:51 2012
@@ -20,7 +20,7 @@ The labels in the portal are maintained
##1) Get Rave
-There are multiple ways to build your custom Rave instance, but the quickest
is to use a Maven WAR overlay. See [Extending Rave](rave-extensions.html) for
an example overlay.
+There are multiple ways to build your custom Apache Rave instance, but the
quickest is to use a Maven WAR overlay. See [Extending
Rave](rave-extensions.html) for an example overlay.
##2) Add your translation
@@ -30,7 +30,7 @@ There are multiple ways to build your cu
##3) Build and test
-Build your custom Rave project and deploy it.
+Build your custom Apache Rave project and deploy it.
You will see the French translations in the portal if the preferred language
of your browser is French.
