Merge pull request SORMAS-Foundation#3979 from hzi-braunschweig/feature-3927-Add-system-events-entity-2

Feature 3927 add system events entity 2

Author: FredrikSchaefer

sormas-api/src/main/java/de/symeda/sormas/api/ConfigFacade.java

@@ -85,6 +85,8 @@ public interface ConfigFacade {
 
 	int getDaysAfterEventGetsArchived();
 
+	int getDaysAfterSystemEventGetsDeleted();
+
 	GeoLatLon getCountryCenter();
 
 	int getMapZoom();

sormas-api/src/main/java/de/symeda/sormas/api/FacadeProvider.java

@@ -64,6 +64,7 @@
 import de.symeda.sormas.api.sormastosormas.SormasToSormasFacade;
 import de.symeda.sormas.api.survnet.SurvnetGatewayFacade;
 import de.symeda.sormas.api.symptoms.SymptomsFacade;
+import de.symeda.sormas.api.systemevents.SystemEventFacade;
 import de.symeda.sormas.api.task.TaskFacade;
 import de.symeda.sormas.api.therapy.PrescriptionFacade;
 import de.symeda.sormas.api.therapy.TherapyFacade;
@@ -160,6 +161,7 @@ public static FacilityFacade getFacilityFacade() {
 	public static CountryFacade getCountryFacade() {
 		return get().lookupEjbRemote(CountryFacade.class);
 	}
+
 	public static RegionFacade getRegionFacade() {
 		return get().lookupEjbRemote(RegionFacade.class);
 	}
@@ -320,6 +322,11 @@ public static DocumentFacade getDocumentFacade() {
 		return get().lookupEjbRemote(DocumentFacade.class);
 	}
 
+	public static SystemEventFacade getSystemEventFacade() {
+
+		return get().lookupEjbRemote(SystemEventFacade.class);
+	}
+
 	@SuppressWarnings("unchecked")
 	public <P> P lookupEjbRemote(Class<P> clazz) {
 		try {

sormas-api/src/main/java/de/symeda/sormas/api/systemevents/SystemEventDto.java

@@ -0,0 +1,64 @@
+package de.symeda.sormas.api.systemevents;
+
+import de.symeda.sormas.api.EntityDto;
+import de.symeda.sormas.api.labmessage.LabMessageDto;
+import de.symeda.sormas.api.utils.DataHelper;
+
+import java.util.Date;
+
+public class SystemEventDto extends EntityDto {
+
+	private SystemEventType type;
+	private Date startDate;
+	private Date endDate;
+	private SystemEventStatus status;
+	private String additionalInfo;
+
+	public SystemEventType getType() {
+		return type;
+	}
+
+	public void setType(SystemEventType type) {
+		this.type = type;
+	}
+
+	public Date getStartDate() {
+		return startDate;
+	}
+
+	public void setStartDate(Date startDate) {
+		this.startDate = startDate;
+	}
+
+	public Date getEndDate() {
+		return endDate;
+	}
+
+	public void setEndDate(Date endDate) {
+		this.endDate = endDate;
+	}
+
+	public SystemEventStatus getStatus() {
+		return status;
+	}
+
+	public void setStatus(SystemEventStatus status) {
+		this.status = status;
+	}
+
+	public String getAdditionalInfo() {
+		return additionalInfo;
+	}
+
+	public void setAdditionalInfo(String additionalInfo) {
+		this.additionalInfo = additionalInfo;
+	}
+
+	public static SystemEventDto build() {
+
+		SystemEventDto systemEvent = new SystemEventDto();
+		systemEvent.setUuid(DataHelper.createUuid());
+		return systemEvent;
+	}
+
+}

sormas-api/src/main/java/de/symeda/sormas/api/systemevents/SystemEventFacade.java

@@ -0,0 +1,18 @@
+package de.symeda.sormas.api.systemevents;
+
+import javax.ejb.Remote;
+import java.util.Date;
+
+/**
+ * As subsequent manipulation of SystemEvents is undesired, this Facade shall not provide methods to fetch specific SystemEvents.
+ */
+@Remote
+public interface SystemEventFacade {
+
+	Date getLatestSuccessByType(SystemEventType type);
+
+	void saveSystemEvent(SystemEventDto dto);
+
+	void deleteAllDeletableSystemEvents(int daysAfterSystemEventGetsDeleted);
+
+}

sormas-api/src/main/java/de/symeda/sormas/api/systemevents/SystemEventStatus.java

@@ -0,0 +1,15 @@
+package de.symeda.sormas.api.systemevents;
+
+import de.symeda.sormas.api.i18n.I18nProperties;
+
+public enum SystemEventStatus {
+
+	STARTED,
+	SUCCESS,
+	CANCELLED,
+	ERROR;
+
+	public String toString() {
+		return I18nProperties.getEnumCaption(this);
+	}
+}

sormas-api/src/main/java/de/symeda/sormas/api/systemevents/SystemEventType.java

@@ -0,0 +1,5 @@
+package de.symeda.sormas.api.systemevents;
+
+public enum SystemEventType {
+	FETCH_LAB_MESSAGES
+}

sormas-backend/src/main/java/de/symeda/sormas/backend/common/ConfigFacadeEjb.java

@@ -108,6 +108,8 @@ public class ConfigFacadeEjb implements ConfigFacade {
 	public static final String DAYS_AFTER_CASE_GETS_ARCHIVED = "daysAfterCaseGetsArchived";
 	private static final String DAYS_AFTER_EVENT_GETS_ARCHIVED = "daysAfterEventGetsArchived";
 
+	private static final String DAYS_AFTER_SYSTEM_EVENT_GETS_DELETED = "daysAfterSystemEventGetsDeleted";
+
 	private static final String GEOCODING_SERVICE_URL_TEMPLATE = "geocodingServiceUrlTemplate";
 	private static final String GEOCODING_LONGITUDE_JSON_PATH = "geocodingLongitudeJsonPath";
 	private static final String GEOCODING_LATITUDE_JSON_PATH = "geocodingLatitudeJsonPath";
@@ -373,6 +375,11 @@ public int getDaysAfterEventGetsArchived() {
 		return getInt(DAYS_AFTER_EVENT_GETS_ARCHIVED, 90);
 	}
 
+	@Override
+	public int getDaysAfterSystemEventGetsDeleted() {
+		return getInt(DAYS_AFTER_SYSTEM_EVENT_GETS_DELETED, 90);
+	}
+
 	@Override
 	public String getGeocodingServiceUrlTemplate() {
 		return getProperty(GEOCODING_SERVICE_URL_TEMPLATE, null);

sormas-backend/src/main/java/de/symeda/sormas/backend/common/CronService.java

@@ -25,6 +25,7 @@
 import javax.ejb.Schedule;
 import javax.ejb.Singleton;
 
+import de.symeda.sormas.backend.systemevent.SystemEventFacadeEjb.SystemEventFacadeEjbLocal;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -65,6 +66,8 @@ public class CronService {
 	private EventFacadeEjbLocal eventFacade;
 	@EJB
 	private DocumentFacadeEjbLocal documentFacade;
+	@EJB
+	private SystemEventFacadeEjbLocal systemEventFacade;
 
 	@Schedule(hour = "*", minute = "*/" + TASK_UPDATE_INTERVAL, second = "0", persistent = false)
 	public void sendNewAndDueTaskMessages() {
@@ -138,4 +141,13 @@ public void archiveEvents() {
 	public void cleanupDeletedDocuments() {
 		documentFacade.cleanupDeletedDocuments();
 	}
+
+	@Schedule(hour = "1", minute = "30", second = "0", persistent = false)
+	public void deleteSystemEvents() {
+		int daysAfterSystemEventGetsDeleted = configFacade.getDaysAfterSystemEventGetsDeleted();
+		if (daysAfterSystemEventGetsDeleted >= 1) {
+			systemEventFacade.deleteAllDeletableSystemEvents(daysAfterSystemEventGetsDeleted);
+		}
+	}
+
 }

sormas-backend/src/main/java/de/symeda/sormas/backend/systemevent/SystemEvent.java

@@ -0,0 +1,106 @@
+package de.symeda.sormas.backend.systemevent;
+
+import de.symeda.auditlog.api.Audited;
+import de.symeda.sormas.api.systemevents.SystemEventStatus;
+import de.symeda.sormas.api.systemevents.SystemEventType;
+import de.symeda.sormas.backend.common.AbstractDomainObject;
+
+import javax.persistence.Column;
+import javax.persistence.Entity;
+import javax.persistence.EnumType;
+import javax.persistence.Enumerated;
+import javax.persistence.Temporal;
+import javax.persistence.TemporalType;
+import javax.validation.constraints.NotNull;
+import java.util.Date;
+import java.util.Objects;
+
+import static de.symeda.sormas.api.EntityDto.COLUMN_LENGTH_DEFAULT;
+
+@Entity
+@Audited
+public class SystemEvent extends AbstractDomainObject {
+
+	public static final String TABLE_NAME = "systemevent";
+
+	public static final String TYPE = "type";
+	public static final String START_DATE = "startDate";
+	public static final String END_DATE = "endDate";
+	public static final String STATUS = "status";
+	public static final String ADDITIONAL_INFO = "additionalInfo";
+
+	private SystemEventType type;
+	private Date startDate;
+	private Date endDate;
+	private SystemEventStatus status;
+	private String additionalInfo;
+
+	@Enumerated(EnumType.STRING)
+	@Column(nullable = false)
+	public SystemEventType getType() {
+		return type;
+	}
+
+	public void setType(SystemEventType type) {
+		this.type = type;
+	}
+
+	@Temporal(TemporalType.TIMESTAMP)
+	@Column(nullable = false)
+	public Date getStartDate() {
+		return startDate;
+	}
+
+	public void setStartDate(Date startDate) {
+		this.startDate = startDate;
+	}
+
+	@Temporal(TemporalType.TIMESTAMP)
+	public Date getEndDate() {
+		return endDate;
+	}
+
+	public void setEndDate(Date endDate) {
+		this.endDate = endDate;
+	}
+
+	@Enumerated(EnumType.STRING)
+	@Column(nullable = false)
+	public SystemEventStatus getStatus() {
+		return status;
+	}
+
+	public void setStatus(SystemEventStatus status) {
+		this.status = status;
+	}
+
+	@Column(columnDefinition = "text")
+	public String getAdditionalInfo() {
+		return additionalInfo;
+	}
+
+	public void setAdditionalInfo(String additionalInfo) {
+		this.additionalInfo = additionalInfo;
+	}
+
+	@Override
+	public boolean equals(Object o) {
+		if (this == o)
+			return true;
+		if (o == null || getClass() != o.getClass())
+			return false;
+		if (!super.equals(o))
+			return false;
+		SystemEvent that = (SystemEvent) o;
+		return type == that.type
+			&& Objects.equals(startDate, that.startDate)
+			&& Objects.equals(endDate, that.endDate)
+			&& status == that.status
+			&& Objects.equals(additionalInfo, that.additionalInfo);
+	}
+
+	@Override
+	public int hashCode() {
+		return Objects.hash(super.hashCode(), type, startDate, endDate, status, additionalInfo);
+	}
+}