Added LogInterface and default used implementation LogHandler, which wrap logging enabled status and verbosity level

Author: smarek

library/src/main/java/com/loopj/android/http/AsyncHttpClient.java

@@ -141,6 +141,8 @@ public class AsyncHttpClient {
     private final Map<String, String> clientHeaderMap;
     private boolean isUrlEncodingEnabled = true;
 
+    public static LogInterface log = new LogHandler();
+
     /**
      * Creates a new AsyncHttpClient with default constructor arguments values
      */
@@ -187,17 +189,17 @@ public AsyncHttpClient(boolean fixNoHttpResponseException, int httpPort, int htt
      */
     private static SchemeRegistry getDefaultSchemeRegistry(boolean fixNoHttpResponseException, int httpPort, int httpsPort) {
         if (fixNoHttpResponseException) {
-            Log.d(LOG_TAG, "Beware! Using the fix is insecure, as it doesn't verify SSL certificates.");
+            log.d(LOG_TAG, "Beware! Using the fix is insecure, as it doesn't verify SSL certificates.");
         }
 
         if (httpPort < 1) {
             httpPort = 80;
-            Log.d(LOG_TAG, "Invalid HTTP port number specified, defaulting to 80");
+            log.d(LOG_TAG, "Invalid HTTP port number specified, defaulting to 80");
         }
 
         if (httpsPort < 1) {
             httpsPort = 443;
-            Log.d(LOG_TAG, "Invalid HTTPS port number specified, defaulting to 443");
+            log.d(LOG_TAG, "Invalid HTTPS port number specified, defaulting to 443");
         }
 
         // Fix to SSL flaw in API < ICS
@@ -254,7 +256,7 @@ public void process(HttpRequest request, HttpContext context) {
                 for (String header : clientHeaderMap.keySet()) {
                     if (request.containsHeader(header)) {
                         Header overwritten = request.getFirstHeader(header);
-                        Log.d(LOG_TAG,
+                        log.d(LOG_TAG,
                                 String.format("Headers were overwritten! (%s | %s) overwrites (%s | %s)",
                                         header, clientHeaderMap.get(header),
                                         overwritten.getName(), overwritten.getValue())
@@ -342,6 +344,67 @@ public HttpContext getHttpContext() {
         return this.httpContext;
     }
 
+    /**
+     * Will set logging enabled flag on underlying LogInterface instance.
+     * Default setting is logging enabled.
+     *
+     * @param loggingEnabled whether the logging should be enabled or not
+     */
+    public void setLoggingEnabled(boolean loggingEnabled) {
+        log.setLoggingEnabled(loggingEnabled);
+    }
+
+    /**
+     * Returns logging enabled flag from underlying LogInterface instance
+     * Default setting is logging enabled.
+     *
+     * @return boolean whether is logging across the library currently enabled
+     */
+    public boolean isLoggingEnabled() {
+        return log.isLoggingEnabled();
+    }
+
+    /**
+     * Sets log level to be used across all library default implementation
+     * Default setting is VERBOSE log level.
+     *
+     * @param logLevel int log level, either from LogInterface interface or from {@link android.util.Log}
+     */
+    public void setLoggingLevel(int logLevel) {
+        log.setLoggingLevel(logLevel);
+    }
+
+    /**
+     * Retrieves current log level from underlying LogInterface instance.
+     * Default setting is VERBOSE log level.
+     *
+     * @return int log level currently in effect
+     */
+    public int getLoggingLevel() {
+        return log.getLoggingLevel();
+    }
+
+    /**
+     * Will return current LogInterface used in AsyncHttpClient instance
+     *
+     * @return LogInterface currently used by AsyncHttpClient instance
+     */
+    public LogInterface getLogInterface() {
+        return log;
+    }
+
+    /**
+     * Sets default LogInterface (similar to std Android Log util class) instance,
+     * to be used in AsyncHttpClient instance
+     *
+     * @param logInterfaceInstance LogInterface instance, if null, nothing is done
+     */
+    public void setLogInterface(LogInterface logInterfaceInstance) {
+        if (logInterfaceInstance != null) {
+            log = logInterfaceInstance;
+        }
+    }
+
     /**
      * Sets an optional CookieStore to use when making requests
      *
@@ -669,7 +732,7 @@ public void setBasicAuth(String username, String password, AuthScope scope, bool
 
     public void setCredentials(AuthScope authScope, Credentials credentials) {
         if (credentials == null) {
-            Log.d(LOG_TAG, "Provided credentials are null, not setting");
+            log.d(LOG_TAG, "Provided credentials are null, not setting");
             return;
         }
         this.httpClient.getCredentialsProvider().setCredentials(authScope == null ? AuthScope.ANY : authScope, credentials);
@@ -718,7 +781,7 @@ public void clearCredentialsProvider() {
      */
     public void cancelRequests(final Context context, final boolean mayInterruptIfRunning) {
         if (context == null) {
-            Log.e(LOG_TAG, "Passed null Context to cancelRequests");
+            log.e(LOG_TAG, "Passed null Context to cancelRequests");
             return;
         }
 
@@ -1304,10 +1367,10 @@ protected RequestHandle sendRequest(DefaultHttpClient client, HttpContext httpCo
         if (responseHandler.getUseSynchronousMode() && !responseHandler.getUsePoolThread()) {
             throw new IllegalArgumentException("Synchronous ResponseHandler used in AsyncHttpClient. You should create your response handler in a looper thread or use SyncHttpClient instead.");
         }
-        
+
         if (contentType != null) {
             if (uriRequest instanceof HttpEntityEnclosingRequestBase && ((HttpEntityEnclosingRequestBase) uriRequest).getEntity() != null && uriRequest.containsHeader(HEADER_CONTENT_TYPE)) {
-                Log.w(LOG_TAG, "Passed contentType will be ignored because HttpEntity sets content type");
+                log.w(LOG_TAG, "Passed contentType will be ignored because HttpEntity sets content type");
             } else {
                 uriRequest.setHeader(HEADER_CONTENT_TYPE, contentType);
             }
@@ -1384,7 +1447,7 @@ public static String getUrlWithQueryString(boolean shouldEncodeUrl, String url,
                 url = _uri.toASCIIString();
             } catch (Exception ex) {
                 // Should not really happen, added just for sake of validity
-                Log.e(LOG_TAG, "getUrlWithQueryString encoding URL", ex);
+                log.e(LOG_TAG, "getUrlWithQueryString encoding URL", ex);
             }
         }
 
@@ -1433,7 +1496,7 @@ public static void silentCloseInputStream(InputStream is) {
                 is.close();
             }
         } catch (IOException e) {
-            Log.w(LOG_TAG, "Cannot close input stream", e);
+            log.w(LOG_TAG, "Cannot close input stream", e);
         }
     }
 
@@ -1448,7 +1511,7 @@ public static void silentCloseOutputStream(OutputStream os) {
                 os.close();
             }
         } catch (IOException e) {
-            Log.w(LOG_TAG, "Cannot close output stream", e);
+            log.w(LOG_TAG, "Cannot close output stream", e);
         }
     }
 
@@ -1521,7 +1584,7 @@ public static void endEntityViaReflection(HttpEntity entity) {
                     }
                 }
             } catch (Throwable t) {
-                Log.e(LOG_TAG, "wrappedEntity consume", t);
+                log.e(LOG_TAG, "wrappedEntity consume", t);
             }
         }
     }

library/src/main/java/com/loopj/android/http/AsyncHttpRequest.java

@@ -110,7 +110,7 @@ public void run() {
             if (!isCancelled()) {
                 responseHandler.sendFailureMessage(0, null, null, e);
             } else {
-                Log.e("AsyncHttpRequest", "makeRequestWithRetries returned error", e);
+                AsyncHttpClient.log.e("AsyncHttpRequest", "makeRequestWithRetries returned error", e);
             }
         }
 
@@ -204,7 +204,7 @@ private void makeRequestWithRetries() throws IOException {
             }
         } catch (Exception e) {
             // catch anything else to ensure failure message is propagated
-            Log.e("AsyncHttpRequest", "Unhandled exception origin cause", e);
+            AsyncHttpClient.log.e("AsyncHttpRequest", "Unhandled exception origin cause", e);
             cause = new IOException("Unhandled exception: " + e.getMessage());
         }
 

library/src/main/java/com/loopj/android/http/AsyncHttpResponseHandler.java

@@ -195,7 +195,7 @@ public void setUseSynchronousMode(boolean sync) {
         // A looper must be prepared before setting asynchronous mode.
         if (!sync && looper == null) {
             sync = true;
-            Log.w(LOG_TAG, "Current thread has not called Looper.prepare(). Forcing synchronous mode.");
+            AsyncHttpClient.log.w(LOG_TAG, "Current thread has not called Looper.prepare(). Forcing synchronous mode.");
         }
 
         // If using asynchronous mode.
@@ -248,7 +248,7 @@ public String getCharset() {
      * @param totalSize    total size of file
      */
     public void onProgress(long bytesWritten, long totalSize) {
-        Log.v(LOG_TAG, String.format("Progress %d from %d (%2.0f%%)", bytesWritten, totalSize, (totalSize > 0) ? (bytesWritten * 1.0 / totalSize) * 100 : -1));
+        AsyncHttpClient.log.v(LOG_TAG, String.format("Progress %d from %d (%2.0f%%)", bytesWritten, totalSize, (totalSize > 0) ? (bytesWritten * 1.0 / totalSize) * 100 : -1));
     }
 
     /**
@@ -301,15 +301,15 @@ public void onPostProcessResponse(ResponseHandlerInterface instance, HttpRespons
      * @param retryNo number of retry
      */
     public void onRetry(int retryNo) {
-        Log.d(LOG_TAG, String.format("Request retry no. %d", retryNo));
+        AsyncHttpClient.log.d(LOG_TAG, String.format("Request retry no. %d", retryNo));
     }
 
     public void onCancel() {
-        Log.d(LOG_TAG, "Request got cancelled");
+        AsyncHttpClient.log.d(LOG_TAG, "Request got cancelled");
     }
 
     public void onUserException(Throwable error) {
-        Log.e(LOG_TAG, "User-space exception detected!", error);
+        AsyncHttpClient.log.e(LOG_TAG, "User-space exception detected!", error);
         throw new RuntimeException(error);
     }
 
@@ -359,15 +359,15 @@ protected void handleMessage(Message message) {
                     if (response != null && response.length >= 3) {
                         onSuccess((Integer) response[0], (Header[]) response[1], (byte[]) response[2]);
                     } else {
-                        Log.e(LOG_TAG, "SUCCESS_MESSAGE didn't got enough params");
+                        AsyncHttpClient.log.e(LOG_TAG, "SUCCESS_MESSAGE didn't got enough params");
                     }
                     break;
                 case FAILURE_MESSAGE:
                     response = (Object[]) message.obj;
                     if (response != null && response.length >= 4) {
                         onFailure((Integer) response[0], (Header[]) response[1], (byte[]) response[2], (Throwable) response[3]);
                     } else {
-                        Log.e(LOG_TAG, "FAILURE_MESSAGE didn't got enough params");
+                        AsyncHttpClient.log.e(LOG_TAG, "FAILURE_MESSAGE didn't got enough params");
                     }
                     break;
                 case START_MESSAGE:
@@ -382,18 +382,18 @@ protected void handleMessage(Message message) {
                         try {
                             onProgress((Long) response[0], (Long) response[1]);
                         } catch (Throwable t) {
-                            Log.e(LOG_TAG, "custom onProgress contains an error", t);
+                            AsyncHttpClient.log.e(LOG_TAG, "custom onProgress contains an error", t);
                         }
                     } else {
-                        Log.e(LOG_TAG, "PROGRESS_MESSAGE didn't got enough params");
+                        AsyncHttpClient.log.e(LOG_TAG, "PROGRESS_MESSAGE didn't got enough params");
                     }
                     break;
                 case RETRY_MESSAGE:
                     response = (Object[]) message.obj;
                     if (response != null && response.length == 1) {
                         onRetry((Integer) response[0]);
                     } else {
-                        Log.e(LOG_TAG, "RETRY_MESSAGE didn't get enough params");
+                        AsyncHttpClient.log.e(LOG_TAG, "RETRY_MESSAGE didn't get enough params");
                     }
                     break;
                 case CANCEL_MESSAGE:

library/src/main/java/com/loopj/android/http/BaseJsonHttpResponseHandler.java

@@ -87,7 +87,7 @@ public void run() {
                             }
                         });
                     } catch (final Throwable t) {
-                        Log.d(LOG_TAG, "parseResponse thrown an problem", t);
+                        AsyncHttpClient.log.d(LOG_TAG, "parseResponse thrown an problem", t);
                         postRunnable(new Runnable() {
                             @Override
                             public void run() {
@@ -123,7 +123,7 @@ public void run() {
                             }
                         });
                     } catch (Throwable t) {
-                        Log.d(LOG_TAG, "parseResponse thrown an problem", t);
+                        AsyncHttpClient.log.d(LOG_TAG, "parseResponse thrown an problem", t);
                         postRunnable(new Runnable() {
                             @Override
                             public void run() {

library/src/main/java/com/loopj/android/http/BinaryHttpResponseHandler.java

@@ -89,7 +89,7 @@ public BinaryHttpResponseHandler(String[] allowedContentTypes) {
         if (allowedContentTypes != null) {
             mAllowedContentTypes = allowedContentTypes;
         } else {
-            Log.e(LOG_TAG, "Constructor passed allowedContentTypes was null !");
+            AsyncHttpClient.log.e(LOG_TAG, "Constructor passed allowedContentTypes was null !");
         }
     }
 
@@ -105,7 +105,7 @@ public BinaryHttpResponseHandler(String[] allowedContentTypes, Looper looper) {
         if (allowedContentTypes != null) {
             mAllowedContentTypes = allowedContentTypes;
         } else {
-            Log.e(LOG_TAG, "Constructor passed allowedContentTypes was null !");
+            AsyncHttpClient.log.e(LOG_TAG, "Constructor passed allowedContentTypes was null !");
         }
     }
 
@@ -140,7 +140,7 @@ public final void sendResponseMessage(HttpResponse response) throws IOException
                     foundAllowedContentType = true;
                 }
             } catch (PatternSyntaxException e) {
-                Log.e(LOG_TAG, "Given pattern is not valid: " + anAllowedContentType, e);
+                AsyncHttpClient.log.e(LOG_TAG, "Given pattern is not valid: " + anAllowedContentType, e);
             }
         }
         if (!foundAllowedContentType) {

library/src/main/java/com/loopj/android/http/DataAsyncHttpResponseHandler.java

@@ -46,7 +46,7 @@ public DataAsyncHttpResponseHandler() {
      * @param responseBody response body received so far
      */
     public void onProgressData(byte[] responseBody) {
-        Log.d(LOG_TAG, "onProgressData(byte[]) was not overriden, but callback was received");
+        AsyncHttpClient.log.d(LOG_TAG, "onProgressData(byte[]) was not overriden, but callback was received");
     }
 
 
@@ -67,10 +67,10 @@ protected void handleMessage(Message message) {
                     try {
                         onProgressData((byte[]) response[0]);
                     } catch (Throwable t) {
-                        Log.e(LOG_TAG, "custom onProgressData contains an error", t);
+                        AsyncHttpClient.log.e(LOG_TAG, "custom onProgressData contains an error", t);
                     }
                 } else {
-                    Log.e(LOG_TAG, "PROGRESS_DATA_MESSAGE didn't got enough params");
+                    AsyncHttpClient.log.e(LOG_TAG, "PROGRESS_DATA_MESSAGE didn't got enough params");
                 }
                 break;
         }

library/src/main/java/com/loopj/android/http/FileAsyncHttpResponseHandler.java

@@ -71,7 +71,7 @@ public FileAsyncHttpResponseHandler(File file, boolean append, boolean renameTar
         }
         if (file.isDirectory()) {
             if (!file.mkdirs()) {
-                Log.d(LOG_TAG, "Cannot create directories for requested Directory location, might not be a problem");
+                AsyncHttpClient.log.d(LOG_TAG, "Cannot create directories for requested Directory location, might not be a problem");
             }
         }
         this.file = file;
@@ -111,7 +111,7 @@ protected File getTemporaryFile(Context context) {
         try {
             return File.createTempFile("temp_", "_handled", context.getCacheDir());
         } catch (IOException e) {
-            Log.e(LOG_TAG, "Cannot create temporary file", e);
+            AsyncHttpClient.log.e(LOG_TAG, "Cannot create temporary file", e);
         }
         return null;
     }