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.Oauth2ClientAuthenticationMethodEnum;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import io.swagger.v3.oas.annotations.media.Schema;

import java.io.Serializable;
import java.util.Date;

import static ca.cdr.api.model.json.OAuth2ServerJson.ISSUER;
import static ca.cdr.api.model.json.OAuth2ServerJson.MODULE_ID;
import static ca.cdr.api.model.json.OAuth2ServerJson.NAME;
import static ca.cdr.api.model.json.OAuth2ServerJson.NODE_ID;
import static ca.cdr.api.model.json.OAuth2ServerJson.PID;

@Schema(name = "OAuth2Server", description = "An OAuth2/OpenID Connect server definition")
@JsonPropertyOrder(
                value = {PID, NODE_ID, MODULE_ID, ISSUER, NAME},
                alphabetic = true)
public class OAuth2ServerJson implements IModelJson, Serializable {
        public static final String PID = "pid";
        public static final String NAME = "name";
        public static final String ISSUER = "issuer";
        public static final String NODE_ID = "nodeId";
        public static final String MODULE_ID = "moduleId";

        @JsonProperty(value = PID)
        @Schema(description = "The internal persistence ID for this provider.", accessMode = Schema.AccessMode.READ_ONLY)
        private Long myPid;

        @JsonProperty(value = NAME)
        @Schema(description = "A user friendly name/description of this provider.")
        private String myName;

        @JsonProperty(value = ISSUER)
        @Schema(description = "The issuer URL.")
        private String myIssuer;

        @JsonProperty(value = "tokenIntrospectionClientId")
        @Schema(
                        description =
                                        "The client ID to use when performing token introspection against this provider. The client ID and client secret may also be used for client authentication during code exchange if the `federationClientAuthenticationMethod` is set to a client secret method.")
        private String myTokenIntrospectionClientId;

        @JsonProperty(value = "tokenIntrospectionClientSecret")
        @Schema(
                        description =
                                        "The client secret to use when performing token introspection against this provider. The client ID and client secret may also be used for client authentication during code exchange if the `federationClientAuthenticationMethod` is set to a client secret method.")
        private String myTokenIntrospectionClientSecret;

        @JsonProperty(value = NODE_ID)
        @Schema(description = "The Node ID for the security module that this definition applies to.")
        private String myNodeId;

        @JsonProperty(value = MODULE_ID)
        @Schema(description = "The security Module ID that this definition applies to.")
        private String myModuleId;

        @JsonProperty(value = "validationJwkText")
        @Schema(
                        description =
                                        "A JSON document containing the JWK Set containing the public key used to validate signed tokens issued by this server. This is not required for federated server definitions but is required otherwise. This field does not need to be populated if the JWKS can be fetched using the well-known OpenID Connect configuration URL.")
        private String myValidationJwkText;

        @JsonProperty(value = "validationJwkFile")
        @Schema(
                        description =
                                        "A local file path / classpath to use to supply the JWK Set containing the public key used to validate signed tokens issued by this server. This field applies only to non-federated providers. This field does not need to be populated if the JWKS can be fetched using the well-known OpenID Connect configuration URL.")
        private String myValidationJwkFile;

        @JsonProperty(value = "federationRegistrationId")
        @Schema(
                        description =
                                        "A unique identifier for the federation between Smile CDR and the federated provider. If this is left blank, a unique value will be automatically created by Smile CDR. You may choose to use a more descriptive value however, as it will appear in URLs and log statements. Since this value will appear in URL paths, only letters and numbers should be used with no whitespace.")
        private String myFederationRegistrationId;

        @JsonProperty(value = "federationRequestScopes")
        @Schema(
                        description =
                                        "When requesting authorization against the federated provider, this setting controls which OAuth2 scopes will be requested. Note that the scopes requested by the security module from the federated provider are independent from the scopes requested by the SMART application that is authorizing against Smile CDR. In a typical flow, a SMART on FHIR application will request SMART scopes from Smile CDR, and Smile CDR will in turn request a different set of appropriate scopes from the federated provider.")
        private String myFederationRequestScopes;

        @JsonProperty(value = "federationAuthorizationUrl")
        @Schema(
                        description =
                                        "The URL to redirect the requesting user to in order to request user authentication/authorization with the federated provider.")
        private String myFederationAuthorizationUrl;

        @JsonProperty(value = "federationTokenUrl")
        @Schema(
                        description =
                                        "This field is used in two ways. It is the service URL used by the SMART Outbound Security module for code exchange when requesting a token from the federated provider. It is also used in the system-to-system flow, as the token_endpoint for the client credentials flow, to retrieve a token from the remote payer. In the system-to-system flow this field takes precedence over `authWellKnownConfigUrl`: when it is set, no `.well-known` discovery request is made.")
        private String myFederationTokenUrl;

