From 36612377e2ddf2341336bd88591068ec29ab5801 Mon Sep 17 00:00:00 2001 From: Luke Taylor Date: Sun, 14 Feb 2010 23:23:23 +0000 Subject: [PATCH] Replace package.html with package-info.java files, creating new ones where missing and updating outdated contents. --- .../acls/afterinvocation/package-info.java | 6 +++++ .../security/acls/domain/package-info.java | 5 ++++ .../security/acls/domain/package.html | 5 ---- .../security/acls/jdbc/package-info.java | 5 ++++ .../security/acls/jdbc/package.html | 5 ---- .../security/acls/model/package-info.java | 5 ++++ .../security/acls/model/package.html | 5 ---- .../security/acls/package-info.java | 9 +++++++ .../cas/authentication/package-info.java | 5 ++++ .../security/cas/authentication/package.html | 6 ----- .../security/cas/package-info.java | 5 ++++ .../security/cas/web/package-info.java | 5 ++++ .../security/cas/web/package.html | 6 ----- .../config/authentication/package-info.java | 5 ++++ .../security/config/http/package-info.java | 5 ++++ .../security/config/ldap/package-info.java | 5 ++++ .../security/config/method/package-info.java | 5 ++++ .../security/config/package-info.java | 6 +++++ .../access/annotation/package-info.java | 4 +++ .../security/access/event/package-info.java | 4 +++ .../expression/method/package-info.java | 6 +++++ .../access/expression/package-info.java | 7 +++++ .../security/access/expression/package.html | 8 ------ .../hierarchicalroles/package-info.java | 4 +++ .../intercept/aopalliance/package-info.java | 4 +++ .../access/intercept/aopalliance/package.html | 6 ----- .../intercept/aspectj/package-info.java | 4 +++ .../access/intercept/aspectj/package.html | 8 ------ .../access/intercept/package-info.java | 21 +++++++++++++++ .../security/access/intercept/package.html | 26 ------------------- .../security/access/method/package-info.java | 5 ++++ .../security/access/method/package.html | 6 ----- .../security/access/package-info.java | 7 +++++ .../security/access/package.html | 11 -------- .../security/access/prepost/package-info.java | 8 ++++++ .../security/access/prepost/package.html | 10 ------- .../security/access/vote/package-info.java | 4 +++ .../security/access/vote/package.html | 6 ----- .../authentication/dao/package-info.java | 4 +++ .../security/authentication/dao/package.html | 5 ---- .../authentication/encoding/package-info.java | 10 +++++++ .../authentication/encoding/package.html | 5 ---- .../authentication/event/package-info.java | 8 ++++++ .../authentication/event/package.html | 9 ------- .../jaas/event/package-info.java | 5 ++++ .../authentication/jaas/event/package.html | 5 ---- .../authentication/jaas/package-info.java | 4 +++ .../security/authentication/jaas/package.html | 5 ---- .../security/authentication/package-info.java | 9 +++++++ .../security/authentication/package.html | 6 ----- .../authentication/rcp/package-info.java | 4 +++ .../security/authentication/rcp/package.html | 7 ----- .../core/authority/mapping/package-info.java | 8 ++++++ .../security/core/authority/package-info.java | 4 +++ .../security/core/codec/package-info.java | 4 +++ .../security/core/context/package-info.java | 11 ++++++++ .../security/core/context/package.html | 10 ------- .../security/core/package-info.java | 5 ++++ .../security/core/session/package-info.java | 6 +++++ .../security/core/session/package.html | 6 ----- .../security/core/token/package-info.java | 4 +++ .../core/userdetails/cache/package-info.java | 4 +++ .../core/userdetails/jdbc/package-info.java | 5 ++++ .../core/userdetails/jdbc/package.html | 5 ---- .../core/userdetails/memory/package-info.java | 4 +++ .../core/userdetails/memory/package.html | 6 ----- .../core/userdetails/package-info.java | 8 ++++++ .../security/provisioning/package-info.java | 5 ++++ .../security/provisioning/package.html | 6 ----- .../security/remoting/dns/package-info.java | 4 +++ .../remoting/httpinvoker/package-info.java | 19 ++++++++++++++ .../remoting/httpinvoker/package.html | 21 --------------- .../security/remoting/package-info.java | 4 +++ .../security/remoting/rmi/package-info.java | 18 +++++++++++++ .../security/remoting/rmi/package.html | 23 ---------------- .../security/util/package-info.java | 7 +++++ .../security/util/package.html | 11 -------- .../ldap/authentication/package-info.java | 11 ++++++++ .../security/ldap/authentication/package.html | 15 ----------- .../security/ldap/package-info.java | 5 ++++ .../security/ldap/ppolicy/package-info.java | 9 +++++++ .../security/ldap/search/package-info.java | 5 ++++ .../security/ldap/search/package.html | 5 ---- .../security/ldap/server/package-info.java | 5 ++++ .../ldap/userdetails/package-info.java | 6 +++++ .../security/openid/package-info.java | 2 ++ .../security/taglibs/authz/package-info.java | 5 ++++ .../security/taglibs/authz/package.html | 5 ---- .../security/taglibs/package-info.java | 5 ++++ .../security/taglibs/package.html | 5 ---- .../taglibs/velocity/package-info.java | 2 ++ .../web/access/channel/package-info.java | 7 +++++ .../security/web/access/channel/package.html | 6 ----- .../web/access/expression/package-info.java | 5 ++++ .../web/access/intercept/package-info.java | 5 ++++ .../web/access/intercept/package.html | 5 ---- .../security/web/access/package-info.java | 5 ++++ .../authentication/logout/package-info.java | 5 ++++ .../web/authentication/package-info.java | 6 +++++ .../security/web/authentication/package.html | 6 ----- .../preauth/j2ee/package-info.java | 8 ++++++ .../authentication/preauth/package-info.java | 6 +++++ .../preauth/websphere/package-info.java | 5 ++++ .../preauth/x509/package-info.java | 6 +++++ .../rememberme/package-info.java | 9 +++++++ .../authentication/rememberme/package.html | 5 ---- .../authentication/session/package-info.java | 11 ++++++++ .../web/authentication/session/package.html | 5 ---- .../switchuser/package-info.java | 5 ++++ .../authentication/switchuser/package.html | 5 ---- .../web/authentication/ui/package-info.java | 6 +++++ .../web/authentication/ui/package.html | 6 ----- .../web/authentication/www/package-info.java | 5 ++++ .../web/authentication/www/package.html | 5 ---- .../security/web/context/package-info.java | 5 ++++ .../security/web/context/package.html | 8 ------ .../security/web/package-info.java | 5 ++++ .../web/savedrequest/package-info.java | 8 ++++++ .../security/web/savedrequest/package.html | 8 ------ .../security/web/servletapi/package-info.java | 7 +++++ .../security/web/servletapi/package.html | 9 ------- .../security/web/session/package-info.java | 5 ++++ .../security/web/session/package.html | 5 ---- .../security/web/util/package-info.java | 7 +++++ 124 files changed, 499 insertions(+), 341 deletions(-) create mode 100644 acl/src/main/java/org/springframework/security/acls/afterinvocation/package-info.java create mode 100644 acl/src/main/java/org/springframework/security/acls/domain/package-info.java delete mode 100644 acl/src/main/java/org/springframework/security/acls/domain/package.html create mode 100644 acl/src/main/java/org/springframework/security/acls/jdbc/package-info.java delete mode 100644 acl/src/main/java/org/springframework/security/acls/jdbc/package.html create mode 100644 acl/src/main/java/org/springframework/security/acls/model/package-info.java delete mode 100644 acl/src/main/java/org/springframework/security/acls/model/package.html create mode 100644 acl/src/main/java/org/springframework/security/acls/package-info.java create mode 100644 cas/src/main/java/org/springframework/security/cas/authentication/package-info.java delete mode 100644 cas/src/main/java/org/springframework/security/cas/authentication/package.html create mode 100644 cas/src/main/java/org/springframework/security/cas/package-info.java create mode 100644 cas/src/main/java/org/springframework/security/cas/web/package-info.java delete mode 100644 cas/src/main/java/org/springframework/security/cas/web/package.html create mode 100644 config/src/main/java/org/springframework/security/config/authentication/package-info.java create mode 100644 config/src/main/java/org/springframework/security/config/http/package-info.java create mode 100644 config/src/main/java/org/springframework/security/config/ldap/package-info.java create mode 100644 config/src/main/java/org/springframework/security/config/method/package-info.java create mode 100644 config/src/main/java/org/springframework/security/config/package-info.java create mode 100644 core/src/main/java/org/springframework/security/access/annotation/package-info.java create mode 100644 core/src/main/java/org/springframework/security/access/event/package-info.java create mode 100644 core/src/main/java/org/springframework/security/access/expression/method/package-info.java create mode 100644 core/src/main/java/org/springframework/security/access/expression/package-info.java delete mode 100644 core/src/main/java/org/springframework/security/access/expression/package.html create mode 100644 core/src/main/java/org/springframework/security/access/hierarchicalroles/package-info.java create mode 100644 core/src/main/java/org/springframework/security/access/intercept/aopalliance/package-info.java delete mode 100644 core/src/main/java/org/springframework/security/access/intercept/aopalliance/package.html create mode 100644 core/src/main/java/org/springframework/security/access/intercept/aspectj/package-info.java delete mode 100644 core/src/main/java/org/springframework/security/access/intercept/aspectj/package.html create mode 100644 core/src/main/java/org/springframework/security/access/intercept/package-info.java delete mode 100644 core/src/main/java/org/springframework/security/access/intercept/package.html create mode 100644 core/src/main/java/org/springframework/security/access/method/package-info.java delete mode 100644 core/src/main/java/org/springframework/security/access/method/package.html create mode 100644 core/src/main/java/org/springframework/security/access/package-info.java delete mode 100644 core/src/main/java/org/springframework/security/access/package.html create mode 100644 core/src/main/java/org/springframework/security/access/prepost/package-info.java delete mode 100644 core/src/main/java/org/springframework/security/access/prepost/package.html create mode 100644 core/src/main/java/org/springframework/security/access/vote/package-info.java delete mode 100644 core/src/main/java/org/springframework/security/access/vote/package.html create mode 100644 core/src/main/java/org/springframework/security/authentication/dao/package-info.java delete mode 100644 core/src/main/java/org/springframework/security/authentication/dao/package.html create mode 100644 core/src/main/java/org/springframework/security/authentication/encoding/package-info.java delete mode 100644 core/src/main/java/org/springframework/security/authentication/encoding/package.html create mode 100644 core/src/main/java/org/springframework/security/authentication/event/package-info.java delete mode 100644 core/src/main/java/org/springframework/security/authentication/event/package.html create mode 100644 core/src/main/java/org/springframework/security/authentication/jaas/event/package-info.java delete mode 100644 core/src/main/java/org/springframework/security/authentication/jaas/event/package.html create mode 100644 core/src/main/java/org/springframework/security/authentication/jaas/package-info.java delete mode 100644 core/src/main/java/org/springframework/security/authentication/jaas/package.html create mode 100644 core/src/main/java/org/springframework/security/authentication/package-info.java delete mode 100644 core/src/main/java/org/springframework/security/authentication/package.html create mode 100644 core/src/main/java/org/springframework/security/authentication/rcp/package-info.java delete mode 100644 core/src/main/java/org/springframework/security/authentication/rcp/package.html create mode 100644 core/src/main/java/org/springframework/security/core/authority/mapping/package-info.java create mode 100644 core/src/main/java/org/springframework/security/core/authority/package-info.java create mode 100644 core/src/main/java/org/springframework/security/core/codec/package-info.java create mode 100644 core/src/main/java/org/springframework/security/core/context/package-info.java delete mode 100644 core/src/main/java/org/springframework/security/core/context/package.html create mode 100644 core/src/main/java/org/springframework/security/core/package-info.java create mode 100644 core/src/main/java/org/springframework/security/core/session/package-info.java delete mode 100644 core/src/main/java/org/springframework/security/core/session/package.html create mode 100644 core/src/main/java/org/springframework/security/core/token/package-info.java create mode 100644 core/src/main/java/org/springframework/security/core/userdetails/cache/package-info.java create mode 100644 core/src/main/java/org/springframework/security/core/userdetails/jdbc/package-info.java delete mode 100644 core/src/main/java/org/springframework/security/core/userdetails/jdbc/package.html create mode 100644 core/src/main/java/org/springframework/security/core/userdetails/memory/package-info.java delete mode 100644 core/src/main/java/org/springframework/security/core/userdetails/memory/package.html create mode 100644 core/src/main/java/org/springframework/security/core/userdetails/package-info.java create mode 100644 core/src/main/java/org/springframework/security/provisioning/package-info.java delete mode 100644 core/src/main/java/org/springframework/security/provisioning/package.html create mode 100644 core/src/main/java/org/springframework/security/remoting/dns/package-info.java create mode 100644 core/src/main/java/org/springframework/security/remoting/httpinvoker/package-info.java delete mode 100644 core/src/main/java/org/springframework/security/remoting/httpinvoker/package.html create mode 100644 core/src/main/java/org/springframework/security/remoting/package-info.java create mode 100644 core/src/main/java/org/springframework/security/remoting/rmi/package-info.java delete mode 100644 core/src/main/java/org/springframework/security/remoting/rmi/package.html create mode 100644 core/src/main/java/org/springframework/security/util/package-info.java delete mode 100644 core/src/main/java/org/springframework/security/util/package.html create mode 100644 ldap/src/main/java/org/springframework/security/ldap/authentication/package-info.java delete mode 100644 ldap/src/main/java/org/springframework/security/ldap/authentication/package.html create mode 100644 ldap/src/main/java/org/springframework/security/ldap/package-info.java create mode 100644 ldap/src/main/java/org/springframework/security/ldap/ppolicy/package-info.java create mode 100644 ldap/src/main/java/org/springframework/security/ldap/search/package-info.java delete mode 100644 ldap/src/main/java/org/springframework/security/ldap/search/package.html create mode 100644 ldap/src/main/java/org/springframework/security/ldap/server/package-info.java create mode 100644 ldap/src/main/java/org/springframework/security/ldap/userdetails/package-info.java create mode 100644 openid/src/main/java/org/springframework/security/openid/package-info.java create mode 100644 taglibs/src/main/java/org/springframework/security/taglibs/authz/package-info.java delete mode 100644 taglibs/src/main/java/org/springframework/security/taglibs/authz/package.html create mode 100644 taglibs/src/main/java/org/springframework/security/taglibs/package-info.java delete mode 100644 taglibs/src/main/java/org/springframework/security/taglibs/package.html create mode 100644 taglibs/src/main/java/org/springframework/security/taglibs/velocity/package-info.java create mode 100644 web/src/main/java/org/springframework/security/web/access/channel/package-info.java delete mode 100644 web/src/main/java/org/springframework/security/web/access/channel/package.html create mode 100644 web/src/main/java/org/springframework/security/web/access/expression/package-info.java create mode 100644 web/src/main/java/org/springframework/security/web/access/intercept/package-info.java delete mode 100644 web/src/main/java/org/springframework/security/web/access/intercept/package.html create mode 100644 web/src/main/java/org/springframework/security/web/access/package-info.java create mode 100644 web/src/main/java/org/springframework/security/web/authentication/logout/package-info.java create mode 100644 web/src/main/java/org/springframework/security/web/authentication/package-info.java delete mode 100644 web/src/main/java/org/springframework/security/web/authentication/package.html create mode 100644 web/src/main/java/org/springframework/security/web/authentication/preauth/j2ee/package-info.java create mode 100644 web/src/main/java/org/springframework/security/web/authentication/preauth/package-info.java create mode 100644 web/src/main/java/org/springframework/security/web/authentication/preauth/websphere/package-info.java create mode 100644 web/src/main/java/org/springframework/security/web/authentication/preauth/x509/package-info.java create mode 100644 web/src/main/java/org/springframework/security/web/authentication/rememberme/package-info.java delete mode 100644 web/src/main/java/org/springframework/security/web/authentication/rememberme/package.html create mode 100644 web/src/main/java/org/springframework/security/web/authentication/session/package-info.java delete mode 100644 web/src/main/java/org/springframework/security/web/authentication/session/package.html create mode 100644 web/src/main/java/org/springframework/security/web/authentication/switchuser/package-info.java delete mode 100644 web/src/main/java/org/springframework/security/web/authentication/switchuser/package.html create mode 100644 web/src/main/java/org/springframework/security/web/authentication/ui/package-info.java delete mode 100644 web/src/main/java/org/springframework/security/web/authentication/ui/package.html create mode 100644 web/src/main/java/org/springframework/security/web/authentication/www/package-info.java delete mode 100644 web/src/main/java/org/springframework/security/web/authentication/www/package.html create mode 100644 web/src/main/java/org/springframework/security/web/context/package-info.java delete mode 100644 web/src/main/java/org/springframework/security/web/context/package.html create mode 100644 web/src/main/java/org/springframework/security/web/package-info.java create mode 100644 web/src/main/java/org/springframework/security/web/savedrequest/package-info.java delete mode 100644 web/src/main/java/org/springframework/security/web/savedrequest/package.html create mode 100644 web/src/main/java/org/springframework/security/web/servletapi/package-info.java delete mode 100644 web/src/main/java/org/springframework/security/web/servletapi/package.html create mode 100644 web/src/main/java/org/springframework/security/web/session/package-info.java delete mode 100644 web/src/main/java/org/springframework/security/web/session/package.html create mode 100644 web/src/main/java/org/springframework/security/web/util/package-info.java diff --git a/acl/src/main/java/org/springframework/security/acls/afterinvocation/package-info.java b/acl/src/main/java/org/springframework/security/acls/afterinvocation/package-info.java new file mode 100644 index 0000000000..9d27664c26 --- /dev/null +++ b/acl/src/main/java/org/springframework/security/acls/afterinvocation/package-info.java @@ -0,0 +1,6 @@ +/** + * After-invocation providers for collection and array filtering. Consider using a {@code PostFilter} annotation in + * preference. + */ +package org.springframework.security.acls.afterinvocation; + diff --git a/acl/src/main/java/org/springframework/security/acls/domain/package-info.java b/acl/src/main/java/org/springframework/security/acls/domain/package-info.java new file mode 100644 index 0000000000..9201afa7f5 --- /dev/null +++ b/acl/src/main/java/org/springframework/security/acls/domain/package-info.java @@ -0,0 +1,5 @@ +/** + * Basic implementation of access control lists (ACLs) interfaces. + */ +package org.springframework.security.acls.domain; + diff --git a/acl/src/main/java/org/springframework/security/acls/domain/package.html b/acl/src/main/java/org/springframework/security/acls/domain/package.html deleted file mode 100644 index 58fd09a56a..0000000000 --- a/acl/src/main/java/org/springframework/security/acls/domain/package.html +++ /dev/null @@ -1,5 +0,0 @@ - - -Basic implementation of access control lists (ACLs) interfaces. - - diff --git a/acl/src/main/java/org/springframework/security/acls/jdbc/package-info.java b/acl/src/main/java/org/springframework/security/acls/jdbc/package-info.java new file mode 100644 index 0000000000..382a7b111a --- /dev/null +++ b/acl/src/main/java/org/springframework/security/acls/jdbc/package-info.java @@ -0,0 +1,5 @@ +/** + * JDBC-based persistence of ACL information + */ +package org.springframework.security.acls.jdbc; + diff --git a/acl/src/main/java/org/springframework/security/acls/jdbc/package.html b/acl/src/main/java/org/springframework/security/acls/jdbc/package.html deleted file mode 100644 index e0190860d7..0000000000 --- a/acl/src/main/java/org/springframework/security/acls/jdbc/package.html +++ /dev/null @@ -1,5 +0,0 @@ - - -JDBC-based persistence of ACL information. - - diff --git a/acl/src/main/java/org/springframework/security/acls/model/package-info.java b/acl/src/main/java/org/springframework/security/acls/model/package-info.java new file mode 100644 index 0000000000..476ab3424b --- /dev/null +++ b/acl/src/main/java/org/springframework/security/acls/model/package-info.java @@ -0,0 +1,5 @@ +/** + * Interfaces and shared classes to manage access control lists (ACLs) for domain object instances. + */ +package org.springframework.security.acls.model; + diff --git a/acl/src/main/java/org/springframework/security/acls/model/package.html b/acl/src/main/java/org/springframework/security/acls/model/package.html deleted file mode 100644 index 612305b745..0000000000 --- a/acl/src/main/java/org/springframework/security/acls/model/package.html +++ /dev/null @@ -1,5 +0,0 @@ - - -Interfaces and shared classes to manage access control lists (ACLs) for domain object instances. - - diff --git a/acl/src/main/java/org/springframework/security/acls/package-info.java b/acl/src/main/java/org/springframework/security/acls/package-info.java new file mode 100644 index 0000000000..2429048aae --- /dev/null +++ b/acl/src/main/java/org/springframework/security/acls/package-info.java @@ -0,0 +1,9 @@ +/** + * The Spring Security ACL package which implements instance-based security for domain objects. + *

+ * Consider using the annotation based approach ({@code @PreAuthorize}, {@code @PostFilter} annotations) combined + * with a {@link org.springframework.security.acls.AclPermissionEvaluator} in preference to the older and more verbose + * attribute/voter/after-invocation approach from versions before Spring Security 3.0. + */ +package org.springframework.security.acls; + diff --git a/cas/src/main/java/org/springframework/security/cas/authentication/package-info.java b/cas/src/main/java/org/springframework/security/cas/authentication/package-info.java new file mode 100644 index 0000000000..6671180b87 --- /dev/null +++ b/cas/src/main/java/org/springframework/security/cas/authentication/package-info.java @@ -0,0 +1,5 @@ +/** + * An {@code AuthenticationProvider} that can process CAS service tickets and proxy tickets. + */ +package org.springframework.security.cas.authentication; + diff --git a/cas/src/main/java/org/springframework/security/cas/authentication/package.html b/cas/src/main/java/org/springframework/security/cas/authentication/package.html deleted file mode 100644 index e4e5966052..0000000000 --- a/cas/src/main/java/org/springframework/security/cas/authentication/package.html +++ /dev/null @@ -1,6 +0,0 @@ - - -An authentication provider that can process JA-SIG Central Authentication Service (CAS) -service tickets and proxy tickets. - - diff --git a/cas/src/main/java/org/springframework/security/cas/package-info.java b/cas/src/main/java/org/springframework/security/cas/package-info.java new file mode 100644 index 0000000000..6f1ef76ea7 --- /dev/null +++ b/cas/src/main/java/org/springframework/security/cas/package-info.java @@ -0,0 +1,5 @@ +/** + * Spring Security support for Jasig's Central Authentication Service (CAS). + */ +package org.springframework.security.cas; + diff --git a/cas/src/main/java/org/springframework/security/cas/web/package-info.java b/cas/src/main/java/org/springframework/security/cas/web/package-info.java new file mode 100644 index 0000000000..b370ab5f0d --- /dev/null +++ b/cas/src/main/java/org/springframework/security/cas/web/package-info.java @@ -0,0 +1,5 @@ +/** + * Authenticates standard web browser users via CAS. + */ +package org.springframework.security.cas.web; + diff --git a/cas/src/main/java/org/springframework/security/cas/web/package.html b/cas/src/main/java/org/springframework/security/cas/web/package.html deleted file mode 100644 index ab7677598f..0000000000 --- a/cas/src/main/java/org/springframework/security/cas/web/package.html +++ /dev/null @@ -1,6 +0,0 @@ - - -Authenticates standard web browser users via -JA-SIG Central Authentication Service (CAS). - - diff --git a/config/src/main/java/org/springframework/security/config/authentication/package-info.java b/config/src/main/java/org/springframework/security/config/authentication/package-info.java new file mode 100644 index 0000000000..72e20c4e36 --- /dev/null +++ b/config/src/main/java/org/springframework/security/config/authentication/package-info.java @@ -0,0 +1,5 @@ +/** + * Parsing of <authentication-manager> and related elements. + */ +package org.springframework.security.config.authentication; + diff --git a/config/src/main/java/org/springframework/security/config/http/package-info.java b/config/src/main/java/org/springframework/security/config/http/package-info.java new file mode 100644 index 0000000000..b317aaf96f --- /dev/null +++ b/config/src/main/java/org/springframework/security/config/http/package-info.java @@ -0,0 +1,5 @@ +/** + * Parsing of the <http> namespace element. + */ +package org.springframework.security.config.http; + diff --git a/config/src/main/java/org/springframework/security/config/ldap/package-info.java b/config/src/main/java/org/springframework/security/config/ldap/package-info.java new file mode 100644 index 0000000000..4357f836ba --- /dev/null +++ b/config/src/main/java/org/springframework/security/config/ldap/package-info.java @@ -0,0 +1,5 @@ +/** + * Security namespace support for LDAP authentication. + */ +package org.springframework.security.config.ldap; + diff --git a/config/src/main/java/org/springframework/security/config/method/package-info.java b/config/src/main/java/org/springframework/security/config/method/package-info.java new file mode 100644 index 0000000000..c5d0a3b0ac --- /dev/null +++ b/config/src/main/java/org/springframework/security/config/method/package-info.java @@ -0,0 +1,5 @@ +/** + * Support for parsing of the <global-method-security> and <intercept-methods> elements. + */ +package org.springframework.security.config.method; + diff --git a/config/src/main/java/org/springframework/security/config/package-info.java b/config/src/main/java/org/springframework/security/config/package-info.java new file mode 100644 index 0000000000..b8ca690b1e --- /dev/null +++ b/config/src/main/java/org/springframework/security/config/package-info.java @@ -0,0 +1,6 @@ +/** + * Support classes for the Spring Security namespace. None of the code in these packages should be used directly + * in applications. + */ +package org.springframework.security.config; + diff --git a/core/src/main/java/org/springframework/security/access/annotation/package-info.java b/core/src/main/java/org/springframework/security/access/annotation/package-info.java new file mode 100644 index 0000000000..cd5b575676 --- /dev/null +++ b/core/src/main/java/org/springframework/security/access/annotation/package-info.java @@ -0,0 +1,4 @@ +/** + * Support for JSR-250 and Spring Security {@code @Secured} annotations. + */ +package org.springframework.security.access.annotation; diff --git a/core/src/main/java/org/springframework/security/access/event/package-info.java b/core/src/main/java/org/springframework/security/access/event/package-info.java new file mode 100644 index 0000000000..777c2da534 --- /dev/null +++ b/core/src/main/java/org/springframework/security/access/event/package-info.java @@ -0,0 +1,4 @@ +/** + * Authorization event and listener classes. + */ +package org.springframework.security.access.event; diff --git a/core/src/main/java/org/springframework/security/access/expression/method/package-info.java b/core/src/main/java/org/springframework/security/access/expression/method/package-info.java new file mode 100644 index 0000000000..0908dfe789 --- /dev/null +++ b/core/src/main/java/org/springframework/security/access/expression/method/package-info.java @@ -0,0 +1,6 @@ +/** + * Implementation of expression-based method security. + * + * @since 3.0 + */ +package org.springframework.security.access.expression.method; diff --git a/core/src/main/java/org/springframework/security/access/expression/package-info.java b/core/src/main/java/org/springframework/security/access/expression/package-info.java new file mode 100644 index 0000000000..d37860e9f2 --- /dev/null +++ b/core/src/main/java/org/springframework/security/access/expression/package-info.java @@ -0,0 +1,7 @@ +/** + * Expression handling code to support the use of Spring-EL based expressions in {@code @PreAuthorize}, {@code @PreFilter}, + * {@code @PostAuthorize} and {@code @PostFilter} annotations. Mainly for internal framework use and liable to change. + * + * @since 3.0 + */ +package org.springframework.security.access.expression; diff --git a/core/src/main/java/org/springframework/security/access/expression/package.html b/core/src/main/java/org/springframework/security/access/expression/package.html deleted file mode 100644 index 014be3c277..0000000000 --- a/core/src/main/java/org/springframework/security/access/expression/package.html +++ /dev/null @@ -1,8 +0,0 @@ - - -

