public class EPPAuthInfo extends java.lang.Object implements EPPCodecComponent
authInfo
in
the EPP Shared Structure Schema (with the name space eppcom
).Modifier and Type | Field and Description |
---|---|
protected static java.lang.String |
ATTR_ROID
XML Element roid attribute name of
EPPAuthInfo root
element. |
protected static java.lang.String |
ELM_EXT
XML Element name extensible authorization type
|
protected static java.lang.String |
ELM_PW
XML Element name password authorization type
|
protected EPPCodecComponent |
ext
Extension authorization information.
|
protected java.lang.String |
password
Password authorization information.
|
protected java.lang.String |
roid
roid.
|
protected short |
type
type, and default value is
TYPE_PW |
static short |
TYPE_EXT
Extensible auth info type.
|
static short |
TYPE_PW
password auth info type
|
Constructor and Description |
---|
EPPAuthInfo()
Default constructor that must have the password or extension attributes
set before calling
encode . |
EPPAuthInfo(EPPCodecComponent aExt)
Constructor that takes just the authorization extension.
|
EPPAuthInfo(java.lang.String aPassword)
Constructor that takes just the authorization password.
|
EPPAuthInfo(java.lang.String aRootNS,
java.lang.String aRootName,
EPPCodecComponent aExt)
Constructor that takes a root elemeent and the authorization extension.
|
EPPAuthInfo(java.lang.String aRootNS,
java.lang.String aRootName,
java.lang.String aPassword)
Constructor that takes the root element and the authorization password.
|
EPPAuthInfo(java.lang.String aRootNS,
java.lang.String aRootName,
java.lang.String aRoid,
java.lang.String aPassword)
Constructor that takes the root element, the authorization password,
and the roid.
|
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
clone()
Clone
EPPAuthInfo . |
void |
decode(org.w3c.dom.Element aElement)
Decode the EPPAuthInfo attributes from the aElement DOM Element tree.
|
org.w3c.dom.Element |
encode(org.w3c.dom.Document aDocument)
Encode a DOM Element tree from the attributes of the EPPAuthInfo
instance.
|
boolean |
equals(java.lang.Object aObject)
implements a deep
EPPAuthInfo compare. |
java.lang.String |
getAuthInfo()
Deprecated.
Replaced by
getPassword() . |
EPPCodecComponent |
getExt()
Gets the extension authorization.
|
java.lang.String |
getNamespace()
Returns the XML namespace associated with the
EPPCodecComponent . |
java.lang.String |
getPassword()
Gets the password authorization information.
|
java.lang.String |
getRoid()
Get Registry Object IDentifier (ROID).
|
java.lang.String |
getRootName()
Get root name such as domain or contact.
|
java.lang.String |
getRootNS()
Gets the root element XML namespace URI.
|
short |
getType()
Get the type of the auth info.
|
void |
setAuthInfo(java.lang.String aPassword)
Deprecated.
Replaced by
setPassword(String) . |
void |
setExt(EPPCodecComponent aExt)
Sets the extension authorization information.
|
void |
setPassword(java.lang.String aPassword)
Sets the password authorization information.
|
void |
setRoid(java.lang.String aRoid)
Set Registry Object IDentifier (ROID).
|
void |
setRootName(java.lang.String aRootNS,
java.lang.String newRootName)
Set root name and XML namespace.
|
void |
setType(short aType)
Set auth info type.
|
java.lang.String |
toString()
Implementation of
Object.toString , which will result in an
indented XML String representation of the concrete
EPPCodecComponent . |
public static final short TYPE_PW
public static final short TYPE_EXT
protected static final java.lang.String ELM_PW
protected static final java.lang.String ELM_EXT
protected static final java.lang.String ATTR_ROID
EPPAuthInfo
root
element.protected java.lang.String password
protected EPPCodecComponent ext
protected short type
TYPE_PW
protected java.lang.String roid
public EPPAuthInfo()
encode
.public EPPAuthInfo(java.lang.String aPassword)
aPassword
- Authorization passwordpublic EPPAuthInfo(java.lang.String aRootNS, java.lang.String aRootName, java.lang.String aPassword)
aRootNS
- Root element namespace URIaRootName
- Root element of auth info.aPassword
- Authorization passwordpublic EPPAuthInfo(java.lang.String aRootNS, java.lang.String aRootName, java.lang.String aRoid, java.lang.String aPassword)
aRootNS
- Root element namespace URIaRootName
- Root element of auth info.aRoid
- Roid of the RegistrantaPassword
- Authorization passwordpublic EPPAuthInfo(EPPCodecComponent aExt)
aExt
- Extension authorization elementpublic EPPAuthInfo(java.lang.String aRootNS, java.lang.String aRootName, EPPCodecComponent aExt)
aRootNS
- Root element namespace URIaRootName
- Root element of auth info.aExt
- Extension authorization elementpublic java.lang.String getRoid()
public void setRoid(java.lang.String aRoid)
aRoid
- The Registry Object IDentifier (ROID) value.public java.lang.String getRootNS()
public java.lang.String getRootName()
public void setRootName(java.lang.String aRootNS, java.lang.String newRootName)
aRootNS
- Root element namespace URInewRootName
- Stringpublic java.lang.String getAuthInfo()
getPassword()
.public java.lang.String getPassword()
public void setPassword(java.lang.String aPassword)
aPassword
- Authorization passwordpublic EPPCodecComponent getExt()
public void setExt(EPPCodecComponent aExt)
aExt
- Authorization extensionpublic void setAuthInfo(java.lang.String aPassword)
setPassword(String)
.aPassword
- Authorization passwordpublic short getType()
TYPE_
constants.public void setType(short aType)
TYPE_PW
.aType
- One of the TYPE_
constantspublic java.lang.Object clone() throws java.lang.CloneNotSupportedException
EPPAuthInfo
.clone
in interface EPPCodecComponent
clone
in class java.lang.Object
EPPAuthInfo
java.lang.CloneNotSupportedException
- standard Object.clone exceptionpublic void decode(org.w3c.dom.Element aElement) throws EPPDecodeException
decode
in interface EPPCodecComponent
aElement
- - Root DOM Element to decode EPPDomainContact from.EPPDecodeException
- - Unable to decode aElement.public org.w3c.dom.Element encode(org.w3c.dom.Document aDocument) throws EPPEncodeException
encode
in interface EPPCodecComponent
aDocument
- - DOM Document that is being built. Used as an Element
factory.EPPEncodeException
- - Unable to encode EPPAuthInfo instance.public boolean equals(java.lang.Object aObject)
EPPAuthInfo
compare.equals
in class java.lang.Object
aObject
- EPPAuthInfo
instance to compare withtrue
if equal; false
otherwisepublic 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
.Copyright © VeriSign Inc. All Rights Reserved.