com.verisign.epp.interfaces
Class EPPReseller

java.lang.Object
  extended by com.verisign.epp.interfaces.EPPReseller

public class EPPReseller
extends java.lang.Object

EPPReseller is the primary client interface class used for the Reseller EPP mapping. An instance of EPPReseller is created with an initialized EPPSession, and can be used for more than one request within a single thread. A set of setter methods are provided to set the attributes before a call to one of the send action methods. The responses returned from the send action methods are either instances of EPPResponse or instances of response classes in the com.verisign.epp.codec.reseller package.

See Also:
EPPResellerCheckResp, EPPResellerInfoResp, EPPResellerCreateResp

Constructor Summary
EPPReseller(EPPSession aSession)
          Constructs an EPPReseller given an initialized EPP session.
 
Method Summary
 void addAddContact(EPPResellerContact aContact)
          Adds an add contact to the list of add contacts.
 void addContact(EPPResellerContact aContact)
          Adds a contact to the list of contacts.
 void addExtension(EPPCodecComponent aExtension)
          Adds a command extension object.
 void addPostalInfo(EPPResellerPostalDefinition aPostalInfo)
          Adds a postal definition to the postal information for the reseller.
 void addRemContact(EPPResellerContact aContact)
          Adds a remove contact to the list of remove contacts.
 void addResellerId(java.lang.String aResellerId)
          Adds a reseller identifier for use with a send method.
 java.util.List<EPPResellerContact> getAddContacts()
          Gets the add contacts.
 java.util.List<EPPResellerContact> getContacts()
           
 EPPResellerDisclose getDisclose()
          Gets the disclosure information.
 java.lang.String getEmail()
           
 java.util.Vector getExtensions()
          Gets the command extensions.
 java.lang.String getFax()
           
 java.lang.String getFaxExt()
           
 java.lang.String getParentId()
           
 java.util.List<EPPResellerPostalDefinition> getPostalInfo()
          Gets the postal information for the reseller.
 java.util.List<EPPResellerContact> getRemContacts()
          Gets the remove contacts.
 java.util.List<java.lang.String> getResellerIds()
          Get the list of reseller identifiers.
 EPPResponse getResponse()
          Gets the response associated with the last command.
 State getState()
          Gets the operational state of the reseller.
 java.lang.String getUrl()
          Gets the URL of the website of the reseller.
 java.lang.String getVoice()
           
 java.lang.String getVoiceExt()
           
 boolean hasContacts()
          Is there any contacts set?
 boolean hasPostalInfo()
          Is there any postal information set?
 boolean hasRemContacts()
          Is there any remove contacts set?
protected  void resetReseller()
          Resets the Reseller instance to its initial state.
 EPPResellerCheckResp sendCheck()
          Sends a Reseller Check Command to the server.
 EPPResellerCreateResp sendCreate()
          Sends a Reseller Create Command to the server.
 EPPResponse sendDelete()
          Sends a Reseller Delete Command to the server.
 EPPResellerInfoResp sendInfo()
          Sends a Reseller Info Command to the server.
 EPPResponse sendUpdate()
          Sends a Reseller Update Command to the server.
 void setAddContacts(java.util.List<EPPResellerContact> aContacts)
          Sets the add contacts.
 void setContacts(java.util.List<EPPResellerContact> aContacts)
           
 void setDisclose(EPPResellerDisclose aDisclose)
          Sets the disclosure information.
 void setEmail(java.lang.String aEmail)
           
 void setExtensions(java.util.Vector aExtensions)
          Sets the command extension objects.
 void setFax(java.lang.String aFax)
           
 void setFaxExt(java.lang.String aFaxExt)
           
 void setParentId(java.lang.String aParentId)
           
 void setPostalInfo(java.util.List<EPPResellerPostalDefinition> aPostalInfo)
          Sets the postal information for the reseller.
 void setRemContacts(java.util.List<EPPResellerContact> aContacts)
          Sets the remove contacts.
 void setState(State aState)
          Sets the operational state of the reseller supported.
 void setTransId(java.lang.String aTransId)
          Sets the client transaction identifier.
 void setUrl(java.lang.String aUrl)
          Sets the URL of the website of the reseller.
 void setVoice(java.lang.String aVoice)
           
 void setVoiceExt(java.lang.String aVoiceExt)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