-Expression handling code to support the use of Spring-EL based expressions in @PreAuthorize, @PreFilter, -@PostAuthorizue and @PostFilter annotations. Mainly for internal framework use and liable to change. -

- - \ No newline at end of file diff --git a/core/src/main/java/org/springframework/security/access/hierarchicalroles/package-info.java b/core/src/main/java/org/springframework/security/access/hierarchicalroles/package-info.java new file mode 100644 index 0000000000..ddce6ad472 --- /dev/null +++ b/core/src/main/java/org/springframework/security/access/hierarchicalroles/package-info.java @@ -0,0 +1,4 @@ +/** + * Role hierarchy implementation. + */ +package org.springframework.security.access.hierarchicalroles; diff --git a/core/src/main/java/org/springframework/security/access/intercept/aopalliance/package-info.java b/core/src/main/java/org/springframework/security/access/intercept/aopalliance/package-info.java new file mode 100644 index 0000000000..313fffbd95 --- /dev/null +++ b/core/src/main/java/org/springframework/security/access/intercept/aopalliance/package-info.java @@ -0,0 +1,4 @@ +/** + * Enforces security for AOP Alliance MethodInvocations, such as via Spring AOP. + */ +package org.springframework.security.access.intercept.aopalliance; diff --git a/core/src/main/java/org/springframework/security/access/intercept/aopalliance/package.html b/core/src/main/java/org/springframework/security/access/intercept/aopalliance/package.html deleted file mode 100644 index fb9e2a88f3..0000000000 --- a/core/src/main/java/org/springframework/security/access/intercept/aopalliance/package.html +++ /dev/null @@ -1,6 +0,0 @@ - - -Enforces security for AOP Alliance MethodInvocations, such as via -Spring AOP. - - diff --git a/core/src/main/java/org/springframework/security/access/intercept/aspectj/package-info.java b/core/src/main/java/org/springframework/security/access/intercept/aspectj/package-info.java new file mode 100644 index 0000000000..2782ae9c0a --- /dev/null +++ b/core/src/main/java/org/springframework/security/access/intercept/aspectj/package-info.java @@ -0,0 +1,4 @@ +/** + * Enforces security for AspectJ JointPoints, delegating secure object callbacks to the calling aspect. + */ +package org.springframework.security.access.intercept.aspectj; diff --git a/core/src/main/java/org/springframework/security/access/intercept/aspectj/package.html b/core/src/main/java/org/springframework/security/access/intercept/aspectj/package.html deleted file mode 100644 index ea0a671118..0000000000 --- a/core/src/main/java/org/springframework/security/access/intercept/aspectj/package.html +++ /dev/null @@ -1,8 +0,0 @@ - - -Enforces security for AspectJ JointPoints, delegating secure -object callbacks to the calling aspect. - -

