Add InstanceEvents to Jackson module

solves codecentric#1348
srempfer · Apr 28, 2020 · 5d25c6b · 5d25c6b
1 parent 53ce34a
commit 5d25c6b
Show file tree

Hide file tree

Showing 14 changed files with 963 additions and 32 deletions.
diff --git a/...c/main/java/de/codecentric/boot/admin/server/domain/events/InstanceDeregisteredEvent.java b/...c/main/java/de/codecentric/boot/admin/server/domain/events/InstanceDeregisteredEvent.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2014-2018 the original author or authors.
+ * Copyright 2014-2020 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -18,6 +18,9 @@
 
 import java.time.Instant;
 
+import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonProperty;
+
 import de.codecentric.boot.admin.server.domain.values.InstanceId;
 
 /**
@@ -30,14 +33,18 @@
 @lombok.ToString(callSuper = true)
 public class InstanceDeregisteredEvent extends InstanceEvent {
 
+	public static final String TYPE = "DEREGISTERED";
+
 	private static final long serialVersionUID = 1L;
 
 	public InstanceDeregisteredEvent(InstanceId instance, long version) {
 		this(instance, version, Instant.now());
 	}
 
-	public InstanceDeregisteredEvent(InstanceId instance, long version, Instant timestamp) {
-		super(instance, version, "DEREGISTERED", timestamp);
+	@JsonCreator
+	public InstanceDeregisteredEvent(@JsonProperty("instance") InstanceId instance,
+			@JsonProperty("version") long version, @JsonProperty("timestamp") Instant timestamp) {
+		super(instance, version, TYPE, timestamp);
 	}
 
 }
diff --git a/...n/java/de/codecentric/boot/admin/server/domain/events/InstanceEndpointsDetectedEvent.java b/...n/java/de/codecentric/boot/admin/server/domain/events/InstanceEndpointsDetectedEvent.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2014-2018 the original author or authors.
+ * Copyright 2014-2020 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -18,6 +18,9 @@
 
 import java.time.Instant;
 
+import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonProperty;
+
 import de.codecentric.boot.admin.server.domain.values.Endpoints;
 import de.codecentric.boot.admin.server.domain.values.InstanceId;
 
@@ -31,6 +34,8 @@
 @lombok.ToString(callSuper = true)
 public class InstanceEndpointsDetectedEvent extends InstanceEvent {
 
+	public static final String TYPE = "ENDPOINTS_DETECTED";
+
 	private static final long serialVersionUID = 1L;
 
 	private final Endpoints endpoints;
@@ -39,8 +44,11 @@ public InstanceEndpointsDetectedEvent(InstanceId instance, long version, Endpoin
 		this(instance, version, Instant.now(), endpoints);
 	}
 
-	public InstanceEndpointsDetectedEvent(InstanceId instance, long version, Instant timestamp, Endpoints endpoints) {
-		super(instance, version, "ENDPOINTS_DETECTED", timestamp);
+	@JsonCreator
+	public InstanceEndpointsDetectedEvent(@JsonProperty("instance") InstanceId instance,
+			@JsonProperty("version") long version, @JsonProperty("timestamp") Instant timestamp,
+			@JsonProperty("endpoints") Endpoints endpoints) {
+		super(instance, version, TYPE, timestamp);
 		this.endpoints = endpoints;
 	}
 

diff --git a/...rc/main/java/de/codecentric/boot/admin/server/domain/events/InstanceInfoChangedEvent.java b/...rc/main/java/de/codecentric/boot/admin/server/domain/events/InstanceInfoChangedEvent.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2014-2018 the original author or authors.
+ * Copyright 2014-2020 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -18,6 +18,9 @@
 
 import java.time.Instant;
 
+import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonProperty;
+
 import de.codecentric.boot.admin.server.domain.values.Info;
 import de.codecentric.boot.admin.server.domain.values.InstanceId;
 
@@ -31,6 +34,8 @@
 @lombok.ToString(callSuper = true)
 public class InstanceInfoChangedEvent extends InstanceEvent {
 
+	public static final String TYPE = "INFO_CHANGED";
+
 	private static final long serialVersionUID = 1L;
 
 	private final Info info;
@@ -39,8 +44,11 @@ public InstanceInfoChangedEvent(InstanceId instance, long version, Info info) {
 		this(instance, version, Instant.now(), info);
 	}
 
-	public InstanceInfoChangedEvent(InstanceId instance, long version, Instant timestamp, Info info) {
-		super(instance, version, "INFO_CHANGED", timestamp);
+	@JsonCreator
+	public InstanceInfoChangedEvent(@JsonProperty("instance") InstanceId instance,
+			@JsonProperty("version") long version, @JsonProperty("timestamp") Instant timestamp,
+			@JsonProperty("info") Info info) {
+		super(instance, version, TYPE, timestamp);
 		this.info = info;
 	}
 

diff --git a/...src/main/java/de/codecentric/boot/admin/server/domain/events/InstanceRegisteredEvent.java b/...src/main/java/de/codecentric/boot/admin/server/domain/events/InstanceRegisteredEvent.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2014-2018 the original author or authors.
+ * Copyright 2014-2020 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -18,6 +18,9 @@
 
 import java.time.Instant;
 
+import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonProperty;
+
 import de.codecentric.boot.admin.server.domain.values.InstanceId;
 import de.codecentric.boot.admin.server.domain.values.Registration;
 
@@ -31,6 +34,8 @@
 @lombok.ToString(callSuper = true)
 public class InstanceRegisteredEvent extends InstanceEvent {
 
+	public static final String TYPE = "REGISTERED";
+
 	private static final long serialVersionUID = 1L;
 
 	private final Registration registration;
@@ -39,8 +44,10 @@ public InstanceRegisteredEvent(InstanceId instance, long version, Registration r
 		this(instance, version, Instant.now(), registration);
 	}
 
-	public InstanceRegisteredEvent(InstanceId instance, long version, Instant timestamp, Registration registration) {
-		super(instance, version, "REGISTERED", timestamp);
+	@JsonCreator
+	public InstanceRegisteredEvent(@JsonProperty("instance") InstanceId instance, @JsonProperty("version") long version,
+			@JsonProperty("timestamp") Instant timestamp, @JsonProperty("registration") Registration registration) {
+		super(instance, version, TYPE, timestamp);
 		this.registration = registration;
 	}
 

diff --git a/...java/de/codecentric/boot/admin/server/domain/events/InstanceRegistrationUpdatedEvent.java b/...java/de/codecentric/boot/admin/server/domain/events/InstanceRegistrationUpdatedEvent.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2014-2018 the original author or authors.
+ * Copyright 2014-2020 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -18,6 +18,9 @@
 
 import java.time.Instant;
 
+import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonProperty;
+
 import de.codecentric.boot.admin.server.domain.values.InstanceId;
 import de.codecentric.boot.admin.server.domain.values.Registration;
 
@@ -31,6 +34,8 @@
 @lombok.ToString(callSuper = true)
 public class InstanceRegistrationUpdatedEvent extends InstanceEvent {
 
+	public static final String TYPE = "REGISTRATION_UPDATED";
+
 	private static final long serialVersionUID = 1L;
 
 	private final Registration registration;
@@ -39,9 +44,11 @@ public InstanceRegistrationUpdatedEvent(InstanceId instance, long version, Regis
 		this(instance, version, Instant.now(), registration);
 	}
 
-	public InstanceRegistrationUpdatedEvent(InstanceId instance, long version, Instant timestamp,
-			Registration registration) {
-		super(instance, version, "REGISTRATION_UPDATED", timestamp);
+	@JsonCreator
+	public InstanceRegistrationUpdatedEvent(@JsonProperty("instance") InstanceId instance,
+			@JsonProperty("version") long version, @JsonProperty("timestamp") Instant timestamp,
+			@JsonProperty("registration") Registration registration) {
+		super(instance, version, TYPE, timestamp);
 		this.registration = registration;
 	}
 

diff --git a/.../main/java/de/codecentric/boot/admin/server/domain/events/InstanceStatusChangedEvent.java b/.../main/java/de/codecentric/boot/admin/server/domain/events/InstanceStatusChangedEvent.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2014-2018 the original author or authors.
+ * Copyright 2014-2020 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -18,6 +18,9 @@
 
 import java.time.Instant;
 
+import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonProperty;
+
 import de.codecentric.boot.admin.server.domain.values.InstanceId;
 import de.codecentric.boot.admin.server.domain.values.StatusInfo;
 
@@ -31,6 +34,8 @@
 @lombok.ToString(callSuper = true)
 public class InstanceStatusChangedEvent extends InstanceEvent {
 
+	public static final String TYPE = "STATUS_CHANGED";
+
 	private static final long serialVersionUID = 1L;
 
 	private final StatusInfo statusInfo;
@@ -39,8 +44,11 @@ public InstanceStatusChangedEvent(InstanceId instance, long version, StatusInfo
 		this(instance, version, Instant.now(), statusInfo);
 	}
 
-	public InstanceStatusChangedEvent(InstanceId instance, long version, Instant timestamp, StatusInfo statusInfo) {
-		super(instance, version, "STATUS_CHANGED", timestamp);
+	@JsonCreator
+	public InstanceStatusChangedEvent(@JsonProperty("instance") InstanceId instance,
+			@JsonProperty("version") long version, @JsonProperty("timestamp") Instant timestamp,
+			@JsonProperty("statusInfo") StatusInfo statusInfo) {
+		super(instance, version, TYPE, timestamp);
 		this.statusInfo = statusInfo;
 	}
 

diff --git a/...t-admin-server/src/main/java/de/codecentric/boot/admin/server/domain/values/Endpoint.java b/...t-admin-server/src/main/java/de/codecentric/boot/admin/server/domain/values/Endpoint.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2014-2018 the original author or authors.
+ * Copyright 2014-2020 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -18,6 +18,8 @@
 
 import java.io.Serializable;
 
+import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonProperty;
 import org.springframework.util.Assert;
 
 @lombok.Data
@@ -52,7 +54,8 @@ private Endpoint(String id, String url) {
 		this.url = url;
 	}
 
-	public static Endpoint of(String id, String url) {
+	@JsonCreator
+	public static Endpoint of(@JsonProperty("id") String id, @JsonProperty("url") String url) {
 		return new Endpoint(id, url);
 	}
 

diff --git a/...-admin-server/src/main/java/de/codecentric/boot/admin/server/domain/values/Endpoints.java b/...-admin-server/src/main/java/de/codecentric/boot/admin/server/domain/values/Endpoints.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2014-2019 the original author or authors.
+ * Copyright 2014-2020 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -28,6 +28,8 @@
 
 import javax.annotation.Nullable;
 
+import com.fasterxml.jackson.annotation.JsonCreator;
+
 import static java.util.stream.Collectors.toMap;
 
 @lombok.EqualsAndHashCode
@@ -68,6 +70,7 @@ public static Endpoints single(String id, String url) {
 		return new Endpoints(Collections.singletonList(Endpoint.of(id, url)));
 	}
 
+	@JsonCreator
 	public static Endpoints of(@Nullable Collection<Endpoint> endpoints) {
 		if (endpoints == null || endpoints.isEmpty()) {
 			return empty();

diff --git a/...-boot-admin-server/src/main/java/de/codecentric/boot/admin/server/domain/values/Info.java b/...-boot-admin-server/src/main/java/de/codecentric/boot/admin/server/domain/values/Info.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2014-2018 the original author or authors.
+ * Copyright 2014-2020 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -24,6 +24,7 @@
 import javax.annotation.Nullable;
 
 import com.fasterxml.jackson.annotation.JsonAnyGetter;
+import com.fasterxml.jackson.annotation.JsonCreator;
 
 /**
  * Represents the info fetched from the info actuator endpoint
@@ -46,6 +47,7 @@ private Info(Map<String, Object> values) {
 		}
 	}
 
+	@JsonCreator
 	public static Info from(@Nullable Map<String, Object> values) {
 		if (values == null || values.isEmpty()) {
 			return empty();

diff --git a/...admin-server/src/main/java/de/codecentric/boot/admin/server/domain/values/StatusInfo.java b/...admin-server/src/main/java/de/codecentric/boot/admin/server/domain/values/StatusInfo.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2014-2018 the original author or authors.
+ * Copyright 2014-2020 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -25,7 +25,9 @@
 
 import javax.annotation.Nullable;
 
+import com.fasterxml.jackson.annotation.JsonCreator;
 import com.fasterxml.jackson.annotation.JsonIgnore;
+import com.fasterxml.jackson.annotation.JsonProperty;
 import org.springframework.util.Assert;
 
 import static java.util.Arrays.asList;
@@ -63,7 +65,9 @@ private StatusInfo(String status, @Nullable Map<String, ?> details) {
 		this.details = (details != null) ? new HashMap<>(details) : Collections.emptyMap();
 	}
 
-	public static StatusInfo valueOf(String statusCode, @Nullable Map<String, ?> details) {
+	@JsonCreator
+	public static StatusInfo valueOf(@JsonProperty("status") String statusCode,
+			@JsonProperty("details") @Nullable Map<String, ?> details) {
 		return new StatusInfo(statusCode, details);
 	}
 

diff --git a/...erver/src/main/java/de/codecentric/boot/admin/server/utils/jackson/AdminServerModule.java b/...erver/src/main/java/de/codecentric/boot/admin/server/utils/jackson/AdminServerModule.java
@@ -18,10 +18,17 @@
 
 import com.fasterxml.jackson.databind.module.SimpleModule;
 
+import de.codecentric.boot.admin.server.domain.events.InstanceEvent;
 import de.codecentric.boot.admin.server.domain.values.Registration;
 
 /**
- * Jackson module for Spring Boot Admin Server.
+ * Jackson module for Spring Boot Admin Server. <br>
+ * In order to use this module just add this modules into your ObjectMapper configuration.
+ * <pre>
+ *     ObjectMapper mapper = new ObjectMapper();
+ *     mapper.registerModule(new AdminServerModule());
+ *     mapper.registerModule(new JavaTimeModule());
+ * </pre>
  *
  * @author Stefan Rempfer
  */
@@ -37,6 +44,7 @@ public AdminServerModule(String[] metadataKeyPatterns) {
 
 		addDeserializer(Registration.class, new RegistrationDeserializer());
 		setSerializerModifier(new RegistrationBeanSerializerModifier(new SanitizingMapSerializer(metadataKeyPatterns)));
+		setMixInAnnotation(InstanceEvent.class, InstanceEventMixin.class);
 	}
 
 }