package ca.cdr.api.model.json;

/*
 * #%L
 * Smile CDR - CDR
 * %%
 * Copyright (C) 2016 - 2026 Smile CDR, Inc.
 * %%
 * All rights reserved.
 * #L%
 */

import ca.cdr.api.model.enm.AuthenticatedUserTypeEnum;
import ca.cdr.api.model.json.jackson2deprecated.JsonDateDeserializerJacksonV2Deprecated;
import ca.cdr.api.model.json.jackson2deprecated.JsonDateSerializerJacksonV2Deprecated;
import com.fasterxml.jackson.annotation.JsonProperty;
import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.media.Schema;
import jakarta.validation.Valid;
import jakarta.validation.constraints.NotBlank;
import jakarta.validation.constraints.NotNull;
import tools.jackson.databind.annotation.JsonDeserialize;
import tools.jackson.databind.annotation.JsonSerialize;

import java.time.Instant;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Date;
import java.util.List;

import static org.apache.commons.lang3.StringUtils.isNotBlank;

/**
 * This class represents a single Audit Event, with nested objects for all related audit data.
 *
 * Also see {@link StringifiedCollectionMixin} to see how we flatten high cardinality elements during CSV export.
 */
public class AuditEventJson implements IModelJson {
        @JsonProperty("id")
        private Long myId;

        @JsonProperty("transactionGuid")
        private String myTransactionGuid;

        @JsonProperty("requestId")
        private String myRequestId;

        @NotBlank
        @JsonProperty("endpointModuleId")
        private String myEndpointModuleId;

        @NotBlank
        @JsonProperty("endpointNodeId")
        private String myEndpointNodeId;
        // Nullable
        @JsonProperty("remoteAddress")
        private String myRemoteAddress;

        @Valid
        @JsonProperty("targetModules")
        private Collection<AuditEventTargetModuleJson> myTargetModules;

        @Valid
        @JsonProperty("targetResources")
        private List<AuditEventTargetResourceJson> myTargetResources;

        @Valid
        @JsonProperty("targetUsers")
        private Collection<AuditEventTargetUserJson> myTargetUsers;

        @JsonProperty("targetRequestId")
        @Parameter(
                        description =
                                        "If the target of this audit event is a transaction log item (i.e. we are auditing the viewing of the transaction log) this is the Request ID for the transaction log entry in question")
        private String myTargetRequestId;

        @NotNull
        @JsonProperty("timestamp")
        @com.fasterxml.jackson.databind.annotation.JsonSerialize(using = JsonDateSerializerJacksonV2Deprecated.class)
        @JsonSerialize(using = JsonDateSerializer.class)
        @com.fasterxml.jackson.databind.annotation.JsonDeserialize(using = JsonDateDeserializerJacksonV2Deprecated.class)
        @JsonDeserialize(using = JsonDateDeserializer.class)
        private Date myTimestamp;

        @NotBlank
        @JsonProperty("typeCode")
        private String myTypeCode;

        @NotBlank
        @JsonProperty("typeDisplay")
        private String myTypeDisplay;

        @NotBlank
        @JsonProperty("typeSystem")
        private String myTypeSystem;

        @JsonProperty("familyName")
        private String myUserFamilyName;

        @JsonProperty("givenName")
        private String myUserGivenName;

        @JsonProperty("userId")
        private Long myUserId;

        @JsonProperty("username")
        private String myUsername;

        @JsonProperty("userModuleId")
        private String myUserModuleId;

        @JsonProperty("userNodeId")
        private String myUserNodeId;

        @JsonProperty("authenticatedUserType")
        @NotNull
        @Parameter(
                        description =
                                        "Was the authentication performed by a user (generally a person) or a client (generally a system)")
        private AuthenticatedUserTypeEnum myAuthenticatedUserType;

        @JsonProperty("clientNodeId")
        @Parameter(
                        description =
                                        "If this event was received from an OAuth2 client, this is the node ID of the module that supplied the client definition")
        private String myClientNodeId;

        @JsonProperty("clientModuleId")
        @Parameter(
                        description =
                                        "If this event was received from an OAuth2 client, this is the module ID of the module that supplied the client definition")
        private String myClientModuleId;

        @JsonProperty("clientId")
        @Parameter(description = "If this event was received from an OAuth2 client, this is the client ID")
        private String myClientId;

        @JsonProperty("clientPid")
        @Schema(
                        description = "If this event was received from an OAuth2 client, this is the client PID",
                        accessMode = Schema.AccessMode.READ_ONLY)
        private Long myClientPid;

        @JsonProperty("clientName")
        @Parameter(description = "If this event was received from an OAuth2 client, this is the client name")
        private String myClientName;

        @JsonProperty("headers")
        @Parameter(
                        description =
                                        "A list of headers to be stored in the audit event. This can be configured to change which headers are persisted.")
        private Collection<AuditEventHeaderJson> myHeaders;

        @JsonProperty("additionalJson")
        @Parameter(description = "Additional desired JSON to be logged")
        private String myAdditionalJson;
        /**
         * Constructor
         */
        public AuditEventJson() {
                super();
        }

        public String getRequestId() {
                return myRequestId;
        }

        public void setRequestId(String theRequestId) {
                myRequestId = theRequestId;
        }

        public Long getClientPid() {
                return myClientPid;
        }

