|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.verisign.epp.interfaces.EPPDomain
com.verisign.epp.interfaces.EPPRelatedDomain
com.verisign.epp.namestore.interfaces.NSDomain
public class NSDomain
NameStore Domain interface that extends that standard EPPDomain
by adding new operations like restore request, restore report, and sync.
Field Summary | |
---|---|
static java.util.List |
REM_ALL_DS
Constant used to remove all DS using aRemDsData parameter of
the method setSecDNSUpdate(List, List) . |
Fields inherited from class com.verisign.epp.interfaces.EPPRelatedDomain |
---|
DOMAIN_INFO_FORM, RELATED_INFO_FORM |
Constructor Summary | |
---|---|
NSDomain(EPPSession aSession)
Creates an NSDomain with an established
EPPSession . |
Method Summary | |
---|---|
int |
getDay()
Gets the day of sync. |
int |
getMonth()
Gets the month of sync. |
EPPRgpExtReport |
getReport()
Gets the report information for the restore report. |
protected void |
resetDomain()
Resets the domain attributes for the next command. |
EPPResponse |
sendRestoreReport()
Send a restore report. |
EPPResponse |
sendRestoreRequest()
Send a restore request. |
EPPResponse |
sendSync()
Send a sync command for a domain with a specified expiration month and day The required attributes have been set with the following methods: addDomainName - Sets the domain name for report. |
void |
setAllocationToken(java.lang.String aAllocationToken)
Sets the allocation token extension with the token value to be passed along with either sendCheck , sendCreate() ,
sendUpdate , or sendTransfer . |
void |
setCoaCreate(java.util.List aAttrs)
Sets the list of EPPCoaExtAttr instances to associate Client
Object Attributes with the object being created. |
void |
setCoaUpdateForPut(java.util.List aAttrs)
Sets the list of EPPCoaExtAttr instances to associate Client
Object Attributes with the object being updated. |
void |
setCoaUpdateForRem(java.util.List aKeys)
Sets the list of EPPCoaExtKey instances to specify Client
Object Attributes to be removed from the object being updated. |
void |
setDay(int aDay)
Sets the day of sync. |
void |
setIDNLangTag(java.lang.String aLangTag)
Set the IDN language tag used with sendCreate . |
void |
setIDNMap(java.lang.String aTable,
java.lang.String aUname)
Set the IDN Map used with sendCreate , which includes the IDN
table identifer and optionally the uname. |
void |
setMonth(int aMonth)
Sets the month of sync. |
void |
setReport(EPPRgpExtReport aReport)
Sets the report information for the restore report. |
void |
setResellerId(java.lang.String aResellerId)
Sets the reseller identifier used with sendCreate() . |
void |
setSecDNSCreate(java.util.List aDsData)
Sets the list of EPPSecDNSExtDsData instances in order to
create delegation signer (DS) information. |
void |
setSecDNSUpdate(java.util.List aAddDsData,
java.util.List aRemDsData)
Sets the list of EPPSecDNSExtDsData instances to add along
with the list of EPPSecDNSExtDsData instances to remove. |
void |
setSecDNSUpdateForAdd(java.util.List aAddDsData,
boolean aUrgent)
Deprecated. Supports secDNS-1.0 and secDNS-1.1, but use the secDNS-1.1 method setSecDNSUpdate(List, List) . |
void |
setSecDNSUpdateForChg(java.util.List aChgDsData,
boolean aUrgent)
Deprecated. Only supported with secDNS-1.0. Look to use the secDNS-1.1 method setSecDNSUpdate(List, List) . |
void |
setSecDNSUpdateForRem(java.util.List aRemDsData,
boolean aUrgent)
Deprecated. Supports secDNS-1.0 and secDNS-1.1, but use the secDNS-1.1 method setSecDNSUpdate(List, List) . |
void |
setSubProductID(java.lang.String aSubProductID)
Sets the domain sub-product id which specifies which is the target registry for the domain operation. |
void |
setWhoisInfo(boolean aWhoisInfo)
Sets if whois information is desired in the response to a call to sendInfo() . |
void |
updateResellerId(EPPResellerExtUpdate.Action aAction,
java.lang.String aResellerId)
Updates the reseller identifier used with sendUpdate() . |
Methods inherited from class com.verisign.epp.interfaces.EPPRelatedDomain |
---|
addRelatedDomain, addRelatedName, sendRelatedCreate, sendRelatedDelete, sendRelatedInfo, sendRelatedRenew, sendRelatedTransfer, sendRelatedUpdate, setInfoForm |
Methods inherited from class com.verisign.epp.interfaces.EPPDomain |
---|
addContact, addDomainName, addExtension, addHostAttr, addHostName, getAuthRoid, getAuthString, getExpirationDate, getExtensions, getHosts, getPeriodLength, getPeriodUnit, getRegistrant, getResponse, sendCheck, sendCreate, sendDelete, sendInfo, sendRenew, sendTransfer, sendUpdate, setAuthRoid, setAuthString, setExpirationDate, setExtension, setExtensions, setHosts, setPeriodLength, setPeriodUnit, setRegistrant, setTransferOpCode, setTransId, setUpdateAttrib, setUpdateAttrib, setUpdateAttrib |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.util.List REM_ALL_DS
aRemDsData
parameter of
the method setSecDNSUpdate(List, List)
.
Constructor Detail |
---|
public NSDomain(EPPSession aSession)
NSDomain
with an established
EPPSession
.
aSession
- Established sessionMethod Detail |
---|
public EPPResponse sendRestoreRequest() throws EPPCommandException
addDomainName
- Sets the domain name to restore. Only one
domain name is valid.setSubProductID
- Sets the sub-product idsetTransId
- Sets the client transaction identifier
EPPResponse
containing the Domain restore request
result.
EPPCommandException
- Error executing the restore request command. Use
getResponse
to get the associated server
error response.public EPPResponse sendRestoreReport() throws EPPCommandException
addDomainName
- Sets the domain name for report. Only one
domain name is valid.setSubProductID
- Sets the sub-product idsetReport
- Sets the report informationsetTransId
- Sets the client transaction identifier
EPPResponse
containing the Domain restore report
result.
EPPCommandException
- Error executing the restore report command. Use
getResponse
to get the associated server
error response.public EPPResponse sendSync() throws EPPCommandException
addDomainName
- Sets the domain name for report. Only one
domain name is valid.setSubProductID
- Sets the sub-product idsetMonth
- Month to set expiration datesetDay
- Day to set expiration datesetTransId
- Sets the client transaction identifier
EPPResponse
containing the Domain sync result.
EPPCommandException
- Error executing the sync command. Use
getResponse
to get the associated server
error response.public int getDay()
-1
otherwisepublic void setDay(int aDay)
aDay
- The day to set.public int getMonth()
java.util.Calendar
month constant
if defined; -1
otherwisepublic void setMonth(int aMonth)
aMonth
- the month using a java.util.Calendar
month
constantpublic EPPRgpExtReport getReport()
null
otherwise.public void setReport(EPPRgpExtReport aReport)
aReport
- Report informationpublic void setIDNLangTag(java.lang.String aLangTag)
sendCreate
.
aLangTag
- Valid XML schema language value as defined by . For
example, use a two letter language tag like en
or
fr
.public void setIDNMap(java.lang.String aTable, java.lang.String aUname)
sendCreate
, which includes the IDN
table identifer and optionally the uname.
aTable
- IDN table identifieraUname
- OPTIONAL domain name in Unicode NFC. Set to null
if undefined.public void setSubProductID(java.lang.String aSubProductID)
EPPNamestoreExtNamestoreExt
extension being added to the command.
aSubProductID
- Sub-product id of domain operation. Some constants for the
sub-product id are defined in NSSubProduct
.
Passing null
will not add any extension.public void setWhoisInfo(boolean aWhoisInfo)
sendInfo()
. If true
is specified, the
com.verisign.epp.codec.whois.EPPWhoisInfData
extension will
be added to the
com.verisign.epp.codec.domain.EPPDomainInfoResp
when the
server supports it.
aWhoisInfo
- true
to include the whois response information;
false
otherwise.public void setSecDNSUpdate(java.util.List aAddDsData, java.util.List aRemDsData) throws EPPCommandException
EPPSecDNSExtDsData
instances to add along
with the list of EPPSecDNSExtDsData
instances to remove.
This method only supports secDNS-1.1. This method can be used to remove
all DS data by passing the REM_ALL_DS
constant with the
aRemDsData
parameter, and can be used to replace all DS data
by passing the REM_ALL_DS
constant with the
aRemDsData
parameter and setting the aAddDsData
to a non-null, non-empty list.
aAddDsData
- - List of
EPPSecDNSExtDsData
instances to add; null
if there is nothing to
add.aRemDsData
- - List of
EPPSecDNSExtDsData
instances to remove; null
if there is nothing to
remove. Set to REM_ALL_DS
constant to remove all DS
data.
EPPCommandException
- Error with parameters passed in.public void setSecDNSCreate(java.util.List aDsData)
EPPSecDNSExtDsData
instances in order to
create delegation signer (DS) information.
aDsData
- - List of EPPSecDNSExtDsData
instancespublic void setCoaCreate(java.util.List aAttrs)
EPPCoaExtAttr
instances to associate Client
Object Attributes with the object being created.
aAttrs
- - List of EPPCoaExtAttr
instancespublic void setCoaUpdateForPut(java.util.List aAttrs)
EPPCoaExtAttr
instances to associate Client
Object Attributes with the object being updated.
aAttrs
- - List of EPPCoaExtAttr
instancespublic void setCoaUpdateForRem(java.util.List aKeys)
EPPCoaExtKey
instances to specify Client
Object Attributes to be removed from the object being updated.
aKeys
- - List of EPPCoaExtKey
instancespublic void setSecDNSUpdateForAdd(java.util.List aAddDsData, boolean aUrgent)
setSecDNSUpdate(List, List)
.
EPPSecDNSExtDsData
instances in order to
add delegation signer (DS) information.
aAddDsData
- - List of EPPSecDNSExtDsData
instancesaUrgent
- - boolean value indicates whether it is a high priority
requestpublic void setSecDNSUpdateForChg(java.util.List aChgDsData, boolean aUrgent)
setSecDNSUpdate(List, List)
.
EPPSecDNSExtDsData
instances in order to
change delegation signer (DS) information. This method is only used for
secDNS-1.0.
aChgDsData
- - List of
EPPSecDNSExtDsData
instancesaUrgent
- - boolean value indicates whether it is a high priority
requestpublic void setSecDNSUpdateForRem(java.util.List aRemDsData, boolean aUrgent)
setSecDNSUpdate(List, List)
.
Integer
instances in order to remove
delegation signer (DS) information.
aRemDsData
- - List of Integer
instances for secDNS-1.0 or
EPPSecDNSExtDsData
instances for secDNS-1.1.aUrgent
- - boolean value indicates whether it is a high priority
requestpublic void setAllocationToken(java.lang.String aAllocationToken)
sendCheck
, sendCreate()
,
sendUpdate
, or sendTransfer
. The allocation
token is used to allocation a domain name that be held or reserved for
use.
aAllocationToken
- Allocation token valuepublic void setResellerId(java.lang.String aResellerId)
sendCreate()
.
aResellerId
- Reseller identifierpublic void updateResellerId(EPPResellerExtUpdate.Action aAction, java.lang.String aResellerId)
sendUpdate()
.
There are three possible actions add, remove, and change defined in the
EPPResellerExtUpdate.Action
aAction
parameter that can be taken with the
reseller identifier defined by the aResellerId
parameter.
aAction
- Update action to take using the Action
enumerated
values.aResellerId
- Reseller identifierprotected void resetDomain()
resetDomain
in class EPPRelatedDomain
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |