From b7a579f27abe39483b7d960f478d300c0d923f16 Mon Sep 17 00:00:00 2001
From: Ben Alex
- * Stored in a request {@link - * org.acegisecurity.context.security.SecurityContext}. + * Stored in a request {@link org.acegisecurity.context.SecurityContext}. *
* * @author Ben Alex diff --git a/core/src/main/java/org/acegisecurity/concurrent/ConcurrentSessionController.java b/core/src/main/java/org/acegisecurity/concurrent/ConcurrentSessionController.java index 9d349ab16a..e4ccd911b6 100644 --- a/core/src/main/java/org/acegisecurity/concurrent/ConcurrentSessionController.java +++ b/core/src/main/java/org/acegisecurity/concurrent/ConcurrentSessionController.java @@ -47,7 +47,7 @@ public interface ConcurrentSessionController { /** * Called by anAuthenticationManager when the authentication was successful. An
* implementation is expected to register the authenticated user in some sort of registry, for future concurrent
- * tracking via the {@link #checkConcurrentAuthentication(Authentication)} method.
+ * tracking via the {@link #checkAuthenticationAllowed(Authentication)} method.
*
* @param authentication the successfully authenticated user (never null)
*/
diff --git a/core/src/main/java/org/acegisecurity/concurrent/SessionRegistry.java b/core/src/main/java/org/acegisecurity/concurrent/SessionRegistry.java
index 27c01d485d..8700a2adb6 100644
--- a/core/src/main/java/org/acegisecurity/concurrent/SessionRegistry.java
+++ b/core/src/main/java/org/acegisecurity/concurrent/SessionRegistry.java
@@ -27,7 +27,7 @@ public interface SessionRegistry {
/**
* Obtains all the known principals in the SessionRegistry.
*
- * @return each of the unique principals, which can then be presented to {@link #getAllSessions(Object)}.
+ * @return each of the unique principals, which can then be presented to {@link #getAllSessions(Object, boolean)}.
*/
public Object[] getAllPrincipals();
diff --git a/core/src/main/java/org/acegisecurity/event/authentication/InteractiveAuthenticationSuccessEvent.java b/core/src/main/java/org/acegisecurity/event/authentication/InteractiveAuthenticationSuccessEvent.java
index 340ca82f9a..9debf3cd84 100644
--- a/core/src/main/java/org/acegisecurity/event/authentication/InteractiveAuthenticationSuccessEvent.java
+++ b/core/src/main/java/org/acegisecurity/event/authentication/InteractiveAuthenticationSuccessEvent.java
@@ -46,7 +46,7 @@ public class InteractiveAuthenticationSuccessEvent extends AbstractAuthenticatio
* Getter for the Class that generated this event. This can be useful for generating
* additional logging information.
*
- * @return
+ * @return the class
*/
public Class getGeneratedBy() {
return generatedBy;
diff --git a/core/src/main/java/org/acegisecurity/intercept/package.html b/core/src/main/java/org/acegisecurity/intercept/package.html
index 53137b0094..6f368ed8cb 100644
--- a/core/src/main/java/org/acegisecurity/intercept/package.html
+++ b/core/src/main/java/org/acegisecurity/intercept/package.html
@@ -8,17 +8,17 @@ secured, but instead refers to some infrastructure object that can have
security facilities provided for it by the Acegi Security System for
Spring. For example, one secure object would be
MethodInvocation, whilst another would be HTTP {@link
-net.sf.acegisecurity.intercept.web.FilterInvocation}. Note these are
+org.acegisecurity.intercept.web.FilterInvocation}. Note these are
infrastructure objects and their design allows them to represent a large
variety of actual resources that might need to be secured, such as business
objects or HTTP request URLs.
Each secure object typically has its
-own net.sf.acegisecurity.intercept package.
+own org.acegisecurity.intercept package.
Each package usually includes a concrete security interceptor (which
-subclasses {@link net.sf.acegisecurity.intercept.AbstractSecurityInterceptor},
-an appropriate {@link net.sf.acegisecurity.intercept.ObjectDefinitionSource}
+subclasses {@link org.acegisecurity.intercept.AbstractSecurityInterceptor},
+an appropriate {@link org.acegisecurity.intercept.ObjectDefinitionSource}
for the type of resources the secure object represents, and a property editor
to populate the ObjectDefinitionSource.
diff --git a/core/src/main/java/org/acegisecurity/providers/dao/salt/ReflectionSaltSource.java b/core/src/main/java/org/acegisecurity/providers/dao/salt/ReflectionSaltSource.java
index 48bd7b5a95..ca9a4b61c5 100644
--- a/core/src/main/java/org/acegisecurity/providers/dao/salt/ReflectionSaltSource.java
+++ b/core/src/main/java/org/acegisecurity/providers/dao/salt/ReflectionSaltSource.java
@@ -27,9 +27,10 @@ import java.lang.reflect.Method;
/**
- * Obtains a salt from a specified property of the {@link User} object.
This allows you to subclass
- * User and provide an additional bean getter for a salt. You should use a synthetic value that does not
- * change, such as a database primary key. Do not use username if it is likely to change.
This allows
+ * you to subclass User and provide an additional bean getter for a salt. You should use a synthetic
+ * value that does not change, such as a database primary key. Do not use username if it is likely to
+ * change.
String as the salt.Does not supply a different salt for each {@link - * User}. This means users sharing the same password will still have the same digested password. Of benefit is the - * digested passwords will at least be more protected than if stored without any salt.
+ * org.acegisecurity.userdetails.User}. This means users sharing the same password will still have the same digested + * password. Of benefit is the digested passwords will at least be more protected than if stored without any salt. * * @author Ben Alex * @version $Id$ diff --git a/core/src/main/java/org/acegisecurity/providers/rememberme/RememberMeAuthenticationProvider.java b/core/src/main/java/org/acegisecurity/providers/rememberme/RememberMeAuthenticationProvider.java index 02f0383ab5..b07a8d196f 100644 --- a/core/src/main/java/org/acegisecurity/providers/rememberme/RememberMeAuthenticationProvider.java +++ b/core/src/main/java/org/acegisecurity/providers/rememberme/RememberMeAuthenticationProvider.java @@ -37,8 +37,8 @@ import org.springframework.util.Assert; /** * An {@link AuthenticationProvider} implementation that validates {@link * org.acegisecurity.providers.rememberme.RememberMeAuthenticationToken}s.To be successfully validated, the - * {@link{@link org.acegisecurity.providers.rememberme.RememberMeAuthenticationToken#getKeyHash()} must match this - * class' {@link #getKey()}.
+ * {@link org.acegisecurity.providers.rememberme.RememberMeAuthenticationToken#getKeyHash()} must match this class' + * {@link #getKey()}. */ public class RememberMeAuthenticationProvider implements AuthenticationProvider, InitializingBean, MessageSourceAware { //~ Static fields/initializers ===================================================================================== diff --git a/core/src/main/java/org/acegisecurity/providers/x509/X509AuthenticationToken.java b/core/src/main/java/org/acegisecurity/providers/x509/X509AuthenticationToken.java index d6ec9468ce..bb6e2816e3 100644 --- a/core/src/main/java/org/acegisecurity/providers/x509/X509AuthenticationToken.java +++ b/core/src/main/java/org/acegisecurity/providers/x509/X509AuthenticationToken.java @@ -36,9 +36,9 @@ public class X509AuthenticationToken extends AbstractAuthenticationToken { //~ Constructors =================================================================================================== -/** - * Used for an authentication request. The {@link - * Authentication#isAuthenticated()} will returnfalse.
+ /**
+ * Used for an authentication request. The {@link org.acegisecurity.Authentication#isAuthenticated()} will return
+ * false.
*
* @param credentials the certificate
*/
@@ -47,9 +47,9 @@ public class X509AuthenticationToken extends AbstractAuthenticationToken {
this.credentials = credentials;
}
-/**
- * Used for an authentication response object. The {@link
- * Authentication#isAuthenticated()} will return true.
+ /**
+ * Used for an authentication response object. The {@link Authentication#isAuthenticated()}
+ * will return true.
*
* @param principal the principal, which is generally a
* UserDetails
diff --git a/core/src/main/java/org/acegisecurity/securechannel/ChannelDecisionManager.java b/core/src/main/java/org/acegisecurity/securechannel/ChannelDecisionManager.java
index c83eccbd18..5d873425d2 100644
--- a/core/src/main/java/org/acegisecurity/securechannel/ChannelDecisionManager.java
+++ b/core/src/main/java/org/acegisecurity/securechannel/ChannelDecisionManager.java
@@ -28,12 +28,6 @@ import javax.servlet.ServletException;
/**
* Decides whether a web channel provides sufficient security.
*
- * - * If necessary due to the nature of the redirection, implementations should - * store the original destination of the request in {@link - * org.acegisecurity.ui.AbstractProcessingFilter#ACEGI_SECURITY_TARGET_URL_KEY}. - *
- * * @author Ben Alex * @version $Id$ */ diff --git a/core/src/main/java/org/acegisecurity/taglibs/velocity/Authz.java b/core/src/main/java/org/acegisecurity/taglibs/velocity/Authz.java index 9da0761d21..f9f05cb67d 100644 --- a/core/src/main/java/org/acegisecurity/taglibs/velocity/Authz.java +++ b/core/src/main/java/org/acegisecurity/taglibs/velocity/Authz.java @@ -73,7 +73,7 @@ public interface Authz { /** * return true if the principal holds either permission specified for the provided domain objectOnly - * works with permissions that are subclasses of {@link net.sf.acegisecurity.acl.basic.AbstractBasicAclEntry}.
+ * works with permissions that are subclasses of {@link org.acegisecurity.acl.basic.AbstractBasicAclEntry}. *For this class to operate it must be able to access the application context via the
* WebApplicationContextUtils and locate an {@link AclManager}.
SecurityEnforcementFilter to commence authentication via the {@link
* BasicProcessingFilter}.Once a user agent is authenticated using BASIC authentication, logout requires that * the browser be closed or an unauthorized (401) header be sent. The simplest way of achieving the latter is to call - * the {@link #commence(ServletRequest, ServletResponse)} method below. This will indicate to the browser its - * credentials are no longer authorized, causing it to prompt the user to login again.
+ * the {@link #commence(ServletRequest, ServletResponse, AuthenticationException)} method below. This will indicate to + * the browser its credentials are no longer authorized, causing it to prompt the user to login again. * * @author Ben Alex * @version $Id$ diff --git a/core/src/main/java/org/acegisecurity/ui/rememberme/TokenBasedRememberMeServices.java b/core/src/main/java/org/acegisecurity/ui/rememberme/TokenBasedRememberMeServices.java index 5cec838c49..929f3c0b04 100644 --- a/core/src/main/java/org/acegisecurity/ui/rememberme/TokenBasedRememberMeServices.java +++ b/core/src/main/java/org/acegisecurity/ui/rememberme/TokenBasedRememberMeServices.java @@ -71,7 +71,7 @@ import javax.servlet.http.HttpServletResponse; *This is a basic remember-me implementation which is suitable for many applications. However, we recommend a * database-based implementation if you require a more secure remember-me approach.
*By default the tokens will be valid for 14 days from the last successful authentication attempt. This can be - * changed using {@link #setTokenValiditySeconds(int)}.
+ * changed using {@link #setTokenValiditySeconds(long)}. * * @author Ben Alex * @version $Id$ diff --git a/core/src/main/java/org/acegisecurity/ui/session/HttpSessionEventPublisher.java b/core/src/main/java/org/acegisecurity/ui/session/HttpSessionEventPublisher.java index 3e9b89660b..69f666198e 100644 --- a/core/src/main/java/org/acegisecurity/ui/session/HttpSessionEventPublisher.java +++ b/core/src/main/java/org/acegisecurity/ui/session/HttpSessionEventPublisher.java @@ -58,8 +58,7 @@ public class HttpSessionEventPublisher implements HttpSessionListener, ServletCo public void contextDestroyed(ServletContextEvent event) {} /** - * Handled internally by a call to {@link - * org.springframework.web.appContext.support.WebApplicationContextUtils#getRequiredWebApplicationContext(javax.servlet.ServletContext)} + * Handled internally by a call to {@link WebApplicationContextUtils#getWebApplicationContext(javax.servlet.ServletContext)}. * * @param event the ServletContextEvent passed in by the container, event.getServletContext() will be used to get * the WebApplicationContext diff --git a/core/src/main/java/org/acegisecurity/userdetails/User.java b/core/src/main/java/org/acegisecurity/userdetails/User.java index b6ecd6fe14..869079edc7 100644 --- a/core/src/main/java/org/acegisecurity/userdetails/User.java +++ b/core/src/main/java/org/acegisecurity/userdetails/User.java @@ -42,8 +42,7 @@ public class User implements UserDetails { //~ Constructors =================================================================================================== /** - * Construct theUser with the details required by {@link
- * DaoAuthenticationProvider}.
+ * Construct the User with the details required by {@link org.acegisecurity.providers.dao.DaoAuthenticationProvider}.
*
* @param username the username presented to the
* DaoAuthenticationProvider
@@ -67,8 +66,7 @@ public class User implements UserDetails {
}
/**
- * Construct the User with the details required by {@link
- * DaoAuthenticationProvider}.
+ * Construct the User with the details required by {@link org.acegisecurity.providers.dao.DaoAuthenticationProvider}.
*
* @param username the username presented to the
* DaoAuthenticationProvider
@@ -97,8 +95,7 @@ public class User implements UserDetails {
}
/**
- * Construct the User with the details required by {@link
- * DaoAuthenticationProvider}.
+ * Construct the User with the details required by {@link org.acegisecurity.providers.dao.DaoAuthenticationProvider}.
*
* @param username the username presented to the
* DaoAuthenticationProvider
diff --git a/core/src/main/java/org/acegisecurity/userdetails/jdbc/JdbcDaoImpl.java b/core/src/main/java/org/acegisecurity/userdetails/jdbc/JdbcDaoImpl.java
index d561940aec..36b51e595e 100644
--- a/core/src/main/java/org/acegisecurity/userdetails/jdbc/JdbcDaoImpl.java
+++ b/core/src/main/java/org/acegisecurity/userdetails/jdbc/JdbcDaoImpl.java
@@ -171,8 +171,8 @@ public class JdbcDaoImpl extends JdbcDaoSupport implements UserDetailsService {
}
/**
- * If true (the default), indicates the {@link #getUsersByUsernameMapping()} returns a
- * username in response to a query. If false, indicates that a primary key is used instead. If set to
+ * If true (the default), indicates the {@link #getUsersByUsernameQuery()} returns a username
+ * in response to a query. If false, indicates that a primary key is used instead. If set to
* true, the class will use the database-derived username in the returned UserDetails.
* If false, the class will use the {@link #loadUserByUsername(String)} derived username in the
* returned UserDetails.
diff --git a/core/src/main/java/org/acegisecurity/util/FilterChainProxy.java b/core/src/main/java/org/acegisecurity/util/FilterChainProxy.java
index 38433ab5ba..0613baa703 100644
--- a/core/src/main/java/org/acegisecurity/util/FilterChainProxy.java
+++ b/core/src/main/java/org/acegisecurity/util/FilterChainProxy.java
@@ -51,9 +51,9 @@ import javax.servlet.ServletResponse;
/**
* Delegates Filter requests to a list of Spring-managed beans.The FilterChainProxy is
* loaded via a standard {@link org.acegisecurity.util.FilterToBeanProxy} declaration in web.xml.
- * FilterChainProxy will then pass {@link #init(FilterConfig)}, {@link #destroy()}, {@link #doInit()} and
- * {@link #doFilter(ServletRequest, ServletResponse, FilterChain)} invocations through to each Filter
- * defined against FilterChainProxy.
FilterChainProxy will then pass {@link #init(FilterConfig)}, {@link #destroy()} and {@link
+ * #doFilter(ServletRequest, ServletResponse, FilterChain)} invocations through to each Filter defined
+ * against FilterChainProxy.
* FilterChainProxy is configured using a standard {@link
* org.acegisecurity.intercept.web.FilterInvocationDefinitionSource}. Each possible URI pattern that
* FilterChainProxy should service must be entered. The first matching URI pattern located by
diff --git a/core/src/main/java/org/acegisecurity/vote/AbstractAclVoter.java b/core/src/main/java/org/acegisecurity/vote/AbstractAclVoter.java
index 751299288c..ba0fd58451 100644
--- a/core/src/main/java/org/acegisecurity/vote/AbstractAclVoter.java
+++ b/core/src/main/java/org/acegisecurity/vote/AbstractAclVoter.java
@@ -16,9 +16,7 @@
package org.acegisecurity.vote;
import org.acegisecurity.AuthorizationServiceException;
-import org.acegisecurity.ConfigAttribute;
-import org.acegisecurity.acl.AclEntry;
import org.acegisecurity.acl.AclManager;
import org.aopalliance.intercept.MethodInvocation;
@@ -32,40 +30,6 @@ import org.springframework.util.Assert;
/**
*
Given a domain object instance passed as a method argument, ensures the principal has appropriate permission * as defined by the {@link AclManager}.
- *The AclManager is used to retrieve the access control list (ACL) permissions associated with a
- * domain object instance for the current Authentication object. This class is designed to process {@link
- * AclEntry}s that are subclasses of {@link org.acegisecurity.acl.basic.BasicAclEntry} only. Generally these are
- * obtained by using the {@link org.acegisecurity.acl.basic.BasicAclProvider}.
The voter will vote if any {@link ConfigAttribute#getAttribute()} matches the {@link
- * #processConfigAttribute}. The provider will then locate the first method argument of type {@link
- * #processDomainObjectClass}. Assuming that method argument is non-null, the provider will then lookup the ACLs from
- * the AclManager and ensure the principal is {@link
- * org.acegisecurity.acl.basic.BasicAclEntry#isPermitted(int)} for at least one of the {@link #requirePermission}s.
If the method argument is null, the voter will abstain from voting. If the method argument
- * could not be found, an {@link org.acegisecurity.AuthorizationServiceException} will be thrown.
In practical terms users will typically setup a number of BasicAclEntryVoters. Each will have a
- * different {@link #processDomainObjectClass}, {@link #processConfigAttribute} and {@link #requirePermission}
- * combination. For example, a small application might employ the following instances of
- * BasicAclEntryVoter:
- *
BankAccount, configuration attribute
- * VOTE_ACL_BANK_ACCONT_READ, require permission SimpleAclEntry.READBankAccount, configuration attribute
- * VOTE_ACL_BANK_ACCOUNT_WRITE, require permission list SimpleAclEntry.WRITE and
- * SimpleAclEntry.CREATE (allowing the principal to have either of these two permissionsCustomer, configuration attribute
- * VOTE_ACL_CUSTOMER_READ, require permission SimpleAclEntry.READCustomer, configuration attribute
- * VOTE_ACL_CUSTOMER_WRITE, require permission list SimpleAclEntry.WRITE and
- * SimpleAclEntry.CREATEBankAccount and Customer had common parents.
- * If the principal does not have sufficient permissions, the voter will vote to deny access.
- *The AclManager is allowed to return any implementations of AclEntry it wishes.
- * However, this provider will only be able to validate against AbstractBasicAclEntrys, and thus a vote
- * to deny access will be made if no AclEntry is of type AbstractBasicAclEntry.
All comparisons and prefixes are case sensitive.
* * @author Ben Alex * @version $Id$ diff --git a/core/src/main/java/org/acegisecurity/wrapper/SecurityContextHolderAwareRequestWrapper.java b/core/src/main/java/org/acegisecurity/wrapper/SecurityContextHolderAwareRequestWrapper.java index ca4023e171..a752386fde 100644 --- a/core/src/main/java/org/acegisecurity/wrapper/SecurityContextHolderAwareRequestWrapper.java +++ b/core/src/main/java/org/acegisecurity/wrapper/SecurityContextHolderAwareRequestWrapper.java @@ -120,9 +120,10 @@ public class SecurityContextHolderAwareRequestWrapper extends HttpServletRequest } /** - * Simple searches for an exactly matching {@link GrantedAuthority#getAuthority()}.Will always return
- * false if the SecurityContextHolder contains an Authentication with
- * nullprincipal and/or GrantedAuthority[] objects.
Will
+ * always return false if the SecurityContextHolder contains an
+ * Authentication with nullprincipal and/or GrantedAuthority[]
+ * objects.
GrantedAuthorityString representation to check for
*
diff --git a/doc/deploy.bat b/doc/deploy.bat
index 261f14b184..6a818b5fe2 100644
--- a/doc/deploy.bat
+++ b/doc/deploy.bat
@@ -2,4 +2,4 @@ set MAVEN_OPTS=-Xmx768m -XX:MaxPermSize=512m
call maven -Dmaven.jar.override=on -Dmaven.jar.clover-ant=1.3.3_01 clean
call maven -Dmaven.jar.override=on -Dmaven.jar.clover-ant=1.3.3_01 multiproject:clean
call maven -Dmaven.jar.override=on -Dmaven.jar.clover-ant=1.3.3_01 multiproject:artifact
-call maven -X -Dmaven.jar.override=on -Dmaven.jar.clover-ant=1.3.3_01 multiproject:site
\ No newline at end of file
+call maven -Dmaven.jar.override=on -Dmaven.jar.clover-ant=1.3.3_01 multiproject:site
\ No newline at end of file
diff --git a/project.properties b/project.properties
index af5fd31cae..f8845df6f8 100644
--- a/project.properties
+++ b/project.properties
@@ -16,7 +16,7 @@ maven.compile.source=1.3
#signature.storepass=
#signature.keystore=
-maven.javadoc.links=http://java.sun.com/j2se/1.5.0/docs/api/,http://www.springframework.org/docs/api/,http://jakarta.apache.org/commons/lang/api/index.html,http://developer.ja-sig.org/projects/cas/multiproject/cas-server/apidocs/index.html,http://jakarta.apache.org/commons/codec/apidocs/index.html,http://jakarta.apache.org/commons/collections/api/,http://jakarta.apache.org/commons/logging/apidocs/index.html,http://tomcat.apache.org/tomcat-5.0-doc/servletapi/index.html
+maven.javadoc.links=http://java.sun.com/j2se/1.5.0/docs/api/,http://www.springframework.org/docs/api/,http://jakarta.apache.org/commons/lang/api/,http://developer.ja-sig.org/projects/cas/multiproject/cas-server/apidocs/,http://jakarta.apache.org/commons/codec/apidocs/,http://jakarta.apache.org/commons/collections/api/,http://jakarta.apache.org/commons/logging/apidocs/,http://tomcat.apache.org/tomcat-5.0-doc/servletapi/
maven.repo.remote=http://www.ibiblio.org/maven,http://acegisecurity.sourceforge.net/maven,http://svn.apache.org/repository/