diff --git a/docs/manual/src/docbook/community.xml b/docs/manual/src/docbook/community.xml index 99b5bc1d3a..2d7994824b 100644 --- a/docs/manual/src/docbook/community.xml +++ b/docs/manual/src/docbook/community.xml @@ -1,59 +1,50 @@ - - + - Spring Security Community - - -
- Issue Tracking - - Spring Security uses JIRA to manage bug reports and enhancement - requests. If you find a bug, please log a report using JIRA. Do not - log it on the support forum, mailing list or by emailing the project's - developers. Such approaches are ad-hoc and we prefer to manage bugs - using a more formal process. - - 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 the issue tracker, although we only accept enhancement requests - if you include corresponding unit tests. This is necessary to ensure - project test coverage is adequately maintained. - - You can access the issue tracker at - http://jira.springframework.org/browse/SEC. - -
- -
- Becoming Involved - - We welcome your involvement in Spring Security project. - There are many ways of contributing, including reading the forum - and responding to questions from other people, writing new code, - improving existing code, assisting with documentation, developing - samples or tutorials, or simply making suggestions. - -
- -
- Further Information - - Questions and comments on Spring Security are welcome. You can use the - Spring Community Forum web site at - http://forum.springframework.org - to discuss Spring Security with other users of the framework. - Remember to use JIRA for bug reports, as explained above. - Everyone is also welcome to join the Acegisecurity-developer mailing - list and participate in design discussions. The - traffic volume is very light. -
- \ No newline at end of file + +
+ + Further Information + + Questions and comments on Spring Security are welcome. You can use the Spring + Community Forum web site at http://forum.springsource.org to discuss Spring Security with other users of + the framework. Remember to use JIRA for bug reports, as explained above. Everyone is + also welcome to join the Acegisecurity-developer mailing list and participate in design + discussions. The traffic volume is very light. +
+ diff --git a/docs/manual/src/docbook/introduction.xml b/docs/manual/src/docbook/introduction.xml index de33f1d3ec..e5ab7faeaa 100644 --- a/docs/manual/src/docbook/introduction.xml +++ b/docs/manual/src/docbook/introduction.xml @@ -2,7 +2,7 @@ Introduction - +
What is Spring Security? Spring Security provides comprehensive security services for J2EE-based enterprise software applications. There is a particular emphasis on supporting projects built using @@ -161,8 +161,8 @@ Specification web pattern security, EJB Container Managed Security and file system security respectively. Spring Security provides deep capabilities in all of these important areas, which we'll explore later in this reference guide. - - +
+
History Spring Security began in late 2003 as "The Acegi Security System for Spring". A question was posed on the Spring Developers' mailing list asking whether there had been @@ -181,7 +181,7 @@ Container Managed Security was relied upon for the authentication process, with Acegi Security instead focusing on authorization. This was suitable at first, but as more and more users requested additional container support, the fundamental limitation of - container-specific authentication realm interfaces was experienced. There was also a + container-specific authentication realm interfaces became clear. There was also a related issue of adding new JARs to the container's classpath, which was a common source of end user confusion and misconfiguration. Acegi Security-specific authentication services were subsequently introduced. Around a @@ -190,13 +190,13 @@ use in numerous production software projects and many hundreds of improvements and community contributions. Acegi Security became an official Spring Portfolio project towards the end of 2007 and - was rebranded as "Spring Security". + was rebranded as Spring Security. Today Spring Security enjoys a strong and active open source community. There are thousands of messages about Spring Security on the support forums. There is an active - core of developers work who work on the code itself and an active community which also + core of developers who work on the code itself and an active community which also regularly share patches and support their peers. - - +
+
Release Numbering It is useful to understand how Spring Security release numbers work, as it will help you identify the effort (or lack thereof) involved in migrating to future releases of @@ -209,22 +209,88 @@ the API. MINOR versions retain source and binary compatibility with older minor versions, and changes in the PATCH level are perfectly compatible, forwards and backwards. - - - Getting the Source - Since Spring Security is an Open Source project, we'd strongly encourage you to check - out the source code using subversion. This will give you full access to all the sample - applications and you can build the most up to date version of the project easily. Having - the source for a project is also a huge help in debugging. Exception stack traces are no - longer obscure black-box issues but you can get straight to the line that's causing the - problem and work out what's happening. The source is the ultimate documentation for a - project and often the simplest place to find out how something actually works. - To obtain the source for the project trunk, use the following subversion command: - - svn checkout https://src.springframework.org/svn/spring-security/trunk/ - - You can checkout specific versions from - https://src.springframework.org/svn/spring-security/tags/. - - +
+
+ Getting Spring Security + You can get hold of Spring Security in several ways. You can download a packaged + distribution from the main Spring download page, download individual jars (and sample WAR files) from the + Maven Central repository (or a SpringSource Maven repository for snapshot and milestone + releases). Alternatively, you can build the project from source yourself. See the + project web site for more details. +
+ Project Modules + In Spring Security 3.0, the codebase has been sub-divided into separate jars which + more clearly separate different functionaltiy areas and third-party dependencies. If + you are using Maven to build your project, then these are the modules you will add + to your pom.xml. Even if you're not using Maven, we'd recommend + that you consult the pom.xml files to get an idea of + third-party dependencies and versions. Alternatively, a good idea is to examine the + libraries that are included in the sample applications. +
+ Core - <literal>spring-security-core.jar</literal> + Contains core authentication and access-contol classes and interfaces, + remoting support and basic provisioning APIs. Required by any application which + uses Spring Security. Supports standalone applications, remote clients, method + (service layer) security and JDBC user provisioning. Contains the top-level packages:org.springframework.security.coreorg.springframework.security.accessorg.springframework.security.authenticationorg.springframework.security.provisioningorg.springframework.security.remoting +
+
+ Web - <literal>spring-security-web.jar</literal> + Contains filters and related web-security infrastructure code. Anything with a + servlet API dependency. You'll need it if you require Spring Security web + authentication services and URL-based access-control. The main package is + org.springframework.security.web. +
+
+ Config - <literal>spring-security-config.jar</literal> + Contains the security namespace parsing code (and hence nothing that you are + likely yo use directly in your application). You need it if you are using the + Spring Security XML namespace for configuration. The main package is + org.springframework.security.config. +
+
+ LDAP - <literal>spring-security-ldap.jar</literal> + LDAP authentication and provisioning code. Required if you need to use LDAP + authentication or manage LDAP user entries. The top-level package is + org.springframework.security.ldap. +
+
+ ACL - <literal>spring-security-acl.jar</literal> + Specialized domain object ACL implementation. Used to apply security to + specific domain object instances within your application. The top-level package + is org.springframework.security.acls. +
+
+ CAS - <literal>spring-security-cas-client.jar</literal> + Spring Security's CAS client integration. If you want to use Spring Security + web authentication with a CAS single sign-on server. The top-level package is + org.springframework.security.cas. +
+
+ OpenID - <literal>spring-security-openid.jar</literal> + OpenID web authentication support. Used to authenticate users against an + external OpenID server. org.springframework.security.openid. + Requires OpenID4Java. +
+
+
+ Checking out the Source + Since Spring Security is an Open Source project, we'd strongly encourage you to + check out the source code using subversion. This will give you full access to all + the sample applications and you can build the most up to date version of the project + easily. Having the source for a project is also a huge help in debugging. Exception + stack traces are no longer obscure black-box issues but you can get straight to the + line that's causing the problem and work out what's happening. The source is the + ultimate documentation for a project and often the simplest place to find out how + something actually works. + To obtain the source for the project trunk, use the following subversion command: + + svn checkout https://src.springframework.org/svn/spring-security/trunk/ + + You can checkout specific versions from + https://src.springframework.org/svn/spring-security/tags/. + +
+
diff --git a/docs/manual/src/docbook/springsecurity.xml b/docs/manual/src/docbook/springsecurity.xml index f6d930ad0d..f53264f5db 100644 --- a/docs/manual/src/docbook/springsecurity.xml +++ b/docs/manual/src/docbook/springsecurity.xml @@ -76,7 +76,10 @@ approach where you have to wire up all the implementation classes individually. We'll also take a look at the sample applications that are available. It's worth trying to run these and experimenting with them a bit even before you read the later sections - you - can dip back into them as your understanding of the framework increases. + can dip back into them as your understanding of the framework increases. Please also check + out the project website as + it has useful information on building the project, plus links to articles, videos and tutorials. + @@ -112,7 +115,7 @@ - +