Merge branch 'develop'

Author: TanyaEf

README.md

@@ -1783,7 +1783,7 @@ Import/Export
 ###Export service
 The export service works asynchronously: first you request the export with the desired options, then you monitor the state of the export, and finally you request the output file. You must be authenticated as the system admin (superuser) for the export services.
 ```java
-OperationResult<StateDto> operationResult =
+OperationResult<State> operationResult =
         client
                 .authenticate("jasperadmin", "jasperadmin")
                 .exportService()
@@ -1793,19 +1793,64 @@ OperationResult<StateDto> operationResult =
                 .parameter(ExportParameter.EVERYTHING)
                 .create();
 
-StateDto stateDto = operationResult.getEntity();
+State state = operationResult.getEntity();
+
+The export parameters you can specify are:
+
+`everything `- export everything except audit data: all repository resources, permissions, report jobs, users, and roles. This option is equivalent to:--uris --repository-permissions --report-jobs --users --roles
+(default value is false). 
+
+`repository-permissions `- when this option is present, repository permissions are exported along with each exported folder and resource. This option should only be used in conjunction with uris (default value is false).
+
+`role-users `- when this option is present, each role export triggers the export of all users belonging to the role. This option should only be used in conjunction with --roles (default value is false).
+
+`include-access-events `- access events (date, time, and user name of last modification) are exported (default value is false).
+
+`include-audit-events `- include audit data for all resources and users in the export (default value is false).
+ 
+`include-monitoring-events `- include monitoring events (default value is false).
+
+`include-attributes `- include attributes in export (default value is false).
+
+`skip-attribute-values `- skip attributes values to be exported (default value is false).
+
+`include-server-settings`	- include server settings in export(default value is false).
+
+`skip-suborganizations `- if the parameter is set to true, the system will omit all the items(e.g. resources, user, roles, organizations) which belong to "sub organizations" even they are directly specified using corresponding options (default value is false).
+
+`skip-dependent-resources `- skip dependent resources (domain, datasource etc.) to be exported (default value is false). 
+//TODO task
+Also you can specify:
+`uris` - list of folder or resource URIs in the repository  to export.
+`scheduledJobs` - list of repository report unit and folder URIs for which report unit jobs should be exported. For a folder URI, this option exports the scheduled jobs of all reports in the folder and all subfolders.	
+`roles` - list of roles to export.
+`users` - list of users to export.
+`resourceTypes` - list of resource types, that will be included in export. If the parameter is null or empty then will include all resource types.
+`organization` - identifier of organization to export together with its sub organizations. If it is specified it also will be the root organization, starting from it system will export all resources, users, roles e.t.c.
+
+```java
+        OperationResult<State> stateOperationResult = session
+                .exportService()
+                .newTask()
+                .uri("/temp/supermartDomain")
+                .user("jasperadmin")
+                .role("ROLE_USER")
+                .resourceTypes(asList("jdbcDataSource", "reportUnit", "file"))
+                .parameter(ExportParameter.EVERYTHING)
+                .create();
+```
 ```
 ####Checking the Export State
 After receiving the export ID, you can check the state of the export operation.
 ```java
-OperationResult<StateDto> operationResult =
+OperationResult<State> operationResult =
         client
                 .authenticate("jasperadmin", "jasperadmin")
                 .exportService()
-                .task(stateDto.getId())
+                .task(state.getId())
                 .state();
 
-StateDto state = operationResult.getEntity();
+State state = operationResult.getEntity();
 ```
 The body of the response contains the current state of the export operation.
 ####Fetching the Export Output
@@ -1815,7 +1860,7 @@ OperationResult<InputStream> operationResult1 =
         client
                 .authenticate("jasperadmin", "jasperadmin")
                 .exportService()
-                .task(stateDto.getId())
+                .task(state.getId())
                 .fetch();
 
 InputStream inputStream = operationResult1.getEntity();
