From b3aad4cf1943c4609a284142e54c6a93a01d6761 Mon Sep 17 00:00:00 2001 From: Luke Taylor Date: Thu, 6 May 2010 20:02:08 +0100 Subject: [PATCH] Javadoc fixes. --- .../security/acls/domain/AclImpl.java | 13 ++++++------- .../domain/DefaultPermissionGrantingStrategy.java | 2 +- .../DefaultMethodSecurityExpressionHandler.java | 2 +- .../security/taglibs/authz/AuthenticationTag.java | 1 - .../web/access/AccessDeniedHandlerImpl.java | 2 +- .../security/web/util/RegexRequestMatcher.java | 4 ++-- 6 files changed, 11 insertions(+), 13 deletions(-) diff --git a/acl/src/main/java/org/springframework/security/acls/domain/AclImpl.java b/acl/src/main/java/org/springframework/security/acls/domain/AclImpl.java index 3fdda0ec44..61629f463d 100644 --- a/acl/src/main/java/org/springframework/security/acls/domain/AclImpl.java +++ b/acl/src/main/java/org/springframework/security/acls/domain/AclImpl.java @@ -87,13 +87,12 @@ public class AclImpl implements Acl, MutableAcl, AuditableAcl, OwnershipAcl { * Full constructor, which should be used by persistence tools that do not * provide field-level access features. * - * @param objectIdentity the object identity this ACL relates to (required) - * @param id the primary key assigned to this ACL (required) - * @param aclAuthorizationStrategy authorization strategy (required) - * @param auditLogger audit logger (required) - * @param parentAcl the parent (may be null) - * @param loadedSids the loaded SIDs if only a subset were loaded (may be - * null) + * @param objectIdentity the object identity this ACL relates to + * @param id the primary key assigned to this ACL + * @param aclAuthorizationStrategy authorization strategy + * @param grantingStrategy the {@code PermissionGrantingStrategy} which will be used by the {@code isGranted()} method + * @param parentAcl the parent (may be may be {@code null}) + * @param loadedSids the loaded SIDs if only a subset were loaded (may be {@code null}) * @param entriesInheriting if ACEs from the parent should inherit into * this ACL * @param owner the owner (required) diff --git a/acl/src/main/java/org/springframework/security/acls/domain/DefaultPermissionGrantingStrategy.java b/acl/src/main/java/org/springframework/security/acls/domain/DefaultPermissionGrantingStrategy.java index ca399d38be..7294d2adeb 100644 --- a/acl/src/main/java/org/springframework/security/acls/domain/DefaultPermissionGrantingStrategy.java +++ b/acl/src/main/java/org/springframework/security/acls/domain/DefaultPermissionGrantingStrategy.java @@ -34,7 +34,7 @@ public class DefaultPermissionGrantingStrategy implements PermissionGrantingStra * iteration will be performed. If each permission indicates to deny access, the first deny ACE found will be * considered the reason for the failure (as it was the first match found, and is therefore the one most logically * requiring changes - although not always). If absolutely no matching ACE was found at all for any permission, - * the parent ACL will be tried (provided that there is a parent and {@link #isEntriesInheriting()} is + * the parent ACL will be tried (provided that there is a parent and {@link Acl#isEntriesInheriting()} is * true. The parent ACL will also scan its parent and so on. If ultimately no matching ACE is found, * a NotFoundException will be thrown and the caller will need to decide how to handle the permission * check. Similarly, if any of the SID arguments presented to the method were not loaded by the ACL, diff --git a/core/src/main/java/org/springframework/security/access/expression/method/DefaultMethodSecurityExpressionHandler.java b/core/src/main/java/org/springframework/security/access/expression/method/DefaultMethodSecurityExpressionHandler.java index bbdd86ee71..315f9f003b 100644 --- a/core/src/main/java/org/springframework/security/access/expression/method/DefaultMethodSecurityExpressionHandler.java +++ b/core/src/main/java/org/springframework/security/access/expression/method/DefaultMethodSecurityExpressionHandler.java @@ -72,7 +72,7 @@ public class DefaultMethodSecurityExpressionHandler implements MethodSecurityExp * Filters the {@code filterTarget} object (which must be either a collection or an array), by evaluating the * supplied expression. *

- * If a {@Collection} is used, the original instance will be modified to contain the elements for which + * If a {@code Collection} is used, the original instance will be modified to contain the elements for which * the permission expression evaluates to {@code true}. For an array, a new array instance will be returned. */ @SuppressWarnings("unchecked") diff --git a/taglibs/src/main/java/org/springframework/security/taglibs/authz/AuthenticationTag.java b/taglibs/src/main/java/org/springframework/security/taglibs/authz/AuthenticationTag.java index 04a286be29..660c70ae6f 100644 --- a/taglibs/src/main/java/org/springframework/security/taglibs/authz/AuthenticationTag.java +++ b/taglibs/src/main/java/org/springframework/security/taglibs/authz/AuthenticationTag.java @@ -150,7 +150,6 @@ public class AuthenticationTag extends TagSupport { /** * Return the HTML escaping setting for this tag, * or the default setting if not overridden. - * @see #isDefaultHtmlEscape() */ protected boolean isHtmlEscape() { return htmlEscape; diff --git a/web/src/main/java/org/springframework/security/web/access/AccessDeniedHandlerImpl.java b/web/src/main/java/org/springframework/security/web/access/AccessDeniedHandlerImpl.java index 43cd1c08c2..b77c250592 100644 --- a/web/src/main/java/org/springframework/security/web/access/AccessDeniedHandlerImpl.java +++ b/web/src/main/java/org/springframework/security/web/access/AccessDeniedHandlerImpl.java @@ -36,7 +36,7 @@ import org.springframework.security.web.WebAttributes; * Being a "forward", the SecurityContextHolder will remain * populated. This is of benefit if the view (or a tag library or macro) wishes to access the * SecurityContextHolder. The request scope will also be populated with the exception itself, available - * from the key {@link WebAttributes.ACCESS_DENIED_403}. + * from the key {@link WebAttributes#ACCESS_DENIED_403}. * * @author Ben Alex */ diff --git a/web/src/main/java/org/springframework/security/web/util/RegexRequestMatcher.java b/web/src/main/java/org/springframework/security/web/util/RegexRequestMatcher.java index 9ced66a04a..08e74f52bc 100644 --- a/web/src/main/java/org/springframework/security/web/util/RegexRequestMatcher.java +++ b/web/src/main/java/org/springframework/security/web/util/RegexRequestMatcher.java @@ -42,7 +42,7 @@ public final class RegexRequestMatcher implements RequestMatcher { * * @param pattern the regular expression to compile into a pattern. * @param httpMethod the HTTP method to match. May be null to match all methods. - * @param caseInsensitive if true, the pattern will be compiled with the {@link Pattern.CASE_INSENSITIVE} flag set. + * @param caseInsensitive if true, the pattern will be compiled with the {@link Pattern#CASE_INSENSITIVE} flag set. */ public RegexRequestMatcher(String pattern, String httpMethod, boolean caseInsensitive) { if (caseInsensitive) { @@ -57,7 +57,7 @@ public final class RegexRequestMatcher implements RequestMatcher { * Performs the match of the request URL ({@code servletPath + pathInfo + queryString}) against * the compiled pattern. * - * @param requst the request to match + * @param request the request to match * @return true if the pattern matches the URL, false otherwise. */ public boolean matches(HttpServletRequest request) {