        @JsonProperty(value = "federationUserInfoUrl")
        @Schema(description = "The service URL used by the SMART Outbound Security module for requesting user details.")
        private String myFederationUserInfoUrl;

        @JsonProperty(value = "federationJwkSetUrl")
        @Schema(description = "The URL from which to obtain the federated provider's token signing public key.")
        private String myFederationJwkSetUrl;

        @JsonProperty(value = "federationAuthScriptText")
        @Schema(
                        description =
                                        "When using Federated OAuth2/OIDC Login, a script is used to bridge between the user authorization details received from the federated provider and the requested authorization details in the originating SMART on FHIR application. This script is used to assign appropriate permissions and inject any other required details into the user session. It may obtain all required information by inspecting the access token details, or it may make additional service calls to fetch information.")
        private String myFederationAuthScriptText;

        @JsonProperty(value = "federationUserMappingScriptText")
        @Schema(
                        description =
                                        "When using Federated OAuth2/OIDC Login, an optional script that is used to create Smile CDR user name from the federated login details.")
        private String myFederationUserMappingScriptText;

        @JsonProperty(value = "clientAuthenticationMethod")
        @Schema(
                        description =
                                        "The OIDC client authentication mechanism to use during federated OIDC login when performing code exchange between Smile CDR and the federated provider.")
        private Oauth2ClientAuthenticationMethodEnum myClientAuthenticationMethod;

        @JsonProperty(value = "clientAuthenticationKeystoreId")
        @Schema(
                        description =
                                        "If the client authentication method is set to `PRIVATE_KEY_JWT`, this property specifies the [Keystore ID](/docs/smart/oidc_keystores.html) to use for signing the credential JWT.")
        private String myClientAuthenticationKeystoreId;

        @JsonProperty(value = "fhirEndpointUrl")
        @Schema(description = "The FHIR Endpoint URL associated to this OIDC Server. P2P specific-optional")
        private String myFhirEndpointUrl;

        @JsonProperty(value = "authWellKnownConfigUrl")
        @Schema(
                        description =
                                        "The auth well-known configuration URL associated to this OIDC Server to retrieve fhir data. P2P specific-optional. In the system-to-system flow, this URL is fetched exactly as configured, including any query string, when `federationTokenUrl` is not set, and its token_endpoint is used. If neither this field nor `federationTokenUrl` is set, discovery uses `{fhirEndpointUrl}/.well-known/smart-configuration`.")
        private String myAuthWellKnownConfigUrl;

        @JsonProperty(value = "notes")
        @Schema(description = "Registration URL, etc. P2P specific-optional")
        private String myNotes;

        @JsonProperty(value = "customTokenParams")
        @Schema(description = "Customized token parameters for this OIDC Server. P2P specific-optional")
        private String myCustomTokenParams;

        @JsonProperty(value = "responseType")
        @Schema(description = "The response type for the associated OIDC Server. P2P specific-optional")
        private String myResponseType;

        @JsonProperty(value = "organizationId")
        @Schema(
                        description =
                                        "The identification code used to specify an organization or business. (i.e. Payer ID/A five digit standardized industry identify used by payers). P2P specific-optional")
        private String myOrganizationId;

        @JsonProperty(value = "audience")
        @Schema(description = "The audience parameter. Defines the intended consumer of the token. P2P specific-optional")
        private String myAudience;

        @JsonProperty(value = "archivedAt")
        @Schema(description = "The time at which this module was archived, if it has been.")
        private Date myArchivedAt;

        public String getIssuer() {
                return myIssuer;
        }

        public OAuth2ServerJson setIssuer(String theIssuer) {
                myIssuer = theIssuer;
                return this;
        }

        public String getModuleId() {
                return myModuleId;
        }

        public OAuth2ServerJson setModuleId(String theModuleId) {
                myModuleId = theModuleId;
                return this;
        }

        public String getName() {
                return myName;
        }

        public void setName(String theName) {
                myName = theName;
        }

        public String getNodeId() {
                return myNodeId;
        }

        public OAuth2ServerJson setNodeId(String theNodeId) {
                myNodeId = theNodeId;
                return this;
        }

        public Long getPid() {
                return myPid;
        }

        public void setPid(Long thePid) {
                myPid = thePid;
        }

        public String getTokenIntrospectionClientId() {
                return myTokenIntrospectionClientId;
        }

        public void setTokenIntrospectionClientId(String theTokenIntrospectionClientId) {
                myTokenIntrospectionClientId = theTokenIntrospectionClientId;
        }

        public String getTokenIntrospectionClientSecret() {
                return myTokenIntrospectionClientSecret;
        }

