|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.verisign.epp.interfaces.EPPReseller
public class EPPReseller
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.
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 |
---|
public EPPReseller(EPPSession aSession)
EPPReseller
given an initialized EPP session.
aSession
- Server session to use.Method Detail |
---|
public void addExtension(EPPCodecComponent aExtension)
aExtension
- command extension object associated with the commandpublic void setExtensions(java.util.Vector aExtensions)
aExtensions
- command extension objects associated with the commandpublic java.util.Vector getExtensions()
Vector
of concrete EPPCodecComponent
associated with the command if exists; null
otherwise.public void setTransId(java.lang.String aTransId)
aTransId
- Client transaction identifierpublic java.util.List<java.lang.String> getResellerIds()
List
of reseller identifier String
'spublic void addResellerId(java.lang.String aResellerId)
send
method.
Adding more than one reseller identifier is only supported by
sendCheck()
.
aResellerId
- Reseller Identifierpublic State getState()
null
otherwise.public void setState(State aState)
aState
- Operation statepublic java.lang.String getParentId()
public void setParentId(java.lang.String aParentId)
aParentId
- the parentId to setpublic boolean hasPostalInfo()
true
if there is at least one
EPPResellerPostalDefinition
set in the postal information;
false
otherwise.public void addPostalInfo(EPPResellerPostalDefinition aPostalInfo)
aPostalInfo
- Postal definition to add to the postal information.public java.util.List<EPPResellerPostalDefinition> getPostalInfo()
EPPResellerPostalDefinition
objects in the postal information
list.
public void setPostalInfo(java.util.List<EPPResellerPostalDefinition> aPostalInfo)
EPPResellerPostalDefinition
objects in the postal information
list.
aPostalInfo
- Postal information for the reseller.public java.lang.String getVoice()
public void setVoice(java.lang.String aVoice)
aVoice
- the voice to setpublic java.lang.String getVoiceExt()
public void setVoiceExt(java.lang.String aVoiceExt)
aVoiceExt
- the voiceExt to setpublic java.lang.String getFax()
public void setFax(java.lang.String aFax)
aFax
- the fax to setpublic java.lang.String getFaxExt()
public void setFaxExt(java.lang.String aFaxExt)
aFaxExt
- the faxExt to setpublic java.lang.String getEmail()
public void setEmail(java.lang.String aEmail)
aEmail
- the email to setpublic java.lang.String getUrl()
public void setUrl(java.lang.String aUrl)
aUrl
- URL of the website of the reseller.public boolean hasContacts()
true
if there is at least one
EPPResellerContact
set; false
otherwise.public void addContact(EPPResellerContact aContact)
aContact
- Contact add to the list of contacts.public java.util.List<EPPResellerContact> getContacts()
public void setContacts(java.util.List<EPPResellerContact> aContacts)
aContacts
- the contacts to setpublic void addAddContact(EPPResellerContact aContact)
aContact
- Contact to add to the list of add contacts.public java.util.List<EPPResellerContact> getAddContacts()
public void setAddContacts(java.util.List<EPPResellerContact> aContacts)
aContacts
- List of add contactspublic boolean hasRemContacts()
true
if there is at least one remove
EPPResellerContact
set; false
otherwise.public void addRemContact(EPPResellerContact aContact)
aContact
- Contact to add to the list of remove contacts.public java.util.List<EPPResellerContact> getRemContacts()
public void setRemContacts(java.util.List<EPPResellerContact> aContacts)
aContacts
- List of remove contactspublic EPPResellerDisclose getDisclose()
null
otherwise.public void setDisclose(EPPResellerDisclose aDisclose)
aDisclose
- Disclosure informationpublic EPPResellerCheckResp sendCheck() throws EPPCommandException
sendCheck()
include:addResellerId(String)
- Sets the reseller identifiers to
check. At least one reseller identifier must be set.setTransId(String)
- Sets the client transaction identifier.
EPPResellerCheckResp
with the check results.
EPPCommandException
- On errorpublic EPPResellerInfoResp sendInfo() throws EPPCommandException
sendInfo()
include:addResellerId(String)
- Sets the reseller identifier to get
the information for. Only one reseller identifier is valid.setTransId(String)
- Sets the client transaction identifier.
EPPResellerInfoResp
that contains the reseller
information.
EPPCommandException
- On errorpublic EPPResellerCreateResp sendCreate() throws EPPCommandException
sendCheck()
include:addResellerId(String)
- Sets the reseller identifier to
create.addPostalInfo(EPPResellerPostalDefinition)
- Sets the postal
information of the reseller.setEmail(String)
- Sets the reseller email.setTransId(String)
- Sets the client transaction identifier.
setState(State)
- Sets the state of the reseller with the
default of State.OK
.setParentId(String)
- Sets the parent reseller identifier of
the reseller.setVoice(String)
- Sets the reseller voice number.setVoiceExt(String)
- Sets the reseller voice number
extension.setFax(String)
- Sets the reseller fax number.setFaxExt(String)
- Sets the reseller fax number extension.setUrl(String)
- Sets the reseller URL.setContacts(List)
- Sets the reseller contacts.setDisclose(EPPResellerDisclose)
- Sets the client
disclosure preferences for the reseller.
EPPResellerCreateResp
with the create result.
EPPCommandException
- On errorpublic EPPResponse sendDelete() throws EPPCommandException
sendInfo()
include:addResellerId(String)
- Sets the reseller identifier to get
deleted. Only one reseller identifier is valid.setTransId(String)
- Sets the client transaction identifier.
EPPResponse
that contains the deletion result.
EPPCommandException
- On errorpublic EPPResponse sendUpdate() throws EPPCommandException
sendCheck()
include:addResellerId(String)
- Sets the reseller identifier to
create.setTransId(String)
- Sets the client transaction identifier.
setState(State)
- Sets the state of the reseller with the
default of State.OK
.setParentId(String)
- Sets the parent reseller identifier of
the reseller.addPostalInfo(EPPResellerPostalDefinition)
- Sets the postal
information of the reseller.setVoice(String)
- Sets the reseller voice number.setVoiceExt(String)
- Sets the reseller voice number
extension.setFax(String)
- Sets the reseller fax number.setFaxExt(String)
- Sets the reseller fax number extension.setEmail(String)
- Sets the reseller email.setUrl(String)
- Sets the reseller URL.setAddContacts(List)
- Sets the reseller contacts to add.setRemContacts(List)
- Sets the reseller contacts to remove.
setDisclose(EPPResellerDisclose)
- Sets the client
disclosure preferences for the reseller.
EPPResponse
with the update result.
EPPCommandException
- On errorprotected void resetReseller()
public EPPResponse getResponse()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |