svn commit: r1769295 - in /sling/trunk/bundles/auth/core/src/main/java/org/apache/sling/auth/core: AuthConstants.java AuthUtil.java

[as...@apache.org]

Author: asanso
Date: Fri Nov 11 15:02:30 2016
New Revision: 1769295

URL: http://svn.apache.org/viewvc?rev=1769295&view=rev
Log:
@releng fixing javadoc

Modified:
    sling/trunk/bundles/auth/core/src/main/java/org/apache/sling/auth/core/AuthConstants.java
    sling/trunk/bundles/auth/core/src/main/java/org/apache/sling/auth/core/AuthUtil.java

Modified: sling/trunk/bundles/auth/core/src/main/java/org/apache/sling/auth/core/AuthConstants.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/auth/core/src/main/java/org/apache/sling/auth/core/AuthConstants.java?rev=1769295&r1=1769294&r2=1769295&view=diff
==============================================================================
--- sling/trunk/bundles/auth/core/src/main/java/org/apache/sling/auth/core/AuthConstants.java (original)
+++ sling/trunk/bundles/auth/core/src/main/java/org/apache/sling/auth/core/AuthConstants.java Fri Nov 11 15:02:30 2016
@@ -36,33 +36,33 @@ public final class AuthConstants {
      * and password should just be checked and a status code be set for success
      * (200/OK) or failure (403/FORBIDDEN).
      *
-     * @see #isValidateRequest(HttpServletRequest)
-     * @see #sendValid(HttpServletResponse)
-     * @see #sendInvalid(HttpServletRequest, HttpServletResponse)
+     * @see AuthUtil#isValidateRequest(HttpServletRequest)
+     * @see AuthUtil#sendValid(HttpServletResponse)
+     * @see AuthUtil#sendInvalid(HttpServletRequest, HttpServletResponse)
      */
     public static final String PAR_J_VALIDATE = "j_validate";
 
     /**
      * The name of the request header set by the
-     * {@link #sendInvalid(HttpServletRequest, HttpServletResponse)} method if the provided
+     * {@link AuthUtil#sendInvalid(HttpServletRequest, HttpServletResponse)} method if the provided
      * credentials cannot be used for login.
      * <p>
      * This header may be inspected by clients for a reason why the request
      * failed.
      *
-     * @see #sendInvalid(HttpServletRequest, HttpServletResponse)
+     * @see AuthUtil#sendInvalid(HttpServletRequest, HttpServletResponse)
      */
     public static final String X_REASON = "X-Reason";
 
     /**
      * The name of the request header set by the
-     * {@link #sendInvalid(HttpServletRequest, HttpServletResponse)} method if the provided
+     * {@link AuthUtil#sendInvalid(HttpServletRequest, HttpServletResponse)} method if the provided
      * credentials cannot be used for login.
      * <p>
      * This header may be inspected by clients for a a detailed reason code why the request
      * failed.
      *
-     * @see #sendInvalid(HttpServletRequest, HttpServletResponse)
+     * @see AuthUtil#sendInvalid(HttpServletRequest, HttpServletResponse)
      */
     public static final String X_REASON_CODE = "X-Reason-Code";
 

Modified: sling/trunk/bundles/auth/core/src/main/java/org/apache/sling/auth/core/AuthUtil.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/auth/core/src/main/java/org/apache/sling/auth/core/AuthUtil.java?rev=1769295&r1=1769294&r2=1769295&view=diff
==============================================================================
--- sling/trunk/bundles/auth/core/src/main/java/org/apache/sling/auth/core/AuthUtil.java (original)
+++ sling/trunk/bundles/auth/core/src/main/java/org/apache/sling/auth/core/AuthUtil.java Fri Nov 11 15:02:30 2016
@@ -98,7 +98,6 @@ public final class AuthUtil {
     /**
      * Returns the value of the named request attribute or parameter as a string
      * as follows:
-     * <ol>
      * <li>If there is a request attribute of that name, which is a non-empty
      * string, it is returned.</li>If there is a non-empty request parameter of
      * that name, this parameter is returned.
@@ -302,12 +301,12 @@ public final class AuthUtil {
      * submitted username/password credentials.
      * <p>
      * This implementation returns <code>true</code> if the request parameter
-     * {@link #PAR_J_VALIDATE} is set to <code>true</code> (case-insensitve). If
+     * {@link AuthConstants#PAR_J_VALIDATE} is set to <code>true</code> (case-insensitve). If
      * the request parameter is not set or to any value other than
      * <code>true</code> this method returns <code>false</code>.
      *
      * @param request The request to provide the parameter to check
-     * @return <code>true</code> if the {@link #PAR_J_VALIDATE} parameter is set
+     * @return <code>true</code> if the {@link AuthConstants#PAR_J_VALIDATE} parameter is set
      *         to <code>true</code>.
      */
     public static boolean isValidateRequest(final HttpServletRequest request) {
@@ -350,8 +349,8 @@ public final class AuthUtil {
 
     /**
      * Sends a 403/FORBIDDEN response optionally stating the reason for this
-     * response code in the {@link #X_REASON} header. The value for the
-     * {@link #X_REASON} header is taken from
+     * response code in the {@link AuthConstants#X_REASON} header. The value for the
+     * {@link AuthConstants#X_REASON} header is taken from
      * {@link AuthenticationHandler#FAILURE_REASON} request attribute if set.
      * <p>
      * This method just overwrites the response status to 403/FORBIDDEN, adds