Package com.verisign.epp.codec.maintenance.v1_0

Class EPPMaintenanceSystem

java.lang.Object
com.verisign.epp.codec.maintenance.v1_0.EPPMaintenanceSystem
All Implemented Interfaces:
EPPCodecComponent, Serializable, Cloneable
public class EPPMaintenanceSystem extends Object implements EPPCodecComponent
EPPMaintenanceSystem indicates what impacted system with the following attributes:
  • name - Name of the affected system, such as 'EPP', 'WHOIS', 'DNS', 'Portal', etc..
  • host - Indicates the affected maintained system based on host name or host address.
  • impact - Indicates the impact level, which is either 'full' or 'partial'.
See Also:

  • Field Details

  • Constructor Details

    • EPPMaintenanceSystem

      public EPPMaintenanceSystem()
      Default constructor for EPPMaintenanceSystem. The required attributes need to be set. The impact attribute defaults to EPPMaintenanceSystem.Impact.partial.

    • EPPMaintenanceSystem

      public EPPMaintenanceSystem(String aName, String aHost, EPPMaintenanceSystem.Impact aImpact)
      Constructor for EPPMaintenanceSystem with all of the attributes as parameters.
      Parameters:
      aName - Name of the affected system, such as 'EPP', 'WHOIS', 'DNS', 'PORTAL', etc..
      aHost - Host of the system
      aImpact - Impact of system maintenance

  • Method Details

    • getName

      public String getName()
      Gets the name of the affected system, such as 'EPP', 'WHOIS', 'DNS', 'PORTAL', etc..
      Returns:
      Name of the affected system if set; null otherwise.

    • setName

      public void setName(String aName)
      Sets the name of the affected system, such as 'EPP', 'WHOIS', 'DNS', 'PORTAL', etc..
      Parameters:
      aName - Name of the affected system

    • hasHost

      public boolean hasHost()
      Is the system host defined?
      Returns:
      true if the system host is defined; false otherwise.

    • getHost

      public String getHost()
      Gets the OPTIONAL affected maintained system host.
      Returns:
      The affected maintained system host if defined; null otherwise.

    • setHost

      public void setHost(String aHost)
      Sets the OPTIONAL affected maintained system host.
      Parameters:
      aHost - affected maintained system host.

    • getImpact

      public EPPMaintenanceSystem.Impact getImpact()
      Gets the impact level.
      Returns:
      Returns the impact level with the default set to EPPMaintenanceSystem.Impact.partial.

    • setImpact

      public void setImpact(EPPMaintenanceSystem.Impact impact)
      Sets the impact level.
      Parameters:
      impact - level of the system maintenance

    • encode

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

    • decode

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

    • equals

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

    • clone

      public Object clone() throws CloneNotSupportedException
      Clone EPPMaintenanceSystem.
      Specified by:
      clone in interface EPPCodecComponent
      Overrides:
      clone in class Object
      Returns:
      clone of EPPMaintenanceSystem
      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.

    • getNamespace

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