ソースを参照

Minor doc modifications

Luke Taylor 17 年 前
コミット
6f289b3620

+ 15 - 12
src/docbkx/community.xml

@@ -7,8 +7,7 @@
 
 
 <section xml:id="jira">
-    <info><title>Use JIRA for Issue Tracking</title></info>
-    
+    <info><title>Issue Tracking</title></info>
     
     <para>Spring Security uses JIRA to manage bug reports and enhancement
         requests. If you find a bug, please log a report using JIRA. Do not
@@ -16,14 +15,15 @@
         developers. Such approaches are ad-hoc and we prefer to manage bugs
         using a more formal process.</para>
     
-    <para>If possible, in your JIRA report please provide a JUnit test
+    <para>If possible, in your issue report please provide a JUnit test
         that demonstrates any incorrect behaviour. Or, better yet, provide a
         patch that corrects the issue. Similarly, enhancements are welcome to
-        be logged in JIRA, although we only accept commit enhancement requests
+        be logged in the issue tracker, although we only accept commit enhancement requests
         if you include corresponding unit tests. This is necessary to ensure
         project test coverage is adequately maintained.</para>
     
-    <para>You can access JIRA at <link xlink:href="http://jira.springframework.org/browse/SEC">http://jira.springframework.org/browse/SEC</link>.</para>
+    <para>You can access the issue tracker at 
+        <link xlink:href="http://jira.springframework.org/browse/SEC">http://jira.springframework.org/browse/SEC</link>.</para>
 </section>
 
 <section xml:id="becoming-involved"><info><title>Becoming Involved</title></info>
@@ -41,17 +41,20 @@
         project.</para>
 </section>
 
-<section xml:id="further-info"><info><title>Further Information</title></info>
-    
-    
-    <para>Questions and comments on Spring Security are welcome. Please
-        use the Spring Community Forum web site at <uri xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://forum.springframework.org">http://forum.springframework.org</uri> for all support
-        issues. Remember to use JIRA for bug reports, as explained above.
+<section xml:id="further-info">
+    <info><title>Further Information</title></info>
+    
+    <para>Questions and comments on Spring Security are welcome. You can use the 
+        Spring Community Forum web site at  
+        <uri xlink:href="http://forum.springframework.org">http://forum.springframework.org</uri>
+        to discuss Spring Security with other users of the framework. 
+        Remember to use the JIRA for bug reports, as explained above.
         Everyone is also welcome to join the Acegisecurity-developer mailing
         list and participate in design discussions. It's also a good way of
         finding out what's happening with regard to release timing, and the
         traffic volume is quite light. Finally, our project home page (where
         you can obtain the latest release of the project and convenient links
-        to Subversion, JIRA, mailing lists, forums etc) is at <uri xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://acegisecurity.org">http://acegisecurity.org</uri>.</para>
+        to Subversion, JIRA, mailing lists, forums etc) is at 
+        <uri xlink:href="http://static.springframework.org/spring-security/site/">http://static.springframework.org/spring-security/site/</uri>.</para>
 </section>
 </chapter>

+ 6 - 2
src/docbkx/dao-auth-provider.xml

@@ -72,8 +72,8 @@
     <para><programlisting><![CDATA[
 <bean id="daoAuthenticationProvider"
     class="org.springframework.security.providers.dao.DaoAuthenticationProvider">
-  <property name="userDetailsService"><ref bean="userDetailsService"/></property>
-  <property name="userCache"><ref bean="userCache"/></property>
+  <property name="userDetailsService" ref="userDetailsService"/>
+  <property name="userCache" ref="userCache"/>
 </bean>
         
 <bean id="cacheManager" class="org.springframework.cache.ehcache.EhCacheManagerFactoryBean">
@@ -98,6 +98,10 @@
         Spring's factory classes, please refer to the Spring documentation for
         further details on how to optimise the cache storage location, memory
         usage, eviction policies, timeouts etc.</para>
+    <note><para>In the majority of cases, where your application is a stateful web
+        application, you don't need to use a cache as the user's authentication
+        information will be stored in the <literal>HttpSession</literal>.
+    </para></note>
     
     <para>A design decision was made not to support account locking in the
         <literal>DaoAuthenticationProvider</literal>, as doing so would have

+ 9 - 5
src/docbkx/introduction.xml

@@ -75,6 +75,10 @@
                 needs)</para>
         </listitem>
         
+        <listitem>
+            <para>OpenID authentication</para>
+        </listitem>
+        
         <listitem>
             <para>Computer Associates Siteminder</para>
         </listitem>
@@ -251,14 +255,14 @@
         use in numerous production software projects and many hundreds of
         improvements and community contributions.</para>
     
-    <para>Since work began on the 2.0 release, the project has been
-        rebranded as "Spring Security".</para>
+    <para>Acegi Security became an official Spring Portfolio project 
+        towards the end of 2007 and was rebranded as "Spring Security".</para>
     
     <para>Today Spring Security enjoys a strong and active open source
         community. There are thousands of messages about Spring Security on
-        the support forums. Fourteen developers work on the code itself, with
-        an active community who also regularly share patches and support their
-        peers.</para>
+        the support forums. There is an active core of developers work 
+        who work on the code itself and an active community which also 
+        regularly share patches and support their peers.</para>
 </sect1>
 
 <sect1 xml:id="release-numbering">

+ 1 - 1
src/docbkx/springsecurity.xml

@@ -88,7 +88,7 @@
       framework architecture and implementation classes, an understanding of which is important
       if you need to do any serious customization. In this part, we take a slightly
       gentler look at how to get started using some of the features of Spring Security 2.0.
-      In particular, the use of namespace configuration provides a much simpler path to securing
+      In particular, we'll look at namespace configuration which provides a much simpler path to securing
       your application with little or no knowledge of the classes involved, unlike the traditional
       Spring bean approach which required you to configure large numbers of beans.
     </para>

+ 6 - 5
src/docbkx/technical-overview.xml

@@ -73,12 +73,13 @@
     object. You can use the following code block - from anywhere in your
     application - to do this:</para>
 
-    <programlisting>Object obj = SecurityContextHolder.getContext().getAuthentication().getPrincipal();
+    <programlisting>
+Object obj = SecurityContextHolder.getContext().getAuthentication().getPrincipal();
 
 if (obj instanceof UserDetails) {
-String username = ((UserDetails)obj).getUsername();
+  String username = ((UserDetails)obj).getUsername();
 } else {
-String username = obj.toString();
+  String username = obj.toString();
 }</programlisting>
 
     <para>The above code introduces a number of interesting relationships
@@ -221,8 +222,8 @@ String username = obj.toString();
     authentication.</para>
   </section>
 
-  <section xml:id="common-authentication"><info><title>Authentication</title></info>
-    
+  <section xml:id="common-authentication">
+    <info><title>Authentication</title></info>
 
     <para>As mentioned in the beginning of this reference guide, Spring
     Security can participate in many different authentication

+ 2 - 1
src/docbkx/x509-auth-provider.xml

@@ -54,7 +54,8 @@
             then the security context will remain empty. This means that you can easily use X.509
             authentication with other options such as a form-based login. </para>
     </section>
-    <section xml:id="x509-ssl-config"><info><title>Setting up SSL in Tomcat</title></info>
+    <section xml:id="x509-ssl-config">
+        <info><title>Setting up SSL in Tomcat</title></info>
         
         <para>There are some pre-generated certificates in the  
             <filename>samples/certificate</filename> directory in the Spring Security project.