google-nomulus/java/google/registry/rdap/RdapIcannStandardInformation.java

// Copyright 2017 The Nomulus Authors. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package google.registry.rdap;

import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;

/**
 * This file contains boilerplate required by the ICANN RDAP Profile.
 *
 * @see <a href="https://www.icann.org/resources/pages/rdap-operational-profile-2016-07-26-en">RDAP Operational Profile for gTLD Registries and Registrars</a>
 */

public class RdapIcannStandardInformation {

  /** Required by ICANN RDAP Profile section 1.4.10. */
  private static final ImmutableMap<String, Object> CONFORMANCE_NOTICE =
      ImmutableMap.of(
          "description",
          ImmutableList.of(
              "This response conforms to the RDAP Operational Profile for gTLD Registries and"
                  + " Registrars version 1.0"));

  /** Required by ICANN RDAP Profile section 1.5.18. */
  private static final ImmutableMap<String, Object> DOMAIN_STATUS_CODES_NOTICE =
      ImmutableMap.of(
          "title",
          "EPP Status Codes",
          "description",
          ImmutableList.of(
              "For more information on domain status codes, please visit https://icann.org/epp"),
          "links",
          ImmutableList.of(
              ImmutableMap.of(
                  "value", "https://icann.org/epp",
                  "rel", "alternate",
                  "href", "https://icann.org/epp",
                  "type", "text/html")));

  /** Required by ICANN RDAP Profile section 1.5.20. */
  private static final ImmutableMap<String, Object> INACCURACY_COMPLAINT_FORM_NOTICE =
      ImmutableMap.of(
          "description",
          ImmutableList.of(
              "URL of the ICANN Whois Inaccuracy Complaint Form: https://www.icann.org/wicf"),
          "links",
          ImmutableList.of(
              ImmutableMap.of(
                  "value", "https://www.icann.org/wicf",
                  "rel", "alternate",
                  "href", "https://www.icann.org/wicf",
                  "type", "text/html")));

  /** Boilerplate notices required by domain responses. */
  static final ImmutableList<ImmutableMap<String, Object>> domainBoilerplateNotices =
      ImmutableList.of(
          CONFORMANCE_NOTICE, DOMAIN_STATUS_CODES_NOTICE, INACCURACY_COMPLAINT_FORM_NOTICE);

  /** Boilerplate remarks required by nameserver and entity responses. */
  static final ImmutableList<ImmutableMap<String, Object>> nameserverAndEntityBoilerplateNotices =
      ImmutableList.of(CONFORMANCE_NOTICE);

  /**
   * Required by ICANN RDAP Profile section 1.4.9, as corrected by Gustavo Lozano of ICANN.
   *
   * @see <a href="http://mm.icann.org/pipermail/gtld-tech/2016-October/000822.html">Questions about the ICANN RDAP Profile</a>
   */
  static final ImmutableMap<String, Object> SUMMARY_DATA_REMARK =
      ImmutableMap.of(
          "title",
          "Incomplete Data",
          "description",
          ImmutableList.of(
              "Summary data only. For complete data, send a specific query for the object."),
          "type",
          "object truncated due to unexplainable reasons");

  /**
   * Required by ICANN RDAP Profile section 1.4.8, as corrected by Gustavo Lozano of ICANN.
   *
   * @see <a href="http://mm.icann.org/pipermail/gtld-tech/2016-October/000822.html">Questions about the ICANN RDAP Profile</a>
   */
  static final ImmutableMap<String, Object> TRUNCATED_RESULT_SET_NOTICE =
      ImmutableMap.of(
          "title",
          "Search Policy",
          "description",
          ImmutableList.of("Search results per query are limited."),
          "type",
          "result set truncated due to unexplainable reasons");

  /** Truncation notice as a singleton list, for easy use. */
  static final ImmutableList<ImmutableMap<String, Object>> TRUNCATION_NOTICES =
      ImmutableList.of(TRUNCATED_RESULT_SET_NOTICE);

  /**
   * Used when a search for domains by nameserver may have returned incomplete information because
   * there were too many nameservers in the first stage results.
   */
  static final ImmutableMap<String, Object> POSSIBLY_INCOMPLETE_RESULT_SET_NOTICE =
      ImmutableMap.of(
          "title",
          "Search Policy",
          "description",
          ImmutableList.of(
              "Search results may contain incomplete information due to first-stage query limits."),
          "type",
          "result set truncated due to unexplainable reasons");

  /** Possibly incomplete notice as a singleton list, for easy use. */
  static final ImmutableList<ImmutableMap<String, Object>> POSSIBLY_INCOMPLETE_NOTICES =
      ImmutableList.of(POSSIBLY_INCOMPLETE_RESULT_SET_NOTICE);

  /** Included when the requester is not logged in as the owner of the domain being returned. */
  static final ImmutableMap<String, Object> DOMAIN_CONTACTS_HIDDEN_DATA_REMARK =
      ImmutableMap.of(
          "title",
          "Contacts Hidden",
          "description",
          ImmutableList.of("Domain contacts are visible only to the owning registrar."),
          "type",
          "object truncated due to unexplainable reasons");

  /**
   * Included when requester is not logged in as the owner of the contact being returned. Format
   * required by ICANN RDAP Pilot Profile draft section 1.4.11.
   */
  static final ImmutableMap<String, Object> CONTACT_PERSONAL_DATA_HIDDEN_DATA_REMARK =
      ImmutableMap.of(
          "title",
          "Data Policy",
          "description",
          ImmutableList.of(
              "Some of the data in this object has been removed.",
              "Contact personal data is visible only to the owning registrar."),
          "type",
          "object truncated due to authorization",
          "links",
          ImmutableList.of(
              ImmutableMap.of(
                  "value",
                      "https://github.com/google/nomulus/blob/master/docs/rdap.md#authentication",
                  "rel", "alternate",
                  "href",
                      "https://github.com/google/nomulus/blob/master/docs/rdap.md#authentication",
                  "type", "text/html")));
}