Merge pull request #17 from stefaneberl/feature/OpenKitMemoryLeak

Feature/open kit memory leak

Author: stefaneberl

docs/internals.md

@@ -1,6 +1,6 @@
 #OpenKit - Internals
 
-## Data Sending (Beacon sending)
+## Data Sending (Beacon Sending)
 
 All data sending, including synchronization with the backend (Dynatrace SaaS/Dynatrace Managed/AppMon)
 happens asynchronously by starting an own thread when OpenKit is initialized.  

src/main/java/com/dynatrace/openkit/OpenKitFactory.java

@@ -47,8 +47,11 @@ public static OpenKit createDynatraceInstance(String applicationName, String app
 	 * @return					Dynatrace SaaS instance of the OpenKit
 	 */
 	public static OpenKit createDynatraceInstance(String applicationName, String applicationID, long visitorID, String endpointURL, boolean verbose) {
-		return new OpenKitImpl(
+		OpenKitImpl openKit = new OpenKitImpl(
 				new DynatraceConfiguration(applicationName, applicationID, visitorID, endpointURL, verbose));
+		openKit.initialize();
+
+		return openKit;
 	}
 
 	/**
@@ -77,8 +80,11 @@ public static OpenKit createDynatraceManagedInstance(String applicationName, Str
 	 * @return					Dynatrace Managed instance of the OpenKit
 	 */
 	public static OpenKit createDynatraceManagedInstance(String applicationName, String applicationID, long visitorID, String endpointURL, String tenantID, boolean verbose) {
-		return new OpenKitImpl(
+        OpenKitImpl openKit = new OpenKitImpl(
 				new DynatraceManagedConfiguration(tenantID, applicationName, applicationID, visitorID, endpointURL, verbose));
+        openKit.initialize();
+
+        return openKit;
 	}
 
 	/**
@@ -103,8 +109,11 @@ public static OpenKit createAppMonInstance(String applicationName, long visitorI
 	 * @return					Dynatrace AppMon instance of the OpenKit
 	 */
 	public static OpenKit createAppMonInstance(String applicationName, long visitorID, String endpointURL, boolean verbose) {
-		return new OpenKitImpl(
+        OpenKitImpl openKit = new OpenKitImpl(
 				new AppMonConfiguration(applicationName, visitorID, endpointURL, verbose));
+        openKit.initialize();
+
+        return openKit;
 	}
 
 }

src/main/java/com/dynatrace/openkit/api/Action.java

@@ -18,7 +18,7 @@ public interface Action {
 	 * @param eventName		name of the event
 	 * @return				this Action (for usage as fluent API)
 	 */
-	public Action reportEvent(String eventName);
+	Action reportEvent(String eventName);
 
 	/**
 	 * Reports an int value with a specified name.
@@ -27,7 +27,7 @@ public interface Action {
 	 * @param value			value itself
 	 * @return				this Action (for usage as fluent API)
 	 */
-	public Action reportValue(String valueName, int value);
+	Action reportValue(String valueName, int value);
 
 	/**
 	 * Reports a double value with a specified name.
@@ -36,7 +36,7 @@ public interface Action {
 	 * @param value			value itself
 	 * @return				this Action (for usage as fluent API)
 	 */
-	public Action reportValue(String valueName, double value);
+	Action reportValue(String valueName, double value);
 
 	/**
 	 * Reports a String value with a specified name.
@@ -45,7 +45,7 @@ public interface Action {
 	 * @param value			value itself
 	 * @return				this Action (for usage as fluent API)
 	 */
-	public Action reportValue(String valueName, String value);
+	Action reportValue(String valueName, String value);
 
 	/**
 	 * Reports an error with a specified name, error code and a reason.
@@ -55,7 +55,7 @@ public interface Action {
 	 * @param reason			reason for this error
 	 * @return					this Action (for usage as fluent API)
 	 */
-	public Action reportError(String errorName, int errorCode, String reason);
+	Action reportError(String errorName, int errorCode, String reason);
 
 	/**
 	 * Traces a web request - which is provided as a URLConnection - and allows adding timing information to this request.
@@ -65,7 +65,7 @@ public interface Action {
 	 * @param connection	the URLConnection of the HTTP request to be tagged and timed
 	 * @return				a WebRequestTracer which allows adding timing information
 	 */
-	public WebRequestTracer traceWebRequest(URLConnection connection);
+	WebRequestTracer traceWebRequest(URLConnection connection);
 
 	/**
 	 * Allows tracing and timing of a web request handled by any 3rd party HTTP Client (e.g. Apache, Google, Jetty, ...).
@@ -77,13 +77,13 @@ public interface Action {
 	 * @param url		the URL of the web request to be tagged and timed
 	 * @return			a WebRequestTracer which allows getting the tag value and adding timing information
 	 */
-	public WebRequestTracer traceWebRequest(String url);
+	WebRequestTracer traceWebRequest(String url);
 
 	/**
 	 * Leaves this Action.
 	 *
 	 * @return	this Action (for usage as fluent API)
 	 */
-	public Action leaveAction();
+	Action leaveAction();
 
 }

src/main/java/com/dynatrace/openkit/api/Device.java

@@ -15,20 +15,20 @@ public interface Device {
 	 *
 	 * @param operatingSystem	name of operating system
 	 */
-	public void setOperatingSystem(String operatingSystem);
+	void setOperatingSystem(String operatingSystem);
 
 	/**
 	 * Sets manufacturer name.
 	 *
 	 * @param manufacturer		name of manufacturer
 	 */
-	public void setManufacturer(String manufacturer);
+	void setManufacturer(String manufacturer);
 
 	/**
 	 * Sets a model identifier.
 	 *
 	 * @param modelID		model identifier
 	 */
-	public void setModelID(String modelID);
+	void setModelID(String modelID);
 
 }

src/main/java/com/dynatrace/openkit/api/OpenKit.java

@@ -15,19 +15,6 @@ public interface OpenKit {
      */
     String WEBREQUEST_TAG_HEADER = "X-dynaTrace";
 
-    /**
-     * Initializes the OpenKit.
-     * <p>
-     *     The initial settings are received in a background thread, allowing the OpenKit user to continue
-     *     without waiting for OpenKit to be initialized.
-     *
-     *     After calling this method {@link #waitForInitCompletion()} can be used to wait until OpenKit is
-     *     fully initialized.
-     * </p>
-     *
-     * Must be done before any other calls to the OpenKit, otherwise those calls to the OpenKit will do nothing.
-     */
-    void initialize();
     /**
      * Waits until OpenKit is fully initialized.
      *

src/main/java/com/dynatrace/openkit/api/RootAction.java

@@ -10,5 +10,5 @@ public interface RootAction extends Action {
      * @param actionName	name of the Action
      * @return				Action instance to work with
      */
-    public Action enterAction(String actionName);
+    Action enterAction(String actionName);
 }

src/main/java/com/dynatrace/openkit/api/Session.java

@@ -16,7 +16,7 @@ public interface Session {
 	 * @param actionName	name of the Action
 	 * @return				Action instance to work with
 	 */
-	public RootAction enterAction(String actionName);
+	RootAction enterAction(String actionName);
 
 	/**
 	 * Reports a crash with a specified error name, crash reason and a stacktrace.
@@ -25,11 +25,11 @@ public interface Session {
 	 * @param reason			reason or description of that error
 	 * @param stacktrace		stacktrace leading to that crash
 	 */
-	public void reportCrash(String errorName, String reason, String stacktrace);
+	void reportCrash(String errorName, String reason, String stacktrace);
 
 	/**
 	 * Ends this Session and marks it as finished for sending.
 	 */
-	public void end();
+	void end();
 
 }

src/main/java/com/dynatrace/openkit/api/WebRequestTracer.java

@@ -17,23 +17,22 @@ public interface WebRequestTracer {
 	 *
 	 * @return		the Dynatrace tag to be set as HTTP header value or an empty String if capture is off
 	 */
-	public String getTag();
+	String getTag();
 
 	/**
-	 * Sets the response code of this web request. Has to be called before {@link WebRequestTracer#stopTiming()}.
+	 * Sets the response code of this web request. Has to be called before {@link WebRequestTracer#stop()}.
 	 *
 	 * @param responseCode		response code of this web request
 	 */
-	public void setResponseCode(int responseCode);
+	void setResponseCode(int responseCode);
 
 	/**
 	 * Starts the web request timing. Should be called when the web request is initiated.
 	 */
-	public void startTiming();
+	void start();
 
 	/**
 	 * Stops the web request timing. Should be called when the web request is finished.
 	 */
-	public void stopTiming();
-
+	void stop();
 }

src/main/java/com/dynatrace/openkit/core/DummyWebRequestTracer.java

@@ -24,12 +24,12 @@ public void setResponseCode(int responseCode) {
 	}
 
 	@Override
-	public void startTiming() {
+	public void start() {
 		// do nothing
 	}
 
 	@Override
-	public void stopTiming() {
+	public void stop() {
 		// do nothing
 	}
 

src/main/java/com/dynatrace/openkit/core/OpenKitImpl.java

@@ -39,13 +39,20 @@ protected OpenKitImpl(AbstractConfiguration config, HTTPClientProvider httpClien
 		beaconSender = new BeaconSender(configuration, httpClientProvider, timingProvider);
 	}
 
-	// *** OpenKit interface methods ***
-
-	@Override
+	/**
+	 * Initialize this OpenKit instance.
+	 *
+	 * <p>
+	 *     This method starts the {@link BeaconSender} and is called directly after
+     *     the instance has been created in {@link com.dynatrace.openkit.OpenKitFactory}.
+	 * </p>
+	 */
 	public void initialize() {
 		beaconSender.initialize();
 	}
 
+	// *** OpenKit interface methods ***
+
 	@Override
 	public boolean waitForInitCompletion() {
 		return beaconSender.waitForInit();