public class EPPRegistryInfoCmd extends EPPInfoCmd
isAll
and setAll
to get and set the element.getName
and
setName
to get and set the element.isSystem
and setSystem
to get and set the
element.EPPRegistryInfoCmd
must contains one and only one of the
above elements. EPPRegistryInfoResp
is the concrete EPPReponse
associated
with EPPRegistryInfoResp
. EPPRegistryInfoResp
,
Serialized FormModifier and Type | Class and Description |
---|---|
static class |
EPPRegistryInfoCmd.Mode
Possible values for the
mode attribute, which defines the mode to
query. |
static class |
EPPRegistryInfoCmd.Scope
Possible values for the
scope attribute. |
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ATTR_SCOPE
XML attribute name for the
scope attribute. |
static java.lang.String |
ELM_LOCALNAME
XML local name for
EPPRegistryInfoCmd . |
static java.lang.String |
ELM_NAME
XML root tag for
EPPRegistryInfoCmd . |
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 and Description |
---|
EPPRegistryInfoCmd()
EPPRegistryInfoCmd default constructor. |
EPPRegistryInfoCmd(java.lang.String aTransId,
EPPRegistryInfoCmd.Mode aMode)
EPPRegistryInfoCmd constructor defines the query mode to use. |
EPPRegistryInfoCmd(java.lang.String aTransId,
EPPRegistryInfoCmd.Scope aScope)
EPPRegistryInfoCmd constructor that queries for all of the
accessible and/or available zone objects from the server with the desired
scope. |
EPPRegistryInfoCmd(java.lang.String aTransId,
EPPRegistryZoneName aName)
EPPRegistryInfoCmd constructor that takes the qualified zone
object name as an argument. |
EPPRegistryInfoCmd(java.lang.String aTransId,
java.lang.String aName)
EPPRegistryInfoCmd constructor that takes the qualified aLabel
zone object name as an argument. |
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
clone()
Clone
EPPRegistryInfoCmd . |
protected void |
doDecode(org.w3c.dom.Element aElement)
Decode the
EPPRegistryInfoCmd 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 the
EPPRegistryInfoCmd instance. |
boolean |
equals(java.lang.Object aObject)
Compare an instance of
EPPRegistryInfoCmd with this instance. |
EPPRegistryInfoCmd.Mode |
getMode()
Gets the query mode.
|
EPPRegistryZoneName |
getName()
Gets the zone name.
|
java.lang.String |
getNamespace()
Gets the EPP command namespace associated with
EPPRegistryInfoCmd
. |
EPPRegistryInfoCmd.Scope |
getScope()
Gets the zone scope used with the query all option.
|
boolean |
hasMode()
Is the query mode defined?
|
boolean |
hasName()
Is the name defined?
|
void |
setMode(EPPRegistryInfoCmd.Mode aMode)
Sets the query mode.
|
void |
setName(EPPRegistryZoneName aName)
Sets the zone name to query for.
|
void |
setName(java.lang.String aName)
Sets the zone name to query for.
|
void |
setScope(EPPRegistryInfoCmd.Scope aScope)
Sets the zone scope used with the query all mode.
|
doGenDecode, doGenEncode, getType
addExtension, decode, encode, findDuplicateExtNamespaces, getExtension, getExtension, getExtensions, getOp, getTransId, hasExtension, hasExtensions, hasTransId, setExtension, setExtensions, setTransId, toString
public static final java.lang.String ELM_LOCALNAME
EPPRegistryInfoCmd
.public static final java.lang.String ELM_NAME
EPPRegistryInfoCmd
.public static final java.lang.String ATTR_SCOPE
scope
attribute.public EPPRegistryInfoCmd()
EPPRegistryInfoCmd
default constructor. The mode
must be
set using setMode(Mode)
prior to invoking
EPPCommand.encode(Document)
.public EPPRegistryInfoCmd(java.lang.String aTransId, java.lang.String aName)
EPPRegistryInfoCmd
constructor that takes the qualified aLabel
zone object name as an argument. The mode is set to EPPRegistryInfoCmd.Mode.name
.aTransId
- transaction Id associated with commandaName
- fully qualified aLabel zone object name to get information onpublic EPPRegistryInfoCmd(java.lang.String aTransId, EPPRegistryZoneName aName)
EPPRegistryInfoCmd
constructor that takes the qualified zone
object name as an argument. The mode is set to EPPRegistryInfoCmd.Mode.name
.aTransId
- transaction Id associated with commandaName
- fully qualified zone object name to get information onpublic EPPRegistryInfoCmd(java.lang.String aTransId, EPPRegistryInfoCmd.Mode aMode)
EPPRegistryInfoCmd
constructor defines the query mode to use. It
is most likely used when setting the mode to EPPRegistryInfoCmd.Mode.system
.aTransId
- transaction Id associated with commandaMode
- Query mode to use.public EPPRegistryInfoCmd(java.lang.String aTransId, EPPRegistryInfoCmd.Scope aScope)
EPPRegistryInfoCmd
constructor that queries for all of the
accessible and/or available zone objects from the server with the desired
scope. The mode is set to EPPRegistryInfoCmd.Mode.all
.aTransId
- transaction Id associated with commandaScope
- Zone scope to query for. Passing null
will result in the
use of the default scope Scope#accessible
.protected org.w3c.dom.Element doEncode(org.w3c.dom.Document aDocument) throws EPPEncodeException
EPPRegistryInfoCmd
instance.doEncode
in class EPPInfoCmd
aDocument
- DOM Document that is being built. Used as an Element factory.EPPRegistryInfoCmd
instance.EPPEncodeException
- Unable to encode EPPRegistryInfoCmd
instance.protected void doDecode(org.w3c.dom.Element aElement) throws EPPDecodeException
EPPRegistryInfoCmd
attributes from the aElement DOM
Element tree.doDecode
in class EPPInfoCmd
aElement
- Root DOM Element to decode EPPRegistryInfoCmd
from.EPPDecodeException
- Unable to decode aElementpublic java.lang.String getNamespace()
EPPRegistryInfoCmd
.getNamespace
in interface EPPCodecComponent
getNamespace
in interface EPPMessage
getNamespace
in class EPPCommand
EPPRegistryMapFactory.NS
public boolean equals(java.lang.Object aObject)
EPPRegistryInfoCmd
with this instance.equals
in class EPPInfoCmd
aObject
- Object to compare withtrue
if this object is the same as the aObject argument;
false
otherwisepublic java.lang.Object clone() throws java.lang.CloneNotSupportedException
EPPRegistryInfoCmd
.clone
in interface EPPCodecComponent
clone
in class EPPCommand
EPPRegistryInfoCmd
java.lang.CloneNotSupportedException
- standard Object.clone exceptionpublic boolean hasName()
true
if the name is defined; false
otherwise.public EPPRegistryZoneName getName()
null
otherwise.public void setName(EPPRegistryZoneName aName)
EPPRegistryInfoCmd.Mode.name
.aName
- Zone namepublic void setName(java.lang.String aName)
EPPRegistryInfoCmd.Mode.name
.aName
- aLabel zone namepublic boolean hasMode()
true
if the query mode is defined; false
otherwise.public EPPRegistryInfoCmd.Mode getMode()
null
otherwise.public void setMode(EPPRegistryInfoCmd.Mode aMode)
aMode
- Query mode to usepublic EPPRegistryInfoCmd.Scope getScope()
null
otherwise.public void setScope(EPPRegistryInfoCmd.Scope aScope)
EPPRegistryInfoCmd.Mode.all
.aScope
- Scope passed with the <registry:all> "scope" attribute. If
null
is passed, the default value of
EPPRegistryInfoCmd.Scope.accessible
will be used.