Author: fmeschbe
Date: Sun Apr 26 20:58:08 2009
New Revision: 768787
URL: http://svn.apache.org/viewvc?rev=768787&view=rev
Log:
Fix JavaDoc
Modified:
incubator/sling/trunk/bundles/engine/src/main/java/org/apache/sling/engine/auth/AuthenticationHandler.java
Modified:
incubator/sling/trunk/bundles/engine/src/main/java/org/apache/sling/engine/auth/AuthenticationHandler.java
URL:
http://svn.apache.org/viewvc/incubator/sling/trunk/bundles/engine/src/main/java/org/apache/sling/engine/auth/AuthenticationHandler.java?rev=768787&r1=768786&r2=768787&view=diff
==============================================================================
---
incubator/sling/trunk/bundles/engine/src/main/java/org/apache/sling/engine/auth/AuthenticationHandler.java
(original)
+++
incubator/sling/trunk/bundles/engine/src/main/java/org/apache/sling/engine/auth/AuthenticationHandler.java
Sun Apr 26 20:58:08 2009
@@ -24,30 +24,33 @@
import javax.servlet.http.HttpServletResponse;
/**
- * The <code>AuthenticationHandler</code> interface defines the service API
- * used by the authentication implementation to support plugin various ways of
+ * The <code>AuthenticationHandler</code> interface defines the service API
used
+ * by the authentication implementation to support plugin various ways of
* extracting credentials from the request.
*/
public interface AuthenticationHandler {
/**
- * An authentication handler is associated with url paths.
- * If the handler is not configured with a path, it is regarded as
inactive.
- * If the handler should be used for all requests, the path should be '/'.
+ * An authentication handler is associated with url paths. If the handler
is
+ * not configured with a path, it is regarded as inactive. If the handler
+ * should be used for all requests, the path should be '/'.
*/
String PATH_PROPERTY = "path";
/**
* Extracts credential data from the request if at all contained.
* <p>
- * The method returns any of the following values : <table>
+ * The method returns any of the following values :
+ * <table>
* <tr>
* <th>value
- * <th>description</tr>
+ * <th>description
+ * </tr>
* <tr>
* <td><code>null</code>
* <td>no user details were contained in the request or the handler is not
- * capable or willing to extract credentials from the request</tr>
+ * capable or willing to extract credentials from the request
+ * </tr>
* <tr>
* <td>{...@link AuthenticationInfo#DOING_AUTH}
* <td>the handler is in an ongoing authentication transaction with the
@@ -56,22 +59,29 @@
* <tr>
* <td><code>AuthenticationInfo</code> object
* <td>The user sent credentials. The returned object contains the
- * credentials as well as the type of authentication transmission
employed.</tr>
+ * credentials as well as the type of authentication transmission employed.
+ * </tr>
* </table>
* <p>
* The method must not request credential information from the client, if
* they are not found in the request.
- *
+ * <p>
+ * The value of {...@link #PATH_PROPERTY} service registration property
value
+ * triggering this call is available as the <code>path</code> request
+ * attribute. If the service is registered with multiple path values, the
+ * value of the <code>path</code> request attribute may be used to
implement
+ * specific handling.
+ *
* @param request The request object containing the information for the
* authentication.
* @param response The response object which may be used to send the
* information on the request failure to the user.
- * @return A valid <code>AuthenticationInfo</code> instance identifying
- * the request user, {...@link AuthenticationInfo#DOING_AUTH} if
the handler is in an
- * authentication transaction with the client or null if the
request
- * does not contain authentication information. In case of
- * {...@link AuthenticationInfo#DOING_AUTH}, the method must have
sent a response
- * indicating that fact to the client.
+ * @return A valid <code>AuthenticationInfo</code> instance identifying the
+ * request user, {...@link AuthenticationInfo#DOING_AUTH} if the
+ * handler is in an authentication transaction with the client or
+ * null if the request does not contain authentication information.
+ * In case of {...@link AuthenticationInfo#DOING_AUTH}, the method
must
+ * have sent a response indicating that fact to the client.
*/
AuthenticationInfo authenticate(HttpServletRequest request,
HttpServletResponse response);
@@ -82,14 +92,19 @@
* processing can be terminated normally. Otherwise the authorization
* information could not be requested.
* <p>
- * Any response sent by the handler though the <code>sendError</code>
- * method is also handled by the error handler infrastructure.
- *
+ * Any response sent by the handler though the <code>sendError</code>
method
+ * is also handled by the error handler infrastructure.
+ * <p>
+ * The value of {...@link #PATH_PROPERTY} service registration property
value
+ * triggering this call is available as the <code>path</code> request
+ * attribute. If the service is registered with multiple path values, the
+ * value of the <code>path</code> request attribute may be used to
implement
+ * specific handling.
+ *
* @param request The request object.
* @param response The response object to which to send the request.
- * @return <code>true</code> if the handler is able to end an
- * authentication inquiry for the given request. <code>false</code>
- * otherwise.
+ * @return <code>true</code> if the handler is able to end an
authentication
+ * inquiry for the given request. <code>false</code> otherwise.
* @throws IOException If an error occurrs sending the authentication
* inquiry to the client.
*/
