Enum RdapJsonFormatter.OutputDataType

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<RdapJsonFormatter.OutputDataType>
    Enclosing class:
    RdapJsonFormatter

    public static enum RdapJsonFormatter.OutputDataType
    extends java.lang.Enum<RdapJsonFormatter.OutputDataType>
    What type of data to generate.

    Summary data includes only information about the object itself, while full data includes associated items (e.g. for domains, full data includes the hosts, contacts and history entries connected with the domain).

    Summary data is appropriate for search queries which return many results, to avoid load on the system. According to the ICANN operational profile, a remark must be attached to the returned object indicating that it includes only summary data.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      FULL
      The full information about an RDAP object.
      INTERNAL
      The object isn't the subject of the query, but is rather a sub-object of the actual reply.
      SUMMARY
      The minimal information about an RDAP object that is allowed as a reply.
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static RdapJsonFormatter.OutputDataType valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static RdapJsonFormatter.OutputDataType[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Enum Constant Detail

      • FULL

        public static final RdapJsonFormatter.OutputDataType FULL
        The full information about an RDAP object.

        Reserved to cases when this object is the only result of a query - either queried directly, or the sole result of a search query.

      • SUMMARY

        public static final RdapJsonFormatter.OutputDataType SUMMARY
        The minimal information about an RDAP object that is allowed as a reply.

        Reserved to cases when this object is one of many results of a search query.

        We want to minimize the size of the reply, and also minimize the Datastore queries needed to generate these replies since we might have a lot of these objects to return.

        Each object with a SUMMARY type will have a remark with a direct link to itself, which will return the FULL result.

      • INTERNAL

        public static final RdapJsonFormatter.OutputDataType INTERNAL
        The object isn't the subject of the query, but is rather a sub-object of the actual reply.

        These objects have less required fields in the RDAP spec, and hence can be even smaller than the SUMMARY objects.

        Like SUMMARY objects, these objects will also have a remark with a direct link to itself, which will return the FULL result.

    • Method Detail

      • values

        public static RdapJsonFormatter.OutputDataType[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (RdapJsonFormatter.OutputDataType c : RdapJsonFormatter.OutputDataType.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static RdapJsonFormatter.OutputDataType valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null