EPPReseller

public EPPReseller(EPPSession aSession)
Constructs an EPPReseller given an initialized EPP session.

Parameters:
aSession - Server session to use.
Method Detail

addExtension

public void addExtension(EPPCodecComponent aExtension)
Adds a command extension object.

Parameters:
aExtension - command extension object associated with the command

setExtensions

public void setExtensions(java.util.Vector aExtensions)
Sets the command extension objects.

Parameters:
aExtensions - command extension objects associated with the command

getExtensions

public java.util.Vector getExtensions()
Gets the command extensions.

Returns:
Vector of concrete EPPCodecComponent associated with the command if exists; null otherwise.

setTransId

public void setTransId(java.lang.String aTransId)
Sets the client transaction identifier.

Parameters:
aTransId - Client transaction identifier

getResellerIds

public java.util.List<java.lang.String> getResellerIds()
Get the list of reseller identifiers.

Returns:
List of reseller identifier String's

addResellerId

public void addResellerId(java.lang.String aResellerId)
Adds a reseller identifier for use with a send method. Adding more than one reseller identifier is only supported by sendCheck().

Parameters:
aResellerId - Reseller Identifier

getState

public State getState()
Gets the operational state of the reseller.

Returns:
Operational state if defined; null otherwise.

setState

public void setState(State aState)
Sets the operational state of the reseller supported.

Parameters:
aState - Operation state

getParentId

public java.lang.String getParentId()
Returns:
the parentId

setParentId

public void setParentId(java.lang.String aParentId)
Parameters:
aParentId - the parentId to set

hasPostalInfo

public boolean hasPostalInfo()
Is there any postal information set?

Returns:
true if there is at least one EPPResellerPostalDefinition set in the postal information; false otherwise.

addPostalInfo

public void addPostalInfo(EPPResellerPostalDefinition aPostalInfo)
Adds a postal definition to the postal information for the reseller.

Parameters:
aPostalInfo - Postal definition to add to the postal information.

getPostalInfo

public java.util.List<EPPResellerPostalDefinition> getPostalInfo()
Gets the postal information for the reseller. There can be one or two EPPResellerPostalDefinition objects in the postal information list.

Returns:
Postal information for the reseller

setPostalInfo

public void setPostalInfo(java.util.List<EPPResellerPostalDefinition> aPostalInfo)
Sets the postal information for the reseller. There can be one or two EPPResellerPostalDefinition objects in the postal information list.

Parameters:
aPostalInfo - Postal information for the reseller.

getVoice

public java.lang.String getVoice()
Returns:
the voice

setVoice

public void setVoice(java.lang.String aVoice)
Parameters:
aVoice - the voice to set

getVoiceExt

public java.lang.String getVoiceExt()
Returns:
the voiceExt

setVoiceExt

public void setVoiceExt(java.lang.String aVoiceExt)
Parameters:
aVoiceExt - the voiceExt to set

getFax

public java.lang.String getFax()
Returns:
the fax

setFax

public void setFax(java.lang.String aFax)
Parameters:
aFax - the fax to set

getFaxExt

public java.lang.String getFaxExt()
Returns:
the faxExt

setFaxExt

public void setFaxExt(java.lang.String aFaxExt)
Parameters:
aFaxExt - the faxExt to set

getEmail

public java.lang.String getEmail()
Returns:
the email

setEmail

public void setEmail(java.lang.String aEmail)
Parameters:
aEmail - the email to set

getUrl

public java.lang.String getUrl()
Gets the URL of the website of the reseller.

Returns:
URL of the website of the reseller.

