add some javadoc

Author: SylvainJuge

jmx-scraper/src/integrationTest/java/io/opentelemetry/contrib/jmxscraper/JmxScraperContainer.java

@@ -52,20 +52,38 @@ public JmxScraperContainer(String otlpEndpoint, String baseImage) {
     this.extraJars = new ArrayList<>();
   }
 
+  /**
+   * Adds a target system
+   *
+   * @param targetSystem target system
+   * @return this
+   */
   @CanIgnoreReturnValue
   public JmxScraperContainer withTargetSystem(String targetSystem) {
     targetSystems.add(targetSystem);
     return this;
   }
 
+  /**
+   * Set connection to a standard JMX service URL
+   *
+   * @param host JMX host
+   * @param port JMX port
+   * @return this
+   */
   @CanIgnoreReturnValue
   public JmxScraperContainer withRmiServiceUrl(String host, int port) {
-    // TODO: adding a way to provide 'host:port' syntax would make this easier for end users
     return withServiceUrl(
         String.format(
             Locale.getDefault(), "service:jmx:rmi:///jndi/rmi://%s:%d/jmxrmi", host, port));
   }
 
+  /**
+   * Set connection to a JMX service URL
+   *
+   * @param serviceUrl service URL
+   * @return this
+   */
   @CanIgnoreReturnValue
   public JmxScraperContainer withServiceUrl(String serviceUrl) {
     this.serviceUrl = serviceUrl;
@@ -114,26 +132,50 @@ public JmxScraperContainer withCustomYaml(String yamlPath) {
     return this;
   }
 
+  /**
+   * Configure the scraper JVM to only test connection with the JMX endpoint
+   *
+   * @return this
+   */
   @CanIgnoreReturnValue
   public JmxScraperContainer withTestJmx() {
     this.testJmx = true;
     return this;
   }
 
+  /**
+   * Configure key store for the scraper JVM
+   *
+   * @param keyStore path to key store
+   * @param password key store password
+   * @return this
+   */
   @CanIgnoreReturnValue
   public JmxScraperContainer withKeyStore(Path keyStore, String password) {
     this.keyStore = keyStore;
     this.keyStorePassword = password;
     return this;
   }
 
+  /**
+   * Configure trust store for the scraper JVM
+   *
+   * @param trustStore path to trust store
+   * @param password trust store password
+   * @return this
+   */
   @CanIgnoreReturnValue
   public JmxScraperContainer withTrustStore(Path trustStore, String password) {
     this.trustStore = trustStore;
     this.trustStorePassword = password;
     return this;
   }
 
+  /**
+   * Enables connection to an SSL-protected RMI registry
+   *
+   * @return this
+   */
   @CanIgnoreReturnValue
   public JmxScraperContainer withSslRmiRegistry() {
     this.sslRmiRegistry = true;

jmx-scraper/src/integrationTest/java/io/opentelemetry/contrib/jmxscraper/TestAppContainer.java

@@ -63,39 +63,76 @@ public TestAppContainer withJmxPort(int port) {
     return this;
   }
 
+  /**
+   * Enables and configure JMX login/pwd authentication
+   *
+   * @param login user login
+   * @param pwd user password
+   * @return this
+   */
   @CanIgnoreReturnValue
   public TestAppContainer withUserAuth(String login, String pwd) {
     this.login = login;
     this.pwd = pwd;
     return this;
   }
 
+  /**
+   * Enables SSL for JMX endpoint, will require JMX client to trust remote JVM certificate
+   *
+   * @return this
+   */
   @CanIgnoreReturnValue
   public TestAppContainer withJmxSsl() {
     this.jmxSsl = true;
     return this;
   }
 
+  /**
+   * Enables SSL-protected RMI registry, which requires a distinct port from JMX
+   *
+   * @param registryPort registry port
+   * @return this
+   */
   @CanIgnoreReturnValue
   public TestAppContainer withSslRmiRegistry(int registryPort) {
     this.jmxSslRegistry = true;
     this.jmxRmiPort = registryPort;
     return this;
   }
 
+  /**
+   * Enables client certificate verification by the remote JVM
+   *
+   * @return this
+   */
   @CanIgnoreReturnValue
   public TestAppContainer withClientSslCertificate() {
     this.clientCertificate = true;
     return this;
   }
 
+  /**
+   * Configure key store for the remote JVM
+   *
+   * @param keyStore path to key store
+   * @param password key store password
+   * @return this
+   */
   @CanIgnoreReturnValue
   public TestAppContainer withKeyStore(Path keyStore, String password) {
     this.keyStore = keyStore;
     this.keyStorePassword = password;
     return this;
   }
 
+  /**
+   * Configure trust store for the remote JVM
+   *
+   * @param trustStore path to trust store
+   * @param password trust store password
+   * @return this
+   */
   @CanIgnoreReturnValue
   public TestAppContainer withTrustStore(Path trustStore, String password) {
     this.trustStore = trustStore;