Package com.verisign.epp.codec.relateddomainext

Class EPPRelatedDomainExtInfo

java.lang.Object
com.verisign.epp.codec.relateddomainext.EPPRelatedDomainExtInfo
All Implemented Interfaces:
EPPCodecComponent, Serializable, Cloneable
public class EPPRelatedDomainExtInfo extends Object implements EPPCodecComponent
EPPCodecComponent that encodes and decodes a <relDom:info> tag

Title: EPP 1.0 Related Domain - info tag

Description: The EPPRelatedDomainExtInfo object indicates to the server to include the related domain information in the response. As XML, it is represented by a <relDom:info> element.

See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static String
    TYPE_DOMAIN
    Constant for the type attribute that defines the use of the Domain Info Form.
    static String
    TYPE_RELATED
    Constant for the type attribute that defines the use of the Related Info Form.

  • Constructor Summary

    Constructors
    Constructor
    Description
    EPPRelatedDomainExtInfo()
    Default constructor, where the type is set to TYPE_DOMAIN.
    EPPRelatedDomainExtInfo(String aType)
    Constructor that takes the desired type of the extension using either the Domain Info Form, represented by the TYPE_DOMAIN constant, or the Related Info Form, represented by the TYPE_RELATED constant.

  • Method Summary

    Modifier and Type
    Method
    Description
    Object
    clone()
    Clone EPPRelatedDomainExtInfo.
    void
    decode(Element aElement)
    Decode the EPPRelatedDomainExtInfo attributes from the aElement DOM Element tree.
    Element
    encode(Document aDocument)
    Encode a DOM Element tree from the attributes of the EPPRelatedDomainExtInfo instance.
    boolean
    equals(Object aObject)
    implements a deep EPPRelatedDomainExtInfo compare.
    String
    getNamespace()
    Returns the XML namespace associated with the EPPCodecComponent.
    String
    getType()
    Gets the form type of the extension, which must be either the TYPE_DOMAIN constant for the Domain Info Form, and the TYPE_RELATED constant for the Related Info Form.
    void
    setType(String aType)
    Sets the form type of the extension, which must be either the TYPE_DOMAIN constant for the Domain Info Form, and the TYPE_RELATED constant for the Related Info Form.
    String
    toString()
    Implementation of Object.toString, which will result in an indented XML String representation of the concrete EPPCodecComponent.

    Methods inherited from class java.lang.Object

    finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

  • Field Details

    • TYPE_DOMAIN

      public static String TYPE_DOMAIN
      Constant for the type attribute that defines the use of the Domain Info Form. With this form, a successful response will include the domain info of the domain name specified in the domain info command along with the related domain information in the extension.

  • Constructor Details

    • EPPRelatedDomainExtInfo

      public EPPRelatedDomainExtInfo()
      Default constructor, where the type is set to TYPE_DOMAIN.

    • EPPRelatedDomainExtInfo

      public EPPRelatedDomainExtInfo(String aType)
      Constructor that takes the desired type of the extension using either the Domain Info Form, represented by the TYPE_DOMAIN constant, or the Related Info Form, represented by the TYPE_RELATED constant.
      Parameters:
      aType - Type of form to use which must be either the TYPE_DOMAIN constant for the Domain Info Form or the TYPE_RELATED constant for the Related Info Form.

  • Method Details

    • getType

      public String getType()
      Gets the form type of the extension, which must be either the TYPE_DOMAIN constant for the Domain Info Form, and the TYPE_RELATED constant for the Related Info Form.
      Returns:
      Either TYPE_DOMAIN or TYPE_RELATED.

    • setType

      public void setType(String aType)
      Sets the form type of the extension, which must be either the TYPE_DOMAIN constant for the Domain Info Form, and the TYPE_RELATED constant for the Related Info Form.
      Parameters:
      aType - Either TYPE_DOMAIN or TYPE_RELATED.

    • clone

      public Object clone() throws CloneNotSupportedException
      Clone EPPRelatedDomainExtInfo.
      Specified by:
      clone in interface EPPCodecComponent
      Overrides:
      clone in class Object
      Returns:
      clone of EPPRelatedDomainExtInfo
      Throws:
      CloneNotSupportedException - standard Object.clone exception

    • decode

      public void decode(Element aElement) throws EPPDecodeException
      Decode the EPPRelatedDomainExtInfo attributes from the aElement DOM Element tree.
      Specified by:
      decode in interface EPPCodecComponent
      Parameters:
      aElement - - Root DOM Element to decode EPPRelatedDomainExtInfo from.
      Throws:
      EPPDecodeException - Unable to decode aElement

    • encode

      public Element encode(Document aDocument) throws EPPEncodeException
      Encode a DOM Element tree from the attributes of the EPPRelatedDomainExtInfo instance.
      Specified by:
      encode in interface EPPCodecComponent
      Parameters:
      aDocument - - DOM Document that is being built. Used as an Element factory.
      Returns:
      Element - Root DOM Element representing the EPPRelatedDomainExtInfo instance.
      Throws:
      EPPEncodeException - - Unable to encode EPPRelatedDomainExtInfo instance.

    • equals

      public boolean equals(Object aObject)
      implements a deep EPPRelatedDomainExtInfo compare.
      Overrides:
      equals in class Object
      Parameters:
      aObject - EPPRelatedDomainExtInfo instance to compare with
      Returns:
      DOCUMENT ME!

    • toString

      public String toString()
      Implementation of Object.toString, which will result in an indented XML String representation of the concrete EPPCodecComponent.
      Overrides:
      toString in class Object
      Returns:
      Indented XML String if successful; ERROR otherwise.

    • getNamespace

      public String getNamespace()
      Returns the XML namespace associated with the EPPCodecComponent.
      Specified by:
      getNamespace in interface EPPCodecComponent
      Returns:
      XML namespace for the EPPCodecComponent.