Introduce push notifications / webhooks

Author: v-rudkovskiy

NetLicensingClient-demo/src/main/java/com/labs64/netlicensing/examples/CallEveryAPIMethod.java

@@ -70,6 +70,7 @@ public class CallEveryAPIMethod implements NetLicensingExample {
     private static final String randomLicenseeSecret = UUID.randomUUID().toString();
 
     @Override
+    @SuppressWarnings("deprecation")
     public void execute() {
 
         final Context context = new Context();

NetLicensingClient/src/main/java/com/labs64/netlicensing/domain/Constants.java

@@ -101,6 +101,10 @@ public static final class LicenseTemplate {
         public static final String AUTOMATIC = "automatic";
         public static final String HIDDEN = "hidden";
         public static final String HIDE_LICENSES = "hideLicenses";
+        /**
+         * @deprecated Use the NodeLocked licensing model instead.
+         */
+        @Deprecated
         public static final String PROP_LICENSEE_SECRET = "licenseeSecret";
     }
 
@@ -123,6 +127,10 @@ public static final class License {
         public static final String ENDPOINT_PATH = "license";
         public static final String HIDDEN = "hidden";
         public static final String LICENSE_NUMBER = "licenseNumber";
+        /**
+         * @deprecated Use the NodeLocked licensing model instead.
+         */
+        @Deprecated
         public static final String PROP_LICENSEE_SECRET = "licenseeSecret";
     }
 
@@ -211,5 +219,13 @@ public static final class ValidationResult {
         public static final String WARNING_LEVEL = "warningLevel";
     }
 
+    public static final class Notification {
+        public static final String ENDPOINT_PATH = "notification";
+        public static final String EVENTS = "events";
+        public static final String PROTOCOL = "protocol";
+        public static final String ENDPOINT = "endpoint";
+        public static final String PAYLOAD = "payload";
+    }
+
     // CHECKSTYLE:ON
 }

NetLicensingClient/src/main/java/com/labs64/netlicensing/domain/EntityFactory.java

@@ -22,6 +22,7 @@
 import com.labs64.netlicensing.domain.entity.License;
 import com.labs64.netlicensing.domain.entity.LicenseTemplate;
 import com.labs64.netlicensing.domain.entity.Licensee;
+import com.labs64.netlicensing.domain.entity.Notification;
 import com.labs64.netlicensing.domain.entity.PaymentMethod;
 import com.labs64.netlicensing.domain.entity.Product;
 import com.labs64.netlicensing.domain.entity.ProductModule;
@@ -44,6 +45,7 @@
 import com.labs64.netlicensing.schema.converter.ItemToLicenseTypePropertiesConverter;
 import com.labs64.netlicensing.schema.converter.ItemToLicenseeConverter;
 import com.labs64.netlicensing.schema.converter.ItemToLicensingModelPropertiesConverter;
+import com.labs64.netlicensing.schema.converter.ItemToNotificationConverter;
 import com.labs64.netlicensing.schema.converter.ItemToPaymentMethodConverter;
 import com.labs64.netlicensing.schema.converter.ItemToProductConverter;
 import com.labs64.netlicensing.schema.converter.ItemToProductModuleConverter;
@@ -72,6 +74,7 @@ public class EntityFactory {
         entityToConverterMap.put(Country.class, ItemToCountryConverter.class);
         entityToConverterMap.put(LicensingModelProperties.class, ItemToLicensingModelPropertiesConverter.class);
         entityToConverterMap.put(LicenseTypeProperties.class, ItemToLicenseTypePropertiesConverter.class);
+        entityToConverterMap.put(Notification.class, ItemToNotificationConverter.class);
     }
 
     private Map<Class<?>, Converter<Item, ?>> convertersCache;

NetLicensingClient/src/main/java/com/labs64/netlicensing/domain/entity/Notification.java

@@ -0,0 +1,26 @@
+package com.labs64.netlicensing.domain.entity;
+
+import java.util.Set;
+
+import com.labs64.netlicensing.domain.vo.Event;
+import com.labs64.netlicensing.domain.vo.NotificationProtocol;
+
+public interface Notification extends BaseEntity {
+    String getName();
+
+    void setName(String name);
+    
+    Set<Event> getEvents();
+    
+    void setEvents(Set<Event> events);
+
+    void addEvent(final Event event);
+    
+    NotificationProtocol getProtocol();
+
+    void setProtocol(NotificationProtocol notificationProtocol);
+
+    String getPayload();
+
+    void setPayload(String payload);
+}

NetLicensingClient/src/main/java/com/labs64/netlicensing/domain/entity/impl/NotificationImpl.java

@@ -0,0 +1,119 @@
+/* Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.labs64.netlicensing.domain.entity.impl;
+
+import java.util.HashSet;
+import java.util.List;
+import java.util.Set;
+import java.util.stream.Collectors;
+
+import javax.ws.rs.core.MultivaluedMap;
+
+import com.labs64.netlicensing.domain.Constants;
+import com.labs64.netlicensing.domain.entity.Notification;
+import com.labs64.netlicensing.domain.entity.Product;
+import com.labs64.netlicensing.domain.vo.Event;
+import com.labs64.netlicensing.domain.vo.NotificationProtocol;
+
+/**
+ * Default implementation of {@link Product}.
+ */
+public class NotificationImpl extends BaseEntityImpl implements Notification {
+
+    private static final long serialVersionUID = -4059438768485180571L;
+
+	private String name;
+
+    private Set<Event> events = new HashSet<>();
+
+    private NotificationProtocol protocol;
+
+    private String payload;
+
+
+    @Override
+    public String getName() {
+        return name;
+    }
+
+    @Override
+    public void setName(final String name) {
+        this.name = name;
+    }
+
+    @Override
+    public Set<Event> getEvents() {
+        return events;
+    }
+
+    @Override
+    public void setEvents(final Set<Event> events) {
+        this.events = events;
+    }
+
+    @Override
+    public void addEvent(final Event event) {
+        getEvents().add(event);
+    }
+
+    @Override
+    public NotificationProtocol getProtocol() {
+        return protocol;
+    }
+
+    @Override
+    public void setProtocol(final NotificationProtocol protocol) {
+        this.protocol = protocol;
+    }
+
+    @Override
+    public String getPayload() {
+        return payload;
+    }
+
+    @Override
+    public void setPayload(final String payload) {
+        this.payload = payload;
+    }
+
+    public static List<String> getReservedProps() {
+        final List<String> reserved = BaseEntityImpl.getReservedProps();
+        reserved.add(Constants.Notification.EVENTS);
+        reserved.add(Constants.Notification.PROTOCOL);
+        reserved.add(Constants.Notification.ENDPOINT);
+        reserved.add(Constants.Notification.PAYLOAD);
+        return reserved;
+    }
+
+    @Override
+    protected MultivaluedMap<String, Object> asPropertiesMap() {
+        final Set<Event> events = getEvents();
+        final NotificationProtocol protocol = getProtocol();
+
+        final MultivaluedMap<String, Object> map = super.asPropertiesMap();
+        map.add(Constants.NAME, getName());
+        map.add(Constants.Notification.EVENTS, events.stream().map(Enum::name).collect(Collectors.joining(",")));
+
+        if (protocol != null) {
+            map.add(Constants.Notification.PROTOCOL, protocol.name());
+        }
+
+        if (NotificationProtocol.WEBHOOK.equals(protocol)) {
+            map.add(Constants.Notification.ENDPOINT, getProperties().get(Constants.Notification.ENDPOINT));
+        }
+
+        map.add(Constants.Notification.PAYLOAD, getPayload());
+
+        return map;
+    }
+}

NetLicensingClient/src/main/java/com/labs64/netlicensing/domain/vo/Event.java

@@ -0,0 +1,11 @@
+package com.labs64.netlicensing.domain.vo;
+
+import java.util.Arrays;
+
+public enum Event {
+    CREATE_LICENSEE, CREATE_LICENSE;
+
+    public static Event parseString(final String value) {
+        return Arrays.stream(Event.values()).filter((e) -> e.name().equalsIgnoreCase(value)).findFirst().orElse(null);
+    }
+}

NetLicensingClient/src/main/java/com/labs64/netlicensing/domain/vo/NotificationProtocol.java

@@ -0,0 +1,12 @@
+package com.labs64.netlicensing.domain.vo;
+
+import java.util.Arrays;
+
+public enum NotificationProtocol {
+    WEBHOOK;
+
+    public static NotificationProtocol parseString(final String value) {
+        return Arrays.stream(NotificationProtocol.values()).filter((t) -> t.name().equalsIgnoreCase(value))
+                .findFirst().orElse(null);
+    }
+}

NetLicensingClient/src/main/java/com/labs64/netlicensing/domain/vo/ValidationParameters.java

@@ -57,14 +57,23 @@ public String getLicenseeName() {
 
     /**
      * Sets the licensee secret
+     * 
+     * @deprecated Use the NodeLocked licensing model instead.
      *
      * @param licenseeSecret
      *            licensee secret stored on the client side. Refer to Licensee Secret documentation for details.
      */
+    @Deprecated
     public void setLicenseeSecret(final String licenseeSecret) {
         setLicenseeProperty(Constants.Licensee.PROP_LICENSEE_SECRET, licenseeSecret);
     }
 
+    /**
+     * Gets the licensee secret
+     * 
+     * @deprecated Use the NodeLocked licensing model instead.
+     */
+    @Deprecated
     public String getLicenseeSecret() {
         return getLicenseeProperties().get(Constants.Licensee.PROP_LICENSEE_SECRET);
     }

NetLicensingClient/src/main/java/com/labs64/netlicensing/schema/converter/ItemToNotificationConverter.java

@@ -0,0 +1,72 @@
+/* Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.labs64.netlicensing.schema.converter;
+
+import java.util.Arrays;
+import java.util.Set;
+import java.util.stream.Collectors;
+
+import com.labs64.netlicensing.domain.Constants;
+import com.labs64.netlicensing.domain.entity.Notification;
+import com.labs64.netlicensing.domain.entity.Product;
+import com.labs64.netlicensing.domain.entity.impl.NotificationImpl;
+import com.labs64.netlicensing.domain.vo.Event;
+import com.labs64.netlicensing.domain.vo.NotificationProtocol;
+import com.labs64.netlicensing.exception.ConversionException;
+import com.labs64.netlicensing.schema.SchemaFunction;
+import com.labs64.netlicensing.schema.context.Item;
+import com.labs64.netlicensing.schema.context.Property;
+
+/**
+ * Convert {@link Item} entity into {@link Product} object.
+ */
+public class ItemToNotificationConverter extends ItemToEntityBaseConverter<Notification> {
+
+    @Override
+    public Notification convert(final Item source) throws ConversionException {
+        final Notification target = super.convert(source);
+
+        target.setName(SchemaFunction.propertyByName(source.getProperty(), Constants.NAME).getValue());
+
+        final Set<Event> events = Arrays
+                .stream(SchemaFunction.propertyByName(source.getProperty(), Constants.Notification.EVENTS).getValue().split(","))
+                .map(Event::parseString)
+                .collect(Collectors.toSet());
+
+        target.setEvents(events);
+        target.setProtocol(NotificationProtocol.parseString(SchemaFunction.propertyByName(source.getProperty(), Constants.Notification.PROTOCOL).getValue()));
+        
+        final String endpoint = SchemaFunction.propertyByName(source.getProperty(), Constants.Notification.ENDPOINT).getValue();
+
+        if (endpoint != null) {
+            target.addProperty(Constants.Notification.ENDPOINT, endpoint);
+        }
+
+        target.setPayload(SchemaFunction.propertyByName(source.getProperty(), Constants.Notification.PAYLOAD).getValue());
+
+        // Custom properties
+        for (final Property property : source.getProperty()) {
+            if (!NotificationImpl.getReservedProps().contains(property.getName())) {
+                target.addProperty(property.getName(), property.getValue());
+            }
+        }
+
+        return target;
+    }
+
+    @Override
+    public Notification newTarget() {
+        return new NotificationImpl();
+    }
+
+}