Javadoc fixes.

This commit is contained in:
Luke Taylor 2010-05-06 20:02:08 +01:00
parent 5a4c81a2a5
commit b3aad4cf19
6 changed files with 11 additions and 13 deletions

View File

@ -87,13 +87,12 @@ public class AclImpl implements Acl, MutableAcl, AuditableAcl, OwnershipAcl {
* Full constructor, which should be used by persistence tools that do not * Full constructor, which should be used by persistence tools that do not
* provide field-level access features. * provide field-level access features.
* *
* @param objectIdentity the object identity this ACL relates to (required) * @param objectIdentity the object identity this ACL relates to
* @param id the primary key assigned to this ACL (required) * @param id the primary key assigned to this ACL
* @param aclAuthorizationStrategy authorization strategy (required) * @param aclAuthorizationStrategy authorization strategy
* @param auditLogger audit logger (required) * @param grantingStrategy the {@code PermissionGrantingStrategy} which will be used by the {@code isGranted()} method
* @param parentAcl the parent (may be <code>null</code>) * @param parentAcl the parent (may be may be {@code null})
* @param loadedSids the loaded SIDs if only a subset were loaded (may be * @param loadedSids the loaded SIDs if only a subset were loaded (may be {@code null})
* <code>null</code>)
* @param entriesInheriting if ACEs from the parent should inherit into * @param entriesInheriting if ACEs from the parent should inherit into
* this ACL * this ACL
* @param owner the owner (required) * @param owner the owner (required)

View File

@ -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 * 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 * 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, * 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
* <code>true</code>. The parent ACL will also scan its parent and so on. If ultimately no matching ACE is found, * <code>true</code>. The parent ACL will also scan its parent and so on. If ultimately no matching ACE is found,
* a <code>NotFoundException</code> will be thrown and the caller will need to decide how to handle the permission * a <code>NotFoundException</code> 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, * check. Similarly, if any of the SID arguments presented to the method were not loaded by the ACL,

View File

@ -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 * Filters the {@code filterTarget} object (which must be either a collection or an array), by evaluating the
* supplied expression. * supplied expression.
* <p> * <p>
* 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. * the permission expression evaluates to {@code true}. For an array, a new array instance will be returned.
*/ */
@SuppressWarnings("unchecked") @SuppressWarnings("unchecked")

View File

@ -150,7 +150,6 @@ public class AuthenticationTag extends TagSupport {
/** /**
* Return the HTML escaping setting for this tag, * Return the HTML escaping setting for this tag,
* or the default setting if not overridden. * or the default setting if not overridden.
* @see #isDefaultHtmlEscape()
*/ */
protected boolean isHtmlEscape() { protected boolean isHtmlEscape() {
return htmlEscape; return htmlEscape;

View File

@ -36,7 +36,7 @@ import org.springframework.security.web.WebAttributes;
* Being a "forward", the <code>SecurityContextHolder</code> will remain * Being a "forward", the <code>SecurityContextHolder</code> will remain
* populated. This is of benefit if the view (or a tag library or macro) wishes to access the * populated. This is of benefit if the view (or a tag library or macro) wishes to access the
* <code>SecurityContextHolder</code>. The request scope will also be populated with the exception itself, available * <code>SecurityContextHolder</code>. 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 * @author Ben Alex
*/ */

View File

@ -42,7 +42,7 @@ public final class RegexRequestMatcher implements RequestMatcher {
* *
* @param pattern the regular expression to compile into a pattern. * @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 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) { public RegexRequestMatcher(String pattern, String httpMethod, boolean caseInsensitive) {
if (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 * Performs the match of the request URL ({@code servletPath + pathInfo + queryString}) against
* the compiled pattern. * 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. * @return true if the pattern matches the URL, false otherwise.
*/ */
public boolean matches(HttpServletRequest request) { public boolean matches(HttpServletRequest request) {