Refer to the reference guide for information on usage. - - diff --git a/core/src/main/java/org/springframework/security/access/intercept/package-info.java b/core/src/main/java/org/springframework/security/access/intercept/package-info.java new file mode 100644 index 0000000000..b67b8a732d --- /dev/null +++ b/core/src/main/java/org/springframework/security/access/intercept/package-info.java @@ -0,0 +1,21 @@ +/** + * Abstract level security interception classes which are responsible for enforcing the + * configured security constraints for a secure object. + *

+ * A secure object is a term frequently used throughout the security + * system. It does not refer to a business object that is being + * secured, but instead refers to some infrastructure object that can have + * security facilities provided for it by Spring Security. + * For example, one secure object would be MethodInvocation, + * whilst another would be HTTP + * {@link org.springframework.security.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 interceptor package. + * Each package usually includes a concrete security interceptor (which subclasses + * {@link org.springframework.security.access.intercept.AbstractSecurityInterceptor}) and an + * appropriate {@link org.springframework.security.access.SecurityMetadataSource} + * for the type of resources the secure object represents. + */ +package org.springframework.security.access.intercept; diff --git a/core/src/main/java/org/springframework/security/access/intercept/package.html b/core/src/main/java/org/springframework/security/access/intercept/package.html deleted file mode 100644 index 819026001d..0000000000 --- a/core/src/main/java/org/springframework/security/access/intercept/package.html +++ /dev/null @@ -1,26 +0,0 @@ - - -Actually enforces the security and ties the whole security system together. -