        public void setTokenIntrospectionClientSecret(String theTokenIntrospectionClientSecret) {
                myTokenIntrospectionClientSecret = theTokenIntrospectionClientSecret;
        }

        public String getValidationJwkText() {
                return myValidationJwkText;
        }

        public void setValidationJwkText(String theValidationJwkText) {
                myValidationJwkText = theValidationJwkText;
        }

        public String getValidationJwkFile() {
                return myValidationJwkFile;
        }

        public void setValidationJwkFile(String theValidationJwkFile) {
                myValidationJwkFile = theValidationJwkFile;
        }

        public String getFederationRegistrationId() {
                return myFederationRegistrationId;
        }

        public void setFederationRegistrationId(String theFederationRegistrationId) {
                myFederationRegistrationId = theFederationRegistrationId;
        }

        public String getFederationRequestScopes() {
                return myFederationRequestScopes;
        }

        public void setFederationRequestScopes(String theFederationRequestScopes) {
                myFederationRequestScopes = theFederationRequestScopes;
        }

        public String getFederationAuthorizationUrl() {
                return myFederationAuthorizationUrl;
        }

        public void setFederationAuthorizationUrl(String theFederationAuthorizationUrl) {
                myFederationAuthorizationUrl = theFederationAuthorizationUrl;
        }

        public String getClientAuthenticationKeystoreId() {
                return myClientAuthenticationKeystoreId;
        }

        public void setClientAuthenticationKeystoreId(String theClientAuthenticationKeystoreId) {
                myClientAuthenticationKeystoreId = theClientAuthenticationKeystoreId;
        }

        public String getFederationTokenUrl() {
                return myFederationTokenUrl;
        }

        public void setFederationTokenUrl(String theTokenUrl) {
                myFederationTokenUrl = theTokenUrl;
        }

        public String getFederationUserInfoUrl() {
                return myFederationUserInfoUrl;
        }

        public void setFederationUserInfoUrl(String theFederationUserInfoUrl) {
                myFederationUserInfoUrl = theFederationUserInfoUrl;
        }

        public String getFederationJwkSetUrl() {
                return myFederationJwkSetUrl;
        }

        public void setFederationJwkSetUrl(String theFederationJwkSetUrl) {
                myFederationJwkSetUrl = theFederationJwkSetUrl;
        }

        public String getFederationAuthScriptText() {
                return myFederationAuthScriptText;
        }

        public void setFederationAuthScriptText(String theFederationAuthScriptText) {
                myFederationAuthScriptText = theFederationAuthScriptText;
        }

        public String getFederationUserMappingScriptText() {
                return myFederationUserMappingScriptText;
        }

        public void setFederationUserMappingScriptText(String theFederationUserMappingScriptText) {
                myFederationUserMappingScriptText = theFederationUserMappingScriptText;
        }

        public void setClientAuthenticationMethod(Oauth2ClientAuthenticationMethodEnum theClientAuthenticationMethod) {
                myClientAuthenticationMethod = theClientAuthenticationMethod;
        }

        public Oauth2ClientAuthenticationMethodEnum getClientAuthenticationMethod() {
                return myClientAuthenticationMethod;
        }

        public String getFhirEndpointUrl() {
                return myFhirEndpointUrl;
        }

        public void setFhirEndpointUrl(String theFhirEndpointUrl) {
                myFhirEndpointUrl = theFhirEndpointUrl;
        }

        public String getAuthWellKnownConfigUrl() {
                return myAuthWellKnownConfigUrl;
        }

        public void setAuthWellKnownConfigUrl(String theAuthWellKnownConfigUrl) {
                myAuthWellKnownConfigUrl = theAuthWellKnownConfigUrl;
        }

        public String getNotes() {
                return myNotes;
        }

        public void setNotes(String theNotes) {
                myNotes = theNotes;
        }

        public String getCustomTokenParams() {
                return myCustomTokenParams;
        }

        public void setCustomTokenParams(String theCustomTokenParams) {
                myCustomTokenParams = theCustomTokenParams;
        }

        public String getResponseType() {
                return myResponseType;
        }

        public void setResponseType(String theResponseType) {
                myResponseType = theResponseType;
        }

        public String getOrganizationId() {
                return myOrganizationId;
        }

        public void setOrganizationId(String theOrganizationId) {
                myOrganizationId = theOrganizationId;
        }

        public String getAudience() {
                return myAudience;
        }

        public void setAudience(String theAudience) {
                myAudience = theAudience;
        }

        public void setArchivedAt(Date theArchivedAt) {
                myArchivedAt = theArchivedAt;
        }

        public Date getArchivedAt() {
                return myArchivedAt;
        }
}