Merge pull request #159 from splunk/DVPL-9622

Fixed test cases failures and Clean-up Javadoc generation 
Breaking Change: Changed getMaxHotBuckets to String type to conform to Splunk platform updates

Author: ashah-splunk

.idea/ant.xml

@@ -14,7 +14,7 @@
     <properties>
         <!-- <jvm.arg.https.protocol>-Dhttps.protocols=TLSv1.1,TLSv1.2</jvm.arg.https.protocol> -->
         <https.protocols>TLSv1.2</https.protocols>
-        <maven.javadoc.skip>true</maven.javadoc.skip>
+<!--        <maven.javadoc.skip>true</maven.javadoc.skip>-->
     </properties>
     <dependencies>
         <dependency>

build.xml

@@ -91,6 +91,7 @@ public void setDescription(String description) {
      * take effect immediately. 
      * @see Entity#disable
      * @see Entity#enable
+     * @param disabled The boolean flag
      */
     public void setDisabled(boolean disabled) {
         setCacheValue("disabled", disabled);

splunk/pom.xml

@@ -198,6 +198,7 @@ public static SSLSecurityProtocol getSslSecurityProtocol() {
 
     /**
      * Sets the SSL security protocol of this service.
+     * @param securityProtocol The SSLSecurityProtocal instance
      */
     public static void setSslSecurityProtocol(SSLSecurityProtocol securityProtocol) {
         // Only update the SSL_SOCKET_FACTORY if changing protocols

splunk/src/main/java/com/splunk/EventType.java

@@ -40,27 +40,28 @@ public class Index extends Entity {
      * Creates a writable socket to this index.
      *
      * @return The writable socket.
-     * @throws IOException
+     * @throws IOException Throws exception if fails to write socket.
      */
     public Socket attach() throws IOException {
         Receiver receiver = service.getReceiver();
         return receiver.attach(getName());
     }
 
     /**
-     * Writes events to this index, reusing the connection. 
-     * This method passes an output stream connected to the index to the 
-     * {@code run} method of the {@code ReceiverBehavior} object, then handles 
+     * Writes events to this index, reusing the connection.
+     * This method passes an output stream connected to the index to the
+     * {@code run} method of the {@code ReceiverBehavior} object, then handles
      * setting up and tearing down the socket.
      * <p>
-     * For an example of how to use this method, see 
-     * <a href="http://dev.splunk.com/view/SP-CAAAEJ2" target="_blank">How to 
-     * get data into Splunk</a> on 
-     * <a href="http://dev.splunk.com/view/SP-CAAAEJ2" 
+     * For an example of how to use this method, see
+     * <a href="http://dev.splunk.com/view/SP-CAAAEJ2" target="_blank">How to
+     * get data into Splunk</a> on
+     * <a href="http://dev.splunk.com/view/SP-CAAAEJ2"
      * target="_blank">dev.splunk.com</a>.
-     * 
-     * @param behavior The body of a {@code try} block as an anonymous 
+     *
+     * @param behavior The body of a {@code try} block as an anonymous
      * implementation of the {@code ReceiverBehavior} interface.
+     * @throws IOException The IOException class
      */
     public void attachWith(ReceiverBehavior behavior) throws IOException {
         Socket socket = null;
@@ -82,7 +83,7 @@ public void attachWith(ReceiverBehavior behavior) throws IOException {
      * @param args Optional arguments for this stream. Valid parameters are: 
      * "host", "host_regex", "source", and "sourcetype".
      * @return The socket.
-     * @throws IOException
+     * @throws IOException The IOException class
      */
     public Socket attach(Args args) throws IOException {
         Receiver receiver = service.getReceiver();
@@ -327,6 +328,7 @@ public String getLastInitTime() {
      * is older than this, Splunk does not create or rebuild its bloomfilter.  
      * The valid format is <i>number</i> followed by a time unit ("s", "m", "h",
      * or "d"). For example, "30d" for 30 days.
+     * @return String value
      */
     public String getMaxBloomBackfillBucketAge() {
         return getString("maxBloomBackfillBucketAge", null);
@@ -358,10 +360,10 @@ public String getMaxDataSize() {
     /**
      * Returns the maximum number of hot buckets that can exist for this index.
      *
-     * @return The maximum number of hot buckets.
+     * @return The maximum number of hot buckets or "auto" (which means 3).
      */
-    public int getMaxHotBuckets() {
-        return getInteger("maxHotBuckets");
+    public String getMaxHotBuckets() {
+        return getString("maxHotBuckets");
     }
 
     /**
@@ -441,6 +443,7 @@ public int getMaxTotalDataSizeMB() {
      * If there are any acknowledged events sharing this raw slice, the 
      * {@code MaxTimeUnreplicatedWithAcksparamater} applies instead.
      * @see #getMaxTimeUnreplicatedWithAcks
+     * @return int value
      */
     public int getMaxTimeUnreplicatedNoAcks() {
         return getInteger("maxTimeUnreplicatedNoAcks");
@@ -451,6 +454,7 @@ public int getMaxTimeUnreplicatedNoAcks() {
      * unacknowledged in a raw slice. This value only applies when indexer 
      * acknowledgement is enabled on forwarders and replication is enabled with 
      * clustering.
+     * @return int value
      */
     public int getMaxTimeUnreplicatedWithAcks() {
         return getInteger("maxTimeUnreplicatedWithAcks");
@@ -720,8 +724,7 @@ public void setBucketRebuildMemoryHint(String value) {
     /**
      * Sets the destination path for the frozen archive, where Splunk
      * automatically puts frozen buckets. The bucket freezing policy is as
-     *follows:
-     * <p>
+     * follows:
      * <ul><li><b>New-style buckets (4.2 and later):</b> All files are removed
      * except the raw data. To thaw frozen buckets, run {@code Splunk rebuild
      * <bucket dir>} on the bucket, then move the buckets to the thawed
@@ -828,9 +831,9 @@ public void setMaxDataSize(String size) {
      * @see #setMaxHotIdleSecs
      * @see #getMaxHotIdleSecs
      *
-     * @param size The maximum number of hot buckets per index.
+     * @param size The maximum number of hot buckets per index, or an 'auto' string.
      */
-    public void setMaxHotBuckets(int size) {
+    public void setMaxHotBuckets(String size) {
         setCacheValue("maxHotBuckets", size);
     }
 

splunk/src/main/java/com/splunk/HttpService.java

@@ -39,6 +39,7 @@ public class Input extends Entity {
      * Returns an {@code InputKind} representing this input's type.
      *
      * The input kind is inferred from the input's path.
+     * @return InputKind instance
      */
     public InputKind getKind() {
         String[] pathComponents = 

splunk/src/main/java/com/splunk/Index.java

@@ -64,7 +64,7 @@ public class InputCollection extends EntityCollection<Input> {
      * <li> The stanza (for Windows Registry inputs)</li>
      * <li> The name of the configuration (for Windows AD inputs)</li></ul>
      * @return No return value.
-     * @throws UnsupportedOperationException
+     * @throws UnsupportedOperationException The UnsupportedOperationException instance
      */
     @Override public Input create(String name) {
         throw new UnsupportedOperationException();
@@ -88,7 +88,7 @@ public class InputCollection extends EntityCollection<Input> {
      * <a href="http://dev.splunk.com/view/SP-CAAAEJ2" 
      * target="_blank">dev.splunk.com</a>.
      * @return No return value.
-     * @throws UnsupportedOperationException
+     * @throws UnsupportedOperationException The UnsupportedOperationException instance
      */
     @Override public Input create(String name, Map args) {
         throw new UnsupportedOperationException();

splunk/src/main/java/com/splunk/Input.java

@@ -98,7 +98,7 @@ public Map<String, Long> getSlavesUsageBytes() {
 
     /**
      * Returns the stack ID for this license pool. Valid values are:
-     * <p><ul>
+     * <ul>
      * <li>"download-trial"</li>
      * <li>"enterprise"</li>
      * <li>"forwarder"</li>

splunk/src/main/java/com/splunk/InputCollection.java

@@ -54,6 +54,7 @@ public class LimitPivotFilter extends PivotFilter {
 
     /**
      * Return the name of the field to use for sorting.
+     * @return String value
      */
     public String getAttributeName() {
         return this.sortAttribute;