-A secure object is a term frequently used throughout the security -system. It does not refer to a business object that is being -secured, but instead refers to some infrastructure object that can have -security facilities provided for it by Spring Security. -For example, one secure object would be MethodInvocation, -whilst another would be HTTP -{@link org.springframework.security.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 interceptor package. -Each package usually includes a concrete security interceptor (which -subclasses {@link org.springframework.security.access.intercept.AbstractSecurityInterceptor}, -an appropriate {@link org.springframework.security.access.SecurityMetadataSource} -for the type of resources the secure object represents, and a property editor -to populate the SecurityMetadataSource. - - - diff --git a/core/src/main/java/org/springframework/security/access/method/package-info.java b/core/src/main/java/org/springframework/security/access/method/package-info.java new file mode 100644 index 0000000000..7ba2aff4a2 --- /dev/null +++ b/core/src/main/java/org/springframework/security/access/method/package-info.java @@ -0,0 +1,5 @@ +/** + * Provides {@code SecurityMetadataSource} implementations for securing Java method invocations via different + * AOP libraries. + */ +package org.springframework.security.access.method; diff --git a/core/src/main/java/org/springframework/security/access/method/package.html b/core/src/main/java/org/springframework/security/access/method/package.html deleted file mode 100644 index 78719a0b39..0000000000 --- a/core/src/main/java/org/springframework/security/access/method/package.html +++ /dev/null @@ -1,6 +0,0 @@ - - -Provides support objects for securing Java method invocations -via different AOP libraries. - - diff --git a/core/src/main/java/org/springframework/security/access/package-info.java b/core/src/main/java/org/springframework/security/access/package-info.java new file mode 100644 index 0000000000..9f9070d976 --- /dev/null +++ b/core/src/main/java/org/springframework/security/access/package-info.java @@ -0,0 +1,7 @@ +/** + * Core access-control related code, including security metadata related classes, interception code, access control + * annotations, EL support and voter-based implementations of the central + * {@link org.springframework.security.access.AccessDecisionManager AccessDecisionManager} interface. + */ +package org.springframework.security.access; + diff --git a/core/src/main/java/org/springframework/security/access/package.html b/core/src/main/java/org/springframework/security/access/package.html deleted file mode 100644 index 7691e1e9e9..0000000000 --- a/core/src/main/java/org/springframework/security/access/package.html +++ /dev/null @@ -1,11 +0,0 @@ - - -Core access-control related code, including -

- - diff --git a/core/src/main/java/org/springframework/security/access/prepost/package-info.java b/core/src/main/java/org/springframework/security/access/prepost/package-info.java new file mode 100644 index 0000000000..d283b8c2a4 --- /dev/null +++ b/core/src/main/java/org/springframework/security/access/prepost/package-info.java @@ -0,0 +1,8 @@ +/** + * Contains the infrastructure classes for handling the {@code @PreAuthorize}, {@code @PreFilter}, {@code @PostAuthorize} + * and {@code @PostFilter} annotations. + *

+ * Other than the annotations themselves, the classes should be regarded as for internal framework use and + * are liable to change without notice. + */ +package org.springframework.security.access.prepost; diff --git a/core/src/main/java/org/springframework/security/access/prepost/package.html b/core/src/main/java/org/springframework/security/access/prepost/package.html deleted file mode 100644 index 3d338f3276..0000000000 --- a/core/src/main/java/org/springframework/security/access/prepost/package.html +++ /dev/null @@ -1,10 +0,0 @@ - - -

-Contains the infrastructure classes for handling the @PreAuthorize, @PreFilter, @PostAuthorize and -@PostFilter annotations. -

-Other than the annotations themselves, the classes should be regarded as for internal framework use and -are liable to change without notice. - - \ No newline at end of file diff --git a/core/src/main/java/org/springframework/security/access/vote/package-info.java b/core/src/main/java/org/springframework/security/access/vote/package-info.java new file mode 100644 index 0000000000..3b32fb6023 --- /dev/null +++ b/core/src/main/java/org/springframework/security/access/vote/package-info.java @@ -0,0 +1,4 @@ +/** + * Implements a vote-based approach to authorization decisions. + */ +package org.springframework.security.access.vote; diff --git a/core/src/main/java/org/springframework/security/access/vote/package.html b/core/src/main/java/org/springframework/security/access/vote/package.html deleted file mode 100644 index f33ca8bd9e..0000000000 --- a/core/src/main/java/org/springframework/security/access/vote/package.html +++ /dev/null @@ -1,6 +0,0 @@ - - -Implements a vote-based approach to authorization decisions. -

- - diff --git a/core/src/main/java/org/springframework/security/authentication/dao/package-info.java b/core/src/main/java/org/springframework/security/authentication/dao/package-info.java new file mode 100644 index 0000000000..b5b557ef24 --- /dev/null +++ b/core/src/main/java/org/springframework/security/authentication/dao/package-info.java @@ -0,0 +1,4 @@ +/** + * An {@code AuthenticationProvider} which relies upon a data access object. + */ +package org.springframework.security.authentication.dao; diff --git a/core/src/main/java/org/springframework/security/authentication/dao/package.html b/core/src/main/java/org/springframework/security/authentication/dao/package.html deleted file mode 100644 index f6caf3b566..0000000000 --- a/core/src/main/java/org/springframework/security/authentication/dao/package.html +++ /dev/null @@ -1,5 +0,0 @@ - - -An authentication provider that relies upon a data access object. - - diff --git a/core/src/main/java/org/springframework/security/authentication/encoding/package-info.java b/core/src/main/java/org/springframework/security/authentication/encoding/package-info.java new file mode 100644 index 0000000000..edcc4ab247 --- /dev/null +++ b/core/src/main/java/org/springframework/security/authentication/encoding/package-info.java @@ -0,0 +1,10 @@ +/** + * Password encoding implementations. Apart from the "null" implementations, they are all based on + * password hashing using digest functions. See the + * + * reference manual for more information. + *

+ * Third part implementations such as those provided by Jasypt + * can also be used. + */ +package org.springframework.security.authentication.encoding; diff --git a/core/src/main/java/org/springframework/security/authentication/encoding/package.html b/core/src/main/java/org/springframework/security/authentication/encoding/package.html deleted file mode 100644 index c6b8499dbb..0000000000 --- a/core/src/main/java/org/springframework/security/authentication/encoding/package.html +++ /dev/null @@ -1,5 +0,0 @@ - - -Password encoding implementations. - - diff --git a/core/src/main/java/org/springframework/security/authentication/event/package-info.java b/core/src/main/java/org/springframework/security/authentication/event/package-info.java new file mode 100644 index 0000000000..1cb37bce74 --- /dev/null +++ b/core/src/main/java/org/springframework/security/authentication/event/package-info.java @@ -0,0 +1,8 @@ +/** + * Authentication success and failure events which can be published to the Spring application context. + * + * The ProviderManager automatically publishes events to the application context. These events are + * received by all registered Spring ApplicationListeners. + */ + +package org.springframework.security.authentication.event; diff --git a/core/src/main/java/org/springframework/security/authentication/event/package.html b/core/src/main/java/org/springframework/security/authentication/event/package.html deleted file mode 100644 index 2aabcd0a02..0000000000 --- a/core/src/main/java/org/springframework/security/authentication/event/package.html +++ /dev/null @@ -1,9 +0,0 @@ - - -Enables authentication events to be published to the Spring application context. - -

The ProviderManager automatically publishes -events to the application context. These events are received by all -registered Spring ApplicationListeners.

- - diff --git a/core/src/main/java/org/springframework/security/authentication/jaas/event/package-info.java b/core/src/main/java/org/springframework/security/authentication/jaas/event/package-info.java new file mode 100644 index 0000000000..6a99de0391 --- /dev/null +++ b/core/src/main/java/org/springframework/security/authentication/jaas/event/package-info.java @@ -0,0 +1,5 @@ +/** + * JAAS authentication events which can be published to the Spring application context by the JAAS authentication + * provider. + */ +package org.springframework.security.authentication.jaas.event; diff --git a/core/src/main/java/org/springframework/security/authentication/jaas/event/package.html b/core/src/main/java/org/springframework/security/authentication/jaas/event/package.html deleted file mode 100644 index 74c7f3519f..0000000000 --- a/core/src/main/java/org/springframework/security/authentication/jaas/event/package.html +++ /dev/null @@ -1,5 +0,0 @@ - - -Enables JAAS events to be published to the Spring application context. - - diff --git a/core/src/main/java/org/springframework/security/authentication/jaas/package-info.java b/core/src/main/java/org/springframework/security/authentication/jaas/package-info.java new file mode 100644 index 0000000000..0c4538548c --- /dev/null +++ b/core/src/main/java/org/springframework/security/authentication/jaas/package-info.java @@ -0,0 +1,4 @@ +/** + * An authentication provider for JAAS. + */ +package org.springframework.security.authentication.jaas; diff --git a/core/src/main/java/org/springframework/security/authentication/jaas/package.html b/core/src/main/java/org/springframework/security/authentication/jaas/package.html deleted file mode 100644 index 4cdeddfb57..0000000000 --- a/core/src/main/java/org/springframework/security/authentication/jaas/package.html +++ /dev/null @@ -1,5 +0,0 @@ - - -An authentication provider for JAAS. - - diff --git a/core/src/main/java/org/springframework/security/authentication/package-info.java b/core/src/main/java/org/springframework/security/authentication/package-info.java new file mode 100644 index 0000000000..2f49e2ebc5 --- /dev/null +++ b/core/src/main/java/org/springframework/security/authentication/package-info.java @@ -0,0 +1,9 @@ +/** + * Core classes and interfaces related to user authentication, which are used throughout Spring Security. + *

+ * Of key importance is the {@link org.springframework.security.authentication.AuthenticationManager AuthenticationManager} + * and its default implementation {@link org.springframework.security.authentication.ProviderManager + * ProviderManager}, which maintains a list {@link org.springframework.security.authentication.AuthenticationProvider + * AuthenticationProvider}s to which it delegates authentication requests. + */ +package org.springframework.security.authentication; diff --git a/core/src/main/java/org/springframework/security/authentication/package.html b/core/src/main/java/org/springframework/security/authentication/package.html deleted file mode 100644 index 3d69a10b0e..0000000000 --- a/core/src/main/java/org/springframework/security/authentication/package.html +++ /dev/null @@ -1,6 +0,0 @@ - - -Implements a provider-based approach to authentication decisions. -

- - diff --git a/core/src/main/java/org/springframework/security/authentication/rcp/package-info.java b/core/src/main/java/org/springframework/security/authentication/rcp/package-info.java new file mode 100644 index 0000000000..507c58f6f4 --- /dev/null +++ b/core/src/main/java/org/springframework/security/authentication/rcp/package-info.java @@ -0,0 +1,4 @@ +/** + * Allows remote clients to authenticate and obtain a populated Authentication object. + */ +package org.springframework.security.authentication.rcp; diff --git a/core/src/main/java/org/springframework/security/authentication/rcp/package.html b/core/src/main/java/org/springframework/security/authentication/rcp/package.html deleted file mode 100644 index 3fbed2f919..0000000000 --- a/core/src/main/java/org/springframework/security/authentication/rcp/package.html +++ /dev/null @@ -1,7 +0,0 @@ - - -Allows remote clients to authenticate and obtain a populated -Authentication object. - - - diff --git a/core/src/main/java/org/springframework/security/core/authority/mapping/package-info.java b/core/src/main/java/org/springframework/security/core/authority/mapping/package-info.java new file mode 100644 index 0000000000..da9d6ed241 --- /dev/null +++ b/core/src/main/java/org/springframework/security/core/authority/mapping/package-info.java @@ -0,0 +1,8 @@ +/** + * Strategies for mapping a list of attributes (such as roles or LDAP groups) to a list of + * {@code GrantedAuthority}s. + *

+ * Provides a layer of indirection between a security data repository and the logical authorities + * required within an application. + */ +package org.springframework.security.core.authority.mapping; diff --git a/core/src/main/java/org/springframework/security/core/authority/package-info.java b/core/src/main/java/org/springframework/security/core/authority/package-info.java new file mode 100644 index 0000000000..d9fcaf6d44 --- /dev/null +++ b/core/src/main/java/org/springframework/security/core/authority/package-info.java @@ -0,0 +1,4 @@ +/** + * The default implementation of the {@code GrantedAuthority} interface. + */ +package org.springframework.security.core.authority; diff --git a/core/src/main/java/org/springframework/security/core/codec/package-info.java b/core/src/main/java/org/springframework/security/core/codec/package-info.java new file mode 100644 index 0000000000..b1cfa6aea7 --- /dev/null +++ b/core/src/main/java/org/springframework/security/core/codec/package-info.java @@ -0,0 +1,4 @@ +/** + * Internal codec classes. Only intended for use within the framework. + */ +package org.springframework.security.core.codec; diff --git a/core/src/main/java/org/springframework/security/core/context/package-info.java b/core/src/main/java/org/springframework/security/core/context/package-info.java new file mode 100644 index 0000000000..b102eaef4b --- /dev/null +++ b/core/src/main/java/org/springframework/security/core/context/package-info.java @@ -0,0 +1,11 @@ +/** + * Classes related to the establishment of a security context for the duration of a request (such as + * an HTTP or RMI invocation). + *

+ * A security context is usually associated with the current execution thread for the duration of the request, + * making the authentication information it contains available throughout all the layers of an application. + *

+ * The {@link org.springframework.security.core.context.SecurityContext SecurityContext} can be accessed at any point + * by calling the {@link org.springframework.security.core.context.SecurityContextHolder SecurityContextHolder}. + */ +package org.springframework.security.core.context; diff --git a/core/src/main/java/org/springframework/security/core/context/package.html b/core/src/main/java/org/springframework/security/core/context/package.html deleted file mode 100644 index 8b9530cc79..0000000000 --- a/core/src/main/java/org/springframework/security/core/context/package.html +++ /dev/null @@ -1,10 +0,0 @@ - - -Classes related to the establishment of a security context for the duration of a request (such as -an HTTP or RMI invocation). -

-A security context is associated with the current execution thread for the duration of the request, making the -authentication information it contains available throughout all the layers of an application. - - - diff --git a/core/src/main/java/org/springframework/security/core/package-info.java b/core/src/main/java/org/springframework/security/core/package-info.java new file mode 100644 index 0000000000..aea31f4b30 --- /dev/null +++ b/core/src/main/java/org/springframework/security/core/package-info.java @@ -0,0 +1,5 @@ +/** + * Core classes and interfaces related to user authentication and authorization, as well as the maintenance of + * a security context. + */ +package org.springframework.security.core; diff --git a/core/src/main/java/org/springframework/security/core/session/package-info.java b/core/src/main/java/org/springframework/security/core/session/package-info.java new file mode 100644 index 0000000000..a8cc7b7506 --- /dev/null +++ b/core/src/main/java/org/springframework/security/core/session/package-info.java @@ -0,0 +1,6 @@ +/** + * Session abstraction which is provided by the {@code org.springframework.security.core.session.SessionInformation + * SessionInformation} class. The {@link org.springframework.security.core.session.SessionRegistry SessionRegistry} + * is a core part of the web-based concurrent session control, but the code is not dependent on any of the servlet APIs. + */ +package org.springframework.security.core.session; diff --git a/core/src/main/java/org/springframework/security/core/session/package.html b/core/src/main/java/org/springframework/security/core/session/package.html deleted file mode 100644 index 690d318501..0000000000 --- a/core/src/main/java/org/springframework/security/core/session/package.html +++ /dev/null @@ -1,6 +0,0 @@ - - -Session registry and other related classes. - - - diff --git a/core/src/main/java/org/springframework/security/core/token/package-info.java b/core/src/main/java/org/springframework/security/core/token/package-info.java new file mode 100644 index 0000000000..b8f8bbd308 --- /dev/null +++ b/core/src/main/java/org/springframework/security/core/token/package-info.java @@ -0,0 +1,4 @@ +/** + * A service for building secure random tokens. + */ +package org.springframework.security.core.token; diff --git a/core/src/main/java/org/springframework/security/core/userdetails/cache/package-info.java b/core/src/main/java/org/springframework/security/core/userdetails/cache/package-info.java new file mode 100644 index 0000000000..1cadd53d78 --- /dev/null +++ b/core/src/main/java/org/springframework/security/core/userdetails/cache/package-info.java @@ -0,0 +1,4 @@ +/** + * Implementations of {@link org.springframework.security.core.userdetails.UserCache UserCache}. + */ +package org.springframework.security.core.userdetails.cache; diff --git a/core/src/main/java/org/springframework/security/core/userdetails/jdbc/package-info.java b/core/src/main/java/org/springframework/security/core/userdetails/jdbc/package-info.java new file mode 100644 index 0000000000..bffdf53c66 --- /dev/null +++ b/core/src/main/java/org/springframework/security/core/userdetails/jdbc/package-info.java @@ -0,0 +1,5 @@ +/** + * Exposes a JDBC-based authentication repository, implementing + * {@code org.springframework.security.core.userdetails.UserDetailsService UserDetailsService}. + */ +package org.springframework.security.core.userdetails.jdbc; diff --git a/core/src/main/java/org/springframework/security/core/userdetails/jdbc/package.html b/core/src/main/java/org/springframework/security/core/userdetails/jdbc/package.html deleted file mode 100644 index 695b3d5c9f..0000000000 --- a/core/src/main/java/org/springframework/security/core/userdetails/jdbc/package.html +++ /dev/null @@ -1,5 +0,0 @@ - - -Exposes a JDBC-based authentication repository. - - diff --git a/core/src/main/java/org/springframework/security/core/userdetails/memory/package-info.java b/core/src/main/java/org/springframework/security/core/userdetails/memory/package-info.java new file mode 100644 index 0000000000..16afaa46da --- /dev/null +++ b/core/src/main/java/org/springframework/security/core/userdetails/memory/package-info.java @@ -0,0 +1,4 @@ +/** + * Exposes an in-memory authentication repository. + */ +package org.springframework.security.core.userdetails.memory; diff --git a/core/src/main/java/org/springframework/security/core/userdetails/memory/package.html b/core/src/main/java/org/springframework/security/core/userdetails/memory/package.html deleted file mode 100644 index b8a3b5d88f..0000000000 --- a/core/src/main/java/org/springframework/security/core/userdetails/memory/package.html +++ /dev/null @@ -1,6 +0,0 @@ - - -Exposes an in-memory authentication repository. - - - diff --git a/core/src/main/java/org/springframework/security/core/userdetails/package-info.java b/core/src/main/java/org/springframework/security/core/userdetails/package-info.java new file mode 100644 index 0000000000..738ad7912e --- /dev/null +++ b/core/src/main/java/org/springframework/security/core/userdetails/package-info.java @@ -0,0 +1,8 @@ +/** + * The standard interfaces for implementing user data DAOs. + *

+ * Can be the traditional {@link org.springframework.security.core.userdetails.UserDetailsService UserDetailsService} + * which uses a unique username to identify the user or, for more complex requirements, the + * {@link org.springframework.security.core.userdetails.AuthenticationUserDetailsService AuthenticationUserDetailsService}. + */ +package org.springframework.security.core.userdetails; diff --git a/core/src/main/java/org/springframework/security/provisioning/package-info.java b/core/src/main/java/org/springframework/security/provisioning/package-info.java new file mode 100644 index 0000000000..ccb46716fc --- /dev/null +++ b/core/src/main/java/org/springframework/security/provisioning/package-info.java @@ -0,0 +1,5 @@ +/** + * Contains simple user and authority group account provisioning interfaces together with a a + * JDBC-based implementation. + */ +package org.springframework.security.provisioning; diff --git a/core/src/main/java/org/springframework/security/provisioning/package.html b/core/src/main/java/org/springframework/security/provisioning/package.html deleted file mode 100644 index f0dd2b0856..0000000000 --- a/core/src/main/java/org/springframework/security/provisioning/package.html +++ /dev/null @@ -1,6 +0,0 @@ - - -

Contains simple user and authority group account provisioning interfaces together with a -a JDBC-based implementation.

- - diff --git a/core/src/main/java/org/springframework/security/remoting/dns/package-info.java b/core/src/main/java/org/springframework/security/remoting/dns/package-info.java new file mode 100644 index 0000000000..3144434ea5 --- /dev/null +++ b/core/src/main/java/org/springframework/security/remoting/dns/package-info.java @@ -0,0 +1,4 @@ +/** + * DNS resolution. + */ +package org.springframework.security.remoting.dns; diff --git a/core/src/main/java/org/springframework/security/remoting/httpinvoker/package-info.java b/core/src/main/java/org/springframework/security/remoting/httpinvoker/package-info.java new file mode 100644 index 0000000000..c8a9b993f8 --- /dev/null +++ b/core/src/main/java/org/springframework/security/remoting/httpinvoker/package-info.java @@ -0,0 +1,19 @@ +/** + * Enables use of Spring's HttpInvoker extension points to + * present the principal and credentials located + * in the ContextHolder via BASIC authentication. + *

+ * The beans are wired as follows: + * + * 

+ * <bean id="test" class="org.springframework.remoting.httpinvoker.HttpInvokerProxyFactoryBean">
+ *   <property name="serviceUrl"><value>http://localhost/Test</value></property>
+ *   <property name="serviceInterface"><value>test.TargetInterface</value></property>
+ *   <property name="httpInvokerRequestExecutor"><ref bean="httpInvokerRequestExecutor"/></property>
+ * </bean>
+ *
+ * <bean id="httpInvokerRequestExecutor"
+ *     class="org.springframework.security.core.context.httpinvoker.AuthenticationSimpleHttpInvokerRequestExecutor"/>
+ *
+ */ +package org.springframework.security.remoting.httpinvoker; diff --git a/core/src/main/java/org/springframework/security/remoting/httpinvoker/package.html b/core/src/main/java/org/springframework/security/remoting/httpinvoker/package.html deleted file mode 100644 index 444c29f0bc..0000000000 --- a/core/src/main/java/org/springframework/security/remoting/httpinvoker/package.html +++ /dev/null @@ -1,21 +0,0 @@ - - -Enables use of Spring's HttpInvoker extension points to -present the principal and credentials located -in the ContextHolder via BASIC authentication. - -

The beans are wired as follows: - -

- -<bean id="test" class="org.springframework.remoting.httpinvoker.HttpInvokerProxyFactoryBean">
- <property name="serviceUrl"><value>http://localhost/Test</value></property>
- <property name="serviceInterface"><value>test.TargetInterface</value></property>
- <property name="httpInvokerRequestExecutor"><ref bean="httpInvokerRequestExecutor"/></property>
-</bean>
-
-<bean id="httpInvokerRequestExecutor" class="org.springframework.security.core.context.httpinvoker.AuthenticationSimpleHttpInvokerRequestExecutor"/>
- - - - diff --git a/core/src/main/java/org/springframework/security/remoting/package-info.java b/core/src/main/java/org/springframework/security/remoting/package-info.java new file mode 100644 index 0000000000..caa6c8a372 --- /dev/null +++ b/core/src/main/java/org/springframework/security/remoting/package-info.java @@ -0,0 +1,4 @@ +/** + * Remote client related functionality. + */ +package org.springframework.security.remoting; diff --git a/core/src/main/java/org/springframework/security/remoting/rmi/package-info.java b/core/src/main/java/org/springframework/security/remoting/rmi/package-info.java new file mode 100644 index 0000000000..4ed18fc06d --- /dev/null +++ b/core/src/main/java/org/springframework/security/remoting/rmi/package-info.java @@ -0,0 +1,18 @@ +/** + * Enables use of Spring's RMI remoting extension points to propagate the SecurityContextHolder (which + * should contain an Authentication request token) from one JVM to the remote JVM. + *

+ * The beans are wired as follows: + * 

+ * <bean id="test" class="org.springframework.remoting.rmi.RmiProxyFactoryBean">
+ *   <property name="serviceUrl"><value>rmi://localhost/Test</value></property>
+ *   <property name="serviceInterface"><value>test.TargetInterface</value></property>
+ *   <property name="refreshStubOnConnectFailure"><value>true</value></property>
+ *   <property name="remoteInvocationFactory"><ref bean="remoteInvocationFactory"/></property>
+ * </bean>
+ *
+ * <bean id="remoteInvocationFactory"
+ *     class="org.springframework.security.remoting.rmi.ContextPropagatingRemoteInvocationFactory"/>
+ *
+ */ +package org.springframework.security.remoting.rmi; diff --git a/core/src/main/java/org/springframework/security/remoting/rmi/package.html b/core/src/main/java/org/springframework/security/remoting/rmi/package.html deleted file mode 100644 index 93eb2602de..0000000000 --- a/core/src/main/java/org/springframework/security/remoting/rmi/package.html +++ /dev/null @@ -1,23 +0,0 @@ - - -Enables use of Spring's RMI remoting extension points to propagate -the ContextHolder (which should contain an -Authentication request token) -from one JVM to the remote JVM. - -

The beans are wired as follows: - -

- -<bean id="test" class="org.springframework.remoting.rmi.RmiProxyFactoryBean">
- <property name="serviceUrl"><value>rmi://localhost/Test</value></property>
- <property name="serviceInterface"><value>test.TargetInterface</value></property>
- <property name="refreshStubOnConnectFailure"><value>true</value></property>
- <property name="remoteInvocationFactory"><ref bean="remoteInvocationFactory"/></property>
-</bean>
-
-<bean id="remoteInvocationFactory" class="org.springframework.security.core.context.rmi.ContextPropagatingRemoteInvocationFactory"/>
- - - - diff --git a/core/src/main/java/org/springframework/security/util/package-info.java b/core/src/main/java/org/springframework/security/util/package-info.java new file mode 100644 index 0000000000..2b135a3d63 --- /dev/null +++ b/core/src/main/java/org/springframework/security/util/package-info.java @@ -0,0 +1,7 @@ +/** + * General utility classes used throughout the Spring Security framework. Intended for internal use. + *

+ * This package should be standalone - it should not have dependencies on other parts of the framework, + * just on external libraries and the JDK. + */ +package org.springframework.security.util; diff --git a/core/src/main/java/org/springframework/security/util/package.html b/core/src/main/java/org/springframework/security/util/package.html deleted file mode 100644 index 9b641cfad7..0000000000 --- a/core/src/main/java/org/springframework/security/util/package.html +++ /dev/null @@ -1,11 +0,0 @@ - - -

-General utility classes used throughout the Spring Security framework. -

-

-This package should essentially be standalone - it should not have dependencies on other -parts of the framework, just on external libraries and the JDK. -

- - diff --git a/ldap/src/main/java/org/springframework/security/ldap/authentication/package-info.java b/ldap/src/main/java/org/springframework/security/ldap/authentication/package-info.java new file mode 100644 index 0000000000..4f02fa443e --- /dev/null +++ b/ldap/src/main/java/org/springframework/security/ldap/authentication/package-info.java @@ -0,0 +1,11 @@ +/** + * The LDAP authentication provider package. Interfaces are provided for + * both authentication and retrieval of user roles from an LDAP server. + *

+ * The main provider class is LdapAuthenticationProvider. + * This is configured with an LdapAuthenticator instance and + * an LdapAuthoritiesPopulator. The latter is used to obtain the + * list of roles for the user. + */ +package org.springframework.security.ldap.authentication; + diff --git a/ldap/src/main/java/org/springframework/security/ldap/authentication/package.html b/ldap/src/main/java/org/springframework/security/ldap/authentication/package.html deleted file mode 100644 index 494eb4b36f..0000000000 --- a/ldap/src/main/java/org/springframework/security/ldap/authentication/package.html +++ /dev/null @@ -1,15 +0,0 @@ - - -

-The LDAP authentication provider package. Interfaces are provided for -both authentication and retrieval of user roles from an LDAP server. -

-

-The main provider class is LdapAuthenticationProvider. -This is configured with an LdapAuthenticator instance and -an LdapAuthoritiesPopulator. The latter is used to obtain the -list of roles for the user. -

- - - diff --git a/ldap/src/main/java/org/springframework/security/ldap/package-info.java b/ldap/src/main/java/org/springframework/security/ldap/package-info.java new file mode 100644 index 0000000000..63a5da3306 --- /dev/null +++ b/ldap/src/main/java/org/springframework/security/ldap/package-info.java @@ -0,0 +1,5 @@ +/** + * Spring Security's LDAP module. + */ +package org.springframework.security.ldap; + diff --git a/ldap/src/main/java/org/springframework/security/ldap/ppolicy/package-info.java b/ldap/src/main/java/org/springframework/security/ldap/ppolicy/package-info.java new file mode 100644 index 0000000000..1033cf4edd --- /dev/null +++ b/ldap/src/main/java/org/springframework/security/ldap/ppolicy/package-info.java @@ -0,0 +1,9 @@ +/** + * Implementation of password policy functionality based on the + * + * Password Policy for LDAP Directories. + *

+ * This code will not work with servers such as Active Directory, which do not implement this standard. + */ +package org.springframework.security.ldap.ppolicy; + diff --git a/ldap/src/main/java/org/springframework/security/ldap/search/package-info.java b/ldap/src/main/java/org/springframework/security/ldap/search/package-info.java new file mode 100644 index 0000000000..b93bf1ae50 --- /dev/null +++ b/ldap/src/main/java/org/springframework/security/ldap/search/package-info.java @@ -0,0 +1,5 @@ +/** + * {@code LdapUserSearch} implementations. These may be used to locate the user in the directory. + */ +package org.springframework.security.ldap.search; + diff --git a/ldap/src/main/java/org/springframework/security/ldap/search/package.html b/ldap/src/main/java/org/springframework/security/ldap/search/package.html deleted file mode 100644 index 4543b9ef20..0000000000 --- a/ldap/src/main/java/org/springframework/security/ldap/search/package.html +++ /dev/null @@ -1,5 +0,0 @@ - - -LdapUserSearch implementations. These may be used to locate the user in the directory. - - diff --git a/ldap/src/main/java/org/springframework/security/ldap/server/package-info.java b/ldap/src/main/java/org/springframework/security/ldap/server/package-info.java new file mode 100644 index 0000000000..73ce1da42d --- /dev/null +++ b/ldap/src/main/java/org/springframework/security/ldap/server/package-info.java @@ -0,0 +1,5 @@ +/** + * Embedded Apache Directory Server implementation, as used by the configuration namespace. + */ +package org.springframework.security.ldap.server; + diff --git a/ldap/src/main/java/org/springframework/security/ldap/userdetails/package-info.java b/ldap/src/main/java/org/springframework/security/ldap/userdetails/package-info.java new file mode 100644 index 0000000000..615be8791f --- /dev/null +++ b/ldap/src/main/java/org/springframework/security/ldap/userdetails/package-info.java @@ -0,0 +1,6 @@ +/** + * LDAP-focused {@code UserDetails} implementations which map from a ubset of the data + * contained in some of the standard LDAP types (such as {@code InetOrgPerson}). + */ +package org.springframework.security.ldap.userdetails; + diff --git a/openid/src/main/java/org/springframework/security/openid/package-info.java b/openid/src/main/java/org/springframework/security/openid/package-info.java new file mode 100644 index 0000000000..648b5bea15 --- /dev/null +++ b/openid/src/main/java/org/springframework/security/openid/package-info.java @@ -0,0 +1,2 @@ +package org.springframework.security.openid; + diff --git a/taglibs/src/main/java/org/springframework/security/taglibs/authz/package-info.java b/taglibs/src/main/java/org/springframework/security/taglibs/authz/package-info.java new file mode 100644 index 0000000000..7e568e6ff6 --- /dev/null +++ b/taglibs/src/main/java/org/springframework/security/taglibs/authz/package-info.java @@ -0,0 +1,5 @@ +/** + * JSP Security tag library implementation. + */ +package org.springframework.security.taglibs.authz; + diff --git a/taglibs/src/main/java/org/springframework/security/taglibs/authz/package.html b/taglibs/src/main/java/org/springframework/security/taglibs/authz/package.html deleted file mode 100644 index 981e14b6a1..0000000000 --- a/taglibs/src/main/java/org/springframework/security/taglibs/authz/package.html +++ /dev/null @@ -1,5 +0,0 @@ - - -Java implementation of security taglib. - - diff --git a/taglibs/src/main/java/org/springframework/security/taglibs/package-info.java b/taglibs/src/main/java/org/springframework/security/taglibs/package-info.java new file mode 100644 index 0000000000..98e7fad9a2 --- /dev/null +++ b/taglibs/src/main/java/org/springframework/security/taglibs/package-info.java @@ -0,0 +1,5 @@ +/** + * Security related tag libraries that can be used in JSPs and templates. + */ +package org.springframework.security.taglibs; + diff --git a/taglibs/src/main/java/org/springframework/security/taglibs/package.html b/taglibs/src/main/java/org/springframework/security/taglibs/package.html deleted file mode 100644 index 902faf2f75..0000000000 --- a/taglibs/src/main/java/org/springframework/security/taglibs/package.html +++ /dev/null @@ -1,5 +0,0 @@ - - -Provides security related taglibs that can be used in JSPs. - - diff --git a/taglibs/src/main/java/org/springframework/security/taglibs/velocity/package-info.java b/taglibs/src/main/java/org/springframework/security/taglibs/velocity/package-info.java new file mode 100644 index 0000000000..0783ebc077 --- /dev/null +++ b/taglibs/src/main/java/org/springframework/security/taglibs/velocity/package-info.java @@ -0,0 +1,2 @@ +package org.springframework.security.taglibs.velocity; + diff --git a/web/src/main/java/org/springframework/security/web/access/channel/package-info.java b/web/src/main/java/org/springframework/security/web/access/channel/package-info.java new file mode 100644 index 0000000000..5859caba08 --- /dev/null +++ b/web/src/main/java/org/springframework/security/web/access/channel/package-info.java @@ -0,0 +1,7 @@ +/** + * Classes that ensure web requests are received over required transport channels. + *

+ * Most commonly used to enforce that requests are submitted over HTTP or HTTPS. + */ +package org.springframework.security.web.access.channel; + diff --git a/web/src/main/java/org/springframework/security/web/access/channel/package.html b/web/src/main/java/org/springframework/security/web/access/channel/package.html deleted file mode 100644 index 257fc29113..0000000000 --- a/web/src/main/java/org/springframework/security/web/access/channel/package.html +++ /dev/null @@ -1,6 +0,0 @@ - - -Classes that ensure web requests are received over required -transport channels. - - diff --git a/web/src/main/java/org/springframework/security/web/access/expression/package-info.java b/web/src/main/java/org/springframework/security/web/access/expression/package-info.java new file mode 100644 index 0000000000..44ceecc9a9 --- /dev/null +++ b/web/src/main/java/org/springframework/security/web/access/expression/package-info.java @@ -0,0 +1,5 @@ +/** + * Implementation of web security expressions. + */ +package org.springframework.security.web.access.expression; + diff --git a/web/src/main/java/org/springframework/security/web/access/intercept/package-info.java b/web/src/main/java/org/springframework/security/web/access/intercept/package-info.java new file mode 100644 index 0000000000..474655b0c0 --- /dev/null +++ b/web/src/main/java/org/springframework/security/web/access/intercept/package-info.java @@ -0,0 +1,5 @@ +/** + * Enforcement of security for HTTP requests, typically by the URL requested. + */ +package org.springframework.security.web.access.intercept; + diff --git a/web/src/main/java/org/springframework/security/web/access/intercept/package.html b/web/src/main/java/org/springframework/security/web/access/intercept/package.html deleted file mode 100644 index cae66192f1..0000000000 --- a/web/src/main/java/org/springframework/security/web/access/intercept/package.html +++ /dev/null @@ -1,5 +0,0 @@ - - -Enforces security for HTTP requests, typically by the URL requested. - - diff --git a/web/src/main/java/org/springframework/security/web/access/package-info.java b/web/src/main/java/org/springframework/security/web/access/package-info.java new file mode 100644 index 0000000000..877b8e65d7 --- /dev/null +++ b/web/src/main/java/org/springframework/security/web/access/package-info.java @@ -0,0 +1,5 @@ +/** + * Access-control related classes and packages. + */ +package org.springframework.security.web.access; + diff --git a/web/src/main/java/org/springframework/security/web/authentication/logout/package-info.java b/web/src/main/java/org/springframework/security/web/authentication/logout/package-info.java new file mode 100644 index 0000000000..6fa3428cc2 --- /dev/null +++ b/web/src/main/java/org/springframework/security/web/authentication/logout/package-info.java @@ -0,0 +1,5 @@ +/** + * Logout functionality based around a filter which handles a specific logout URL. + */ +package org.springframework.security.web.authentication.logout; + diff --git a/web/src/main/java/org/springframework/security/web/authentication/package-info.java b/web/src/main/java/org/springframework/security/web/authentication/package-info.java new file mode 100644 index 0000000000..0a0033947e --- /dev/null +++ b/web/src/main/java/org/springframework/security/web/authentication/package-info.java @@ -0,0 +1,6 @@ +/** + * Authentication processing mechanisms, which respond to the submission of authentication + * credentials using various protocols (eg BASIC, CAS, form login etc). + */ +package org.springframework.security.web.authentication; + diff --git a/web/src/main/java/org/springframework/security/web/authentication/package.html b/web/src/main/java/org/springframework/security/web/authentication/package.html deleted file mode 100644 index 23a8f43a2e..0000000000 --- a/web/src/main/java/org/springframework/security/web/authentication/package.html +++ /dev/null @@ -1,6 +0,0 @@ - - -Authentication processing mechanisms, which respond to the submission of authentication -credentials using various protocols (eg BASIC, CAS, form login etc). - - diff --git a/web/src/main/java/org/springframework/security/web/authentication/preauth/j2ee/package-info.java b/web/src/main/java/org/springframework/security/web/authentication/preauth/j2ee/package-info.java new file mode 100644 index 0000000000..4f2cde96ee --- /dev/null +++ b/web/src/main/java/org/springframework/security/web/authentication/preauth/j2ee/package-info.java @@ -0,0 +1,8 @@ +/** + * Pre-authentication support for container-authenticated requests. + *

+ * It is assumed that standard JEE security has been configured and Spring Security hooks into the + * security methods exposed by {@code HttpServletRequest} to build {@code Authentication} object for the user. + */ +package org.springframework.security.web.authentication.preauth.j2ee; + diff --git a/web/src/main/java/org/springframework/security/web/authentication/preauth/package-info.java b/web/src/main/java/org/springframework/security/web/authentication/preauth/package-info.java new file mode 100644 index 0000000000..725ee8e9b8 --- /dev/null +++ b/web/src/main/java/org/springframework/security/web/authentication/preauth/package-info.java @@ -0,0 +1,6 @@ +/** + * Support for "pre-authenticated" scenarios, where Spring Security assumes the incoming request has already been + * authenticated by some externally configured system. + */ +package org.springframework.security.web.authentication.preauth; + diff --git a/web/src/main/java/org/springframework/security/web/authentication/preauth/websphere/package-info.java b/web/src/main/java/org/springframework/security/web/authentication/preauth/websphere/package-info.java new file mode 100644 index 0000000000..0cab4aa49c --- /dev/null +++ b/web/src/main/java/org/springframework/security/web/authentication/preauth/websphere/package-info.java @@ -0,0 +1,5 @@ +/** + * Websphere-specific pre-authentication classes. + */ +package org.springframework.security.web.authentication.preauth.websphere; + diff --git a/web/src/main/java/org/springframework/security/web/authentication/preauth/x509/package-info.java b/web/src/main/java/org/springframework/security/web/authentication/preauth/x509/package-info.java new file mode 100644 index 0000000000..745d567f10 --- /dev/null +++ b/web/src/main/java/org/springframework/security/web/authentication/preauth/x509/package-info.java @@ -0,0 +1,6 @@ +/** + * X.509 client certificate authentication support. Hooks into the certificate exposed by the servlet container + * through the {@code javax.servlet.request.X509Certificate} property. + */ +package org.springframework.security.web.authentication.preauth.x509; + diff --git a/web/src/main/java/org/springframework/security/web/authentication/rememberme/package-info.java b/web/src/main/java/org/springframework/security/web/authentication/rememberme/package-info.java new file mode 100644 index 0000000000..f4cae9a3bd --- /dev/null +++ b/web/src/main/java/org/springframework/security/web/authentication/rememberme/package-info.java @@ -0,0 +1,9 @@ +/** + * Support for remembering a user between different web sessions. + *

+ * Comes with two default implementations. See the + * Remember-Me + * Authentication chapter of the reference manual. + */ +package org.springframework.security.web.authentication.rememberme; + diff --git a/web/src/main/java/org/springframework/security/web/authentication/rememberme/package.html b/web/src/main/java/org/springframework/security/web/authentication/rememberme/package.html deleted file mode 100644 index b6d69a70ba..0000000000 --- a/web/src/main/java/org/springframework/security/web/authentication/rememberme/package.html +++ /dev/null @@ -1,5 +0,0 @@ - - -Support for remembering a user between different web sessions. - - diff --git a/web/src/main/java/org/springframework/security/web/authentication/session/package-info.java b/web/src/main/java/org/springframework/security/web/authentication/session/package-info.java new file mode 100644 index 0000000000..64d7717dde --- /dev/null +++ b/web/src/main/java/org/springframework/security/web/authentication/session/package-info.java @@ -0,0 +1,11 @@ +/** + * Strategy interface and implementations for handling session-related behaviour for a newly authenticated user. + *

+ * Comes with support for: + *

+ */ +package org.springframework.security.web.authentication.session; + diff --git a/web/src/main/java/org/springframework/security/web/authentication/session/package.html b/web/src/main/java/org/springframework/security/web/authentication/session/package.html deleted file mode 100644 index a15f4a52b3..0000000000 --- a/web/src/main/java/org/springframework/security/web/authentication/session/package.html +++ /dev/null @@ -1,5 +0,0 @@ - - -Strategy interface and implementations for handling session-related behaviour for a newly authenticated user. - - diff --git a/web/src/main/java/org/springframework/security/web/authentication/switchuser/package-info.java b/web/src/main/java/org/springframework/security/web/authentication/switchuser/package-info.java new file mode 100644 index 0000000000..c4af332b48 --- /dev/null +++ b/web/src/main/java/org/springframework/security/web/authentication/switchuser/package-info.java @@ -0,0 +1,5 @@ +/** + * Provides HTTP-based "switch user" (su) capabilities. + */ +package org.springframework.security.web.authentication.switchuser; + diff --git a/web/src/main/java/org/springframework/security/web/authentication/switchuser/package.html b/web/src/main/java/org/springframework/security/web/authentication/switchuser/package.html deleted file mode 100644 index 0d0249588d..0000000000 --- a/web/src/main/java/org/springframework/security/web/authentication/switchuser/package.html +++ /dev/null @@ -1,5 +0,0 @@ - - -Provides HTTP-based "switch user" (su) capabilities. - - diff --git a/web/src/main/java/org/springframework/security/web/authentication/ui/package-info.java b/web/src/main/java/org/springframework/security/web/authentication/ui/package-info.java new file mode 100644 index 0000000000..56ec76a74a --- /dev/null +++ b/web/src/main/java/org/springframework/security/web/authentication/ui/package-info.java @@ -0,0 +1,6 @@ +/** + * Authentication user-interface rendering code. Used to conveniently create an appropriate login page when using namespace + * configuration without defining a login page URL. + */ +package org.springframework.security.web.authentication.ui; + diff --git a/web/src/main/java/org/springframework/security/web/authentication/ui/package.html b/web/src/main/java/org/springframework/security/web/authentication/ui/package.html deleted file mode 100644 index 079628f15a..0000000000 --- a/web/src/main/java/org/springframework/security/web/authentication/ui/package.html +++ /dev/null @@ -1,6 +0,0 @@ - - -Authentication user-interface rendering code. Used to conveniently create an appropriate login page when using namespace -configuration without defining a login page URL. - - diff --git a/web/src/main/java/org/springframework/security/web/authentication/www/package-info.java b/web/src/main/java/org/springframework/security/web/authentication/www/package-info.java new file mode 100644 index 0000000000..ee6bad71b8 --- /dev/null +++ b/web/src/main/java/org/springframework/security/web/authentication/www/package-info.java @@ -0,0 +1,5 @@ +/** + * WWW-Authenticate based authentication mechanism implementations: Basic and Digest authentication. + */ +package org.springframework.security.web.authentication.www; + diff --git a/web/src/main/java/org/springframework/security/web/authentication/www/package.html b/web/src/main/java/org/springframework/security/web/authentication/www/package.html deleted file mode 100644 index f23bf80f5c..0000000000 --- a/web/src/main/java/org/springframework/security/web/authentication/www/package.html +++ /dev/null @@ -1,5 +0,0 @@ - - -Contains WWW-Authenticate based authentication mechanism implementations: Basic and Digest authentication. - - diff --git a/web/src/main/java/org/springframework/security/web/context/package-info.java b/web/src/main/java/org/springframework/security/web/context/package-info.java new file mode 100644 index 0000000000..a1e6b25f36 --- /dev/null +++ b/web/src/main/java/org/springframework/security/web/context/package-info.java @@ -0,0 +1,5 @@ +/** + * Classes which are responsible for maintaining the security context between HTTP requests. + */ +package org.springframework.security.web.context; + diff --git a/web/src/main/java/org/springframework/security/web/context/package.html b/web/src/main/java/org/springframework/security/web/context/package.html deleted file mode 100644 index 6808fd49f4..0000000000 --- a/web/src/main/java/org/springframework/security/web/context/package.html +++ /dev/null @@ -1,8 +0,0 @@ - - -

-Classes which are responsible for maintaining the security context -between HTTP requests. -

- - \ No newline at end of file diff --git a/web/src/main/java/org/springframework/security/web/package-info.java b/web/src/main/java/org/springframework/security/web/package-info.java new file mode 100644 index 0000000000..b92a97fe14 --- /dev/null +++ b/web/src/main/java/org/springframework/security/web/package-info.java @@ -0,0 +1,5 @@ +/** + * Spring Security's web security module. Classes which have a dependency on the Servlet API can be found here. + */ +package org.springframework.security.web; + diff --git a/web/src/main/java/org/springframework/security/web/savedrequest/package-info.java b/web/src/main/java/org/springframework/security/web/savedrequest/package-info.java new file mode 100644 index 0000000000..39f66f5714 --- /dev/null +++ b/web/src/main/java/org/springframework/security/web/savedrequest/package-info.java @@ -0,0 +1,8 @@ +/** + * Classes related to the caching of an {@code HttpServletRequest} which requires authentication. While the user is + * logging in, the request is cached (using the RequestCache implementation) by the ExceptionTranslationFilter. + * Once the user has been authenticated, the original request is restored following a redirect to a matching URL, and + * the {@code RequestCache} is queried to obtain the original (matching) request. + */ +package org.springframework.security.web.savedrequest; + diff --git a/web/src/main/java/org/springframework/security/web/savedrequest/package.html b/web/src/main/java/org/springframework/security/web/savedrequest/package.html deleted file mode 100644 index 3a00f47fc5..0000000000 --- a/web/src/main/java/org/springframework/security/web/savedrequest/package.html +++ /dev/null @@ -1,8 +0,0 @@ - - -Classes related top the caching of an HttpServletRequest which requires authentication. While the user is -logging in, the request is cached (using the RequestCache implementation) by the ExceptionTranslationFilter. -Once the user has been authenticated, the original request is restored following a redirect to a matching URL, and the -RequestCache is queried to obtain the original (matching) request. - - diff --git a/web/src/main/java/org/springframework/security/web/servletapi/package-info.java b/web/src/main/java/org/springframework/security/web/servletapi/package-info.java new file mode 100644 index 0000000000..1fd19c2a69 --- /dev/null +++ b/web/src/main/java/org/springframework/security/web/servletapi/package-info.java @@ -0,0 +1,7 @@ +/** + * Populates a Servlet request with a new Spring Security compliant {@code HttpServletRequestWrapper}. + *

+ * To use, simply add the {@code SecurityContextHolderAwareRequestFilter} to the Spring Security filter chain. + */ +package org.springframework.security.web.servletapi; + diff --git a/web/src/main/java/org/springframework/security/web/servletapi/package.html b/web/src/main/java/org/springframework/security/web/servletapi/package.html deleted file mode 100644 index 19bd2c0882..0000000000 --- a/web/src/main/java/org/springframework/security/web/servletapi/package.html +++ /dev/null @@ -1,9 +0,0 @@ - - -Populates a Servlet request with a new Spring Security compliant -HttpServletRequestWrapper. - -

To use, simply add the SecurityContextHolderAwareRequestFilter -to the Spring Security filter chain. - - diff --git a/web/src/main/java/org/springframework/security/web/session/package-info.java b/web/src/main/java/org/springframework/security/web/session/package-info.java new file mode 100644 index 0000000000..1c21979bc9 --- /dev/null +++ b/web/src/main/java/org/springframework/security/web/session/package-info.java @@ -0,0 +1,5 @@ +/** + * Session management filters, {@code HttpSession} events and publisher classes. + */ +package org.springframework.security.web.session; + diff --git a/web/src/main/java/org/springframework/security/web/session/package.html b/web/src/main/java/org/springframework/security/web/session/package.html deleted file mode 100644 index 82e4ff8951..0000000000 --- a/web/src/main/java/org/springframework/security/web/session/package.html +++ /dev/null @@ -1,5 +0,0 @@ - - -Session management filters, HttpSession events and publisher classes. - - diff --git a/web/src/main/java/org/springframework/security/web/util/package-info.java b/web/src/main/java/org/springframework/security/web/util/package-info.java new file mode 100644 index 0000000000..40759ec5fc --- /dev/null +++ b/web/src/main/java/org/springframework/security/web/util/package-info.java @@ -0,0 +1,7 @@ +/** + * Web utility classes. + *

+ * Should not depend on any other framework classes. + */ +package org.springframework.security.web.util; +