cvs commit: xml-rpc/src/java/org/apache/xmlrpc AuthenticatedXmlRpcHandler.java

[dl...@apache.org]

dlr         2002/09/27 10:17:01

  Modified:    src/java/org/apache/xmlrpc AuthenticatedXmlRpcHandler.java
  Log:
  o Noted that this class is for HTTP auth (as determined on dev list
  discussion with Adam Megacz).
  
  o Documented execute() method.
  
  Revision  Changes    Path
  1.5       +9 -4      xml-rpc/src/java/org/apache/xmlrpc/AuthenticatedXmlRpcHandler.java
  
  Index: AuthenticatedXmlRpcHandler.java
  ===================================================================
  RCS file: /home/cvs/xml-rpc/src/java/org/apache/xmlrpc/AuthenticatedXmlRpcHandler.java,v
  retrieving revision 1.4
  retrieving revision 1.5
  diff -u -u -r1.4 -r1.5
  --- AuthenticatedXmlRpcHandler.java	21 Aug 2002 09:49:48 -0000	1.4
  +++ AuthenticatedXmlRpcHandler.java	27 Sep 2002 17:17:01 -0000	1.5
  @@ -58,22 +58,27 @@
   import java.util.Vector;
   
   /**
  - * An XML-RPC handler that also handles user authentication.
  + * An XML-RPC handler that also handles HTTP authentication.
    *
    * @author <a href="mailto:hannes@apache.org">Hannes Wallnoefer</a>
    * @see org.apache.xmlrpc.AuthenticationFailed
  - * @version $Id$
    */
   public interface AuthenticatedXmlRpcHandler
   {
       /**
        * Return the result, or throw an Exception if something went wrong.
        *
  +     * @param method The name of the XML-RPC method to invoke.
  +     * @param params The parameters to the XML-RPC method.
  +     * @param user The user name.
  +     * @param password The password of <code>user</code>.
  +     * @return The response.
  +     *
        * @throws AuthenticationFailed If authentication fails, an
        * exception of this type must be thrown.
        * @see org.apache.xmlrpc.AuthenticationFailed
        */
       public Object execute(String method, Vector params, String user,
  -            String password)
  -            throws Exception;
  +                          String password)
  +        throws Exception;
   }