Skip to content
Permalink
Browse files

Javadoc cleanup

Enable Javadoc-related checkstyle rules and clean up a lot of the
documentation based on problems found by those rules and by running
the javadoc tool.
  • Loading branch information...
dirmgr committed Mar 31, 2019
1 parent b2a384b commit 04c1491b7fcbd4649997bf40b0f4400b852b41e9
Showing with 1,257 additions and 544 deletions.
  1. +0 −6 ext/checkstyle/slamd-checkstyle.xml
  2. +4 −1 src/com/slamd/admin/AdminConfig.java
  3. +181 −46 src/com/slamd/admin/RequestInfo.java
  4. +46 −38 src/com/slamd/client/Client.java
  5. +25 −25 src/com/slamd/client/ClientSideJob.java
  6. +21 −21 src/com/slamd/clientmanager/ClientManager.java
  7. +2 −0 src/com/slamd/common/DurationParser.java
  8. +2 −2 src/com/slamd/common/JobClassLoader.java
  9. +198 −40 src/com/slamd/dslogplay/LogPlaybackJobClass.java
  10. +77 −45 src/com/slamd/http/HTTPClient.java
  11. +7 −3 src/com/slamd/http/HTTPRequest.java
  12. +7 −3 src/com/slamd/job/Job.java
  13. +8 −3 src/com/slamd/job/OptimizingJob.java
  14. +2 −0 src/com/slamd/jobs/ldap/BasicModifyRateJob.java
  15. +2 −0 src/com/slamd/jobs/ldap/ComprehensiveBindRateJob.java
  16. +2 −0 src/com/slamd/jobs/ldap/ComprehensiveModifyRateJob.java
  17. +2 −0 src/com/slamd/jobs/ldap/ComprehensiveSearchAndBindRateJob.java
  18. +2 −0 src/com/slamd/jobs/ldap/ComprehensiveSearchAndModifyRateJob.java
  19. +2 −0 src/com/slamd/jobs/ldap/ComprehensiveSearchRateJob.java
  20. +32 −15 src/com/slamd/loadvariance/LoadVarianceJobClass.java
  21. +5 −1 src/com/slamd/resourcemonitor/LDAPMonitoredAttr.java
  22. +6 −1 src/com/slamd/resourcemonitor/LDAPMonitoredEntry.java
  23. +7 −4 src/com/slamd/resourcemonitor/NetStatResourceMonitor.java
  24. +14 −6 src/com/slamd/resourcemonitor/ReplicationLatencyResourceMonitor.java
  25. +8 −4 src/com/slamd/resourcemonitor/ResourceMonitor.java
  26. +8 −0 src/com/slamd/resourcemonitor/ZFSPoolResourceMonitor.java
  27. +4 −1 src/com/slamd/resourcemonitor/netstat/AIXNetStatCollector.java
  28. +4 −1 src/com/slamd/resourcemonitor/netstat/HPUXNetStatCollector.java
  29. +42 −15 src/com/slamd/resourcemonitor/netstat/InterfaceStatistics.java
  30. +4 −1 src/com/slamd/resourcemonitor/netstat/LinuxNetStatCollector.java
  31. +1 −1 src/com/slamd/resourcemonitor/netstat/NetStatCollector.java
  32. +4 −1 src/com/slamd/resourcemonitor/netstat/SolarisNetStatCollector.java
  33. +4 −2 src/com/slamd/resourcemonitor/netstat/WindowsNetStatCollector.java
  34. +2 −2 src/com/slamd/scripting/BSFJobClass.java
  35. +3 −1 src/com/slamd/scripting/engine/Instruction.java
  36. +5 −3 src/com/slamd/scripting/general/ValuePatternVariable.java
  37. +1 −1 src/com/slamd/scripting/http/HTTPClientVariable.java
  38. +4 −2 src/com/slamd/scripting/http/HTTPRequestVariable.java
  39. +1 −1 src/com/slamd/scripting/ldap/LDAPConnectionVariable.java
  40. +16 −7 src/com/slamd/scripting/ldap/LDAPEntryTemplate.java
  41. +3 −3 src/com/slamd/scripting/ldap/LDAPModificationVariable.java
  42. +4 −2 src/com/slamd/scripting/tftp/TFTPClientVariable.java
  43. +17 −8 src/com/slamd/server/ClientConnection.java
  44. +7 −3 src/com/slamd/server/ClientListener.java
  45. +28 −16 src/com/slamd/server/ClientManagerListener.java
  46. +45 −11 src/com/slamd/server/Logger.java
  47. +4 −2 src/com/slamd/server/RealTimeStatHandler.java
  48. +4 −2 src/com/slamd/server/SLAMDServer.java
  49. +4 −2 src/com/slamd/server/StatClientConnection.java
  50. +11 −5 src/com/slamd/stat/PersistentStatViewer.java
  51. +5 −3 src/com/slamd/stat/StatGrapher.java
  52. +83 −31 src/com/slamd/tftp/TFTPClient.java
  53. +219 −123 src/com/slamd/tools/makeldif/MakeLDIF.java
  54. +9 −5 src/com/slamd/tools/makeldif/Template.java
  55. +28 −16 src/com/slamd/tools/tcpreplay/ReplayCapture.java
  56. +12 −6 src/com/slamd/tools/tcpreplay/ReplayThread.java
  57. +3 −1 src/com/slamd/tools/throughputtest/ThroughputTestClient.java
  58. +6 −2 src/com/slamd/tools/throughputtest/ThroughputTestServer.java