setUrl

public void setUrl(java.lang.String aUrl)
Sets the URL of the website of the reseller.

Parameters:
aUrl - URL of the website of the reseller.

hasContacts

public boolean hasContacts()
Is there any contacts set?

Returns:
true if there is at least one EPPResellerContact set; false otherwise.

addContact

public void addContact(EPPResellerContact aContact)
Adds a contact to the list of contacts.

Parameters:
aContact - Contact add to the list of contacts.

getContacts

public java.util.List<EPPResellerContact> getContacts()
Returns:
the contacts

setContacts

public void setContacts(java.util.List<EPPResellerContact> aContacts)
Parameters:
aContacts - the contacts to set

addAddContact

public void addAddContact(EPPResellerContact aContact)
Adds an add contact to the list of add contacts.

Parameters:
aContact - Contact to add to the list of add contacts.

getAddContacts

public java.util.List<EPPResellerContact> getAddContacts()
Gets the add contacts.

Returns:
List of add contacts set.

setAddContacts

public void setAddContacts(java.util.List<EPPResellerContact> aContacts)
Sets the add contacts.

Parameters:
aContacts - List of add contacts

hasRemContacts

public boolean hasRemContacts()
Is there any remove contacts set?

Returns:
true if there is at least one remove EPPResellerContact set; false otherwise.

addRemContact

public void addRemContact(EPPResellerContact aContact)
Adds a remove contact to the list of remove contacts.

Parameters:
aContact - Contact to add to the list of remove contacts.

getRemContacts

public java.util.List<EPPResellerContact> getRemContacts()
Gets the remove contacts.

Returns:
List of remove contacts set.

setRemContacts

public void setRemContacts(java.util.List<EPPResellerContact> aContacts)
Sets the remove contacts.

Parameters:
aContacts - List of remove contacts

getDisclose

public EPPResellerDisclose getDisclose()
Gets the disclosure information.

Returns:
Disclosure information if defined; null otherwise.

setDisclose

public void setDisclose(EPPResellerDisclose aDisclose)
Sets the disclosure information.

Parameters:
aDisclose - Disclosure information

sendCheck

public EPPResellerCheckResp sendCheck()
                               throws EPPCommandException
Sends a Reseller Check Command to the server.

There required attributes that must be set prior to executing sendCheck() include:



The optional attributes can be set with the following:

Returns:
EPPResellerCheckResp with the check results.
Throws:
EPPCommandException - On error

sendInfo

public EPPResellerInfoResp sendInfo()
                             throws EPPCommandException
Sends a Reseller Info Command to the server.

There required attributes that must be set prior to executing sendInfo() include:



The optional attributes can be set with the following:

Returns:
EPPResellerInfoResp that contains the reseller information.
Throws:
EPPCommandException - On error

sendCreate

public EPPResellerCreateResp sendCreate()
                                 throws EPPCommandException
Sends a Reseller Create Command to the server.

There required attributes that must be set prior to executing sendCheck() include:



The optional attributes can be set with the following:

Returns:
EPPResellerCreateResp with the create result.
Throws:
EPPCommandException - On error

sendDelete

public EPPResponse sendDelete()
                       throws EPPCommandException
Sends a Reseller Delete Command to the server.

There required attributes that must be set prior to executing sendInfo() include:



The optional attributes can be set with the following:

Returns:
EPPResponse that contains the deletion result.
Throws:
EPPCommandException - On error

sendUpdate

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

There required attributes that must be set prior to executing sendCheck() include:



The optional attributes can be set with the following:

Returns:
EPPResponse with the update result.
Throws:
EPPCommandException - On error

resetReseller

protected void resetReseller()
Resets the Reseller instance to its initial state.


getResponse

public EPPResponse getResponse()
Gets the response associated with the last command. This method can be used to retrieve the server error response in the catch block of EPPCommandException.

Returns:
Response associated with the last command


Copyright © VeriSign Inc. All Rights Reserved.