From f026b3a08a4326e932d01ec35ad8e609e41697af Mon Sep 17 00:00:00 2001 From: Ben Alex Date: Fri, 2 Apr 2004 12:11:13 +0000 Subject: [PATCH] Documentation improvements. --- .../org/acegisecurity/Authentication.java | 13 +++++----- .../org/acegisecurity/ConfigAttribute.java | 13 +++++----- .../ConfigAttributeDefinition.java | 24 +++++++++++++------ .../org/acegisecurity/adapters/package.html | 11 +++++---- .../acegisecurity/context/SecureContext.java | 2 +- .../main/java/org/acegisecurity/package.html | 17 +------------ .../org/acegisecurity/providers/package.html | 3 +-- .../java/org/acegisecurity/runas/package.html | 2 +- 8 files changed, 42 insertions(+), 43 deletions(-) diff --git a/core/src/main/java/org/acegisecurity/Authentication.java b/core/src/main/java/org/acegisecurity/Authentication.java index 4120975acf..3fb258d0a7 100644 --- a/core/src/main/java/org/acegisecurity/Authentication.java +++ b/core/src/main/java/org/acegisecurity/Authentication.java @@ -37,18 +37,19 @@ public interface Authentication { /** * Indicates whether or not authentication was attempted by the {@link - * net.sf.acegisecurity.SecurityInterceptor}. Note that classes should - * not rely on this value as being valid unless it has been set by a - * trusted SecurityInterceptor. + * net.sf.acegisecurity.intercept.AbstractSecurityInterceptor}. Note that + * classes should not rely on this value as being valid unless it has been + * set by a trusted AbstractSecurityInterceptor. * - * @return true if authenticated by the SecurityInterceptor + * @return true if authenticated by the + * AbstractSecurityInterceptor */ public boolean isAuthenticated(); /** * Set by an AuthenticationManager to indicate the authorities - * that the principal has been granted. Note that classes should not rely - * on this value as being valid unless it has been set by a trusted + * that the principal has been granted. Note that classes should not rely + * on this value as being valid unless it has been set by a trusted * AuthenticationManager. * * @return the authorities granted to the principal, or null diff --git a/core/src/main/java/org/acegisecurity/ConfigAttribute.java b/core/src/main/java/org/acegisecurity/ConfigAttribute.java index cc8783f333..24200c571b 100644 --- a/core/src/main/java/org/acegisecurity/ConfigAttribute.java +++ b/core/src/main/java/org/acegisecurity/ConfigAttribute.java @@ -19,15 +19,16 @@ package net.sf.acegisecurity; * Stores a security system related configuration attribute. * *

- * When the {@link SecurityInterceptor} is setup, a list of configuration - * attributes is defined for secure method patterns. These configuration - * attributes have special meaning to a {@link RunAsManager}, {@link - * AccessDecisionManager} or AccessDecisionManager delegate. + * When an {@link net.sf.acegisecurity.intercept.AbstractSecurityInterceptor} + * is setup, a list of configuration attributes is defined for secure object + * patterns. These configuration attributes have special meaning to a {@link + * RunAsManager}, {@link AccessDecisionManager} or + * AccessDecisionManager delegate. *

* *

* Stored at runtime with other ConfigAttributes for the same - * method within a {@link ConfigAttributeDefinition}. + * secure object target within a {@link ConfigAttributeDefinition}. *

* * @author Ben Alex @@ -47,7 +48,7 @@ public interface ConfigAttribute { *

* If the ConfigAttribute cannot be expressed with sufficient * precision as a String, null should be - * returned. Returning null will require an relying classes + * returned. Returning null will require any relying classes * to specifically support the ConfigAttribute * implementation, so returning null should be avoided * unless actually required. diff --git a/core/src/main/java/org/acegisecurity/ConfigAttributeDefinition.java b/core/src/main/java/org/acegisecurity/ConfigAttributeDefinition.java index c23757d94f..b733152e9b 100644 --- a/core/src/main/java/org/acegisecurity/ConfigAttributeDefinition.java +++ b/core/src/main/java/org/acegisecurity/ConfigAttributeDefinition.java @@ -22,12 +22,12 @@ import java.util.Vector; /** * Holds a group of {@link ConfigAttribute}s that are associated with a given - * method. + * secure object target. * *

* All the ConfigAttributeDefinitions associated with a given - * SecurityInterceptor are stored in a {@link - * MethodDefinitionMap}. + * {@link net.sf.acegisecurity.intercept.AbstractSecurityInterceptor} are + * stored in an {@link net.sf.acegisecurity.intercept.ObjectDefinitionSource}. *

* * @author Ben Alex @@ -47,18 +47,28 @@ public class ConfigAttributeDefinition { //~ Methods ================================================================ /** - * DOCUMENT ME! + * Returns an Iterator over all the + * ConfigAttributes defined by this + * ConfigAttributeDefinition. + * + *

+ * Allows AccessDecisionManagers and other classes to loop + * through every configuration attribute associated with a target secure + * object. + *

* - * @return all the configuration attributes related to the method. + * @return all the configuration attributes stored by the instance, or + * null if an Iterator is unavailable */ public Iterator getConfigAttributes() { return this.configAttributes.iterator(); } /** - * Adds a ConfigAttribute that is related to the method. + * Adds a ConfigAttribute that is related to the secure object + * method. * - * @param newConfigAttribute DOCUMENT ME! + * @param newConfigAttribute the new configuration attribute to add */ public void addConfigAttribute(ConfigAttribute newConfigAttribute) { this.configAttributes.add(newConfigAttribute); diff --git a/core/src/main/java/org/acegisecurity/adapters/package.html b/core/src/main/java/org/acegisecurity/adapters/package.html index cd2ca6424b..117e4e1e86 100644 --- a/core/src/main/java/org/acegisecurity/adapters/package.html +++ b/core/src/main/java/org/acegisecurity/adapters/package.html @@ -1,8 +1,11 @@ -Provides "adapters" so that containers can authenticate with the -Acegi Security System for Spring. -

+Allows external containers to obtain authentication information from the +system. + +

It is recommended to use the net.sf.acegisecurity.ui.webapp +package for standard web applications, as it has much lower configuration +complexity.

+ - diff --git a/core/src/main/java/org/acegisecurity/context/SecureContext.java b/core/src/main/java/org/acegisecurity/context/SecureContext.java index bb33f5357b..223e46cf29 100644 --- a/core/src/main/java/org/acegisecurity/context/SecureContext.java +++ b/core/src/main/java/org/acegisecurity/context/SecureContext.java @@ -24,7 +24,7 @@ import net.sf.acegisecurity.Authentication; *

* This interface must be implemented on contexts that will be presented to the * Acegi Security System for Spring, as it is required by the {@link - * net.sf.acegisecurity.SecurityInterceptor}. + * net.sf.acegisecurity.intercept.method.MethodSecurityInterceptor}. *

* * @author Ben Alex diff --git a/core/src/main/java/org/acegisecurity/package.html b/core/src/main/java/org/acegisecurity/package.html index 7f31f9fd64..36dbb1d84b 100644 --- a/core/src/main/java/org/acegisecurity/package.html +++ b/core/src/main/java/org/acegisecurity/package.html @@ -1,21 +1,6 @@ -Provides core security classes of the Acegi Security System for Spring. -

-The {@link net.sf.acegisecurity.SecurityInterceptor} is the main class. -It delegates to two interfaces, -{@link net.sf.acegisecurity.AuthenticationManager} and -{@link net.sf.acegisecurity.AccessDecisionManager} for authentication and -authorization respectively. -

-When configuring SecurityInterceptor in the bean context, each -method to be secured is provided a comma separated list of configuration -attributes ({@link net.sf.acegisecurity.ConfigAttribute}). -These configuration attributes are relevant only to -AccessDecisionManagers. -

-Read the JavaDocs of the key classes listed above to learn more about how -the security classes operate. +Provides core Acegi Security System for Spring interfaces and classes. diff --git a/core/src/main/java/org/acegisecurity/providers/package.html b/core/src/main/java/org/acegisecurity/providers/package.html index ab98f28b3f..3d69a10b0e 100644 --- a/core/src/main/java/org/acegisecurity/providers/package.html +++ b/core/src/main/java/org/acegisecurity/providers/package.html @@ -1,7 +1,6 @@ -Implements a provider-based approach to authorization decisions. +Implements a provider-based approach to authentication decisions.

- diff --git a/core/src/main/java/org/acegisecurity/runas/package.html b/core/src/main/java/org/acegisecurity/runas/package.html index c0ca485b74..0ab08f2463 100644 --- a/core/src/main/java/org/acegisecurity/runas/package.html +++ b/core/src/main/java/org/acegisecurity/runas/package.html @@ -1,5 +1,5 @@ -Allows intercepted methods to be run under a different authentication identity. +Allows secure objects to be run under a different authentication identity.