Merge pull request #145 from TanyaEf/master

New strategy of error handling, bugFix

Author: yaroslav-kovalchyk

README.md

@@ -52,6 +52,7 @@ Table of Contents
     * [Viewing Server Attributes](#viewing-server-attributes).
     * [Setting Server Attributes](#setting-server-attributes).
     * [Deleting Server Attributes](#deleting-server-attributes).
+    * [Getting attributes permissions](#getting-attributes-permissions).
   4. [The Roles Service](#the-roles-service).
     * [Searching for Roles](#searching-for-roles).
     * [Viewing a Role](#viewing-a-role).
@@ -629,10 +630,9 @@ The code below retrieves single attribute defined for the user:
                    .attribute(attribute.getName())
                    .get()
                    .getEntity();
-   
-  ```
+ ```
  You may work work with user as object:
-    ```java
+```java
     CleintUser userObject = new ClientUser();
     userObject.setName("jasperadmin");
     HypermediaAttribute userAttribute = session
@@ -641,50 +641,48 @@ The code below retrieves single attribute defined for the user:
                        .attribute(attribute.getName())
                        .get()
                        .getEntity();
-   ```
+```
  If user belong to organization you may specify it by name or as object:
- ```java
+```java
  HypermediaAttribute userAttribute = session
                  .attributesService()
                  .forOrganization("organization_1")
                  .forUser("jasperadmin")
                  .attribute(attribute.getName())
                  .get()
                  .getEntity();
- 
- ```
-  ```java
+
   ClientTenant orgObject = new CleintTenant();
   orgObject.setId("someId");
+ 
  HypermediaAttribute userAttribute = session
                  .attributesService()
                  .forOrganization(orgObject)
                  .forUser("jasperadmin")
                  .attribute(attribute.getName())
                  .get()
                  .getEntity();
- 
- ```
-   The code below retrieves the list of attributes defined for the user.
+```
+  
+The code below retrieves the list of attributes defined for the user.
 ```java
    HypermediaAttribute userAttribute = session
                    .attributesService()
                    .forUser("jasperadmin")
                    .attribute("attributeName")
                    .get()
                    .getEntity();
-   
    ```
+
  If user belong to organization you may specify organization:
- ```java
+```java
  HypermediaAttribute userAttribute = session
                  .attributesService()
                  .forOrganization("organization_1")
                  .forUser("jasperadmin")
                  .attribute(attribute.getName())
                  .get()
                  .getEntity();
- 
  ```
 You can get the list of attributes that includes the name and value of each attribute:
  ```java
@@ -713,6 +711,7 @@ serverAttributes.setProfileAttributes(asList(new HypermediaAttribute(new ClientU
                        .attributes("test_attribute_1","test_attribute_2")
                        .createOrUpdate(serverAttributes);
 ```
+
 Be careful with definition of attribute names because the server uses different strategies for creating or updating attributes depending on list of attribute names, list of attributes and existing attributes on the server:
  1. if requested attribute name in `attributes()` method matches with attribute name of object defined in `createOrUpdate()` method and the attribute does not exist on the server it will be *created* on the server;
  2. if requested attribute name in `attributes()` method matches with attribute name of object defined in `createOrUpdate()` method and the attribute exists on the server it will be *updated* on the server;
@@ -901,6 +900,19 @@ session
                 .attributes("max_threads", "admin_cell_phone")
                 .delete();
 ```
+###Getting attributes permissions
+Since `6.1` version of `JaspersoftReportServer` you can obtain attributes with permissions using additional parameter `setIncludePermissions()`:
+```java
+
+ HypermediaAttribute entity = session
+                 .attributesService()
+                 .attribute("attribute_name")
+                 .setIncludePermissions(true)
+                 .get()
+                 .getEntity();
+```
+Pay attention, the setting `setIncludePermission()` specify only the **server response format**, you can not set any permissions with this setting.
+
 ###The Roles Service
 It provides similar methods that allow you to list, view, create, modify, and delete roles. The new service provides improved search functionality, including user-based role searches. Because the role ID is used in the URL, this service can operate only on roles whose ID is less than 100 characters long and does not contain spaces or special symbols. Unlike resource IDs, the role ID is the role name and can be modified.
 ####Searching for Roles
@@ -1716,6 +1728,23 @@ final Map<String, String> bundle = session
         .getEntity();
 ```
 ###Exception handling
+You can choose strategy of errors that are specified by status code of server response:
+1. handling of errors directly. This is allied by default.
+2. getting operation result in any case with null entity and handling error after calling `getEntity()` method:
+```java
+OperationResult<InputStream> result = session
+                .thumbnailsService()
+                .thumbnail()
+                .report("/")
+                .get(); // response status is 406, but exception won't be thrown
+result.getEntity();     // the error will be handled and an exception will be thrown
+```
+To apply the second strategy set `handleErrors` property of `RestCleintConfiguration` to `false`:
+```java
+configuration.setHandleErrors(false);
+```
+or specify this property in configuration file (for details, read section [Configuration](https://github.com/Jaspersoft/jrs-rest-java-client/blob/master/README.md#configuration)).
+
 You can customize exception handling for each endpoint. To do this you need to pass `com.jaspersoft.jasperserver.jaxrs.client.core.exceptions.handling.ErrorHandler` implementation to `JerseyRequestBuilder.buildRequest()` factory method.
 
 JRS REST client exception handling system is based on `com.jaspersoft.jasperserver.jaxrs.client.core.exceptions.handling.ErrorHandler` interface. Its `void handleError(Response response)` method is responsible for all error handling logic. You can use existed handlers, define your own handlers or extend existed handlers.

src/main/java/com/jaspersoft/jasperserver/jaxrs/client/apiadapters/attributes/SingleAttributeAdapter.java

@@ -91,13 +91,24 @@ public void run() {
         return task;
     }
 
+    /**
+     * @deprecated Replaced by {@link SingleAttributeAdapter#createOrUpdate(HypermediaAttribute)}.
+     */
     public OperationResult<HypermediaAttribute> createOrUpdate(ClientUserAttribute attribute) {
-        return buildRequest()
-                .setContentType(MimeTypeUtil.toCorrectContentMime(sessionStorage.getConfiguration(), "application/hal+{mime}"))
-                .put(attribute);
+
+        return this.createOrUpdate(new HypermediaAttribute(attribute));
+    }
+
+
+    public OperationResult<HypermediaAttribute> createOrUpdate(HypermediaAttribute attribute) {
+        JerseyRequest<HypermediaAttribute> request = buildRequest();
+        if (includePermissions) {
+            request.setContentType(MimeTypeUtil.toCorrectContentMime(sessionStorage.getConfiguration(), "application/hal+{mime}"));
+        }
+        return request.put(attribute);
     }
 
-    public <R> RequestExecution asyncCreateOrUpdate(final ClientUserAttribute userAttribute,
+    public <R> RequestExecution asyncCreateOrUpdate(final HypermediaAttribute userAttribute,
                                                     final Callback<OperationResult<HypermediaAttribute>, R> callback) {
         final JerseyRequest<HypermediaAttribute> request = buildRequest();
         RequestExecution task = new RequestExecution(new Runnable() {

src/main/java/com/jaspersoft/jasperserver/jaxrs/client/apiadapters/thumbnails/SingleThumbnailAdapter.java

@@ -3,6 +3,7 @@
 import com.jaspersoft.jasperserver.jaxrs.client.apiadapters.AbstractAdapter;
 import com.jaspersoft.jasperserver.jaxrs.client.core.JerseyRequest;
 import com.jaspersoft.jasperserver.jaxrs.client.core.SessionStorage;
+import com.jaspersoft.jasperserver.jaxrs.client.core.exceptions.MandatoryParameterNotFoundException;
 import com.jaspersoft.jasperserver.jaxrs.client.core.exceptions.handling.DefaultErrorHandler;
 import com.jaspersoft.jasperserver.jaxrs.client.core.operationresult.OperationResult;
 
@@ -37,7 +38,10 @@ public OperationResult<InputStream> get() {
     }
 
     private JerseyRequest<InputStream> request() {
+        if (params.size() == 0) {
+            throw new MandatoryParameterNotFoundException("URI of report should be specified");
+        }
         return JerseyRequest.buildRequest(sessionStorage, InputStream.class,
-                new String[]{"/thumbnails" + params.get("uri").get(0)}, new DefaultErrorHandler());
+                new String[]{"/thumbnails",  params.get("uri").get(0)}, new DefaultErrorHandler());
     }
 }

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

@@ -21,9 +21,11 @@
 
 package com.jaspersoft.jasperserver.jaxrs.client.core;
 
+import com.jaspersoft.jasperserver.jaxrs.client.core.enums.RequestMethod;
 import com.jaspersoft.jasperserver.jaxrs.client.core.exceptions.JSClientWebException;
 import com.jaspersoft.jasperserver.jaxrs.client.core.exceptions.handling.DefaultErrorHandler;
 import com.jaspersoft.jasperserver.jaxrs.client.core.exceptions.handling.ErrorHandler;
+import com.jaspersoft.jasperserver.jaxrs.client.core.operationresult.NullEntityOperationResult;
 import com.jaspersoft.jasperserver.jaxrs.client.core.operationresult.OperationResult;
 import com.jaspersoft.jasperserver.jaxrs.client.core.operationresult.OperationResultFactory;
 import com.jaspersoft.jasperserver.jaxrs.client.core.operationresult.OperationResultFactoryImpl;
@@ -56,6 +58,7 @@ public class JerseyRequest<ResponseType> implements RequestBuilder<ResponseType>
     private WebTarget usersWebTarget;
     private String contentType;
     private String acceptType;
+    private Boolean handleErrors;
 
     protected JerseyRequest(SessionStorage sessionStorage, Class<ResponseType> responseClass) {
         operationResultFactory = new OperationResultFactoryImpl();
@@ -84,6 +87,7 @@ private void init(SessionStorage sessionStorage) {
 
         usersWebTarget = sessionStorage.getRootTarget()
                 .path("/rest_v2");
+        handleErrors = configuration.getHandleErrors();
     }
 
     public static <T> JerseyRequest<T> buildRequest(SessionStorage sessionStorage, Class<T> responseClass, String[] path) {
@@ -152,7 +156,7 @@ private OperationResult<ResponseType> executeRequest(int httpMethod, Invocation.
     private OperationResult<ResponseType> executeRequest(int httpMethod, Invocation.Builder request, Object entity) {
         Response response = null;
         if (restrictedHttpMethods && (httpMethod != POST || httpMethod != GET) ) {
-            request.header("X-HTTP-Method-Override", httpMethod);
+            request.header("X-HTTP-Method-Override", RequestMethod.values()[httpMethod].toString());
             response = request.post(Entity.entity(entity, contentType));
         } else {
             switch (httpMethod) {
@@ -171,14 +175,24 @@ private OperationResult<ResponseType> executeRequest(int httpMethod, Invocation.
             }
 
             if (response != null && response.getStatus() == 411 && (httpMethod != POST || httpMethod != GET)) {
-                request.header("X-HTTP-Method-Override", httpMethod);
+                request.header("X-HTTP-Method-Override", RequestMethod.values()[httpMethod].toString());
                 executeRequest(POST, request, entity);
             }
         }
 
         if (response != null && response.getStatus() >= 400) {
-            errorHandler.handleError(response);
-        }
+            if (handleErrors) {
+                errorHandler.handleError(response);
+            } else {
+                return (responseGenericType != null) ? new NullEntityOperationResult<ResponseType>(response, responseGenericType, errorHandler)
+                        : new NullEntityOperationResult<ResponseType>(response, responseClass, errorHandler);
+            }
+                errorHandler.handleError(response);
+            } else {
+                return (responseGenericType != null) ? new NullEntityOperationResult<ResponseType>(response, responseGenericType, errorHandler)
+                        : new NullEntityOperationResult<ResponseType>(response, responseClass, errorHandler);
+            }
+
         return (responseGenericType != null) ? operationResultFactory.getOperationResult(response, responseGenericType)
                 : operationResultFactory.getOperationResult(response, responseClass);
     }

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

@@ -53,6 +53,7 @@ public class RestClientConfiguration {
     private Boolean restrictedHttpMethods = false;
     private Boolean logHttp = false;
     private Boolean logHttpEntity = false;
+    private Boolean handleErrors = true;
     private Integer connectionTimeout;
     private Integer readTimeout;
     private TrustManager[] trustManagers;
@@ -145,6 +146,11 @@ public static RestClientConfiguration loadConfiguration(Properties properties) {
             configuration.setRestrictedHttpMethods(Boolean.valueOf(restrictedHttpMethods));
         }
 
+        String handleErrors = properties.getProperty("handleErrors");
+        if (isStringValid(handleErrors) && BOOLEAN_PATTERN.matcher(handleErrors).matches()) {
+            configuration.setHandleErrors(Boolean.valueOf(handleErrors));
+        }
+
         String contentMimeType = properties.getProperty("contentMimeType");
         if (isStringValid(contentMimeType)) {
             try {
@@ -216,6 +222,15 @@ public RestClientConfiguration setRestrictedHttpMethods(Boolean restrictedHttpMe
         return this;
     }
 
+    public Boolean getHandleErrors() {
+        return handleErrors;
+    }
+
+    public RestClientConfiguration setHandleErrors(Boolean handleErrors) {
+        this.handleErrors = handleErrors;
+        return this;
+    }
+
     public RestClientConfiguration setLogHttp(Boolean logHttp) {
         this.logHttp = logHttp;
         return this;

src/main/java/com/jaspersoft/jasperserver/jaxrs/client/core/enums/RequestMethod.java

@@ -5,5 +5,7 @@
  */
 public enum RequestMethod {
     GET,
-    POST;
+    DELETE,
+    POST,
+    PUT;
 }

src/main/java/com/jaspersoft/jasperserver/jaxrs/client/core/exceptions/MandatoryParameterNotFoundException.java

@@ -34,11 +34,11 @@ public class MandatoryParameterNotFoundException extends JSClientWebException {
     public final static String MANDATORY_PARAMETER_ERROR = "mandatory.parameter.error";
 
     public MandatoryParameterNotFoundException() {
-        super();    //To change body of overridden methods use File | Settings | File Templates.
+        super();
     }
 
     public MandatoryParameterNotFoundException(String message) {
-        super(message);    //To change body of overridden methods use File | Settings | File Templates.
+        super(message);
     }
 
     public MandatoryParameterNotFoundException(String message, List<ErrorDescriptor> errorDescriptors) {

src/main/java/com/jaspersoft/jasperserver/jaxrs/client/core/operationresult/NullEntityOperationResult.java

@@ -22,21 +22,36 @@
 package com.jaspersoft.jasperserver.jaxrs.client.core.operationresult;
 
 
+import com.jaspersoft.jasperserver.jaxrs.client.core.exceptions.handling.ErrorHandler;
 import javax.ws.rs.core.GenericType;
 import javax.ws.rs.core.Response;
 
 public class NullEntityOperationResult<T> extends OperationResult<T> {
+    private ErrorHandler defaultErrorHandler;
 
-    public NullEntityOperationResult(Response response, Class entityClass) {
+    public NullEntityOperationResult(Response response, Class<T> entityClass) {
         super(response, entityClass);
     }
 
     public NullEntityOperationResult(Response response, GenericType<T> genericType) {
         super(response, genericType);
     }
 
+    public NullEntityOperationResult(Response response, Class<T> entityClass, ErrorHandler defaultErrorHandler) {
+        super(response, entityClass);
+        this.defaultErrorHandler = defaultErrorHandler;
+    }
+
+    public NullEntityOperationResult(Response response, GenericType<T> genericType, ErrorHandler defaultErrorHandler) {
+        super(response, genericType);
+        this.defaultErrorHandler = defaultErrorHandler;
+    }
+
     @Override
     public T getEntity() {
+        if (defaultErrorHandler != null) {
+            defaultErrorHandler.handleError(response);
+        }
         return null;
     }
 }

src/main/java/com/jaspersoft/jasperserver/jaxrs/client/core/operationresult/OperationResult.java

@@ -38,7 +38,6 @@ public OperationResult(Response response, Class<? extends T> entityClass) {
         this.entityClass = entityClass;
     }
 
-
     @SuppressWarnings("unchecked")
     public OperationResult(Response response, GenericType<T> genericEntity) {
         this.response = response;
@@ -50,6 +49,7 @@ public OperationResult(Response response, GenericType<T> genericEntity) {
     public T getEntity() {
         try {
             if (entity == null) {
+
                 if (genericEntity != null) {
                     entity = response.readEntity(genericEntity);
                 } else {
@@ -81,4 +81,8 @@ public Response getResponse() {
     public Class<? extends T> getEntityClass() {
         return entityClass;
     }
+
+    public int getResponseStatus() {
+        return this.getResponse().getStatus();
+    }
 }

src/test/java/com/jaspersoft/jasperserver/jaxrs/client/apiadapters/thumbnails/SingleThumbnailAdapterTest.java

@@ -113,7 +113,7 @@ public void should_return_proper_operation_result() {
         when(buildRequest(
                 eq(sessionStorageMock),
                 eq(InputStream.class),
-                eq(new String[]{"/thumbnails/public/Samples/Reports/07g.RevenueDetailReport"}),
+                eq(new String[]{"/thumbnails", "/public/Samples/Reports/07g.RevenueDetailReport"}),
                 any(DefaultErrorHandler.class))).thenReturn(jerseyRequestMock);
         when(jerseyRequestMock.setAccept("image/jpeg")).thenReturn(requestBuilderMock);
         when(requestBuilderMock.get()).thenReturn(operationResultMock);
@@ -133,7 +133,7 @@ public void should_return_proper_operation_result() {
         buildRequest(
                 eq(sessionStorageMock),
                 eq(InputStream.class),
-                eq(new String[]{"/thumbnails/public/Samples/Reports/07g.RevenueDetailReport"}),
+                eq(new String[]{"/thumbnails", "/public/Samples/Reports/07g.RevenueDetailReport"}),
                 any(DefaultErrorHandler.class));
 
     }