Documentation improvement
This commit is contained in:
Carlos Sanchez
parent
cbd842ea44
commit
b0f6c5179a
|
|
@ -0,0 +1,45 @@
|
|||
<!--
|
||||
* ========================================================================
|
||||
*
|
||||
* Copyright 2004 Acegi Technology Pty Limited
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "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.
|
||||
*
|
||||
* ========================================================================
|
||||
-->
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
|
||||
<head>
|
||||
<title>Building</title>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<h1>Building Acegi Security System</h1>
|
||||
<h2>Building from CVS </h2>
|
||||
<p>This project uses <a href="http://maven.apache.org">Maven</a> as project manager and build tool. You only need to</p>
|
||||
<ol>
|
||||
<li>Install maven (at least 1.0).</li>
|
||||
<li>Run the following instruction on a single line to get latest sources from cvs HEAD </li>
|
||||
<pre>maven scm:checkout-project
|
||||
-Dmaven.scm.method=cvs
|
||||
-Dmaven.scm.cvs.module=acegisecurity
|
||||
-Dmaven.scm.cvs.root=:pserver:anonymous@cvs.sourceforge.net:/cvsroot/acegisecurity
|
||||
-Dmaven.scm.checkout.dir=acegisecurity</pre>
|
||||
|
||||
<li>Run maven in any module directory, or <kbd>maven multiproject:artifact</kbd> in the root folder if you want to build all modules.</li>
|
||||
</ol>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1,60 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
|
||||
<!--
|
||||
* ========================================================================
|
||||
*
|
||||
* Copyright 2004 Acegi Technology Pty Limited
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "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.
|
||||
*
|
||||
* ========================================================================
|
||||
-->
|
||||
|
||||
<document>
|
||||
<properties>
|
||||
<title>Acegi security changes</title>
|
||||
</properties>
|
||||
<body>
|
||||
<release version="0.7-SNAPSHOT" date="in CVS">
|
||||
<action dev="carlossg" type="add">Major CVS repository restructure to support Maven and eliminate libraries</action>
|
||||
<action dev="benalex" type="update">Major improvements to Contacts sample application (now demos ACL security)</action>
|
||||
<action dev="benalex" type="add">Added AfterInvocationManager to mutate objects return from invocations</action>
|
||||
<action dev="benalex" type="add">Added BasicAclEntryAfterInvocationProvider to ACL evaluate returned Object</action>
|
||||
<action dev="benalex" type="add">Added BasicAclEntryAfterInvocationCollectionFilteringProvider</action>
|
||||
<action dev="benalex" type="add">Added security propagation during RMI invocations (from sandbox)</action>
|
||||
<action dev="benalex" type="add">Added security propagation for Spring's HTTP invoker</action>
|
||||
<action dev="benalex" type="add">Added BasicAclEntryVoter, which votes based on AclManager permissions</action>
|
||||
<action dev="benalex" type="add">Added AspectJ support (especially useful for instance-level security)</action>
|
||||
<action dev="benalex" type="add">Added MethodDefinitionSourceAdvisor for performance and autoproxying</action>
|
||||
<action dev="benalex" type="add">Added MethodDefinitionMap querying of interfaces defined by secure objects</action>
|
||||
<action dev="benalex" type="add">Added AuthenticationProcessingFilter.setDetails for use by subclasses</action>
|
||||
<action dev="benalex" type="add">Added 403-causing exception to HttpSession via SecurityEnforcementFilter</action>
|
||||
<action dev="benalex" type="add">Added net.sf.acegisecurity.intercept.event package</action>
|
||||
<action dev="benalex" type="add">Added BasicAclExtendedDao interface and JdbcExtendedDaoImpl for ACL CRUD</action>
|
||||
<action dev="benalex" type="add">Added additional remoting protocol demonstrations to Contacts sample</action>
|
||||
<action dev="benalex" type="update">Improved BasicAclProvider to only respond to specified ACL object requests</action>
|
||||
<action dev="benalex" type="update">Refactored MethodDefinitionSource to work with Method, not MethodInvocation</action>
|
||||
<action dev="benalex" type="update">Refactored AbstractSecurityInterceptor to better support other AOP libraries</action>
|
||||
<action dev="benalex" type="fix">Fixed AbstractProcessingFilter to use removeAttribute (JRun compatibility)</action>
|
||||
<action dev="benalex" type="fix">Fixed GrantedAuthorityEffectiveAclResolver support of UserDetails principals</action>
|
||||
<action dev="benalex" type="update">Moved MethodSecurityInterceptor to ...intercept.method.aopalliance package</action>
|
||||
<action dev="benalex" type="update">Documentation improvements</action>
|
||||
</release>
|
||||
<release version="0.6.1" date="2004-09-24"/>
|
||||
<release version="0.6" date="2004-08-08"/>
|
||||
<release version="0.5.1" date="2004-06-05"/>
|
||||
<release version="0.5" date="2004-04-28"/>
|
||||
<release version="0.4" date="2004-04-03"/>
|
||||
<release version="0.3" date="2004-03-18"/>
|
||||
</body>
|
||||
</document>
|
||||
|
|
@ -0,0 +1,82 @@
|
|||
<!--
|
||||
* ========================================================================
|
||||
*
|
||||
* Copyright 2004 Acegi Technology Pty Limited
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "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.
|
||||
*
|
||||
* ========================================================================
|
||||
-->
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<title>CVS usage</title>
|
||||
<h1>CVS instructions for all modules</h1>
|
||||
<p>This instructions are general, check the module documentation if you need concrete instructions. </p>
|
||||
<p><em>modulename</em> can be for example:</p>
|
||||
<ul>
|
||||
<li>acegisecurity <em>(this will check out all modules) </em></li>
|
||||
<li>acegisecurity/core/</li>
|
||||
<li>acegisecurity/adapters/cas</li>
|
||||
</ul>
|
||||
<h2>Web Access</h2>
|
||||
<p>
|
||||
<a href="http://cvs.sourceforge.net/viewcvs.py/acegisecurity">http://cvs.sourceforge.net/viewcvs.py/acegisecurity</a>
|
||||
</p><h2>Anonymous Access with Maven</h2>
|
||||
<p> This project's CVS repository can be checked out through anonymous (pserver) CVS with the following instruction on a single line. </p>
|
||||
<pre>maven scm:checkout-project
|
||||
-Dmaven.scm.method=cvs
|
||||
-Dmaven.scm.cvs.module=modulename
|
||||
-Dmaven.scm.cvs.root=:pserver:anonymous@cvs.sourceforge.net:/cvsroot/acegisecurity
|
||||
-Dmaven.scm.checkout.dir=acegisecurity</pre>
|
||||
<h2>Anonymous CVS Access</h2>
|
||||
<p>
|
||||
This project's CVS repository can be checked out through anonymous (pserver)
|
||||
CVS with the following instruction set.
|
||||
When prompted for a password for anonymous, simply press the Enter key.
|
||||
</p><p>
|
||||
cvs -d :pserver:anonymous@cvs.sourceforge.net:/cvsroot/acegisecurity login
|
||||
<br>
|
||||
cvs -z3 -d :pserver:anonymous@cvs.sourceforge.net:/cvsroot/acegisecurity co <em>modulename</em> </p>
|
||||
<p>
|
||||
Updates from within the module's directory do not need the -d parameter.
|
||||
</p><h2>Developer Access with Maven</h2>
|
||||
<p> Only project developers can access the CVS tree via this method. Substitute <b>username</b> with the proper value. </p>
|
||||
<pre>maven scm:checkout-project
|
||||
-Dmaven.scm.method=cvs
|
||||
-Dmaven.scm.cvs.module=modulename
|
||||
-Dmaven.scm.cvs.root=:ext:username@cvs.sourceforge.net:/cvsroot/acegisecurity
|
||||
-Dmaven.scm.checkout.dir=acegisecurity
|
||||
-Dmaven.scm.cvs.rsh=ssh</pre>
|
||||
<p> Remember to replace 'username' with your actual username on cvs.sourceforge.net.<br />
|
||||
Also change <code>ssh</code> in <code>maven.scm.cvs.rsh=ssh</code> to the name of your ssh executable. </p>
|
||||
<h2>Developer CVS Access via SSH</h2>
|
||||
<p>
|
||||
Only project developers can access the CVS tree via this method.
|
||||
SSH must be installed on your client machine. Substitute
|
||||
<b>username</b> with the proper value. Enter your site password when prompted.
|
||||
</p>
|
||||
<p>
|
||||
export CVS_RSH=ssh
|
||||
<br>
|
||||
cvs -z3 -d :ext:username@cvs.sourceforge.net:/cvsroot/acegisecurity co <em>modulename</em> </p>
|
||||
<p>
|
||||
Remember to replace 'username' with your actual username on cvs.sourceforge.net.
|
||||
</p><h2>CVS Access behind a firewall</h2>
|
||||
<p>
|
||||
For those developers who are stuck behind a corporate
|
||||
firewall, <a href="http://cvsgrab.sourceforge.net/">CVSGrab</a>
|
||||
can use the viewcvs web interface to checkout the source code.
|
||||
</p>
|
||||
</html>
|
||||
|
|
@ -1,4 +1,4 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<?xml version="1.0"?>
|
||||
|
||||
<!--
|
||||
* ========================================================================
|
||||
|
|
@ -21,12 +21,19 @@
|
|||
-->
|
||||
|
||||
<document>
|
||||
|
||||
<properties>
|
||||
<title>Acegi security changes</title>
|
||||
<title>Downloading Acegi</title>
|
||||
</properties>
|
||||
|
||||
<body>
|
||||
<release version="0.7-SNAPSHOT" date="in CVS">
|
||||
<action dev="carlos" type="add">Migrated to Maven</action>
|
||||
</release>
|
||||
<section name="Downloading Acegi">
|
||||
|
||||
<p>
|
||||
You can download the latest release from the
|
||||
<a href="http://sourceforge.net/project/showfiles.php?group_id=104215">Sourceforge project site</a>.
|
||||
</p>
|
||||
|
||||
</section>
|
||||
</body>
|
||||
</document>
|
||||
|
|
@ -1,49 +0,0 @@
|
|||
<?xml version="1.0"?>
|
||||
|
||||
<document>
|
||||
|
||||
<properties>
|
||||
<title>Acegi FAQ</title>
|
||||
</properties>
|
||||
|
||||
<body>
|
||||
|
||||
<section name="Frequently Asked Questions">
|
||||
<p>
|
||||
This document attempts to answer some of the more frequently asked
|
||||
questions regarding various aspects of JBoss. These questions are
|
||||
typically asked over and over again on the mailing lists and forums. As a
|
||||
courtesy to the developers, we ask that you read this document
|
||||
before posting to the mailing lists.
|
||||
</p>
|
||||
<p>
|
||||
<strong>General</strong>
|
||||
</p>
|
||||
<ol>
|
||||
<li>
|
||||
<a href="#what-is-acegi">
|
||||
What is Acegi?
|
||||
</a>
|
||||
</li>
|
||||
</ol>
|
||||
|
||||
<p>
|
||||
<strong>More FAQs ...</strong>
|
||||
</p>
|
||||
|
||||
|
||||
<section name="General">
|
||||
<dl>
|
||||
<dt>
|
||||
<a name="what-is-acegi">
|
||||
What is Acegi?
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
...
|
||||
</dd>
|
||||
</dl>
|
||||
</section>
|
||||
</section>
|
||||
</body>
|
||||
</document>
|
||||
|
|
@ -1,5 +1,25 @@
|
|||
<?xml version="1.0" encoding="ISO-8859-1"?>
|
||||
|
||||
<!--
|
||||
* ========================================================================
|
||||
*
|
||||
* Copyright 2004 Acegi Technology Pty Limited
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "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.
|
||||
*
|
||||
* ========================================================================
|
||||
-->
|
||||
|
||||
<project>
|
||||
|
||||
<body>
|
||||
|
|
@ -8,8 +28,10 @@
|
|||
</links>
|
||||
|
||||
<menu name="Overview">
|
||||
<item name="Home" href="/index.html"/>
|
||||
<item name="Reference" href="/docbook/index.html"/>
|
||||
<item name="Home" href="index.html"/>
|
||||
<item name="Reference" href="reference.html"/>
|
||||
<item name="Building" href="building.html"/>
|
||||
<item name="Download" href="download.html"/>
|
||||
</menu>
|
||||
|
||||
<menu name="Subprojects">
|
||||
|
|
|
|||
|
|
@ -0,0 +1,59 @@
|
|||
<?xml version="1.0"?>
|
||||
|
||||
<!--
|
||||
* ========================================================================
|
||||
*
|
||||
* Copyright 2004 Acegi Technology Pty Limited
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "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.
|
||||
*
|
||||
* ========================================================================
|
||||
-->
|
||||
|
||||
<document>
|
||||
|
||||
<properties>
|
||||
<title>Reference Documentation</title>
|
||||
</properties>
|
||||
|
||||
<body>
|
||||
<section name="Reference Documentation">
|
||||
|
||||
<subsection name="Overview of the Reference Documentation">
|
||||
<table>
|
||||
<tr><th>Document</th><th>Description</th></tr>
|
||||
|
||||
<tr>
|
||||
<td>
|
||||
<a href="docbook/index.html">Reference Guide HTML</a>
|
||||
</td>
|
||||
<td>
|
||||
The original docbook-generated reference. This is a good place to start if you want
|
||||
to use the Acegi System to secure your applications.
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td>
|
||||
<a href="docbook/index.pdf">Reference Guide PDF</a>
|
||||
</td>
|
||||
<td>
|
||||
The pdf version of the reference guide.
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
</subsection>
|
||||
</section>
|
||||
</body>
|
||||
</document>
|
||||
|
|
@ -1,33 +0,0 @@
|
|||
<?xml version="1.0"?>
|
||||
<document>
|
||||
|
||||
<properties>
|
||||
<title>Reference Documentation</title>
|
||||
</properties>
|
||||
|
||||
<body>
|
||||
<section name="Reference Documentation">
|
||||
|
||||
<subsection name="Overview of the Reference Documentation">
|
||||
<table>
|
||||
<tr><th>Document</th><th>Description</th></tr>
|
||||
|
||||
<tr><td><a href="../ref/index.html">Reference Guide</a></td>
|
||||
<td>
|
||||
The original docbook-generated reference. This is a good place to start if you want
|
||||
to use the Acegi System to secure your applications.
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<!-- <tr><td><a href="developer-guide.html">Developer Guide</a></td>
|
||||
<td>
|
||||
The Developer Guide is intended to help developers get
|
||||
acquainted with the project.
|
||||
</td>
|
||||
</tr>
|
||||
-->
|
||||
</table>
|
||||
</subsection>
|
||||
</section>
|
||||
</body>
|
||||
</document>
|
||||
|
|
@ -1,38 +0,0 @@
|
|||
<?xml version="1.0"?>
|
||||
<document>
|
||||
|
||||
<properties>
|
||||
<title>Building Acegi</title>
|
||||
</properties>
|
||||
|
||||
<body>
|
||||
<section name="Building Acegi">
|
||||
<p>
|
||||
TODO: Checkout the source from Sourceforge...
|
||||
</p>
|
||||
|
||||
<subsection name="Maven Build">
|
||||
<p>
|
||||
The first thing to do if you want to use Maven is download and install it.
|
||||
The build has been tested with version 1-rc3 so use this or a later version if possible.
|
||||
</p>
|
||||
<p>
|
||||
One of the main differences between Maven and plain ant is that Maven manages
|
||||
external dependencies for your projects and (at least in theory) you should no
|
||||
longer have to store third-party jar files in your CVS tree. It maintains a local repository of
|
||||
versioned libraries and shares them between your Maven projects. If it can't find the necessary
|
||||
files there it will attempt to download them from the main Maven repository at www.ibiblio.org/maven.
|
||||
So to use the Maven build, you need to have a network connection available for the inital download of
|
||||
the project dependencies (and any others that Maven itself requires).
|
||||
</p>
|
||||
<p>
|
||||
Once you have Maven installed, building the project should be as simple as typing "maven jar"
|
||||
from the command line. Providing there are no failures in the test suite, this will create the
|
||||
project jar files in the "target" directory. For more information on using Maven, have a look at the
|
||||
<a href="http://maven.apache.org/">Maven web site</a>.
|
||||
</p>
|
||||
</subsection>
|
||||
|
||||
</section>
|
||||
</body>
|
||||
</document>
|
||||
|
|
@ -1,18 +0,0 @@
|
|||
<?xml version="1.0"?>
|
||||
<document>
|
||||
|
||||
<properties>
|
||||
<title>Downloading Acegi</title>
|
||||
</properties>
|
||||
|
||||
<body>
|
||||
<section name="Downloading Acegi">
|
||||
|
||||
<p>
|
||||
You can downloade the latest release from the
|
||||
<a href="http://sourceforge.net/project/showfiles.php?group_id=104215">Sourceforge project site</a>.
|
||||
</p>
|
||||
|
||||
</section>
|
||||
</body>
|
||||
</document>
|
||||
|
|
@ -1,26 +0,0 @@
|
|||
<?xml version="1.0"?>
|
||||
<document>
|
||||
|
||||
<properties>
|
||||
<title>Getting Started with Acegi</title>
|
||||
</properties>
|
||||
|
||||
<body>
|
||||
<section name="Getting Started with Acegi">
|
||||
|
||||
<subsection name="Overview of the Getting Started Documentation">
|
||||
<table>
|
||||
<tr><th>Document</th><th>Description</th></tr>
|
||||
<tr><td><a href="download.html">Download</a></td>
|
||||
<td>
|
||||
Before you can start using Acegi, you'll have
|
||||
to download the distribution to your system (unless
|
||||
you plan on building the project from source). This document
|
||||
provides links to the various distributions available.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</subsection>
|
||||
</section>
|
||||
</body>
|
||||
</document>
|
||||
|
|
@ -1,43 +0,0 @@
|
|||
<?xml version="1.0"?>
|
||||
|
||||
<document>
|
||||
|
||||
<properties>
|
||||
<title>News and Status</title>
|
||||
</properties>
|
||||
|
||||
<body>
|
||||
<section name="News and Status">
|
||||
|
||||
<subsection name="Current Status">
|
||||
<p>
|
||||
The next release of Acegi will be version 0.6.
|
||||
</p>
|
||||
</subsection>
|
||||
|
||||
<subsection name="5th June 2004">
|
||||
<p>
|
||||
Version 0.51 released.
|
||||
</p>
|
||||
</subsection>
|
||||
|
||||
<subsection name="28th April 2004">
|
||||
<p>
|
||||
Version 0.5 released.
|
||||
</p>
|
||||
</subsection>
|
||||
|
||||
<subsection name="3rd April 2004">
|
||||
<p>
|
||||
Version 0.4 released.
|
||||
</p>
|
||||
</subsection>
|
||||
|
||||
<subsection name="18th March 2004">
|
||||
<p>
|
||||
Version 0.3 released.
|
||||
</p>
|
||||
</subsection>
|
||||
</section>
|
||||
</body>
|
||||
</document>
|
||||
Loading…
Reference in New Issue