svn commit: r1198736 - /directory/studio/trunk/plugins/ldapservers/src/main/java/org/apache/directory/studio/ldapservers/model/LdapServerAdapter.java

[pa...@apache.org]

Author: pamarcelot
Date: Mon Nov  7 13:51:28 2011
New Revision: 1198736

URL: http://svn.apache.org/viewvc?rev=1198736&view=rev
Log:
Updated javadoc.

Modified:
    directory/studio/trunk/plugins/ldapservers/src/main/java/org/apache/directory/studio/ldapservers/model/LdapServerAdapter.java

Modified: directory/studio/trunk/plugins/ldapservers/src/main/java/org/apache/directory/studio/ldapservers/model/LdapServerAdapter.java
URL: http://svn.apache.org/viewvc/directory/studio/trunk/plugins/ldapservers/src/main/java/org/apache/directory/studio/ldapservers/model/LdapServerAdapter.java?rev=1198736&r1=1198735&r2=1198736&view=diff
==============================================================================
--- directory/studio/trunk/plugins/ldapservers/src/main/java/org/apache/directory/studio/ldapservers/model/LdapServerAdapter.java (original)
+++ directory/studio/trunk/plugins/ldapservers/src/main/java/org/apache/directory/studio/ldapservers/model/LdapServerAdapter.java Mon Nov  7 13:51:28 2011
@@ -40,6 +40,7 @@ public interface LdapServerAdapter
      * @param monitor
      *      the progress monitor
      * @throws Exception
+     *      if an error occurs when adding the server
      */
     public void add( LdapServer server, StudioProgressMonitor monitor ) throws Exception;
 
@@ -52,6 +53,7 @@ public interface LdapServerAdapter
      * @param monitor
      *      the progress monitor
      * @throws Exception
+     *      if an error occurs when deleting the server
      */
     public void delete( LdapServer server, StudioProgressMonitor monitor ) throws Exception;
 
@@ -64,6 +66,7 @@ public interface LdapServerAdapter
      * @param monitor
      *      the progress monitor
      * @throws Exception
+     *      if an error occurs when opening the configuration of the server
      */
     public void openConfiguration( LdapServer server, StudioProgressMonitor monitor ) throws Exception;
 
@@ -76,7 +79,7 @@ public interface LdapServerAdapter
      * @param monitor
      *      the progress monitor
      * @throws Exception
-     *      if an error occurs when restarting the server
+     *      if an error occurs when starting the server
      */
     public void start( LdapServer server, StudioProgressMonitor monitor ) throws Exception;
 
@@ -89,18 +92,20 @@ public interface LdapServerAdapter
      * @param monitor
      *      the progress monitor
      * @throws Exception
-     *      if an error occurs when restarting the server
+     *      if an error occurs when stopping the server
      */
     public void stop( LdapServer server, StudioProgressMonitor monitor ) throws Exception;
 
 
     /**
-     * Checks the ports before the server start.
+     * Checks the ports before the server starts.
      * <p>
      * The return strings must have the following format: {PROTOCOL} ({PORT})
      *
      * @param server the server
      * @return an array of error message, one for each port being already used.
+     * @throws Exception
+     *      if an error occurs when checking the ports before the server starts
      */
     public String[] checkPortsBeforeServerStart( LdapServer server ) throws Exception;
 }