Package com.verisign.epp.codec.host

Class EPPHostStatus

java.lang.Object
com.verisign.epp.codec.host.EPPHostStatus
All Implemented Interfaces:
EPPCodecComponent, Serializable, Cloneable
public class EPPHostStatus extends Object implements EPPCodecComponent
Represents a host Status.

A host object MUST always have at least one associated status value. Status values MAY be set only by the client that sponsors a host object and by the server on which the object resides. A client can change the status of a host object using the EPP <update> command. Each status value MAY be accompanied by a string of human-readable text that describes the rationale for the status applied to the object. A client MUST NOT alter status values set by the server. A server MAY alter or override status values set by a client subject to local server policies. The status of an object MAY change as a result of either a client-initiated transform command or an action performed by a server operator.

Status values that may be added or removed by a client are prefixed with "client". Corresponding status values that may be added or removed by a server are prefixed with "server". Status values that do not begin with either "client" or "server" are server-managed. Status Value Descriptions:

  • clientDeleteProhibited, serverDeleteProhibited: Requests to delete the object MUST be rejected.
  • clientUpdateProhibited, serverUpdateProhibited: Requests to update the object (other than to remove this status) MUST be rejected.
  • linked: The host object has at least one active association with another object, such as a domain object. Servers SHOULD provide services to determine existing object associations.
  • ok: This is the nominal status value for an object that has no pending operations or prohibitions. This value is set and removed by the server as other status values are added or removed.
  • pendingDelete: A delete request has been received for the object, but the object has not yet been purged from the server database.
  • "ok" status MUST NOT be combined with any other status.
  • pendingCreate: A create request has been received for a host object, and completion of the request is pending.
  • pendingUpdate: An update request has been received for a host object, and completion of the request is pending.
  • pendingTransfer: A transfer request has been received for the host object's superordinate domain object, and completion of the request is pending.
  • pendingDelete An delete request has been received for a host object or superordinate domain object, and completion of the request is pending.
See Also:

  • Field Details

    • ELM_STATUS_OK

      public static final String ELM_STATUS_OK
      Value of the OK status in host mapping
      See Also:

    • ELM_STATUS_PENDING_DELETE

      public static final String ELM_STATUS_PENDING_DELETE
      Value of the pending delete status in host mapping
      See Also:

    • ELM_STATUS_PENDING_CREATE

      public static final String ELM_STATUS_PENDING_CREATE
      Value of the pending create status in host mapping
      See Also:

    • ELM_STATUS_PENDING_UPDATE

      public static final String ELM_STATUS_PENDING_UPDATE
      Value of the pending update status in host mapping
      See Also:

    • ELM_STATUS_PENDING_TRANSFER

      public static final String ELM_STATUS_PENDING_TRANSFER
      Value of the pending transfer status in host mapping
      See Also:

    • ELM_STATUS_CLIENT_DELETE_PROHIBITED

      public static final String ELM_STATUS_CLIENT_DELETE_PROHIBITED
      Value of the client delete prohibited status in host mapping
      See Also:

    • ELM_STATUS_CLIENT_UPDATE_PROHIBITED

      public static final String ELM_STATUS_CLIENT_UPDATE_PROHIBITED
      Value of the client update prohibited status in host mapping
      See Also:

    • ELM_STATUS_LINKED

      public static final String ELM_STATUS_LINKED
      Value of the linked status in host mapping
      See Also:

    • ELM_STATUS_SERVER_DELETE_PROHIBITED

      public static final String ELM_STATUS_SERVER_DELETE_PROHIBITED
      Value of the server delete prohibited status in host mapping
      See Also:

    • ELM_STATUS_SERVER_UPDATE_PROHIBITED

      public static final String ELM_STATUS_SERVER_UPDATE_PROHIBITED
      Value of the server update prohibited status in host mapping
      See Also:

    • ELM_DEFAULT_LANG

      public static final String ELM_DEFAULT_LANG
      Default Language -- English "en"
      See Also:

  • Constructor Details

    • EPPHostStatus

      public EPPHostStatus()
      EPPHostStatus default constructor.

    • EPPHostStatus

      public EPPHostStatus(String aStatus)
      EPPHostStatus constructor that takes the host status as argument.
      Parameters:
      aStatus - Domain status which should be one of the ELM_STATUS constants.

    • EPPHostStatus

      public EPPHostStatus(String aStatus, String aDesc)
      EPPHostStatus constructor that takes the host status and a status description.
      Parameters:
      aStatus - Domain status which should be one of the ELM_STATUS constants.
      aDesc - A description of the status change

    • EPPHostStatus

      public EPPHostStatus(String aStatus, String aDesc, String aLang)
      EPPHostStatus constructor that takes the host status and the language as arguments.
      Parameters:
      aStatus - Domain status which should be one of the ELM_STATUS constants.
      aDesc - A description of the status change
      aLang - Language of the status description

  • Method Details

    • clone

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

    • decode

      public void decode(Element aElement) throws EPPDecodeException
      Decode the EPPHostStatus attributes from the aElement DOM Element tree.
      Specified by:
      decode in interface EPPCodecComponent
      Parameters:
      aElement - - Root DOM Element to decode EPPHostStatus 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 EPPHostStatus 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 EPPHostStatus instance.
      Throws:
      EPPEncodeException - - Unable to encode EPPHostStatus instance.

    • equals

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

    • getLang

      public String getLang()
      Get status description language. The default is ELM_DEFAULT_LANG.
      Returns:
      Language

    • getStatus

      public String getStatus()
      Gets host status.
      Returns:
      Host Status

    • setStatus

      public void setStatus(String newStatus)
      Sets host status.
      Parameters:
      newStatus - String

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

    • setLang

      public void setLang(String newLang)
      Sets status description language.
      Parameters:
      newLang - String

    • getDescription

      public String getDescription()
      Gets the status description, which is free form text describing the rationale for the status.
      Returns:
      Description of the status describing the rationale for the status.

    • setDescription

      public void setDescription(String aDesc)
      Sets the status description, which is free form text describing the rationale for the status.
      Parameters:
      aDesc - status description

    • getNamespace

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