com.io7m.idstore.server.api.IdServerConfigurationFile Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of com.io7m.idstore.server.api Show documentation
Identity server (Server API)
The newest version!
/*
 * Copyright © 2023 Mark Raynsford  https://www.io7m.com
 *
 * Permission to use, copy, modify, and/or distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
 * SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
 * IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */

package com.io7m.idstore.server.api;

import java.util.Objects;
import java.util.Optional;

/**
 * The server configuration file.
 *
 * @param brandingConfiguration    The branding configuration
 * @param databaseConfiguration    The database configuration
 * @param historyConfiguration     The history configuration
 * @param httpConfiguration        The HTTP configuration
 * @param mailConfiguration        The mail configuration
 * @param openTelemetry            The OpenTelemetry configuration
 * @param rateLimit                The rate limiting configuration
 * @param passwordExpiration       The password expiration configuration
 * @param sessionConfiguration     The session configuration
 * @param maintenanceConfiguration The maintenance configuration
 */

public record IdServerConfigurationFile(
  IdServerBrandingConfiguration brandingConfiguration,
  IdServerMailConfiguration mailConfiguration,
  IdServerHTTPConfiguration httpConfiguration,
  IdServerDatabaseConfiguration databaseConfiguration,
  IdServerHistoryConfiguration historyConfiguration,
  IdServerSessionConfiguration sessionConfiguration,
  IdServerRateLimitConfiguration rateLimit,
  IdServerPasswordExpirationConfiguration passwordExpiration,
  IdServerMaintenanceConfiguration maintenanceConfiguration,
  Optional openTelemetry)
  implements IdServerJSONConfigurationElementType
{
  /**
   * The server configuration file.
   *
   * @param brandingConfiguration    The branding configuration
   * @param databaseConfiguration    The database configuration
   * @param historyConfiguration     The history configuration
   * @param httpConfiguration        The HTTP configuration
   * @param mailConfiguration        The mail configuration
   * @param openTelemetry            The OpenTelemetry configuration
   * @param rateLimit                The rate limiting configuration
   * @param maintenanceConfiguration The maintenance configuration
   * @param passwordExpiration       The password expiration configuration
   * @param sessionConfiguration     The session configuration
   */

  public IdServerConfigurationFile
  {
    Objects.requireNonNull(brandingConfiguration, "brandingConfiguration");
    Objects.requireNonNull(mailConfiguration, "mailConfiguration");
    Objects.requireNonNull(httpConfiguration, "httpConfiguration");
    Objects.requireNonNull(databaseConfiguration, "databaseConfiguration");
    Objects.requireNonNull(sessionConfiguration, "sessionConfiguration");
    Objects.requireNonNull(historyConfiguration, "historyConfiguration");
    Objects.requireNonNull(rateLimit, "rateLimit");
    Objects.requireNonNull(
      maintenanceConfiguration,
      "maintenanceConfiguration");
    Objects.requireNonNull(passwordExpiration, "passwordExpiration");
    Objects.requireNonNull(openTelemetry, "openTelemetry");
  }
}