Class EPPLoginSecPolicySystem
- java.lang.Object
-
- com.verisign.epp.codec.loginsecpolicy.v04.EPPLoginSecPolicySystem
-
- All Implemented Interfaces:
EPPCodecComponent
,EPPRegistrySystemInfoInterface
,java.io.Serializable
,java.lang.Cloneable
public class EPPLoginSecPolicySystem extends java.lang.Object implements EPPCodecComponent, EPPRegistrySystemInfoInterface
EPPLoginSecPolicySystem
contains all of the login security policy information associated with the system.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
ELM_LOCALNAME
XML local name forEPPLoginSecPolicySystem
.static java.lang.String
ELM_NAME
XML root tag forEPPLoginSecPolicySystem
.
-
Constructor Summary
Constructors Constructor Description EPPLoginSecPolicySystem()
Default constructor forEPPLoginSecPolicySystem
.EPPLoginSecPolicySystem(EPPLoginSecPolicyPassword aPassword)
Constructor forEPPLoginSecPolicySystem
that takes the required password attribute.EPPLoginSecPolicySystem(EPPLoginSecPolicyPassword aPassword, java.lang.Boolean aUserAgentSupport, EPPLoginSecPolicyEvent aEvent)
Constructor forEPPLoginSecPolicySystem
that the required password attribute and the optional attributes with a single event.EPPLoginSecPolicySystem(EPPLoginSecPolicyPassword aPassword, java.lang.Boolean aUserAgentSupport, java.util.List<EPPLoginSecPolicyEvent> aEvents)
Constructor forEPPLoginSecPolicySystem
that the required password attribute and the optional attributes with a list of events.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addEvent(EPPLoginSecPolicyEvent aEvent)
Adds an event to the list of events.java.lang.Object
clone()
Clone anEPPCodecComponent
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 ofEPPLoginSecPolicySystem
with this instance.java.util.List<EPPLoginSecPolicyEvent>
getEvents()
Gets the list of events if defined.java.lang.String
getNamespace()
Returns the XML namespace associated with theEPPCodecComponent
.EPPLoginSecPolicyPassword
getPassword()
Gets the login password format policy.java.lang.Boolean
getUserAgentSupport()
Gets the OPTIONAL boolean value that indicates the server supports the <loginSec:userAgentSupport> element.boolean
hasEvens()
Are the events defined?boolean
hasUserAgentSupport()
Is the user agent flag defined?void
setEvents(java.util.List<EPPLoginSecPolicyEvent> aEvents)
Sets the list of events.void
setPassword(EPPLoginSecPolicyPassword aPassword)
Sets the login password format policy.void
setUserAgentSupport(java.lang.Boolean aUserAgentSupport)
Sets the OPTIONAL boolean value that indicates the server supports the <loginSec:userAgentSupport> element.java.lang.String
toString()
Implementation ofObject.toString
, which will result in an indented XMLString
representation of the concreteEPPCodecComponent
.
-
-
-
Field Detail
-
ELM_LOCALNAME
public static final java.lang.String ELM_LOCALNAME
XML local name forEPPLoginSecPolicySystem
.- See Also:
- Constant Field Values
-
ELM_NAME
public static final java.lang.String ELM_NAME
XML root tag forEPPLoginSecPolicySystem
.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
EPPLoginSecPolicySystem
public EPPLoginSecPolicySystem()
Default constructor forEPPLoginSecPolicySystem
.
-
EPPLoginSecPolicySystem
public EPPLoginSecPolicySystem(EPPLoginSecPolicyPassword aPassword)
Constructor forEPPLoginSecPolicySystem
that takes the required password attribute.- Parameters:
aPassword
- The login password format policy
-
EPPLoginSecPolicySystem
public EPPLoginSecPolicySystem(EPPLoginSecPolicyPassword aPassword, java.lang.Boolean aUserAgentSupport, EPPLoginSecPolicyEvent aEvent)
Constructor forEPPLoginSecPolicySystem
that the required password attribute and the optional attributes with a single event.- Parameters:
aPassword
- The login password format policyaUserAgentSupport
- OPTIONAL boolean value that indicates the server supports the <loginSec:userAgentSupport> element. Set tonull
if undefined.aEvent
- Login security event. Set tonull
if undefined.
-
EPPLoginSecPolicySystem
public EPPLoginSecPolicySystem(EPPLoginSecPolicyPassword aPassword, java.lang.Boolean aUserAgentSupport, java.util.List<EPPLoginSecPolicyEvent> aEvents)
Constructor forEPPLoginSecPolicySystem
that the required password attribute and the optional attributes with a list of events.- Parameters:
aPassword
- The login password format policyaUserAgentSupport
- OPTIONAL boolean value that indicates the server supports the <loginSec:userAgentSupport> element. Set tonull
if undefined.aEvents
- List of events.
-
-
Method Detail
-
getPassword
public EPPLoginSecPolicyPassword getPassword()
Gets the login password format policy.- Returns:
- the password format policy if defined;
null
otherwise.
-
setPassword
public void setPassword(EPPLoginSecPolicyPassword aPassword)
Sets the login password format policy.- Parameters:
aPassword
- the password format policy to set
-
hasUserAgentSupport
public boolean hasUserAgentSupport()
Is the user agent flag defined?- Returns:
true
if the user agent flag is defined;false
otherwise.
-
getUserAgentSupport
public java.lang.Boolean getUserAgentSupport()
Gets the OPTIONAL boolean value that indicates the server supports the <loginSec:userAgentSupport> element.- Returns:
true
orfalse
indicating whether the server supports the <loginSec:userAgentSupport> element if defined;null
otherwise.
-
setUserAgentSupport
public void setUserAgentSupport(java.lang.Boolean aUserAgentSupport)
Sets the OPTIONAL boolean value that indicates the server supports the <loginSec:userAgentSupport> element.- Parameters:
aUserAgentSupport
-true
orfalse
indicating whether the server supports the <loginSec:userAgentSupport> element. Set tonull
if undefined.
-
hasEvens
public boolean hasEvens()
Are the events defined?- Returns:
true
if the evets are defined;false
otherwise.
-
getEvents
public java.util.List<EPPLoginSecPolicyEvent> getEvents()
Gets the list of events if defined.- Returns:
- List of events if defined; empty list otherwise.
-
addEvent
public void addEvent(EPPLoginSecPolicyEvent aEvent)
Adds an event to the list of events.- Parameters:
aEvent
- The event to add.
-
setEvents
public void setEvents(java.util.List<EPPLoginSecPolicyEvent> aEvents)
Sets the list of events.- Parameters:
aEvents
- The events to set.
-
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 interfaceEPPCodecComponent
- Parameters:
aDocument
- DOM Document, which acts is an Element factory- Returns:
- Element Root element associated with the object
- Throws:
EPPEncodeException
- Error encodingEPPLoginSecPolicySystem
-
decode
public void decode(org.w3c.dom.Element aElement) throws EPPDecodeException
Decode a DOM element tree to initialize the instance attributes. TheaElement
argument represents the root DOM element and is used to traverse the DOM nodes for instance attribute values.- Specified by:
decode
in interfaceEPPCodecComponent
- Parameters:
aElement
-Element
to decode- Throws:
EPPDecodeException
- Error decodingElement
-
clone
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
Clone anEPPCodecComponent
instance.- Specified by:
clone
in interfaceEPPCodecComponent
- Overrides:
clone
in classjava.lang.Object
- Returns:
- clone of concrete
EPPLoginSecPolicySystem
- Throws:
java.lang.CloneNotSupportedException
- standard Object.clone exception
-
toString
public java.lang.String toString()
Implementation ofObject.toString
, which will result in an indented XMLString
representation of the concreteEPPCodecComponent
.- Overrides:
toString
in classjava.lang.Object
- Returns:
- Indented XML
String
if successful;ERROR
otherwise.
-
equals
public boolean equals(java.lang.Object aObject)
Compare an instance ofEPPLoginSecPolicySystem
with this instance.- Overrides:
equals
in classjava.lang.Object
- Parameters:
aObject
- Object to compare with.- Returns:
true
if equal;false
otherwise.
-
getNamespace
public java.lang.String getNamespace()
Returns the XML namespace associated with theEPPCodecComponent
.- Specified by:
getNamespace
in interfaceEPPCodecComponent
- Returns:
- XML namespace for the
EPPCodecComponent
.
-
-