public class EPPRegistry
extends java.lang.Object
EPPRegistry
requires an established EPPSession
that is used
to send the commands and read the responses from a server.Constructor and Description |
---|
EPPRegistry(EPPSession aSession)
Constructs an
EPPRegistry given an initialized EPP session. |
Modifier and Type | Method and Description |
---|---|
void |
addExtension(EPPCodecComponent aExtension)
Adds a command extension object.
|
void |
addZone(EPPRegistryZoneName aZone)
Add a zone name to the list of zone names.
|
void |
addZone(java.lang.String aZone)
Add an aLabel zone name to the list of zone names.
|
EPPRegistryInfoCmd.Scope |
getAllScope()
Gets the zone scope used with the info all option.
|
java.util.Vector<EPPCodecComponent> |
getExtensions()
Gets the command extensions.
|
EPPRegistryInfoCmd.Mode |
getInfoMode()
Gets the info mode.
|
EPPResponse |
getResponse()
Gets the response associated with the last command.
|
EPPSession |
getSession()
Gets the session to use to send commands through.
|
java.lang.String |
getTransId()
Gets the OPTIONAL client transaction identifier.
|
java.util.List<EPPRegistryZoneName> |
getZoneList()
Gets the list of zone names.
|
boolean |
hasInfoMode()
Is the info mode defined?
|
EPPRegistryCheckResp |
sendCheck()
Sends a check command to the server.
|
EPPRegistryCreateResp |
sendCreate()
Sends a create command to the server to create a zone.
|
EPPResponse |
sendDelete()
Sends a delete command to the server to delete a zone by name.
|
EPPRegistryInfoResp |
sendInfo()
Sends an info command to the server.
|
EPPResponse |
sendUpdate()
Sends an update command to the server to update a zone.
|
void |
setAllScope(EPPRegistryInfoCmd.Scope aScope)
Sets the zone scope used with the info all mode.
|
void |
setExtensions(java.util.Vector<EPPCodecComponent> aExtensions)
Sets the command extensions.
|
void |
setInfoMode(EPPRegistryInfoCmd.Mode aInfoMode)
Sets the info mode.
|
void |
setSession(EPPSession aSession)
Sets the session to use to send commands through.
|
void |
setTransId(java.lang.String aTransId)
Sets the OPTIONAL client transaction identifier.
|
void |
setZone(EPPRegistryZone aZone)
Sets the zone to use with
sendCreate() or
sendUpdate() . |
void |
setZoneList(java.util.List<EPPRegistryZoneName> aZoneList)
Sets the list of zone names to use in a command.
|
public EPPRegistry(EPPSession aSession)
EPPRegistry
given an initialized EPP session.aSession
- Server session to use.public EPPRegistryCheckResp sendCheck() throws EPPCommandException
addZone(EPPRegistryZoneName)
, #addZone(String), or
{@link #setZoneList(List)} - To set the zone names to check. More than one
zone name can be checked in {@code sendCheck}.EPPRegistryCheckResp
containing the zone check
information.EPPCommandException
- Error executing the check command. Use
getResponse()
to get the associated server error
response.public EPPResponse sendDelete() throws EPPCommandException
addZone(EPPRegistryZoneName)
, #addZone(String), or
{@link #setZoneList(List)} - To set a single zone name to delete. More
than one zone name will result in an {@link EPPCommandException}.EPPResponse
containing the result of the delete commandEPPCommandException
- Error executing the delete command. Use
getResponse()
to get the associated server error
response.public EPPRegistryInfoResp sendInfo() throws EPPCommandException
addZone(EPPRegistryZoneName)
, #addZone(String), or
{@link #setZoneList(List)} - To set a single zone name to get the detailed
information for. This is used to send the
"get detailed information for an individual zone" form. More than one zone
name will result in an {@link EPPCommandException}. OREPPRegistryInfoResp
containing the requested information
from the server based on the form of the info command.EPPCommandException
- Error executing the info command. Use getResponse()
to get the associated server error response.public EPPRegistryCreateResp sendCreate() throws EPPCommandException
setZone(EPPRegistryZone)
- Contains the attributes of
the zone to create.setTransId(String)
- Sets the client transaction identifier
addExtension(EPPCodecComponent)
or
setExtensions(Vector)
- Set extensions to include with the
command.
EPPRegistryCreateResp
containing the result of the create
commandEPPCommandException
- Error executing the create command. Use
getResponse()
to get the associated server error
response.public EPPResponse sendUpdate() throws EPPCommandException
setZone(EPPRegistryZone)
- Contains the attributes of
the zone to update.setTransId(String)
- Sets the client transaction identifier
addExtension(EPPCodecComponent)
or
setExtensions(Vector)
- Set extensions to include with the
command.
EPPResponse
containing the result of the update commandEPPCommandException
- Error executing the update command. Use
getResponse()
to get the associated server error
response.public EPPSession getSession()
null
otherwise.public void setSession(EPPSession aSession)
aSession
- Active EPP session to send commands throughpublic java.lang.String getTransId()
null
otherwise.public void setTransId(java.lang.String aTransId)
aTransId
- Client transaction identifierpublic java.util.List<EPPRegistryZoneName> getZoneList()
public void setZoneList(java.util.List<EPPRegistryZoneName> aZoneList)
EPPRegistryInfoCmd.Mode#all
.aZoneList
- List of zone namespublic void addZone(java.lang.String aZone)
EPPRegistryInfoCmd.Mode#all
.aZone
- ALabel zone name to add to the list of zone names.public void addZone(EPPRegistryZoneName aZone)
EPPRegistryInfoCmd.Mode#name
.aZone
- Zone name to add to the list of zone names.public EPPRegistryInfoCmd.Scope getAllScope()
null
otherwise.public void setAllScope(EPPRegistryInfoCmd.Scope aScope)
EPPRegistryInfoCmd.Mode#all
.aScope
- Scope used for the info all mode.public boolean hasInfoMode()
true
if the info mode is defined; false
otherwise.public EPPRegistryInfoCmd.Mode getInfoMode()
null
otherwise.public void setInfoMode(EPPRegistryInfoCmd.Mode aInfoMode)
EPPRegistryInfoCmd.Mode#system
mode, where the other modes are
automatically set using the other associated methods.aInfoMode
- Info mode to usepublic void setZone(EPPRegistryZone aZone)
sendCreate()
or
sendUpdate()
.aZone
- The zone to use with sendCreate()
or
sendUpdate()
.public java.util.Vector<EPPCodecComponent> getExtensions()
Vector
of concrete EPPCodecComponent
associated
with the command if exists; null
otherwise.public void setExtensions(java.util.Vector<EPPCodecComponent> aExtensions)
aExtensions
- Command extensions associated with the command. Setting to
null
clears the extensions.public void addExtension(EPPCodecComponent aExtension)
aExtension
- Command extension associated with the commandpublic EPPResponse getResponse()
EPPCommandException
.EPPResponse
associated with the last command if defined;
null
otherwise.Copyright © VeriSign Inc. All Rights Reserved.