Package com.verisign.epp.namestore.interfaces

Class NSDomain

java.lang.Object
com.verisign.epp.interfaces.EPPDomain
com.verisign.epp.interfaces.EPPRelatedDomain
com.verisign.epp.namestore.interfaces.NSDomain
public class NSDomain extends EPPRelatedDomain
NameStore Domain interface that extends that standard EPPDomain by adding new operations like restore request, restore report, and sync.

  • Field Details

  • Constructor Details

    • NSDomain

      public NSDomain(EPPSession aSession)
      Creates an NSDomain with an established EPPSession.
      Parameters:
      aSession - Established session

  • Method Details

    • sendRestoreRequest

      public EPPResponse sendRestoreRequest() throws EPPCommandException
      Send a restore request.

      The required attributes have been set with the following methods:

      • addDomainName - Sets the domain name to restore. Only one domain name is valid.
      • setSubProductID - Sets the sub-product id


      The optional attributes have been set with the following:

      • setTransId - Sets the client transaction identifier
      Returns:
      EPPResponse containing the Domain restore request result.
      Throws:
      EPPCommandException - Error executing the restore request command. Use getResponse to get the associated server error response.

    • sendRestoreReport

      public EPPResponse sendRestoreReport() throws EPPCommandException
      Send a restore report.

      The required attributes have been set with the following methods:

      • addDomainName - Sets the domain name for report. Only one domain name is valid.
      • setSubProductID - Sets the sub-product id
      • setReport - Sets the report information


      The optional attributes have been set with the following:

      • setTransId - Sets the client transaction identifier
      Returns:
      EPPResponse containing the Domain restore report result.
      Throws:
      EPPCommandException - Error executing the restore report command. Use getResponse to get the associated server error response.

    • sendSync

      public EPPResponse sendSync() throws EPPCommandException
      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. Only one domain name is valid.
      • setSubProductID - Sets the sub-product id
      • setMonth - Month to set expiration date
      • setDay - Day to set expiration date


      The optional attributes have been set with the following:

      • setTransId - Sets the client transaction identifier
      Returns:
      EPPResponse containing the Domain sync result.
      Throws:
      EPPCommandException - Error executing the sync command. Use getResponse to get the associated server error response.

    • sendCreate

      public EPPDomainCreateResp sendCreate() throws EPPCommandException
      Sends a Domain Name Create Command to the server.

      The required attributes have been set with the following methods:

      • addDomainName - Sets the domain name to create. Only one domain name is valid.
      • setAuthString - Sets the domain name authorization string.


      The optional attributes have been set with the following:

      • setTransId - Sets the client transaction identifier
      • setPeriodLength - Sets the registration period (default = 1)
      • setPeriodUnit - Sets the registration period unit (default = PERIOD_YEAR)
      • setRegistrant - Sets the Registrant for the domain. This is required for thick registries.
      • addContact - Add domain contact
      • addHostName - Add domain delegation host
      • addOrgId - Add an organization identifier with a role
      Overrides:
      sendCreate in class EPPDomain
      Returns:
      EPPDomainCreateResp containing the Domain create result.
      Throws:
      EPPCommandException - Error executing the create command. Use getResponse to get the associated server error response.

    • sendUpdate

      public EPPResponse sendUpdate() throws EPPCommandException
      Sends a Domain Name Update Command to the server.

      The required attributes have been set with the following methods:

      • addDomainName - Sets the domain name to update. Only one domain name is valid.


      The optional attributes have been set with the following:

      • setTransId - Sets the client transaction identifier
      • setUpdateAttrib(int,String,int) - Adds/removes hosts
      • setUpdateAttrib(int,DomainStatus,int) - Adds/removes statuses
      • setUpdateAttrib(int,String,String,int) - Adds/removes contacts
      • setRegistrant - Sets the Registrant for the domain.
      • setAuthString - Sets the domain name authorization string.
      • addUpdateOrgId - Add an update to organization identifier
      At least one update attribute needs to be set.
      Overrides:
      sendUpdate in class EPPDomain
      Returns:
      EPPResponse containing the Domain update result.
      Throws:
      EPPCommandException - Error executing the update command. Use getResponse to get the associated server error response.

    • getDay

      public int getDay()
      Gets the day of sync.
      Returns:
      Returns the day of sync if set; -1 otherwise

    • setDay

      public void setDay(int aDay)
      Sets the day of sync.
      Parameters:
      aDay - The day to set.

    • getMonth

      public int getMonth()
      Gets the month of sync.
      Returns:
      the month using a java.util.Calendar month constant if defined; -1 otherwise

    • setMonth

      public void setMonth(int aMonth)
      Sets the month of sync.
      Parameters:
      aMonth - the month using a java.util.Calendar month constant

    • getReport

      public EPPRgpExtReport getReport()
      Gets the report information for the restore report.
      Returns:
      Returns the report if defined; null otherwise.

    • setReport

      public void setReport(EPPRgpExtReport aReport)
      Sets the report information for the restore report.
      Parameters:
      aReport - Report information

    • setIDNLangTag

      public void setIDNLangTag(String aLangTag)
      Set the IDN language tag used with sendCreate.
      Parameters:
      aLangTag - Valid XML schema language value as defined by <a href="http://www.w3.org/TR/xmlschema-2/#language"/>. For example, use a two letter language tag like en or fr.

    • setIDNMap

      public void setIDNMap(String aTable, String aUname)
      Set the IDN Map used with sendCreate, which includes the IDN table identifer and optionally the uname.
      Parameters:
      aTable - IDN table identifier
      aUname - OPTIONAL domain name in Unicode NFC. Set to null if undefined.

    • setSubProductID

      public void setSubProductID(String aSubProductID)
      Sets the domain sub-product id which specifies which is the target registry for the domain operation. Some possible values include CC, TV, COM, NET. This results in a EPPNamestoreExtNamestoreExt extension being added to the command.
      Parameters:
      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.

    • setWhoisInfo

      public void setWhoisInfo(boolean aWhoisInfo)
      Sets if whois information is desired in the response to a call to 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.
      Parameters:
      aWhoisInfo - true to include the whois response information; false otherwise.

    • setSecDNSUpdate

      public void setSecDNSUpdate(List aAddDsData, List aRemDsData) throws EPPCommandException
      Sets the list of 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.
      Parameters:
      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.
      Throws:
      EPPCommandException - Error with parameters passed in.

    • setSecDNSCreate

      public void setSecDNSCreate(List aDsData)
      Sets the list of EPPSecDNSExtDsData instances in order to create delegation signer (DS) information.
      Parameters:
      aDsData - - List of EPPSecDNSExtDsData instances

    • setSecDNSKeyUpdate

      public void setSecDNSKeyUpdate(List aAddKeyData, List aRemKeyData) throws EPPCommandException
      Sets the list of EPPSecDNSExtKeyData instances to add along with the list of EPPSecDNSExtKeyData instances to remove. This method only supports secDNS-1.1. This method can be used to remove all key data by passing the REM_ALL_KEY constant with the aRemKeyData parameter, and can be used to replace all key data by passing the REM_ALL_KEY constant with the aRemKeyData parameter and setting the aAddKeyData to a non-null, non-empty list.
      Parameters:
      aAddKeyData - List of EPPSecDNSExtKeyData instances to add; null if there is nothing to add.
      aRemKeyData - List of EPPSecDNSExtKeyData instances to remove; null if there is nothing to remove. Set to REM_ALL_KEY constant to remove all key data.
      Throws:
      EPPCommandException - Error with parameters passed in.

    • setSecDNSKeyCreate

      public void setSecDNSKeyCreate(List aKeyData) throws EPPCommandException
      Sets the list of EPPSecDNSExtKeyData instances in order to create DNSSEC key information.
      Parameters:
      aKeyData - List of EPPSecDNSExtKeyData instances
      Throws:
      EPPCommandException - Error with parameters passed in.

    • setCoaCreate

      public void setCoaCreate(List aAttrs)
      Sets the list of EPPCoaExtAttr instances to associate Client Object Attributes with the object being created.
      Parameters:
      aAttrs - - List of EPPCoaExtAttr instances

    • setCoaUpdateForPut

      public void setCoaUpdateForPut(List aAttrs)
      Sets the list of EPPCoaExtAttr instances to associate Client Object Attributes with the object being updated.
      Parameters:
      aAttrs - - List of EPPCoaExtAttr instances

    • setCoaUpdateForRem

      public void setCoaUpdateForRem(List aKeys)
      Sets the list of EPPCoaExtKey instances to specify Client Object Attributes to be removed from the object being updated.
      Parameters:
      aKeys - - List of EPPCoaExtKey instances

    • setSecDNSUpdateForAdd

      @Deprecated public void setSecDNSUpdateForAdd(List aAddDsData, boolean aUrgent)
      Deprecated.
      Supports secDNS-1.0 and secDNS-1.1, but use the secDNS-1.1 method setSecDNSUpdate(List, List).
      Sets the list of EPPSecDNSExtDsData instances in order to add delegation signer (DS) information.
      Parameters:
      aAddDsData - - List of EPPSecDNSExtDsData instances
      aUrgent - - boolean value indicates whether it is a high priority request

    • setSecDNSUpdateForChg

      @Deprecated public void setSecDNSUpdateForChg(List aChgDsData, boolean aUrgent)
      Deprecated.
      Only supported with secDNS-1.0. Look to use the secDNS-1.1 method setSecDNSUpdate(List, List).
      Sets the list of EPPSecDNSExtDsData instances in order to change delegation signer (DS) information. This method is only used for secDNS-1.0.
      Parameters:
      aChgDsData - - List of EPPSecDNSExtDsData instances
      aUrgent - - boolean value indicates whether it is a high priority request

    • setSecDNSUpdateForRem

      @Deprecated public void setSecDNSUpdateForRem(List aRemDsData, boolean aUrgent)
      Deprecated.
      Supports secDNS-1.0 and secDNS-1.1, but use the secDNS-1.1 method setSecDNSUpdate(List, List).
      Sets the list of Integer instances in order to remove delegation signer (DS) information.
      Parameters:
      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 request

    • setAllocationToken

      public void setAllocationToken(String aAllocationToken)
      Sets the allocation token extension with the token value to be passed along with either sendCheck, sendCreate(), sendUpdate, or sendTransfer. The allocation token is used to allocation a domain name that be held or reserved for use.
      Parameters:
      aAllocationToken - Allocation token value

    • addOrgId

      public void addOrgId(EPPOrgExtId aOrgId)
      Adds an org identifier for use with sendCreate().
      Parameters:
      aOrgId - Org identifier with role to add

    • addUpdateOrgId

      public void addUpdateOrgId(int aAction, EPPOrgExtId aOrgId)
      Updates the org identifier used with sendUpdate(). There are three possible actions that can be used including EPPDomain.ADD, EPPDomain.REMOVE, and EPPDomain.CHANGE for the org identifier.
      Parameters:
      aAction - One of the EPPDomain.ADD, EPPDomain.REMOVE, and EPPDomain.CHANGE for the org identifier.
      aOrgId - Org identifier to add, remove, or change

    • resetDomain

      protected void resetDomain()
      Resets the domain attributes for the next command.
      Overrides:
      resetDomain in class EPPRelatedDomain