Package com.verisign.epp.codec.loginsec.v1_0

Class EPPLoginSecData

java.lang.Object
com.verisign.epp.codec.loginsec.v1_0.EPPLoginSecData
All Implemented Interfaces:
EPPCodecComponent, Serializable, Cloneable
public class EPPLoginSecData extends Object implements EPPCodecComponent
Login Security Data Extension that extends an EPPResponse to support passing security event information back to the client.
See Also:

  • Field Details

  • Constructor Details

    • EPPLoginSecData

      public EPPLoginSecData()
      Default constructor for EPPLoginSecData.

    • EPPLoginSecData

      public EPPLoginSecData(List<EPPLoginSecEvent> aEvents)
      EPPLoginSecData constructor that takes the list of security events.
      Parameters:
      aEvents - List of security events.

  • Method Details

    • hasEvent

      public boolean hasEvent()
      Has at least one set security event?
      Returns:
      true if there is at least one security event; false otherwise.

    • addEvent

      public void addEvent(EPPLoginSecEvent aEvent)
      Adds an event to the list of security events.
      Parameters:
      aEvent - Event to add.

    • getEvents

      public List<EPPLoginSecEvent> getEvents()
      Gets the list of security events.
      Returns:
      List of EPPLoginSecEvent instances. The list should never be null.

    • setEvents

      public void setEvents(List<EPPLoginSecEvent> aEvents)
      Sets the list of security events.
      Parameters:
      aEvents - List of EPPLoginSecEvent instances.

    • encode

      public Element encode(Document aDocument) throws EPPEncodeException
      Encode instance into a DOM element tree. A DOM Document is passed as an argument and functions as a factory for DOM objects. The root element associated with the instance is created and each instance attribute is appended as a child node.
      Specified by:
      encode in interface EPPCodecComponent
      Parameters:
      aDocument - DOM Document, which acts is an Element factory
      Returns:
      Element Root element associated with the object
      Throws:
      EPPEncodeException - Error encoding EPPLoginSecData

    • decode

      public void decode(Element aElement) throws EPPDecodeException
      Decode a DOM element tree to initialize the instance attributes. The aElement argument represents the root DOM element and is used to traverse the DOM nodes for instance attribute values.
      Specified by:
      decode in interface EPPCodecComponent
      Parameters:
      aElement - Element to decode
      Throws:
      EPPDecodeException - Error decoding Element

    • equals

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

    • clone

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