Checkstyle enforcer

[controller.git] / opendaylight / usermanager / src / main / java / org / opendaylight / controller / usermanager / IAAAProvider.java

diff --git a/opendaylight/usermanager/src/main/java/org/opendaylight/controller/usermanager/IAAAProvider.java b/opendaylight/usermanager/src/main/java/org/opendaylight/controller/usermanager/IAAAProvider.java
index 2e330d85edb75ef663adae85dd16d9c1bba17b48..36a2c06bf6873118e58a3df90bd41652259ce776 100644 (file)
--- a/opendaylight/usermanager/src/main/java/org/opendaylight/controller/usermanager/IAAAProvider.java
+++ b/opendaylight/usermanager/src/main/java/org/opendaylight/controller/usermanager/IAAAProvider.java
@@ -1,4 +1,3 @@
-
 /*
  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
  *
@@ -10,20 +9,26 @@
 package org.opendaylight.controller.usermanager;
 
 /**
- * IAAAProvider exposes a pluggable interface for 3rd party Authentication and Authorization
- * providers to support the UserManager with AAA management.
+ * IAAAProvider exposes a pluggable interface for 3rd party Authentication and
+ * Authorization providers to support the UserManager with AAA management.
  */
 
 public interface IAAAProvider {
 
     /**
-     * Authenticate user with AAA server and return authentication and authorization info
-     * using the Provider's mechanism
+     * Authenticate user with AAA server and return authentication and
+     * authorization info using the Provider's mechanism
+     *
      * @param userName
+     *            the username
      * @param password
+     *            the password
      * @param server
+     *            AAA server ip address in string form
      * @param secretKey
-     * @return Authentication and Authorization Response
+     *            shared secret between the AAA client and AAA server
+     * @return {@link org.opendaylight.controller.usermanager.AuthResponse}
+     *         Authentication and Authorization Response
      */
     public AuthResponse authService(String userName, String password,
             String server, String secretKey);