Merge pull request #121 from TanyaEf/master

Added logging functionality

Author: yaroslav-kovalchyk

README.md

@@ -114,9 +114,10 @@ Table of Contents
 17. [Asynchronous API](#asynchronous-api).
 18. [Getting serialized content from response](#getting-serialized-content-from-response).
 19. [Switching between JSON and XML](#switching-between-json-and-xml).
-20. [Possible issues](#possible-issues).
-21. [Maven dependency to add jasperserver-rest-client to your app](#maven-dependency-to-add-jasperserver-rest-client-to-your-app).
-22. [License](#license).
+20. [Logging](#logging).
+21. [Possible issues](#possible-issues).
+22. [Maven dependency to add jasperserver-rest-client to your app](#maven-dependency-to-add-jasperserver-rest-client-to-your-app).
+23. [License](#license).
 
 Introduction
 -------------
@@ -868,7 +869,7 @@ Response response = operationResult.getResponse();
 ```
 ####Setting Role Membership
 To assign role membership to a user, set the roles property on the user account with the PUT method of the rest_
-v2/users service. For details, see section [creating a user](https://github.com/boryskolesnykov/jasperserver-rest-client/edit/master/README.md#creating-a-user).
+v2/users service. For details, see section [creating a user](https://github.com/Jaspersoft/jrs-rest-java-client/blob/master/README.md#creating-a-user).
 ####Deleting a Role
 To delete a role, send the DELETE method and specify the role ID (name) in the URL.
 When this method is successful, the role is permanently deleted.
@@ -1003,7 +1004,7 @@ There are two operations on file resources:
 * Viewing the file resource details to determine the file format
 * Downloading the binary file contents
 
-To view the file resource details, specify the URL of the file in `resource()` method and use the code form [Viewing Resource Details](https://github.com/boryskolesnykov/jasperserver-rest-client/edit/master/README.md#viewing-resource-details) section.
+To view the file resource details, specify the URL of the file in `resource()` method and use the code form [Viewing Resource Details](https://github.com/Jaspersoft/jrs-rest-java-client/blob/master/README.md#viewing-resource-details) section.
 To download file binary content, specify the URL of the file in `resource()` method and use the code below
 ```java
 OperationResult<InputStream> result = client
@@ -1644,6 +1645,16 @@ acceptMimeType=JSON
 RestClientConfiguration configuration = RestClientConfiguration.loadConfiguration("jrs-client-config.properties");
 ```
 
+###Logging
+It is possible to log outgoing requests and incoming responses using `logHttp` property of `RestCleintConfiguration`:
+```java
+config.setLogHttp(true);
+```
+Also, you are able to log entities using `logHttpEntity` option:
+```java
+config.setLogHttpEntity(true).
+```
+
 ###Possible issues
 1. <strong>Deploying jrs-rest-client within web app to any Appplication Server, e.g. JBoss, Glassfish, WebSphere etc.</strong>
 jrs-rest-client uses the implementation of JAX-RS API of version 2.0 and if your application server does not support this version you will get an error. To solve this problem you need to add to your application a deployment configuration specific for your AS where you need to exclude modules with old JAX-RS API version. Example of such descriptor for JBoss AS you can find below:

pom.xml

@@ -143,6 +143,29 @@
             <artifactId>commons-logging</artifactId>
             <version>1.0.4</version>
         </dependency>
+        <!-- Logging -->
+        <dependency>
+            <groupId>org.slf4j</groupId>
+            <artifactId>slf4j-api</artifactId>
+            <version>1.7.12</version>
+        </dependency>
+
+        <dependency>
+            <groupId>org.slf4j</groupId>
+            <artifactId>slf4j-log4j12</artifactId>
+            <version>1.7.12</version>
+        </dependency>
+        <dependency>
+            <groupId>log4j</groupId>
+            <artifactId>log4j</artifactId>
+            <version>1.2.17</version>
+        </dependency>
+
+        <dependency>
+            <groupId>org.slf4j</groupId>
+            <artifactId>jul-to-slf4j</artifactId>
+            <version>1.7.12</version>
+        </dependency>
     </dependencies>
 
 

src/integration-test/java/com/jaspersoft/jasperserver/jaxrs/client/apiadapters/authority/users/UsersServiceIT.java

@@ -4,6 +4,8 @@
 import com.jaspersoft.jasperserver.jaxrs.client.core.JasperserverRestClient;
 import com.jaspersoft.jasperserver.jaxrs.client.core.RestClientConfiguration;
 import com.jaspersoft.jasperserver.jaxrs.client.core.Session;
+import com.jaspersoft.jasperserver.jaxrs.client.core.enums.JRSVersion;
+import com.jaspersoft.jasperserver.jaxrs.client.core.enums.MimeType;
 import java.util.List;
 import org.testng.Assert;
 import org.testng.annotations.AfterMethod;
@@ -21,9 +23,12 @@ public class UsersServiceIT {
 
     @BeforeMethod
     public void before() {
-
-        RestClientConfiguration cfg = new RestClientConfiguration("http://localhost:4444/jasperserver-pro");
-        JasperserverRestClient client = new JasperserverRestClient(cfg);
+        config = new RestClientConfiguration("http://localhost:4444/jasperserver-pro");
+        config.setAcceptMimeType(MimeType.JSON);
+        config.setContentMimeType(MimeType.JSON);
+        config.setJrsVersion(JRSVersion.v6_0_1);
+        config.setLogHttp(true);
+        client = new JasperserverRestClient(config);
 
         session = client.authenticate("superuser", "superuser");
     }

src/integration-test/java/com/jaspersoft/jasperserver/jaxrs/client/apiadapters/reporting/ReportingServiceIT.java

@@ -25,6 +25,8 @@ public class ReportingServiceIT {
     @BeforeMethod
     public void before() {
         configuration = new RestClientConfiguration("http://localhost:4444/jasperserver-pro");
+        configuration.setLogHttp(true);
+        configuration.setLogHttpEntity(true);
         client = new JasperserverRestClient(configuration);
         session = client.authenticate("superuser", "superuser");
     }

src/integration-test/java/com/jaspersoft/jasperserver/jaxrs/client/apiadapters/settings/SettingsServiceIT.java

@@ -41,6 +41,8 @@ public void before() {
         config.setAcceptMimeType(MimeType.JSON);
         config.setContentMimeType(MimeType.JSON);
         config.setJrsVersion(JRSVersion.v6_0_0);
+        config.setLogHttp(true);
+        config.setLogHttpEntity(true);
         client = new JasperserverRestClient(config);
         session = client.getAnonymousSession();
     }

src/main/java/com/jaspersoft/jasperserver/jaxrs/client/apiadapters/resources/ResourcesTypeResolverUtil.java

@@ -42,50 +42,58 @@
 import com.jaspersoft.jasperserver.dto.resources.ClientSemanticLayerDataSource;
 import com.jaspersoft.jasperserver.dto.resources.ClientVirtualDataSource;
 import com.jaspersoft.jasperserver.dto.resources.ClientXmlaConnection;
-import com.jaspersoft.jasperserver.jaxrs.client.core.enums.ResourceMediaType;
+import com.jaspersoft.jasperserver.dto.resources.ResourceMediaType;
 import com.jaspersoft.jasperserver.jaxrs.client.dto.resources.ClientDashboard;
 import com.jaspersoft.jasperserver.jaxrs.client.dto.resources.ClientDomainTopic;
-
 import java.util.HashMap;
 import java.util.Map;
 
 public class ResourcesTypeResolverUtil {
 
     private static final Map<Class<? extends ClientResource>, String> classToMimeMap;
     private static final Map<String, Class<? extends ClientResource>> mimeToClassMap;
+    public static final String RESOURCE_MEDIA_TYPE_PREFIX = "application/repository.";
+    public static final String RESOURCE_MIME_TYPE = "+{mime}";
 
     static {
         classToMimeMap = new HashMap<Class<? extends ClientResource>, String>() {{
-            put(ClientAdhocDataView.class, ResourceMediaType.ADHOC_DATA_VIEW_MIME);
-            put(ClientAwsDataSource.class, ResourceMediaType.AWS_DATA_SOURCE_MIME);
-            put(ClientBeanDataSource.class, ResourceMediaType.BEAN_DATA_SOURCE_MIME);
-            put(ClientCustomDataSource.class, ResourceMediaType.CUSTOM_DATA_SOURCE_MIME);
-            put(ClientDataType.class, ResourceMediaType.DATA_TYPE_MIME);
-            put(ClientFile.class, ResourceMediaType.FILE_MIME);
-            put(ClientFolder.class, ResourceMediaType.FOLDER_MIME);
-            put(ClientInputControl.class, ResourceMediaType.INPUT_CONTROL_MIME);
-            put(ClientJdbcDataSource.class, ResourceMediaType.JDBC_DATA_SOURCE_MIME);
-            put(ClientJndiJdbcDataSource.class, ResourceMediaType.JNDI_JDBC_DATA_SOURCE_MIME);
-            put(ClientListOfValues.class, ResourceMediaType.LIST_OF_VALUES_MIME);
-            put(ClientMondrianConnection.class, ResourceMediaType.MONDRIAN_CONNECTION_MIME);
-            put(ClientMondrianXmlaDefinition.class, ResourceMediaType.MONDRIAN_XMLA_DEFINITION_MIME);
-            put(ClientOlapUnit.class, ResourceMediaType.OLAP_UNIT_MIME);
-            put(ClientQuery.class, ResourceMediaType.QUERY_MIME);
-            put(ClientReportUnit.class, ResourceMediaType.REPORT_UNIT_MIME);
-            put(ClientSecureMondrianConnection.class, ResourceMediaType.SECURE_MONDRIAN_CONNECTION_MIME);
-            put(ClientSemanticLayerDataSource.class, ResourceMediaType.SEMANTIC_LAYER_DATA_SOURCE_MIME);
-            put(ClientVirtualDataSource.class, ResourceMediaType.VIRTUAL_DATA_SOURCE_MIME);
-            put(ClientXmlaConnection.class, ResourceMediaType.XMLA_CONNECTION_MIME);
-            put(ClientResourceLookup.class, ResourceMediaType.RESOURCE_LOOKUP_MIME);
-            put(ClientDashboard.class, ResourceMediaType.DASHBOARD_MIME);
-            put(ClientDomainTopic.class, ResourceMediaType.DOMAIN_TOPIC_MIME);
+            put(ClientAdhocDataView.class, ResourceMediaType.ADHOC_DATA_VIEW_CLIENT_TYPE);
+            put(ClientAwsDataSource.class, ResourceMediaType.AWS_DATA_SOURCE_CLIENT_TYPE);
+            put(ClientBeanDataSource.class, ResourceMediaType.BEAN_DATA_SOURCE_CLIENT_TYPE);
+            put(ClientCustomDataSource.class, ResourceMediaType.CUSTOM_DATA_SOURCE_CLIENT_TYPE);
+            put(ClientDataType.class, ResourceMediaType.DATA_TYPE_CLIENT_TYPE);
+            put(ClientFile.class, ResourceMediaType.FILE_CLIENT_TYPE);
+            put(ClientFolder.class, ResourceMediaType.FOLDER_CLIENT_TYPE);
+            put(ClientInputControl.class, ResourceMediaType.INPUT_CONTROL_CLIENT_TYPE);
+            put(ClientJdbcDataSource.class, ResourceMediaType.JDBC_DATA_SOURCE_CLIENT_TYPE);
+            put(ClientJndiJdbcDataSource.class, ResourceMediaType.JNDI_JDBC_DATA_SOURCE_CLIENT_TYPE);
+            put(ClientListOfValues.class, ResourceMediaType.LIST_OF_VALUES_CLIENT_TYPE);
+            put(ClientMondrianConnection.class, ResourceMediaType.MONDRIAN_CONNECTION_CLIENT_TYPE);
+            put(ClientMondrianXmlaDefinition.class, ResourceMediaType.MONDRIAN_XMLA_DEFINITION_CLIENT_TYPE);
+            put(ClientOlapUnit.class, ResourceMediaType.OLAP_UNIT_CLIENT_TYPE);
+            put(ClientQuery.class, ResourceMediaType.QUERY_CLIENT_TYPE);
+            put(ClientReportUnit.class, ResourceMediaType.REPORT_UNIT_CLIENT_TYPE);
+            put(ClientSecureMondrianConnection.class, ResourceMediaType.SECURE_MONDRIAN_CONNECTION_CLIENT_TYPE);
+            put(ClientSemanticLayerDataSource.class, ResourceMediaType.SEMANTIC_LAYER_DATA_SOURCE_CLIENT_TYPE);
+            put(ClientVirtualDataSource.class, ResourceMediaType.VIRTUAL_DATA_SOURCE_CLIENT_TYPE);
+            put(ClientXmlaConnection.class, ResourceMediaType.XMLA_CONNECTION_CLIENT_TYPE);
+            put(ClientResourceLookup.class, ResourceMediaType.RESOURCE_LOOKUP_CLIENT_TYPE);
+            put(ClientDashboard.class, ResourceMediaType.DASHBOARD_CLIENT_TYPE);
+            put(ClientDomainTopic.class, ResourceMediaType.DOMAIN_TOPIC_CLIENT_TYPE);
         }};
 
+        for (Map.Entry<Class<? extends ClientResource>, String> entry : classToMimeMap.entrySet()) {
+            entry.setValue(typeToMime(entry.getValue()));
+        }
+
         mimeToClassMap = new HashMap<String, Class<? extends ClientResource>>();
         for (Map.Entry<Class<? extends ClientResource>, String> entry : classToMimeMap.entrySet()) {
             mimeToClassMap.put(entry.getValue(), entry.getKey());
         }
     }
+    private static String typeToMime(String type) {
+        return RESOURCE_MEDIA_TYPE_PREFIX + type + RESOURCE_MIME_TYPE;
+    }
 
     public static String getMimeType(Class<? extends ClientResource> clazz) {
         return classToMimeMap.get(clazz);

src/main/java/com/jaspersoft/jasperserver/jaxrs/client/core/JasperserverRestClient.java

@@ -21,7 +21,7 @@
 package com.jaspersoft.jasperserver.jaxrs.client.core;
 
 import com.jaspersoft.jasperserver.jaxrs.client.core.enums.AuthenticationType;
-import com.jaspersoft.jasperserver.jaxrs.client.core.enums.ResponseStatus;
+import javax.ws.rs.core.Response.Status;
 import com.jaspersoft.jasperserver.jaxrs.client.core.exceptions.handling.DefaultErrorHandler;
 import com.jaspersoft.jasperserver.jaxrs.client.filters.BasicAuthenticationFilter;
 import com.jaspersoft.jasperserver.jaxrs.client.filters.SessionOutputFilter;
@@ -73,7 +73,7 @@ protected void login(SessionStorage storage) {
         String sessionId = null;
         String location = response.getLocation().toString();
 
-        if (response.getStatus() == ResponseStatus.FOUND && !location.matches("[^?]+\\?([^&]*&)*error=1(&[^&]*)*$")) {
+        if (response.getStatus() == Status.FOUND.getStatusCode() && !location.matches("[^?]+\\?([^&]*&)*error=1(&[^&]*)*$")) {
             sessionId = response.getCookies().get("JSESSIONID").getValue();
             storage.setSessionId(sessionId);
         } else {

src/main/java/com/jaspersoft/jasperserver/jaxrs/client/core/MimeTypeUtil.java

@@ -21,23 +21,23 @@
 
 package com.jaspersoft.jasperserver.jaxrs.client.core;
 
+import com.jaspersoft.jasperserver.dto.resources.ResourceMediaType;
 import com.jaspersoft.jasperserver.jaxrs.client.core.enums.MimeType;
 
 public class MimeTypeUtil {
 
-    private static final String JSON_SUFFIX = "json";
-    private static final String XML_SUFFIX = "xml";
 
     public static String toCorrectContentMime(RestClientConfiguration configuration, String srcMime) {
-        if (srcMime.endsWith("+{mime}")) {
-            return srcMime.replace("{mime}", configuration.getContentMimeType() == MimeType.JSON ? JSON_SUFFIX : XML_SUFFIX);
-        }
-        return srcMime;
+        return replaceMime(configuration.getContentMimeType(), srcMime);
     }
 
     public static String toCorrectAcceptMime(RestClientConfiguration configuration, String srcMime) {
+        return replaceMime(configuration.getAcceptMimeType(), srcMime);
+    }
+
+    private static String replaceMime(MimeType configMimeType, String srcMime) {
         if (srcMime.endsWith("+{mime}")) {
-            return srcMime.replace("{mime}", configuration.getAcceptMimeType() == MimeType.JSON ? JSON_SUFFIX : XML_SUFFIX);
+            return srcMime.replace("+{mime}", configMimeType == MimeType.JSON ? ResourceMediaType.RESOURCE_JSON_TYPE : ResourceMediaType.RESOURCE_XML_TYPE);
         }
         return srcMime;
     }

src/main/java/com/jaspersoft/jasperserver/jaxrs/client/core/RestClientConfiguration.java

@@ -49,9 +49,10 @@ public class RestClientConfiguration {
     private JRSVersion jrsVersion = JRSVersion.v5_5_0;
     private AuthenticationType authenticationType = AuthenticationType.SPRING;
     private Boolean restrictedHttpMethods = false;
+    private Boolean logHttp = false;
+    private Boolean logHttpEntity = false;
     private TrustManager[] trustManagers;
     private Integer connectionTimeout;
-
     private Integer readTimeout;
 
     public RestClientConfiguration(String jasperReportsServerUrl) {
@@ -87,10 +88,10 @@ public void setJasperReportsServerUrl(String jasperReportsServerUrl) {
             throw new IllegalArgumentException("Given parameter is not a URL");
         this.jasperReportsServerUrl = jasperReportsServerUrl;
     }
+
     public AuthenticationType getAuthenticationType() {
         return authenticationType;
     }
-
     public void setAuthenticationType(AuthenticationType authenticationType) {
         this.authenticationType = authenticationType;
     }
@@ -151,6 +152,22 @@ public void setRestrictedHttpMethods(Boolean restrictedHttpMethods) {
         this.restrictedHttpMethods = restrictedHttpMethods;
     }
 
+    public Boolean getLogHttp() {
+        return logHttp;
+    }
+
+    public void setLogHttp(Boolean logHttp) {
+        this.logHttp = logHttp;
+    }
+
+    public Boolean getLogHttpEntity() {
+        return logHttpEntity;
+    }
+
+    public void setLogHttpEntity(Boolean logHttpEntity) {
+        this.logHttpEntity = logHttpEntity;
+    }
+
     public static RestClientConfiguration loadConfiguration(String path) {
         Properties properties = loadProperties(path);
 

src/main/java/com/jaspersoft/jasperserver/jaxrs/client/core/SessionStorage.java

@@ -26,7 +26,9 @@
 import com.fasterxml.jackson.jaxrs.json.JacksonJsonProvider;
 
 import org.glassfish.jersey.client.ClientProperties;
+import org.glassfish.jersey.filter.LoggingFilter;
 import org.glassfish.jersey.jackson.JacksonFeature;
+import org.slf4j.bridge.SLF4JBridgeHandler;
 
 
 import javax.net.ssl.HostnameVerifier;
@@ -37,6 +39,7 @@
 import javax.ws.rs.client.WebTarget;
 
 import java.security.SecureRandom;
+import java.util.logging.Logger;
 
 
 public class SessionStorage {
@@ -97,7 +100,18 @@ private void init() {
         rootTarget = client.target(configuration.getJasperReportsServerUrl());
         rootTarget.register(JacksonFeature.class);
         rootTarget.register(provider);
+        if (configuration.getLogHttp()) {
+            rootTarget.register(initLoggingFilter());
+        }
+    }
+
+    private LoggingFilter initLoggingFilter() {
+        Logger logger = Logger.getLogger(this.getClass().getName());
+        SLF4JBridgeHandler.removeHandlersForRootLogger();
+        SLF4JBridgeHandler.install();
 
+        return new LoggingFilter(logger,
+                configuration.getLogHttpEntity());
     }