Merge pull request #26 from SMATechnologies/develop

Merge Release into master

Author: FinPlorer

.github/workflows/deploy-release.yml

@@ -29,6 +29,6 @@ jobs:
         if: endsWith(steps.version.outputs.version, '-SNAPSHOT') == false
         run: echo -e "${{ secrets.gpg_private_key }}" | gpg --import --batch
 
-      - name: Deploy Snapshot Maven package
+      - name: Deploy Release Maven package
         if: endsWith(steps.version.outputs.version, '-SNAPSHOT') == false
         run: mvn --batch-mode -Dgpg.passphrase="${{ secrets.gpg_passphrase }}" clean deploy

README.md

@@ -22,10 +22,59 @@ Available from Central Maven Repository (https://search.maven.org/artifact/com.s
 <dependency>
     <groupId>com.smatechnologies</groupId>
     <artifactId>opcon-rest-api-client</artifactId>
-    <version>1.0.1</version>
+    <version>1.0.2</version>
 </dependency>
 ```
 
+# Example
+
+```java
+OpconApiProfile profile = new OpconApiProfile("https://localhost:9010/api");
+
+OpconApi opconApi;
+try {
+    Client client = SmClientBuilder.get()
+            .configureDefaultClientBuilder(defaultClientBuilder -> defaultClientBuilder
+                    .setTrustAllCert(true)
+            )
+            .setDebug(true)
+            .setFailOnUnknownProperties(true)
+            .build();
+
+    opconApi = new OpconApi(client, profile, new OpconApi.OpconApiListener() {
+
+        @Override
+        public void onFailed(WsException e) {
+            e.printStackTrace();
+        }
+    });
+
+    opconApi.login("MyOpconUser", "MyOpconPassword");
+
+} catch (KeyManagementException | NoSuchAlgorithmException | WsException e) {
+    e.printStackTrace();
+    return;
+}
+
+try {
+    //Fetch Machines
+    List<Machine> machines = opconApi.machines().get(null);
+
+    //Fetch Roles with machines
+    RolesCriteria rolesCriteria = new RolesCriteria();
+    rolesCriteria.setIncludeMachines(true);
+    List<Role> roles = opconApi.roles().get(rolesCriteria);
+    
+} catch (WsException e) {
+    e.printStackTrace();
+}
+
+try {
+    opconApi.logout();
+} catch (WsException e) {
+    e.printStackTrace();
+}
+```
 # License
 Copyright 2019 SMA Technologies
 

pom.xml

@@ -4,7 +4,7 @@
 
     <groupId>com.smatechnologies</groupId>
     <artifactId>opcon-rest-api-client</artifactId>
-    <version>1.0.2</version>
+    <version>1.0.3</version>
 
     <name>SMA OpCon Library Rest Api Client</name>
     <description>SMA OpCon Library Rest Api Client</description>

src/main/java/com/smatechnologies/opcon/restapiclient/DefaultClientBuilder.java

@@ -1,17 +1,13 @@
 package com.smatechnologies.opcon.restapiclient;
 
-import com.fasterxml.jackson.databind.ObjectMapper;
 import com.smatechnologies.opcon.commons.util.UrlUtil;
-import com.smatechnologies.opcon.restapiclient.jackson.DefaultObjectMapperProvider;
 import org.glassfish.jersey.client.ClientProperties;
 
 import javax.net.ssl.SSLContext;
 import javax.ws.rs.client.Client;
 import javax.ws.rs.client.ClientBuilder;
-import javax.ws.rs.ext.ContextResolver;
 import java.security.KeyManagementException;
 import java.security.NoSuchAlgorithmException;
-import java.util.Objects;
 
 
 /**
@@ -21,9 +17,6 @@ public class DefaultClientBuilder {
 
     private static final String ALGORITHM_PROTOCOL = "TLS";
 
-    private Class<? extends ContextResolver<ObjectMapper>> objectMapperProviderClass = DefaultObjectMapperProvider.class;
-    private ContextResolver<ObjectMapper> objectMapperProvider;
-
     private boolean trustAllCert;
     private Integer connectTimeout;
     private Integer readTimeout;
@@ -35,20 +28,6 @@ public static DefaultClientBuilder get() {
         return new DefaultClientBuilder();
     }
 
-    public DefaultClientBuilder setObjectMapperProviderClass(Class<? extends ContextResolver<ObjectMapper>> objectMapperProviderClass) {
-        this.objectMapperProviderClass = Objects.requireNonNull(objectMapperProviderClass, "ObjectMapperProviderClass cannot be null");
-        objectMapperProvider = null;
-
-        return this;
-    }
-
-    public DefaultClientBuilder setObjectMapperProvider(ContextResolver<ObjectMapper> objectMapperProvider) {
-        this.objectMapperProvider = Objects.requireNonNull(objectMapperProvider, "ObjectMapperProvider cannot be null");
-        objectMapperProviderClass = null;
-
-        return this;
-    }
-
     public DefaultClientBuilder setTrustAllCert(boolean trustAllCert) {
         this.trustAllCert = trustAllCert;
 
@@ -85,13 +64,6 @@ public Client build() throws KeyManagementException, NoSuchAlgorithmException {
             client.property(ClientProperties.READ_TIMEOUT, readTimeout);
         }
 
-        if (objectMapperProviderClass != null) {
-            client.register(objectMapperProviderClass);
-        }
-        if (objectMapperProvider != null) {
-            client.register(objectMapperProvider);
-        }
-
         return client;
     }
 }

src/main/java/com/smatechnologies/opcon/restapiclient/api/OpconApi.java

@@ -1,5 +1,6 @@
 package com.smatechnologies.opcon.restapiclient.api;
 
+import com.fasterxml.jackson.databind.ObjectMapper;
 import com.smatechnologies.opcon.commons.deserializer.DeserializeException;
 import com.smatechnologies.opcon.commons.deserializer.ZonedDateTimeDeserializer;
 import com.smatechnologies.opcon.commons.util.VersionComparator;
@@ -27,6 +28,7 @@
 import com.smatechnologies.opcon.restapiclient.api.masterjobs.WsMasterJobs;
 import com.smatechnologies.opcon.restapiclient.api.masterschedules.WsMasterSchedules;
 import com.smatechnologies.opcon.restapiclient.api.mastervisionworkspaces.WsMasterVisionWorkspaces;
+import com.smatechnologies.opcon.restapiclient.api.propertyexpressions.WsPropertyExpressions;
 import com.smatechnologies.opcon.restapiclient.api.remoteinstances.WsRemoteInstances;
 import com.smatechnologies.opcon.restapiclient.api.repositories.WsRepositories;
 import com.smatechnologies.opcon.restapiclient.api.resources.WsResources;
@@ -55,13 +57,15 @@
 import com.smatechnologies.opcon.restapiclient.api.visionfrequencies.WsVisionFrequencies;
 import com.smatechnologies.opcon.restapiclient.api.visionjobanomalies.WsVisionJobAnomalies;
 import com.smatechnologies.opcon.restapiclient.api.visionstatistic.WsVisionStatistic;
+import com.smatechnologies.opcon.restapiclient.jackson.DefaultObjectMapperProvider;
 import com.smatechnologies.opcon.restapiclient.model.Token;
 import com.smatechnologies.opcon.restapiclient.model.Version;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 import javax.ws.rs.client.Client;
 import javax.ws.rs.core.Response;
+import javax.ws.rs.ext.ContextResolver;
 import java.time.ZonedDateTime;
 
 
@@ -78,13 +82,20 @@ public class OpconApi {
     private static final String API_SERVER_TIME_HEADER_KEY = "apiServerTime";
     private static final String REQUIRED_VERSION = "18.3.0";
 
+    public static final String VERSION_ATTRIBUTE = "version";
+
     private final WsFactory wsFactory;
 
+    private ContextResolver<ObjectMapper> objectMapperProvider;
     private Token token;
     private Version version;
     private ZonedDateTime lastApiServerTime;
 
     public OpconApi(Client client, final OpconApiProfile profile, OpconApiListener opconApiListener) {
+        this(client, profile, opconApiListener, new DefaultObjectMapperProvider());
+    }
+
+    public OpconApi(Client client, final OpconApiProfile profile, OpconApiListener opconApiListener, ContextResolver<ObjectMapper> objectMapperProvider) {
         Ws.WsListener wsListener = new Ws.WsListener() {
 
             @Override
@@ -137,6 +148,9 @@ public void callModifier(Ws ws) {
 
         };
 
+        this.objectMapperProvider = objectMapperProvider;
+        client.register(objectMapperProvider);
+
         wsFactory = new WsFactory(client, profile, wsListener);
     }
 
@@ -174,6 +188,10 @@ private Token init(Token token) throws WsException {
             throw new WsVersionException("Incompatible Version Rest API Server (Required=[" + REQUIRED_VERSION + "] Actual=[" + actualVersion + "])", REQUIRED_VERSION, actualVersion);
         }
 
+        ObjectMapper objectMapper = objectMapperProvider.getContext(Version.class);
+        objectMapper.setConfig(objectMapper.getDeserializationConfig().withAttribute(VERSION_ATTRIBUTE, version.getOpConRestApiProductVersion()));
+        objectMapper.setConfig(objectMapper.getSerializationConfig().withAttribute(VERSION_ATTRIBUTE, version.getOpConRestApiProductVersion()));
+
         return token;
     }
 
@@ -398,6 +416,10 @@ public WsScriptRunners scriptRunners() {
         return new WsScriptRunners(wsFactory);
     }
 
+    public WsPropertyExpressions propertyExpressions() {
+        return new WsPropertyExpressions(wsFactory);
+    }
+
     public interface OpconApiListener {
 
         /**

src/main/java/com/smatechnologies/opcon/restapiclient/api/machinegroups/MachineGroupsCriteria.java

@@ -13,6 +13,9 @@
  */
 public class MachineGroupsCriteria extends AbstractResourcesCriteria<MachineGroupsCriteria.MachineGroupColumns> {
 
+    @ObjMapperField
+    private String name;
+
     @ObjMapperField
     private Collection<Integer> ids;
 
@@ -25,6 +28,14 @@ public class MachineGroupsCriteria extends AbstractResourcesCriteria<MachineGrou
     @ObjMapperField
     private Boolean includeMachines;
 
+    public String getName() {
+        return name;
+    }
+
+    public void setName(String name) {
+        this.name = name;
+    }
+
     public Collection<Integer> getIds() {
         return ids;
     }

src/main/java/com/smatechnologies/opcon/restapiclient/api/machines/WsMachines.java

@@ -4,12 +4,15 @@
 import com.smatechnologies.opcon.restapiclient.WsException;
 import com.smatechnologies.opcon.restapiclient.WsFactory;
 import com.smatechnologies.opcon.restapiclient.WsResult;
+import com.smatechnologies.opcon.restapiclient.model.Calendar;
 import com.smatechnologies.opcon.restapiclient.model.MachineStatusCount;
+import com.smatechnologies.opcon.restapiclient.model.PropertyExpression;
 import com.smatechnologies.opcon.restapiclient.model.machine.Machine;
 
 import javax.ws.rs.core.GenericType;
 import javax.ws.rs.core.Response;
 import java.util.List;
+import java.util.Objects;
 
 
 /**
@@ -53,4 +56,15 @@ public int count(MachinesCriteria criteria) throws WsException {
     public MachineStatusCount countByStatus(MachinesCriteria criteria) throws WsException {
         return wsFactory.create(Ws.Type.GET).path("count_by_status").criteria(criteria).run(MachineStatusCount.class);
     }
+    
+    public Machine put(Machine machine) throws WsException {
+        Objects.requireNonNull(machine, "Machine cannot be null");
+        return wsFactory.create(Ws.Type.PUT, machine).path(String.valueOf(machine.getId())).run(Machine.class);
+    }
+
+    public Machine post(Machine machine) throws WsException {
+        Objects.requireNonNull(machine, "Machine cannot be null");
+        return wsFactory.create(Ws.Type.POST, machine).run(Machine.class);
+    }
+
 }

src/main/java/com/smatechnologies/opcon/restapiclient/api/propertyexpressions/WsPropertyExpressions.java

@@ -0,0 +1,23 @@
+package com.smatechnologies.opcon.restapiclient.api.propertyexpressions;
+
+import java.util.Objects;
+
+import com.smatechnologies.opcon.restapiclient.Ws;
+import com.smatechnologies.opcon.restapiclient.WsException;
+import com.smatechnologies.opcon.restapiclient.WsFactory;
+import com.smatechnologies.opcon.restapiclient.model.PropertyExpression;
+
+public class WsPropertyExpressions {
+
+    private final WsFactory wsFactory;
+
+    public WsPropertyExpressions(WsFactory wsFactory) {
+        this.wsFactory = wsFactory.path("PropertyExpression");
+    }
+
+    public PropertyExpression post(PropertyExpression propertyExpression) throws WsException {
+        Objects.requireNonNull(propertyExpression, "PropertyExpression cannot be null");
+        return wsFactory.create(Ws.Type.POST, propertyExpression).run(PropertyExpression.class);
+    }
+
+}

src/main/java/com/smatechnologies/opcon/restapiclient/api/solutionmanagersettings/SolutionManagerSettingsCriteria.java

@@ -22,6 +22,8 @@ public class SolutionManagerSettingsCriteria extends AbstractResourcesCriteria<S
     private Integer roleId;
     @ObjMapperField
     private Boolean globalOnly;
+    @ObjMapperField("public")
+    private Boolean isPublic;
 
     public Collection<Integer> getIds() {
         return ids;
@@ -63,6 +65,14 @@ public void setGlobalOnly(Boolean globalOnly) {
         this.globalOnly = globalOnly;
     }
 
+    public Boolean getPublic() {
+        return isPublic;
+    }
+
+    public void setPublic(Boolean isPublic) {
+        this.isPublic = isPublic;
+    }
+
     /**
      * Allowed columns on SolutionManagerSettings to specify sort order.
      *

src/main/java/com/smatechnologies/opcon/restapiclient/jackson/deserializer/ListPropertyDeserializer.java

@@ -0,0 +1,51 @@
+package com.smatechnologies.opcon.restapiclient.jackson.deserializer;
+
+import com.fasterxml.jackson.core.JsonParser;
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.DeserializationContext;
+import com.fasterxml.jackson.databind.JsonDeserializer;
+import com.fasterxml.jackson.databind.JsonNode;
+import com.smatechnologies.opcon.commons.util.VersionComparator;
+import com.smatechnologies.opcon.restapiclient.api.OpconApi;
+import com.smatechnologies.opcon.restapiclient.model.Property;
+
+import java.io.IOException;
+import java.util.ArrayList;
+import java.util.List;
+
+
+/**
+ * Jackson's json deserializer for {@link List<Property>}
+ *
+ * @author Pierre PINON
+ */
+public class ListPropertyDeserializer extends JsonDeserializer<List<Property>> {
+
+    @Override
+    public List<Property> deserialize(JsonParser p, DeserializationContext ctxt) throws IOException, JsonProcessingException {
+        String apiVersion = (String) ctxt.getAttribute(OpconApi.VERSION_ATTRIBUTE);
+
+        List<Property> properties = new ArrayList<>();
+
+        JsonNode jsonNode = p.readValueAsTree();
+
+        if (!jsonNode.isArray()) {
+            return null;
+        }
+
+        for (JsonNode node : jsonNode) {
+            Property property = new Property();
+
+            if (new VersionComparator().compare(apiVersion, "19.1.0") >= 0) {
+                property.setKey(node.get(Property.PROPERTY_KEY).asText());
+            } else { //Before 19.1.0
+                property.setKey(node.get(Property.OLD_PROPERTY_NAME).asText());
+            }
+            property.setValue(node.get(Property.PROPERTY_VALUE).asText());
+
+            properties.add(property);
+        }
+
+        return properties;
+    }
+}