Package com.verisign.epp.codec.gen

Class EPPHello

java.lang.Object
com.verisign.epp.codec.gen.EPPHello
All Implemented Interfaces:
EPPCodecComponent, EPPMessage, Serializable, Cloneable
public class EPPHello extends Object implements EPPMessage
Represents an EPP hello request that is sent by an EPP Client and received by an EPP Server. EPP MAY be carried over both connection-oriented and connection-less transport protocols. An EPP client MAY request a <greeting> from an EPP server at any time by sending a <hello> to a server. Use of this element is essential in a connection-less environment where a server can not return a <greeting> in response to a client-initiated connection. An EPP <hello> SHALL be an empty element with no child elements.

An EPPHello can be encoded and decoded by EPPCodec.

An EPPHello request should result in the EPP Server sending back an EPPGreeting.
See Also:

  • Constructor Details

    • EPPHello

      public EPPHello()
      Allocates a new EPPHello. EPPHello contains no attributes.

  • Method Details

    • getNamespace

      public String getNamespace()
      Gets the associated EPP namespace. The general EPP namespace is returned, which is defined as EPPCodec.NS.
      Specified by:
      getNamespace in interface EPPCodecComponent
      Specified by:
      getNamespace in interface EPPMessage
      Returns:
      namespace URI

    • encode

      public Element encode(Document aDocument) throws EPPEncodeException
      encode EPPHello into a DOM element tree. The <hello> element is created and returned.
      Specified by:
      encode in interface EPPCodecComponent
      Parameters:
      aDocument - DOM Document to create elements
      Returns:
      <hello> root element tree.
      Throws:
      EPPEncodeException - Error encoding the DOM element tree.

    • decode

      public void decode(Element aElement) throws EPPDecodeException
      decode EPPHello from a DOM element tree. The "hello" element needs to be the value of the aElement argument. Since EPPHello contains no attribute, no attributes need to be set the decode.
      Specified by:
      decode in interface EPPCodecComponent
      Parameters:
      aElement - <hello> root element tree.
      Throws:
      EPPDecodeException - Error decoding the DOM element tree.

    • equals

      public boolean equals(Object aObject)
      implements a deep EPPHello compare.
      Overrides:
      equals in class Object
      Parameters:
      aObject - EPPHello instance to compare with
      Returns:
      true if equal; false otherwise.

    • clone

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

    • 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.