@@ -36,7 +36,6 @@

<module name="TreeWalker">
<!-- Ensure that all methods have Javadoc documentation. -->
<!--
<module name="JavadocMethod">
<property name="scope" value="private" />
<property name="allowUndeclaredRTE" value="false" />
@@ -47,26 +46,21 @@
<property name="allowMissingPropertyJavadoc" value="false" />
<property name="suppressLoadErrors" value="true" />
</module>
-->


<!-- Ensure that all non-private variables have Javadoc documentation. -->
<!--
<module name="JavadocVariable">
<property name="scope" value="package" />
</module>
-->


<!-- Ensure that all Javadoc comments are well-formed. -->
<!--
<module name="JavadocStyle">
<property name="scope" value="private" />
<property name="checkFirstSentence" value="true" />
<property name="checkEmptyJavadoc" value="false" />
<property name="checkHtml" value="true" />
</module>
-->


<!-- Ensure that there are no star imports. -->
@@ -58,7 +58,10 @@
public final class AdminConfig
implements ConfigSubscriber
{
static AdminConfig ADMIN_CONFIG = new AdminConfig();
/**
* A singleton reference to this configuration.
*/
static final AdminConfig ADMIN_CONFIG = new AdminConfig();



@@ -40,116 +40,251 @@
*/
public class RequestInfo
{
// Indicates whether the servlet is currently should generate extra HTML that
// can be used for debugging purposes.
/**
* Indicates whether the servlet is currently should generate extra HTML that
* can be used for debugging purposes.
*/
protected boolean debugHTML;

// Indicates whether the doPost method should generate the response that gets
// sent back to the client or if it has already been sent in the course of
// processing.



/**
* Indicates whether the doPost method should generate the response that gets
* sent back to the client or if it has already been sent in the course of
* processing.
*/
protected boolean generateHTML;

// Indicates whether the sidebar containing link information should be
// generated.


/**
* Indicates whether the sidebar containing link information should be
* generated.
*/
protected boolean generateSidebar;

// Indicates whether the user has full access to the SLAMD admin interface.


/**
* Indicates whether the user has full access to the SLAMD admin interface.
*/
protected boolean hasFullAccess;

// Indicates whether the user may add job class definitions.


/**
* Indicates whether the user may add job class definitions.
*/
protected boolean mayAddJobClass;

// Indicates whether the user may cancel scheduled jobs.


/**
* Indicates whether the user may cancel scheduled jobs.
*/
protected boolean mayCancelJob;

// Indicates whether the user may delete completed job info.


/**
* Indicates whether the user may delete completed job info.
*/
protected boolean mayDeleteJob;

// Indicates whether the user may delete job class definitions.


/**
* Indicates whether the user may delete job class definitions.
*/
protected boolean mayDeleteJobClass;

// Indicates whether the user may disconnect clients.


/**
* Indicates whether the user may disconnect clients.
*/
protected boolean mayDisconnectClients;

// Indicates whether the user may edit servlet config info.


/**
* Indicates whether the user may edit servlet config info.
*/
protected boolean mayEditServletConfig;

// Indicates whether the user may edit SLAMD config info.


/**
* Indicates whether the user may edit SLAMD config info.
*/
protected boolean mayEditSLAMDConfig;

// Indicates whether the user may export job data.


/**
* Indicates whether the user may export job data.
*/
protected boolean mayExportJobData;

// Indicates whether the user may manage real and virtual job folders.


/**
* Indicates whether the user may manage real and virtual job folders.
*/
protected boolean mayManageFolders;

// Indicates whether the user may schedule jobs for execution.


/**
* Indicates whether the user may schedule jobs for execution.
*/
protected boolean mayScheduleJob;

// Indicates whether the user may start or stop the access control manager.


/**
* Indicates whether the user may start or stop the access control manager.
*/
protected boolean mayStartStopAccessManager;

// Indicates whether the user may start or stop SLAMD.


/**
* Indicates whether the user may start or stop SLAMD.
*/
protected boolean mayStartStopSLAMD;

// Indicates whether the user may view job class definitions.


/**
* Indicates whether the user may view job class definitions.
*/
protected boolean mayViewJobClass;

// Indicates whether the user may view job information.


/**
* Indicates whether the user may view job information.
*/
protected boolean mayViewJob;

// Indicates whether the user may view the servlet config info.


/**
* Indicates whether the user may view the servlet config info.
*/
//
protected boolean mayViewServletConfig;

// Indicates whether the user may view the SLAMD server config info.


/**
* Indicates whether the user may view the SLAMD server config info.
*/
protected boolean mayViewSLAMDConfig;

// Indicates whether the user may view the server status info.


/**
* Indicates whether the user may view the server status info.
*/
protected boolean mayViewStatus;

// The structure with information regarding the servlet request.


/**
* The structure with information regarding the servlet request.
*/
protected final HttpServletRequest request;

// The structure with information regarding the servlet response.


/**
* The structure with information regarding the servlet response.
*/
//
protected final HttpServletResponse response;

// The unique ID assigned to this request. It will appear as an HTML comment
// at the top of the response page generated, and will also appear at the
// beginning of any messages logged using the admin interface debugging log
// level.


/**
* The unique ID assigned to this request. It will appear as an HTML comment
* at the top of the response page generated, and will also appear at the
* beginning of any messages logged using the admin interface debugging log
* level.
*/
protected int requestID;

// The list of fields provided in the multipart request form, if it was a
// multipart request.


/**
* The list of fields provided in the multipart request form, if it was a
* multipart request.
*/
protected List<FileItem> multipartFieldList;

// The string representation of the URL that may be used to generate the
// current page using an HTTP GET.


/**
* The string representation of the URL that may be used to generate the
* current page using an HTTP GET.
*/
protected String getURL;

// The name of the administration section with which this request is
// associated.


/**
* The name of the administration section with which this request is
* associated.
*/
protected String section;

// The base URI for the servlet request.


/**
* The base URI for the servlet request.
*/
protected String servletBaseURI;

// The name of the administrative subsection with which this request is
// associated.


/**
* The name of the administrative subsection with which this request is
* associated.
*/
protected String subsection;

// The user ID


/**
* The user ID.
*/
//
protected String userIdentifier;

// A set of debug information that will be included as comments in the HTML
// that is generated. Any message that would be logged to the SLAMD server
// log file will also be written here.



/**
* A set of debug information that will be included as comments in the HTML
* that is generated. Any message that would be logged to the SLAMD server
* log file will also be written here.
*/
protected StringBuilder debugInfo;

// The main body of the HTML page to generate.


/**
* The main body of the HTML page to generate.
*/
protected StringBuilder htmlBody;

// A message that should be displayed at the top of the main frame.


/**
* The main body of the HTML page to generate.
*/
protected StringBuilder infoMessage;


Oops, something went wrong.

0 comments on commit 04c1491

Please sign in to comment.
You can’t perform that action at this time.