        public void setClientPid(Long theClientPid) {
                myClientPid = theClientPid;
        }

        public String getClientName() {
                return myClientName;
        }

        public void setClientName(String theClientName) {
                myClientName = theClientName;
        }

        public String getClientNodeId() {
                return myClientNodeId;
        }

        public void setClientNodeId(String theClientNodeId) {
                myClientNodeId = theClientNodeId;
        }

        public String getClientModuleId() {
                return myClientModuleId;
        }

        public void setClientModuleId(String theClientModuleId) {
                myClientModuleId = theClientModuleId;
        }

        public String getClientId() {
                return myClientId;
        }

        public void setClientId(String theClientId) {
                myClientId = theClientId;
        }

        public String getEndpointModuleId() {
                return myEndpointModuleId;
        }

        public void setEndpointModuleId(String theModuleId) {
                myEndpointModuleId = theModuleId;
        }

        public String getEndpointNodeId() {
                return myEndpointNodeId;
        }

        public void setEndpointNodeId(String theNodeId) {
                myEndpointNodeId = theNodeId;
        }

        public Long getId() {
                return myId;
        }

        public void setId(Long theId) {
                myId = theId;
        }

        public String getUserModuleId() {
                return myUserModuleId;
        }

        public void setUserModuleId(String theModuleId) {
                myUserModuleId = theModuleId;
        }

        public String getUserNodeId() {
                return myUserNodeId;
        }

        public void setUserNodeId(String theNodeId) {
                myUserNodeId = theNodeId;
        }

        public String getRemoteAddress() {
                return myRemoteAddress;
        }

        public void setRemoteAddress(String theRemoteAddress) {
                myRemoteAddress = theRemoteAddress;
        }

        public Collection<AuditEventTargetModuleJson> getTargetModules() {
                if (myTargetModules == null) {
                        myTargetModules = new ArrayList<>();
                }
                return myTargetModules;
        }

        public List<AuditEventTargetResourceJson> getTargetResources() {
                if (myTargetResources == null) {
                        myTargetResources = new ArrayList<>();
                }
                return myTargetResources;
        }

        public Collection<AuditEventTargetUserJson> getTargetUsers() {
                if (myTargetUsers == null) {
                        myTargetUsers = new ArrayList<>();
                }
                return myTargetUsers;
        }

        public Collection<AuditEventHeaderJson> getHeaders() {
                if (myHeaders == null) {
                        myHeaders = new ArrayList<>();
                }
                return myHeaders;
        }

        public String getAdditionalJson() {
                return myAdditionalJson;
        }

        public void setAdditionalJson(String theAdditionalJson) {
                myAdditionalJson = theAdditionalJson;
        }

        public Date getTimestamp() {
                return myTimestamp;
        }

        public void setTimestamp(Instant theTimestamp) {
                myTimestamp = new Date(theTimestamp.toEpochMilli());
        }

        public void setTimestamp(Date theTimestamp) {
                myTimestamp = theTimestamp;
        }

        public String getTypeCode() {
                return myTypeCode;
        }

        public void setTypeCode(String theCode) {
                myTypeCode = theCode;
        }

        public String getTypeDisplay() {
                return myTypeDisplay;
        }

        public void setTypeDisplay(String theTypeDisplay) {
                myTypeDisplay = theTypeDisplay;
        }

        public String getTypeSystem() {
                return myTypeSystem;
        }

        public void setTypeSystem(String theSystem) {
                myTypeSystem = theSystem;
        }

        public String getUserFamilyName() {
                return myUserFamilyName;
        }

        public void setUserFamilyName(String theUserFamilyName) {
                myUserFamilyName = theUserFamilyName;
        }

        public String getUserGivenName() {
                return myUserGivenName;
        }

        public void setUserGivenName(String theUserGivenName) {
                myUserGivenName = theUserGivenName;
        }

        public Long getUserId() {
                return myUserId;
        }

        public void setUserId(Long theUserId) {
                myUserId = theUserId;
        }

        public String getUsername() {
                return myUsername;
        }

        public void setUsername(String theUsername) {
                myUsername = theUsername;
        }

        @SuppressWarnings("unused") // Called by Web Admin Console
        public boolean hasTargets() {
                return getTargetModules().isEmpty() == false
                                || getTargetResources().isEmpty() == false
                                || getTargetUsers().isEmpty() == false
                                || isNotBlank(myTargetRequestId);
        }

        public AuthenticatedUserTypeEnum getAuthenticatedUserType() {
                return myAuthenticatedUserType;
        }

        public void setAuthenticatedUserType(AuthenticatedUserTypeEnum theAuthenticatedUserType) {
                myAuthenticatedUserType = theAuthenticatedUserType;
        }

        /**
         * If the target of this audit event is a transaction log item (i.e. we are auditing the viewing of the transaction log) this is the Request ID for the transaction log entry in question
         */
        public String getTargetRequestId() {
                return myTargetRequestId;
        }

        /**
         * If the target of this audit event is a transaction log item (i.e. we are auditing the viewing of the transaction log) this is the Request ID for the transaction log entry in question
         */
        public void setTargetRequestId(String theTargetRequestId) {
                myTargetRequestId = theTargetRequestId;
        }

        public String getTransactionGuid() {
                return myTransactionGuid;
        }

        public void setTransactionGuid(String theTransactionGuid) {
                myTransactionGuid = theTransactionGuid;
        }
}