Package com.verisign.epp.codec.host

Class EPPHostInfoResp

java.lang.Object
com.verisign.epp.codec.gen.EPPResponse
com.verisign.epp.codec.host.EPPHostInfoResp
All Implemented Interfaces:
EPPCodecComponent, EPPMessage, Serializable, Cloneable
public class EPPHostInfoResp extends EPPResponse
Represents an EPP Host <host:infData> response to an EPPHostInfoCmd. When an <info> command has been processed successfully, the EPP <resData> element MUST contain a child <host:infData> element that identifies the host namespace and the location of the host schema. The <host:infData> element contains the following child elements:
  • A <host:name> element that contains the fully qualified name of the host. Use getName and setName to get and set the element.
  • A <host:roid> element that contains the Respoitory Object IDentifier assigned to the host object when the object was created.
  • One or more <host:status> elements that describe the status of the host object. Use getStatuses and setStatuses to get and set the element.
  • Zero or more <host:addr> elements that contain the IP addresses associated with the host object. Use getAddresses and setAddresses to get and set the element.
  • A <host:clID> element that contains the identifier of the sponsoring client. Use getClientId and setClientId to get and set the element.
  • A <host:crID> element that contains the identifier of the client that created the host name. Use getCreatedBy and setCreatedBy to get and set the element.
  • A <host:crDate> element that contains the date and time of host creation. Use getCreatedDate and setCreatedDate to get and set the element.
  • A <host:upID> element that contains the identifier of the client that last updated the host name. This element MUST NOT be present if the host has never been modified. Use getLastUpdatedBy and setLastUpdatedBy to get and set the element.
  • A <host:upDate> element that contains the date and time of the most recent host modification. This element MUST NOT be present if the host has never been modified. Use getUpdatedDate and setUpdatedDate to get and set the element.
  • A <host:trDate> element that contains the date and time of the most recent successful transfer. This element MUST NOT be provided if the host has never been transferred. Note that host objects MUST NOT be transferred directly; host objects MUST be transferred implicitly when the host object's superordinate domain object is transferred. Host objects that are subject to transfer when transferring a domain object are listed in the response to an EPP <info> command performed on the domain object. Use getTrDate and setTrDate to get and set the element.
  • A <host:authInfo> element derived from either the original creation transaction or the most recent successful parent domain transfer transaction. This element MUST NOT be provided if the querying client is not the current sponsoring client. Use getAuthInfo and setAuthInfo to get and set the element.
See Also:

  • Field Details

  • Constructor Details

    • EPPHostInfoResp

      public EPPHostInfoResp()
      EPPHostInfoResp default constructor. Must call required setter methods before invoking encode, which include:

      • name - setName
      • roid - setRoid
      • status - setStatuses
      • client id - setClientId
      • created by - setCreatedBy
      • created date - setCreatedDate

    • EPPHostInfoResp

      public EPPHostInfoResp(EPPTransId aTransId, String aName, String aRoid, EPPHostStatus aHostStatus, String aClientId, String aCreatedBy, Date aCreatedDate)
      EPPHostInfoResp constuctor that takes the required attribute values as parameters. The setter methods of the optional attributes can be called before invoking encode.
      Parameters:
      aTransId - Transaction Id associated with response.
      aName - Host name
      aRoid - roid
      aHostStatus - EPP Host Status
      aClientId - Owning Client Id
      aCreatedBy - Client Id of Registrar that created the host
      aCreatedDate - Date the host was created

  • Method Details

    • getType

      public String getType()
      Gets the EPP response type associated with EPPHostInfoResp.
      Overrides:
      getType in class EPPResponse
      Returns:
      EPPHostInfoResp.ELM_NAME

    • getNamespace

      public String getNamespace()
      Gets the EPP command namespace associated with EPPHostInfoResp.
      Specified by:
      getNamespace in interface EPPCodecComponent
      Specified by:
      getNamespace in interface EPPMessage
      Overrides:
      getNamespace in class EPPResponse
      Returns:
      EPPHostMapFactory.NS

    • doEncode

      protected Element doEncode(Document aDocument) throws EPPEncodeException
      Encode a DOM Element tree from the attributes of the EPPHostInfoResp instance.
      Overrides:
      doEncode in class EPPResponse
      Parameters:
      aDocument - DOM Document that is being built. Used as an Element factory.
      Returns:
      Element Root DOM Element representing the EPPHostPingMap instance.
      Throws:
      EPPEncodeException - Unable to encode EPPHostPingMap instance.

    • doDecode

      protected void doDecode(Element aElement) throws EPPDecodeException
      Decode the EPPHostInfoResp attributes from the aElement DOM Element tree.
      Overrides:
      doDecode in class EPPResponse
      Parameters:
      aElement - Root DOM Element to decode EPPHostInfoResp from.
      Throws:
      EPPDecodeException - Unable to decode aElement

    • equals

      public boolean equals(Object aObject)
      Compare an instance of EPPHostInfoResp with this instance.
      Overrides:
      equals in class EPPResponse
      Parameters:
      aObject - Object to compare with.
      Returns:
      true if equal; false otherwise

    • clone

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

    • getName

      public String getName()
      Gets the host name
      Returns:
      Host Name if defined; null otherwise.

    • setName

      public void setName(String aName)
      Sets the host name.
      Parameters:
      aName - Host Name

    • getClientId

      public String getClientId()
      Gets the host owning Client Id.
      Returns:
      Client Id if defined; null otherwise.

    • setClientId

      public void setClientId(String aClientId)
      Sets the host owning Client Id.
      Parameters:
      aClientId - Client Id

    • hasAddresses

      public boolean hasAddresses()
      Are addresses set?
      Returns:
      true if addresses are set; false otherwise.

    • addAddress

      public void addAddress(EPPHostAddress aAddress)
      Add an address to the list of addresses.
      Parameters:
      aAddress - Address to add

    • getAddresses

      public Vector<EPPHostAddress> getAddresses()
      Gets the list (Vector) of host addresses. Each host address is an instance of EPPHostAddress.
      Returns:
      Vector of EPPHostAddress instances if defined; null otherwise.

    • setAddresses

      public void setAddresses(Vector<EPPHostAddress> aAddresses)
      Sets the list (Vector) of host addresses. Each host address is an instance of EPPHostAddress.
      Parameters:
      aAddresses - Vector of EPPHostAddress instances

    • getCreatedBy

      public String getCreatedBy()
      Gets Client Id that created the host.
      Returns:
      Client Id if defined; null otherwise.

    • setCreatedBy

      public void setCreatedBy(String aCreatedBy)
      Sets Client Id that created the host.
      Parameters:
      aCreatedBy - Client Id that created the host.

    • getCreatedDate

      public Date getCreatedDate()
      Gets the date and time the host was created.
      Returns:
      Date and time the host was created if defined; null otherwise.

    • setCreatedDate

      public void setCreatedDate(Date aDate)
      Sets the date and time the host was created.
      Parameters:
      aDate - Date and time the host was created.

    • getLastUpdatedBy

      public String getLastUpdatedBy()
      Gets the Client Id that last updated the host. This will be null if the host has not been updated since creation.
      Returns:
      Client Id that last updated the host has been updated; null otherwise.

    • setLastUpdatedBy

      public void setLastUpdatedBy(String aLastUpdatedBy)
      Sets the Client Id that last updated the host.
      Parameters:
      aLastUpdatedBy - Client Id String that last updated the host.

    • getLastUpdatedDate

      public Date getLastUpdatedDate()
      Gets the date and time of the last host update. This will be null if the host has not been updated since creation.
      Returns:
      date and time of the last host update if defined; null otherwise.

    • setLastUpdatedDate

      public void setLastUpdatedDate(Date aLastUpdatedDate)
      Sets the last date and time the host was updated.
      Parameters:
      aLastUpdatedDate - Date and time of the last host update.

    • getTrDate

      public Date getTrDate()
      Get transfer date.
      Returns:
      java.util.Date

    • hasStatuses

      public boolean hasStatuses()
      Are statuses set?
      Returns:
      true if statuses are set; false otherwise.

    • getStatuses

      public Vector<EPPHostStatus> getStatuses()
      Get host statuses.
      Returns:
      Vector of EPPHostStatus if defined; null if undefined.

    • addStatus

      public void addStatus(EPPHostStatus aStatus)
      Add a status to the list of statuses.
      Parameters:
      aStatus - Status to add

    • setStatuses

      @Deprecated public void setStatuses(EPPHostStatus aHostStatus)
      Deprecated.
      Use addStatus(EPPHostStatus)
      Add an individual status to the list of statuses.
      Parameters:
      aHostStatus - com.verisign.epp.codec.host.EPPHostStatus

    • setStatuses

      public void setStatuses(Vector<EPPHostStatus> newStatuses)
      Set host statuses.
      Parameters:
      newStatuses - Vector

    • setTrDate

      public void setTrDate(Date newTrDate)
      Set transfer date.
      Parameters:
      newTrDate - java.util.Date

    • getRoid

      public String getRoid()
      Get roid.
      Returns:
      java.lang.String

    • setRoid

      public void setRoid(String newRoid)
      Set roid.
      Parameters:
      newRoid - java.lang.String