From 1849597775bbdc8883651815f9964c7836dbe249 Mon Sep 17 00:00:00 2001 From: Ben Alex Date: Tue, 30 May 2006 14:54:08 +0000 Subject: [PATCH] Add new Petclinic tutorial. --- doc/xdocs/navigation.xml | 1 + doc/xdocs/petclinic-tutorial.html | 149 ++++++++++++++++++++++++++++++ doc/xdocs/suggested.html | 14 ++- 3 files changed, 162 insertions(+), 2 deletions(-) create mode 100644 doc/xdocs/petclinic-tutorial.html diff --git a/doc/xdocs/navigation.xml b/doc/xdocs/navigation.xml index c29823d38c..b8dd57c905 100644 --- a/doc/xdocs/navigation.xml +++ b/doc/xdocs/navigation.xml @@ -38,6 +38,7 @@ + diff --git a/doc/xdocs/petclinic-tutorial.html b/doc/xdocs/petclinic-tutorial.html new file mode 100644 index 0000000000..4554d342dc --- /dev/null +++ b/doc/xdocs/petclinic-tutorial.html @@ -0,0 +1,149 @@ + + +Tutorial: Adding Security to Spring Petclinic + + + +

Tutorial: Adding Security to Spring Petclinic

+

Background requirements

+ +

To complete this tutorial, you will require a servlet container (such as Tomcat) +and a general understanding of using Spring without Acegi Security. The Petclinic +sample itself is part of Spring and should help you learn Spring. We suggest you +only try to learn one thing at a time, and start with Spring/Petclinic before +Acegi Security. +

+ +

Download

+
    +
  • Spring 2.0 M4 with dependencies ZIP file
    • +
  • Acegi Security 1.0.0
    • +
+ +

+Unzip both files. After unzipping Acegi Security, you'll need to unzip the +acegi-security-sample-tutorial.war file, because we need some files that are +included within it. In the code below, we'll refer to the respective unzipped +locations as %spring% and %acegi% (with the latter variable referring to the +unzipped WAR, not the original ZIP). There is no need to setup any environment +variables to complete the tutorial. +

+ +

Setup database

+ +

Start the Hypersonic server (this is just normal Petclinic configuration): +

+cd %spring%\samples\petclinic\db\hsqldb
+server
+
+

+ +

+Insert some data (again, normal Petclinic configuration): +

+cd %spring%\samples\petclinic
+build setupDB
+
+

+ +

Setup Petclinic's web.xml

+ +

Edit %spring%\samples\petclinic\war\WEB-INF\web.xml and insert the following block of code. +

+    <filter>
+        <filter-name>Acegi Filter Chain Proxy</filter-name>
+        <filter-class>org.acegisecurity.util.FilterToBeanProxy</filter-class>
+        <init-param>
+            <param-name>targetClass</param-name>
+            <param-value>org.acegisecurity.util.FilterChainProxy</param-value>
+        </init-param>
+    </filter>
+
+    <filter-mapping>
+      <filter-name>Acegi Filter Chain Proxy</filter-name>
+      <url-pattern>/*</url-pattern>
+    </filter-mapping>
+
+Next, locate the "contextConfigLocation" parameter, and add a new line into the existing param-value. +The resulting block will look like this: +
+<context-param>
+	<param-name>contextConfigLocation</param-name>
+	<param-value>
+		/WEB-INF/applicationContext-jdbc.xml
+		/WEB-INF/applicationContext-acegi-security.xml
+	</param-value>
+</context-param>
+
+

+ +

Add the necessary files

+ +

+We now need to put some extra files into Petclinic. The following commands should work: +

+copy %acegi%\acegilogin.jsp %spring%\samples\petclinic\war
+copy %acegi%\WEB-INF\users.properties %spring%\samples\petclinic\war\WEB-INF
+copy %acegi%\WEB-INF\applicationContext-acegi-security.xml %spring%\samples\petclinic\war\WEB-INF
+copy %acegi%\WEB-INF\lib\acegi-security-1.0.0.jar %spring%\samples\petclinic\war\WEB-INF\lib
+copy %acegi%\WEB-INF\lib\oro-2.0.8.jar %spring%\samples\petclinic\war\WEB-INF\lib
+copy %acegi%\WEB-INF\lib\commons-codec-1.3.jar %spring%\samples\petclinic\war\WEB-INF\lib
+
+

+ +

+To make it easier to experiment with the application, let's edit +%spring%\samples\petclinic\war\WEB-INF\jsp\footer.jsp. Add a new "logout" link, as shown: +

+	<table style="width:100%"><tr>
+		<td><A href="<c:url value="/welcome.htm"/>">Home</A></td>
+		<td><A href="<c:url value="/j_acegi_logout"/>">Logout</A></td>
+		<td style="text-align:right;color:silver">PetClinic :: a Spring Framework demonstration</td>
+	</tr></table>
+
+
+ +

+ +

Modify the allowed URLs

+ +

+Our last step is to specify which URLs require authorization and which do not. Let's +edit %spring%\samples\petclinic\war\WEB-INF\applicationContext-acegi-security.xml. +Scroll to the bottom and locate the bean definition for FilterSecurityInterceptor. +Edit its objectDefinitionSource property so that it reflects the following: +

+		<property name="objectDefinitionSource">
+			<value>
+				CONVERT_URL_TO_LOWERCASE_BEFORE_COMPARISON
+				PATTERN_TYPE_APACHE_ANT
+				/acegilogin.jsp=IS_AUTHENTICATED_ANONYMOUSLY
+				/**=IS_AUTHENTICATED_REMEMBERED
+			</value>
+		</property>
+
+

+ +

Build and deploy the Petclinic WAR file

+ +

+Use the Ant build and deploy to your servlet container: +

+cd %spring%\samples\petclinic
+build warfile
+copy dist\petclinic.war %TOMCAT_HOME%\webapps
+
+

+ +

Finally, start your container and try to visit the home page. +Your request should be intercepted and you will be forced to login.

+ +

What now?

+

+These steps can be applied to your own application. Although we do suggest +that you visit http://acegisecurity.org +and in particular review the "Suggested Steps" for getting started with Acegi +Security.

+ + + \ No newline at end of file diff --git a/doc/xdocs/suggested.html b/doc/xdocs/suggested.html index e75c134ff1..4fd9f2aa9d 100644 --- a/doc/xdocs/suggested.html +++ b/doc/xdocs/suggested.html @@ -36,7 +36,16 @@ ZIP file. The sample doesn't do a great deal, but it does give you a template that can be quickly and easily used to integrate into your own project.

- Estimated time: 30 minutes - 2 hours.

+ Estimated time: 30 minutes.

+ + +
  • + Next, follow the Petclinic tutorial, which + covers how to add Acegi Security to the commonly-used Petclinic sample application + that ships with Spring. This will give you a hands-on approach to integrating + Acegi Security into your own application.

    + + Estimated time: 1 hour.

  • @@ -44,7 +53,8 @@ Part I. It has been designed to give you a solid overview. Go through the beans defined in the "Tutorial Sample" and understand their main purpose within the overall framework. Once you understand this, you'll have no difficulty moving on to more - complex examples.

    + complex examples. You can also experiment in the Petclinic tutorial that you + implemented in the last step.

    Estimated time: 1 day.