@@ -1824,27 +1869,74 @@ InputStream inputStream = operationResult1.getEntity();
 Use the following service to upload a catalog as a zip file and import it with the given options. Specify options as arguments from `com.jaspersoft.jasperserver.jaxrs.client.apiadapters.importexport.importservice.ImportParameter`. Arguments that are omitted are assumed to be false. You must be authenticated as the system admin (superuser) for the import service. Jaspersoft does not recommend uploading files greater than 2 gigabytes.
 ```java
 URL url = ImportService.class.getClassLoader().getResource("testExportArchive.zip");
-OperationResult<StateDto> operationResult =
+OperationResult<State> operationResult =
         client
                 .authenticate("jasperadmin", "jasperadmin")
                 .importService()
                 .newTask()
                 .parameter(ImportParameter.INCLUDE_ACCESS_EVENTS, true)
                 .create(new File(url.toURI()));
 
-StateDto stateDto = operationResult.getEntity();
+State state = operationResult.getEntity();
+```
+Available parameters are:
+`includeAccessEvents` - access events (date, time, and user name of last modification) are exported (default value is false).
+`includeAuditEvents` - include audit data for all resources and users in the export (default value is false).
+`update` - resources in the catalog replace those in the repository if their URIs and typesmatch (default value is false).
+`skipUserUpdate` - when used with --update, users in the catalog are not imported or updated. Use this option to import catalogs without overwriting currently defined user  (default value is false).
+`includeMonitoringEvents` - include monitoring events (default value is false).
+`includeServerSettings` - include server settings  (default value is false).
+`mergeOrganization` - allows merging of exported organization/resource into organization with different identifier. In the case if it is false, then system will throw an exception, if exportedOrganizationId != organizationId_we_import_Into (default value is false).
+`brokenDependencies` - defines strategy with broken dependencies. Available values are - fail, skip, include (default value is fail). 
+
+Also you can set:
+`brokenDependencies` - defines strategy with broken dependencies. Available values are:
+
+    fail - server will give an error (errorCode=import.broken.dependencies) if import archive contain broken dependent resources.
+    skip - import will skip from import broken resources.
+	include - import will proceed with broken dependencies. In this case server will try to import broken dependent resources. a) In the case when in target environment there are already dependent resources import of target resource will be success, and resource will be skipped from import if there are no dependent resources to recover dependency chain.
+`parameters` - list of import parameters. 
+`organization` - organization identifier we import into.
+```java
+
 ```
 ####Checking the Import State
 After receiving the import ID, you can check the state of the import operation.
 ```java
-OperationResult<StateDto> operationResult =
+OperationResult<State> operationResult =
         client
                 .authenticate("jasperadmin", "jasperadmin")
                 .importService()
-                .task(stateDto.getId())
+                .task(state.getId())
                 .state();
 
-StateDto state = operationResult.getEntity();
+State state = operationResult.getEntity();
+```
+####Getting and restarting import task
+
+To get import task metadata you can use next code example:
+```java
+        OperationResult<State> operationResult = session
+                .importService()
+                .newTask()
+                .parameter(ImportParameter.INCLUDE_ACCESS_EVENTS, true)
+                .parameter(ImportParameter.UPDATE, true)
+                .create(new File("\\import.zip"));
+        State state = operationResult.getEntity();
+
+        ImportTask task = session
+                .importService()
+                .task(state.getId())
+                .getTask()
+                .getEntity();
+```
+Also you can restart import task:
+```java
+
+        ImportTask task = importService.
+                task(state.getId())
+                .restartTask(new ImportTask().setBrokenDependencies("false"))
+                .getEntity();
 ```
 
 ####DomainMetadata Service

pom.xml

@@ -38,7 +38,7 @@
         <dependency>
             <groupId>com.jaspersoft.jasperserver</groupId>
             <artifactId>jasperserver-dto</artifactId>
-            <version>6.2.0</version>
+            <version>6.2.1</version>
         </dependency>
 
         <!-- Jersey-->
@@ -62,6 +62,11 @@
             <artifactId>jersey-media-json-jackson</artifactId>
             <version>2.22.1</version>
         </dependency>
+        <dependency>
+            <groupId>org.glassfish.jersey.media</groupId>
+            <artifactId>jersey-media-jaxb</artifactId>
+            <version>2.22.1</version>
+        </dependency>
 
         <!-- TestNG -->
         <dependency>

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

@@ -32,6 +32,7 @@
 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;
+import java.util.ArrayList;
 import java.util.Collection;
 import java.util.Iterator;
 import java.util.LinkedList;
@@ -47,27 +48,25 @@
  */
 public class BatchAttributeAdapter extends AbstractAdapter {
 
+    public static final String SERVICE_URI = "attributes";
+    private static final String SEPARATOR = "/";
     private MultivaluedMap<String, String> params = new MultivaluedHashMap<String, String>();
     private Boolean includePermissions = false;
-    private String holderUri;
     private String userName;
     private String organizationId;
-    private final String SEPARATOR = "/";
+    private ArrayList<String> path = new ArrayList<String>();
 
     public BatchAttributeAdapter(String organizationId, String userName, SessionStorage sessionStorage) {
         super(sessionStorage);
-        StringBuilder builder = new StringBuilder(SEPARATOR);
+
         if (!"/" .equals(organizationId) && organizationId != null) {
-            builder.append("organizations/");
-            builder.append(organizationId);
-            builder.append(SEPARATOR);
+            path.add("organizations");
+            path.add(organizationId);
         }
         if (userName != null) {
-            builder.append("users/");
-            builder.append(userName);
-            builder.append(SEPARATOR);
+            path.add("users");
+            path.add(userName);
         }
-        this.holderUri = builder.toString();
         this.organizationId = organizationId;
         this.userName = userName;
     }
@@ -195,10 +194,11 @@ public void run() {
     }
 
     private JerseyRequest<HypermediaAttributesListWrapper> buildRequest() {
+        path.add(SERVICE_URI);
         JerseyRequest<HypermediaAttributesListWrapper> request = JerseyRequest.buildRequest(
                 sessionStorage,
                 HypermediaAttributesListWrapper.class,
-                new String[]{holderUri, "attributes"}, new DefaultErrorHandler());
+                path.toArray(new String[path.size()]), new DefaultErrorHandler());
         if (includePermissions) {
             request.setAccept(MimeTypeUtil.toCorrectAcceptMime(sessionStorage.getConfiguration(), "application/hal+{mime}"));
             request.addParam("_embedded", "permission");
@@ -211,7 +211,7 @@ private JerseyRequest<HypermediaAttributesListWrapper> buildSearchRequest() {
         JerseyRequest<HypermediaAttributesListWrapper> request = JerseyRequest.buildRequest(
                 sessionStorage,
                 HypermediaAttributesListWrapper.class,
-                new String[]{"attributes"}, new DefaultErrorHandler());
+                new String[]{SERVICE_URI}, new DefaultErrorHandler());
         if (includePermissions) {
             request.addParam("_embedded", "permission");
         }

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

@@ -31,6 +31,7 @@
 import com.jaspersoft.jasperserver.jaxrs.client.core.ThreadPoolUtil;
 import com.jaspersoft.jasperserver.jaxrs.client.core.exceptions.handling.DefaultErrorHandler;
 import com.jaspersoft.jasperserver.jaxrs.client.core.operationresult.OperationResult;
+import java.util.ArrayList;
 
 /**
  * @author Alex Krasnyanskiy
@@ -40,24 +41,22 @@
 
 public class SingleAttributeAdapter extends AbstractAdapter {
 
-    private String attributeName;
     private Boolean includePermissions = false;
-    private String holderUri;
+    private ArrayList<String> path = new ArrayList<String>();
 
     public SingleAttributeAdapter(String organizationId, String userName, SessionStorage sessionStorage, String attributeName) {
         super(sessionStorage);
-        StringBuilder builder = new StringBuilder("/");
+
         if (!"/".equals(organizationId) && organizationId != null) {
-            builder.append("organizations/");
-            builder.append(organizationId);
-            builder.append("/");
+            path.add("organizations");
+            path.add(organizationId);
         }
         if (userName != null) {
-            builder.append("users/");
-            builder.append(userName);
+            path.add("users");
+            path.add(userName);
         }
-        this.holderUri = builder.toString();
-        this.attributeName = attributeName;
+        this.path.add("attributes");
+        this.path.add(attributeName);
     }
 
     public SingleAttributeAdapter setIncludePermissions(Boolean includePermissions) {
@@ -133,8 +132,9 @@ public void run() {
 
     private JerseyRequest<HypermediaAttribute> buildRequest() {
 
+        String[] uri = path.toArray(new String[path.size()]);
         JerseyRequest<HypermediaAttribute> request = JerseyRequest.buildRequest(sessionStorage,HypermediaAttribute.class,
-                new String[]{holderUri,"/attributes/",attributeName}, new DefaultErrorHandler());
+                uri, new DefaultErrorHandler());
         if (includePermissions) {
             request.setAccept(MimeTypeUtil.toCorrectAcceptMime(sessionStorage.getConfiguration(), "application/hal+{mime}"));
             request.addParam("_embedded", "permission");

src/main/java/com/jaspersoft/jasperserver/jaxrs/client/apiadapters/authority/organizations/BatchOrganizationsAdapter.java

@@ -35,6 +35,7 @@
 
 public class BatchOrganizationsAdapter extends AbstractAdapter {
 
+    public static final String SERVICE_URI = "organizations";
     private final MultivaluedMap<String, String> params;
 
     public BatchOrganizationsAdapter(SessionStorage sessionStorage) {
@@ -75,7 +76,7 @@ public void run() {
 
     private <T> JerseyRequest<T> buildRequest(Class<T> responseType) {
         return JerseyRequest.buildRequest(sessionStorage, responseType, 
-                new String[]{"/organizations"}, 
+                new String[]{SERVICE_URI},
                 new DefaultErrorHandler());
     }
 }

src/main/java/com/jaspersoft/jasperserver/jaxrs/client/apiadapters/authority/organizations/SingleOrganizationAdapter.java

@@ -35,6 +35,7 @@
 
 public class SingleOrganizationAdapter extends AbstractAdapter {
 
+    public static final String SERVICE_URI = "organizations";
     private final ClientTenant clientTenant;
     private final MultivaluedHashMap<String, String> params;
 
@@ -127,7 +128,7 @@ private JerseyRequest<ClientTenant> buildRequest() {
         return JerseyRequest.buildRequest(
                 sessionStorage,
                 ClientTenant.class,
-                new String[]{"/organizations",
+                new String[]{SERVICE_URI,
                         (clientTenant.getId() == null) ? clientTenant.getAlias() : clientTenant.getId()},
                 new DefaultErrorHandler()
         );
@@ -137,7 +138,7 @@ private JerseyRequest<ClientTenant> request() {
         return JerseyRequest.buildRequest(
                 sessionStorage,
                 ClientTenant.class,
-                new String[]{"/organizations"},
+                new String[]{SERVICE_URI},
                 new DefaultErrorHandler()
         );
     }