com.verisign.epp.codec.loginsec.v01

Class EPPLoginSecData

java.lang.Object

com.verisign.epp.codec.loginsec.v01.EPPLoginSecData

All Implemented Interfaces:

EPPCodecComponent, java.io.Serializable, java.lang.Cloneable

public class EPPLoginSecData
extends java.lang.Object
implements EPPCodecComponent

Login Security Data Extension that extends an EPPResponse to support passing security event information back to the client.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ELM_LOCALNAME XML local name for EPPLoginSecData.
static java.lang.String	ELM_NAME XML root tag for EPPLoginSecData.

Constructor Summary

Constructors

Constructor and Description
EPPLoginSecData() Default constructor for EPPLoginSecData.
EPPLoginSecData(java.util.List<EPPLoginSecEvent> aEvents) EPPLoginSecData constructor that takes the list of security events.

Method Summary

Modifier and Type	Method and Description
void	addEvent(EPPLoginSecEvent aEvent) Adds an event to the list of security events.
java.lang.Object	clone() Clone an EPPCodecComponent instance.
void	decode(org.w3c.dom.Element aElement) Decode a DOM element tree to initialize the instance attributes.
org.w3c.dom.Element	encode(org.w3c.dom.Document aDocument) Encode instance into a DOM element tree.
boolean	equals(java.lang.Object aObject) Compare an instance of EPPLoginSecData with this instance.
java.util.List<EPPLoginSecEvent>	getEvents() Gets the list of security events.
java.lang.String	getNamespace() Returns the XML namespace associated with the EPPCodecComponent.
boolean	hasEvent() Has at least one set security event?
void	setEvents(java.util.List<EPPLoginSecEvent> aEvents) Sets the list of security events.
java.lang.String	toString() Implementation of Object.toString, which will result in an indented XML String representation of the concrete EPPCodecComponent.

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

ELM_LOCALNAME

public static final java.lang.String ELM_LOCALNAME

XML local name for EPPLoginSecData.

See Also:

Constant Field Values

ELM_NAME

public static final java.lang.String ELM_NAME

XML root tag for EPPLoginSecData.

See Also:

Constant Field Values

Constructor Detail

EPPLoginSecData

public EPPLoginSecData()

Default constructor for EPPLoginSecData.

EPPLoginSecData

public EPPLoginSecData(java.util.List<EPPLoginSecEvent> aEvents)

EPPLoginSecData constructor that takes the list of security events.

Parameters:

aEvents - List of security events.

Method Detail

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 java.util.List<EPPLoginSecEvent> getEvents()

Gets the list of security events.

Returns:

List of EPPLoginSecEvent instances. The list should never be null.

setEvents

public void setEvents(java.util.List<EPPLoginSecEvent> aEvents)

Sets the list of security events.

Parameters:

aEvents - List of EPPLoginSecEvent instances.

encode

public org.w3c.dom.Element encode(org.w3c.dom.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(org.w3c.dom.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(java.lang.Object aObject)

Compare an instance of EPPLoginSecData with this instance.

Overrides:

equals in class java.lang.Object

Parameters:

aObject - Object to compare with.

Returns:

true if equal; false otherwise.

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Clone an EPPCodecComponent instance.

Specified by:

clone in interface EPPCodecComponent

Overrides:

clone in class java.lang.Object

Returns:

clone of concrete EPPLoginSecData

Throws:

java.lang.CloneNotSupportedException - standard Object.clone exception

toString

public java.lang.String toString()

Implementation of Object.toString, which will result in an indented XML String representation of the concrete EPPCodecComponent.

Overrides:

toString in class java.lang.Object

Returns:

Indented XML String if successful; ERROR otherwise.

getNamespace

public java.lang.String getNamespace()

Returns the XML namespace associated with the EPPCodecComponent.

Specified by:

getNamespace in interface EPPCodecComponent

Returns:

XML namespace for the EPPCodecComponent.