Package com.verisign.epp.codec.gen

Class EPPLogoutCmd

java.lang.Object
com.verisign.epp.codec.gen.EPPCommand
com.verisign.epp.codec.gen.EPPLogoutCmd
All Implemented Interfaces:
EPPCodecComponent, EPPMessage, Serializable, Cloneable
public class EPPLogoutCmd extends EPPCommand
The EPP <logout> command is used to end a session with an EPP server. In addition to the standard EPP command elements, the <logout> command SHALL contain an empty <logout> command element. A server MAY also end a session asynchronously due to client inactivity or excessive client session longevity. The parameters for determining excessive client inactivity or session longevity are a matter of server policy and are not specified by this protocol.
See Also:

  • Constructor Details

    • EPPLogoutCmd

      public EPPLogoutCmd()
      Default constructor for EPPLogoutCmd.

    • EPPLogoutCmd

      public EPPLogoutCmd(String aTransId)
      Constructor that takes the transaction id required of all EPPCommand's.
      Parameters:
      aTransId - Client transaction identifier

  • Method Details

    • getType

      public String getType()
      Get the EPP command type associated with EPPLogoutCmd.
      Specified by:
      getType in class EPPCommand
      Returns:
      EPPCommand.TYPE_LOGOUT

    • getNamespace

      public String getNamespace()
      Get the EPP command Namespace associated with EPPLogoutCmd.
      Specified by:
      getNamespace in interface EPPCodecComponent
      Specified by:
      getNamespace in interface EPPMessage
      Specified by:
      getNamespace in class EPPCommand
      Returns:
      EPPCodec.NS

    • doGenEncode

      protected Element doGenEncode(Document aDocument) throws EPPEncodeException
      encode EPPLoginCmd into a DOM element tree. The <logout> element is created and there are currently no attribute nodes are appended as children. This method is part of the Template Design Pattern, where EPPCommand provides the public encode and calls the abstract doGenEncode.
      Specified by:
      doGenEncode in class EPPCommand
      Parameters:
      aDocument - DOM Document to create elements from
      Returns:
      <logout> root element tree.
      Throws:
      EPPEncodeException - Error encoding the DOM element tree.

    • doGenDecode

      protected void doGenDecode(Element aElement) throws EPPDecodeException
      decode EPPLogoutCmd from a DOM element tree. The "logout" element needs to be the value of the aElement argument. This method is part of the Template Design Pattern, where EPPCommand provides the public decode and calls the abstract doGenDecode.
      Specified by:
      doGenDecode in class EPPCommand
      Parameters:
      aElement - <logout> root element tree.
      Throws:
      EPPDecodeException - Error decoding the DOM element tree.

    • equals

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

    • clone

      public Object clone() throws CloneNotSupportedException
      Clone EPPLogoutCmd.
      Specified by:
      clone in interface EPPCodecComponent
      Overrides:
      clone in class EPPCommand
      Returns:
      clone of EPPLogoutCmd
      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 EPPCommand
      Returns:
      Indented XML String if successful; ERROR otherwise.