Package com.verisign.epp.codec.contact
Class EPPContactInfoCmd
- java.lang.Object
-
- com.verisign.epp.codec.gen.EPPCommand
-
- com.verisign.epp.codec.gen.EPPInfoCmd
-
- com.verisign.epp.codec.contact.EPPContactInfoCmd
-
- All Implemented Interfaces:
EPPCodecComponent
,EPPMessage
,java.io.Serializable
,java.lang.Cloneable
public class EPPContactInfoCmd extends EPPInfoCmd
Represents an EPP Contact <info> command that is used to retrieve information associated with a contact. In addition to the standard EPP command elements, the <info> command MUST contain a <contact:info> element that identifies the contact namespace and the location of the contact schema. The <contact:info> element MUST contain the following child elements:
-
A <contact:id> element that contains the server-unique identifier for
the queried contact. Use
getId
andsetId
to get and set the element.
EPPContactInfoResp
is the concreteEPPReponse
associated withEPPContactInfoCmd
.- See Also:
EPPContactInfoResp
, Serialized Form
-
-
Field Summary
-
Fields inherited from class com.verisign.epp.codec.gen.EPPCommand
extensions, OP_APPROVE, OP_CANCEL, OP_QUERY, OP_REJECT, OP_REQUEST, transId, TYPE_CHECK, TYPE_CREATE, TYPE_DELETE, TYPE_INFO, TYPE_LOGIN, TYPE_LOGOUT, TYPE_POLL, TYPE_RENEW, TYPE_TRANSFER, TYPE_UPDATE
-
-
Constructor Summary
Constructors Constructor Description EPPContactInfoCmd()
EPPContactInfoCmd
default constructor.EPPContactInfoCmd(java.lang.String aTransId, java.lang.String aId)
EPPContactInfoCmd
constructor that takes the contact id as an argument.EPPContactInfoCmd(java.lang.String aTransId, java.lang.String aName, EPPAuthInfo aAuthInfo)
EPPDomainInfoCmd
constructor that takes the domain name as an argument.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Object
clone()
CloneEPPContactInfoCmd
.protected void
doDecode(org.w3c.dom.Element aElement)
Decode theEPPContactInfoCmd
attributes from the aElement DOM Element tree.protected org.w3c.dom.Element
doEncode(org.w3c.dom.Document aDocument)
Encode a DOM Element tree from the attributes of theEPPContactInfoCmd
instance.boolean
equals(java.lang.Object aObject)
Compare an instance ofEPPContactInfoCmd
with this instance.EPPAuthInfo
getAuthInfo()
Get authorization informationjava.lang.String
getId()
Gets the contact id to get information on.java.lang.String
getNamespace()
Gets the EPP command Namespace associated withEPPContactInfoCmd
.void
setAuthInfo(EPPAuthInfo aAuthInfo)
Set authorization informationvoid
setId(java.lang.String aId)
Sets the contact id to get information on.java.lang.String
toString()
Implementation ofObject.toString
, which will result in an indented XMLString
representation of the concreteEPPCodecComponent
.-
Methods inherited from class com.verisign.epp.codec.gen.EPPInfoCmd
doGenDecode, doGenEncode, getType
-
Methods inherited from class com.verisign.epp.codec.gen.EPPCommand
addExtension, decode, encode, findDuplicateExtNamespaces, findExtNamespaces, findExtNamespaceSuffixes, findUnsupportedExtNamespaces, findUnsupportedExtNamespaceSuffixes, getExtension, getExtension, getExtensions, getOp, getTransId, hasExtension, hasExtensions, hasTransId, setExtension, setExtensions, setTransId
-
-
-
-
Constructor Detail
-
EPPContactInfoCmd
public EPPContactInfoCmd()
EPPContactInfoCmd
default constructor. The id is initialized tonull
. The id must be set before invokingencode
.
-
EPPContactInfoCmd
public EPPContactInfoCmd(java.lang.String aTransId, java.lang.String aId)
EPPContactInfoCmd
constructor that takes the contact id as an argument.- Parameters:
aTransId
- Transaction Id associated with command.aId
- Contact id to get information on.
-
EPPContactInfoCmd
public EPPContactInfoCmd(java.lang.String aTransId, java.lang.String aName, EPPAuthInfo aAuthInfo)
EPPDomainInfoCmd
constructor that takes the domain name as an argument.- Parameters:
aTransId
- Transaction Id associated with command.aName
- Domain name to get information on.aAuthInfo
- Optional authorization information. Set tonull
to use no authorization information.
-
-
Method Detail
-
getNamespace
public java.lang.String getNamespace()
Gets the EPP command Namespace associated withEPPContactInfoCmd
.- Specified by:
getNamespace
in interfaceEPPCodecComponent
- Specified by:
getNamespace
in interfaceEPPMessage
- Specified by:
getNamespace
in classEPPCommand
- Returns:
EPPContactMapFactory.NS
-
doEncode
protected org.w3c.dom.Element doEncode(org.w3c.dom.Document aDocument) throws EPPEncodeException
Encode a DOM Element tree from the attributes of theEPPContactInfoCmd
instance.- Specified by:
doEncode
in classEPPInfoCmd
- Parameters:
aDocument
- DOM Document that is being built. Used as an Element factory.- Returns:
- Root DOM Element representing the
EPPContactInfoCmd
instance. - Throws:
EPPEncodeException
- Unable to encodeEPPContactInfoCmd
instance.
-
doDecode
protected void doDecode(org.w3c.dom.Element aElement) throws EPPDecodeException
Decode theEPPContactInfoCmd
attributes from the aElement DOM Element tree.- Specified by:
doDecode
in classEPPInfoCmd
- Parameters:
aElement
- - Root DOM Element to decodeEPPContactInfoCmd
from.- Throws:
EPPDecodeException
- - Unable to decode aElement
-
getId
public java.lang.String getId()
Gets the contact id to get information on.- Returns:
- Contact Id
String
instance if defined;null
otherwise.
-
setId
public void setId(java.lang.String aId)
Sets the contact id to get information on.- Parameters:
aId
- Contact Id
-
getAuthInfo
public EPPAuthInfo getAuthInfo()
Get authorization information- Returns:
- Authorization information if defined;
null
otherwise;
-
setAuthInfo
public void setAuthInfo(EPPAuthInfo aAuthInfo)
Set authorization information- Parameters:
aAuthInfo
- EPPAuthInfo
-
equals
public boolean equals(java.lang.Object aObject)
Compare an instance ofEPPContactInfoCmd
with this instance.- Overrides:
equals
in classEPPInfoCmd
- Parameters:
aObject
- Object to compare with.- Returns:
- DOCUMENT ME!
-
clone
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
CloneEPPContactInfoCmd
.- Specified by:
clone
in interfaceEPPCodecComponent
- Overrides:
clone
in classEPPCommand
- Returns:
- clone of
EPPContactInfoCmd
- 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 classEPPCommand
- Returns:
- Indented XML
String
if successful;ERROR
otherwise.
-
-