|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.verisign.epp.interfaces.EPPDefReg
public class EPPDefReg
EPPDefReg
is the primary client interface class used for
defReg management. An instance of EPPDefReg
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.defReg
package.
EPPResponse
,
EPPDefRegCreateResp
,
EPPDefRegInfoResp
,
EPPDefRegCheckResp
,
EPPDefRegTransferResp
Field Summary | |
---|---|
static int |
ADD
DOCUMENT ME! |
static int |
CHANGE
DOCUMENT ME! |
static int |
CONTACT
The Following are add to encapsulate the Update Command |
static java.lang.String |
LEVEL_PREMIUM
Premium level of Defensive Registration. |
static java.lang.String |
LEVEL_STANDARD
Standard level of Defensive Registration. |
static java.lang.String |
PERIOD_MONTH
Currently Only two Priod Type is supported. |
static java.lang.String |
PERIOD_YEAR
DOCUMENT ME! |
static int |
REMOVE
DOCUMENT ME! |
static int |
STATUS
DOCUMENT ME! |
static java.lang.String |
STATUS_CLIENT_DELETE_PROHIBITED
DOCUMENT ME! |
static java.lang.String |
STATUS_CLIENT_RENEW_PROHIBITED
DOCUMENT ME! |
static java.lang.String |
STATUS_CLIENT_TRANSFER_PROHIBITED
DOCUMENT ME! |
static java.lang.String |
STATUS_CLIENT_UPDATE_PROHIBITED
DOCUMENT ME! |
static java.lang.String |
STATUS_OK
Status constants |
static java.lang.String |
STATUS_PENDING_DELETE
DOCUMENT ME! |
static java.lang.String |
STATUS_PENDING_TRANSFER
DOCUMENT ME! |
static java.lang.String |
STATUS_PENDING_VERIFICATION
DOCUMENT ME! |
static java.lang.String |
STATUS_SERVER_DELETE_PROHIBITED
DOCUMENT ME! |
static java.lang.String |
STATUS_SERVER_RENEW_PROHIBITED
DOCUMENT ME! |
static java.lang.String |
STATUS_SERVER_TRANSFER_PROHIBITED
DOCUMENT ME! |
static java.lang.String |
STATUS_SERVER_UPDATE_PROHIBITED
DOCUMENT ME! |
static java.lang.String |
TRANSFER_APPROVE
Transfer Operation constants |
static java.lang.String |
TRANSFER_CANCEL
DOCUMENT ME! |
static java.lang.String |
TRANSFER_QUERY
DOCUMENT ME! |
static java.lang.String |
TRANSFER_REJECT
DOCUMENT ME! |
static java.lang.String |
TRANSFER_REQUEST
DOCUMENT ME! |
Constructor Summary | |
---|---|
EPPDefReg(EPPSession newSession)
Constructs an EPPDefReg given an initialized EPP session. |
Method Summary | |
---|---|
void |
addDefRegName(java.lang.String newLevel,
java.lang.String newName)
Adds a defReg name for use with a send method. |
void |
addExtension(EPPCodecComponent aExtension)
Adds a command extension object. |
void |
addStatus(EPPDefRegStatus aStatus)
Adds a status for use in calling sendUpdate . |
java.lang.String |
getAdminContact()
Get the AdminContact informnation. |
java.lang.String |
getAuthRoid()
Sets the authorization roid that is used to identify the registrant or contact object if and only if the value of authInfo, set by setAuthString(String) , is associated with the registrant
or contact object. |
java.lang.String |
getAuthString()
Sets the authorization string associated with an sendCreate
and sendTransfer . |
java.util.Date |
getExpirationDate()
Gets the DefReg expiration date. |
java.util.Vector |
getExtensions()
Gets the command extensions. |
int |
getPeriodLength()
This is a Getter Method for PriodLength private Attribute This Attribute maintains Validity Period : duration which defReg is registered for. |
java.lang.String |
getPeriodUnit()
This is a Getter Method for PeriodUnit private Attribute This Attribute maintains Validity Unit :time unit where Period Length is mussured by. |
java.lang.String |
getRegistrant()
Gets the DefReg Registrant. |
EPPResponse |
getResponse()
Gets the response associated with the last command. |
java.lang.String |
getRoid()
Gets the DefReg Roid. |
java.lang.String |
getTm()
Get the trademark informnation. |
java.lang.String |
getTmCountry()
Get the trademark country informnation. |
java.util.Date |
getTmDate()
Get the trademark date informnation. |
void |
removeStatus(EPPDefRegStatus aStatus)
Removes a status for use in calling sendUpdate . |
EPPDefRegCheckResp |
sendCheck()
Sends a Defensive Registration Check Command to the server. |
EPPDefRegCreateResp |
sendCreate()
Sends a Defensive Registration Create Command to the server. |
EPPResponse |
sendDelete()
Sends a Defensive Registration Delete Command to the server. |
EPPDefRegInfoResp |
sendInfo()
Sends a Defensive Registration Info Command to the server. |
EPPDefRegRenewResp |
sendRenew()
Sends a Defensive Registration Renew Command to the server. |
EPPDefRegTransferResp |
sendTransfer()
Sends a Defensive Registration Transfer Command to the server. |
EPPResponse |
sendUpdate()
Sends a Defensive Registration Update Command to the server. |
void |
setAdminContact(java.lang.String aAdminContact)
Sets the DefReg Admin Contact. |
void |
setAuthRoid(java.lang.String aAuthRoid)
Gets the authorization roid that is used to identify the registrant or contact object if and only if the value of authInfo, set by setAuthString(String) , is associated with the registrant
or contact object. |
void |
setAuthString(java.lang.String newAuthString)
Sets the authorization string associated with an sendCreate
and sendTransfer . |
void |
setExpirationDate(java.util.Date newExpirationDate)
Sets the DefReg expiration date. |
void |
setExtension(EPPCodecComponent aExtension)
Deprecated. Replaced by addExtension(EPPCodecComponent) . This
method will add the extension as is done in addExtension(EPPCodecComponent) . |
void |
setExtensions(java.util.Vector aExtensions)
Sets the command extension objects. |
void |
setPeriodLength(int newPeriodLength)
This is a Setter Method for PriodLength private Attribute This Attribute maintains Validity Period : duration which defReg is registered for. |
void |
setPeriodUnit(java.lang.String newPeriodUnit)
This is a Setter Method for PeriodUnit private Attribute This Attribute maintains Validity Unit :time unit where Period Length is mussured by. |
void |
setRegistrant(java.lang.String aRegistrant)
Sets the DefReg Registrant. |
void |
setRoid(java.lang.String aRoid)
Sets the DefReg Roid. |
void |
setTm(java.lang.String aTm)
Set the trademark informnation. |
void |
setTmCountry(java.lang.String aTmCountry)
Set the trademark country informnation. |
void |
setTmDate(java.util.Date aTmDate)
Set the trademark date informnation. |
void |
setTransferOpCode(java.lang.String newTransferOpCode)
Sets the transfer operation for a call to encodeTransfer . |
void |
setTransId(java.lang.String newTransId)
Sets the client transaction identifier. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int CONTACT
public static final int STATUS
public static final int ADD
public static final int REMOVE
public static final int CHANGE
public static final java.lang.String STATUS_OK
public static final java.lang.String STATUS_SERVER_RENEW_PROHIBITED
public static final java.lang.String STATUS_SERVER_TRANSFER_PROHIBITED
public static final java.lang.String STATUS_SERVER_UPDATE_PROHIBITED
public static final java.lang.String STATUS_SERVER_DELETE_PROHIBITED
public static final java.lang.String STATUS_CLIENT_RENEW_PROHIBITED
public static final java.lang.String STATUS_CLIENT_TRANSFER_PROHIBITED
public static final java.lang.String STATUS_CLIENT_UPDATE_PROHIBITED
public static final java.lang.String STATUS_CLIENT_DELETE_PROHIBITED
public static final java.lang.String STATUS_PENDING_DELETE
public static final java.lang.String STATUS_PENDING_TRANSFER
public static final java.lang.String STATUS_PENDING_VERIFICATION
public static final java.lang.String TRANSFER_APPROVE
public static final java.lang.String TRANSFER_CANCEL
public static final java.lang.String TRANSFER_QUERY
public static final java.lang.String TRANSFER_REJECT
public static final java.lang.String TRANSFER_REQUEST
public static final java.lang.String LEVEL_STANDARD
public static final java.lang.String LEVEL_PREMIUM
public static final java.lang.String PERIOD_MONTH
public static final java.lang.String PERIOD_YEAR
Constructor Detail |
---|
public EPPDefReg(EPPSession newSession)
EPPDefReg
given an initialized EPP session.
newSession
- Server session to use.Method Detail |
---|
public void addExtension(EPPCodecComponent aExtension)
aExtension
- command extension object associated with the commandpublic void setExtension(EPPCodecComponent aExtension)
addExtension(EPPCodecComponent)
. This
method will add the extension as is done in addExtension(EPPCodecComponent)
.
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 addDefRegName(java.lang.String newLevel, java.lang.String newName)
send
method. Adding more
than one defReg names is only supported by sendCheck
.
newLevel
- Either LEVEL_STANDARD
or
LEVEL_PREMIUM
newName
- Defensive Registration Namepublic void setRoid(java.lang.String aRoid)
aRoid
- DefReg expiration datepublic java.lang.String getRoid()
public java.lang.String getTm()
public void setTm(java.lang.String aTm)
aTm
- DefReg registrantpublic java.lang.String getTmCountry()
public void setTmCountry(java.lang.String aTmCountry)
aTmCountry
- DefReg trademark countrypublic java.util.Date getTmDate()
public void setTmDate(java.util.Date aTmDate)
aTmDate
- DefReg trademark datepublic java.lang.String getAdminContact()
public void setRegistrant(java.lang.String aRegistrant)
aRegistrant
- DefReg Registrant.public void setAdminContact(java.lang.String aAdminContact)
aAdminContact
- DefReg Admin Contact.public java.lang.String getRegistrant()
public void setExpirationDate(java.util.Date newExpirationDate)
newExpirationDate
- DefReg expiration datepublic java.util.Date getExpirationDate()
public void setTransferOpCode(java.lang.String newTransferOpCode)
encodeTransfer
.
The transfer code must be set to one of the
EPPDefReg.TRANSFER_
constants.
newTransferOpCode
- One of the EPPDefReg.TRANSFER_
constantspublic void setTransId(java.lang.String newTransId)
newTransId
- Client transaction identifierpublic void setAuthString(java.lang.String newAuthString)
sendCreate
and sendTransfer
.
newAuthString
- Authorization stringpublic java.lang.String getAuthString()
sendCreate
and sendTransfer
.
null
otherwise.public java.lang.String getAuthRoid()
setAuthString(String)
, is associated with the registrant
or contact object. This can be used with sendTransfer
along with setting the authInfo with the
setAuthString(String)
method.
null
otherwise.public void setAuthRoid(java.lang.String aAuthRoid)
setAuthString(String)
, is associated with the registrant
or contact object. This can be used with sendTransfer
along with setting the authInfo with the
setAuthString(String)
method.
aAuthRoid
- Roid of registrant or contact objectpublic EPPDefRegCreateResp sendCreate() throws EPPCommandException
addDefRegName
- Sets the defensive registration name
to create. Only one defensive registration name is valid. setAuthString
- Sets the defensive registration
authorization string. 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 defensive
registration. This is required for thick registries. setAdminContact
- Sets the adminitrator contact setTm
- Sets the trademark setTmCountry
- Sets the trademark country setTmDate
- Sets the trademark date
EPPDefRegCreateResp
containing the defensive
registration create result. Use
EPPDefRegCreateResp.getRoid
to get the ROID
required for the rest of the EPPDefReg
operations.
EPPCommandException
- Error executing the create command. Use
getResponse
to get the associated server
error response.public EPPResponse sendUpdate() throws EPPCommandException
setRoid
- Sets the defensive registration ROID. setTransId
- Sets the client transaction identifier
addStatus
- Adds a status to the defensive
registration. More than one status can be added. removeStatus
- Removes a status from the defensive
registration. More than one status can be removed. setRegistrant
- Sets the Registrant for the defensive
registration. setAuthString
- Sets the defensive registration name
authorization setRegistrant
- Sets the Registrant for the defensive
registration. setAdminContact
- Sets the adminitrator contact setTm
- Sets the trademark setTmCountry
- Sets the trademark country setTmDate
- Sets the trademark date string.
EPPResponse
containing the defensive registration
update result.
EPPCommandException
- Error executing the update command. Use
getResponse
to get the associated server
error response.public EPPDefRegTransferResp sendTransfer() throws EPPCommandException
setRoid
- Sets the defensive registration ROID. setTransferOpCode
- Sets the defensive registration
transfer operation. setAuthString
- Sets the defensive registration
authorization string. setTransId
- Sets the client transaction identifier
setPeriodLength
- Sets the registration period
(default = 1) setPeriodUnit
- Sets the registration period unit
(default =PERIOD_YEAR
)
EPPDefRegTransferResp
containing the defensive
registration transfer result.
EPPCommandException
- Error executing the create command. Use
getResponse
to get the associated server
error response.public EPPDefRegRenewResp sendRenew() throws EPPCommandException
setRoid
- Sets the defensive registration ROID. setExpirationDate
- Sets current expiration date.
setTransId
- Sets the client transaction identifier
setPeriodLength
- Sets the registration period
(default = 1) setPeriodUnit
- Sets the registration period unit
(default =PERIOD_YEAR
)
EPPDefRegRenewResp
containing the defensive
registration renew result.
EPPCommandException
- Error executing the renew command. Use
getResponse
to get the associated server
error response.public EPPDefRegInfoResp sendInfo() throws EPPCommandException
setRoid
- Sets the defensive registration ROID. setTransId
- Sets the client transaction identifier
EPPDefRegInfoResp
containing the defensive
registration information.
EPPCommandException
- Error executing the info command. Use
getResponse
to get the associated server
error response.public EPPDefRegCheckResp sendCheck() throws EPPCommandException
addDefRegName
- Adds a defensive registration name to
check. More than one defensive registration name can be checked in
sendCheck
setTransId
- Sets the client transaction identifier
EPPDefRegCheckResp
containing the DefReg check
information.
EPPCommandException
- Error executing the check command. Use
getResponse
to get the associated server
error response.public EPPResponse sendDelete() throws EPPCommandException
setRoid
- Sets the defensive registration ROID. setTransId
- Sets the client transaction identifier
EPPResponse
containing the delete result
information.
EPPCommandException
- Error executing the delete command. Use
getResponse
to get the associated server
error response.public void addStatus(EPPDefRegStatus aStatus)
sendUpdate
.
aStatus
- Status to add to defensive registration.public void removeStatus(EPPDefRegStatus aStatus)
sendUpdate
.
aStatus
- Status to add to defensive registration.public EPPResponse getResponse()
public void setPeriodLength(int newPeriodLength)
newPeriodLength
- DOCUMENT ME!public void setPeriodUnit(java.lang.String newPeriodUnit)
newPeriodUnit
- DOCUMENT ME!public int getPeriodLength()
public java.lang.String getPeriodUnit()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |