public class EPPLoginSec extends java.lang.Object implements EPPCodecComponent
EPPLoginCmd
to support passing a longer
password (pw
) or new password (newPW
).Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ELM_LOCALNAME
XML local name for
EPPLoginSec . |
static java.lang.String |
ELM_NAME
XML root tag for
EPPLoginSec . |
static java.lang.String |
LOGIN_SECURITY_PASSWORD
Password set in the
pw or newPW fields of the
login command if overridden the password with the password in the
extension. |
Constructor and Description |
---|
EPPLoginSec()
Default constructor for
EPPLoginSec . |
EPPLoginSec(EPPLoginSecUserAgent aUserAgent)
EPPLoginSec constructor that takes the client user agent. |
EPPLoginSec(EPPLoginSecUserAgent aUserAgent,
java.lang.String aPassword)
EPPLoginSec constructor that takes the password. |
EPPLoginSec(EPPLoginSecUserAgent aUserAgent,
java.lang.String aPassword,
java.lang.String aNewPassword)
EPPLoginSec constructor that takes all attributes (user
agent, password, and new password). |
Modifier and Type | Method and Description |
---|---|
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
EPPLoginSec with this instance. |
java.lang.String |
getNamespace()
Returns the XML namespace associated with the
EPPCodecComponent . |
java.lang.String |
getNewPassword()
Gets the new client password.
|
java.lang.String |
getPassword()
Gets the client password.
|
EPPLoginSecUserAgent |
getUserAgent()
Gets the user agent.
|
boolean |
hasNewPassword()
Is a new password defined?
|
boolean |
hasPassword()
Is a password defined?
|
boolean |
hasUserAgent()
Is a user agent defined?
|
void |
setNewPassword(java.lang.String aNewPassword)
Sets the new client password.
|
void |
setPassword(java.lang.String aPassword)
Sets the client password.
|
void |
setUserAgent(EPPLoginSecUserAgent aUserAgent)
Sets the user agent.
|
java.lang.String |
toString()
Implementation of
Object.toString , which will result in an
indented XML String representation of the concrete
EPPCodecComponent . |
public static final java.lang.String LOGIN_SECURITY_PASSWORD
pw
or newPW
fields of the
login command if overridden the password with the password in the
extension.public static final java.lang.String ELM_LOCALNAME
EPPLoginSec
.public static final java.lang.String ELM_NAME
EPPLoginSec
.public EPPLoginSec()
EPPLoginSec
.public EPPLoginSec(EPPLoginSecUserAgent aUserAgent)
EPPLoginSec
constructor that takes the client user agent.aUserAgent
- Client user agentpublic EPPLoginSec(EPPLoginSecUserAgent aUserAgent, java.lang.String aPassword)
EPPLoginSec
constructor that takes the password.aUserAgent
- Client user agent. Set to null
if undefined.aPassword
- Client passwordpublic EPPLoginSec(EPPLoginSecUserAgent aUserAgent, java.lang.String aPassword, java.lang.String aNewPassword)
EPPLoginSec
constructor that takes all attributes (user
agent, password, and new password).aUserAgent
- Client user agent. Set to null
if undefined.aPassword
- Client passwordaNewPassword
- New client passwordpublic boolean hasUserAgent()
true
if the user agent is defined; false
otherwise.public EPPLoginSecUserAgent getUserAgent()
null
otherwise.public void setUserAgent(EPPLoginSecUserAgent aUserAgent)
aUserAgent
- User agent. Set to null
to unset the user agent.public boolean hasPassword()
true
if the password is defined; false
otherwise.public java.lang.String getPassword()
null
otherwise.public void setPassword(java.lang.String aPassword)
aPassword
- Client password.public boolean hasNewPassword()
true
if the new password is defined;
false
otherwise.public java.lang.String getNewPassword()
null
otherwise.public void setNewPassword(java.lang.String aNewPassword)
aNewPassword
- New client password.public org.w3c.dom.Element encode(org.w3c.dom.Document aDocument) throws EPPEncodeException
encode
in interface EPPCodecComponent
aDocument
- DOM Document, which acts is an Element factoryEPPEncodeException
- Error encoding EPPLoginSec
public void decode(org.w3c.dom.Element aElement) throws EPPDecodeException
aElement
argument represents the root DOM element and is used
to traverse the DOM nodes for instance attribute values.decode
in interface EPPCodecComponent
aElement
- Element
to decodeEPPDecodeException
- Error decoding Element
public boolean equals(java.lang.Object aObject)
EPPLoginSec
with this instance.equals
in class java.lang.Object
aObject
- Object to compare with.true
if equal; false
otherwise.public java.lang.Object clone() throws java.lang.CloneNotSupportedException
EPPCodecComponent
instance.clone
in interface EPPCodecComponent
clone
in class java.lang.Object
EPPLoginSec
java.lang.CloneNotSupportedException
- standard Object.clone exceptionpublic java.lang.String toString()
Object.toString
, which will result in an
indented XML String
representation of the concrete
EPPCodecComponent
.toString
in class java.lang.Object
String
if successful; ERROR
otherwise.public java.lang.String getNamespace()
EPPCodecComponent
.getNamespace
in interface EPPCodecComponent
EPPCodecComponent
.