|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.verisign.epp.interfaces.EPPNameWatch
public class EPPNameWatch
EPPNameWatch
is the primary client interface class used for
nameWatch management. An instance of EPPNameWatch
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.nameWatch
package.
EPPResponse
,
EPPNameWatchCreateResp
,
EPPNameWatchInfoResp
,
EPPNameWatchTransferResp
Field Summary | |
---|---|
static java.lang.String |
FREQ_DAILY
Frequency type constants |
static java.lang.String |
FREQ_MONTHLY
DOCUMENT ME! |
static java.lang.String |
FREQ_WEEKLY
DOCUMENT ME! |
static java.lang.String |
PERIOD_MONTH
Period in Unit Month |
static java.lang.String |
PERIOD_YEAR
Period in Unit Year |
static java.lang.String |
STATUS_CLIENT_DELETE_PROHIBITED
DOCUMENT ME! |
static java.lang.String |
STATUS_CLIENT_HOLD
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_SERVER_DELETE_PROHIBITED
DOCUMENT ME! |
static java.lang.String |
STATUS_SERVER_HOLD
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 | |
---|---|
EPPNameWatch(EPPSession newSession)
Constructs an EPPNameWatch given an initialized EPP
session. |
Method Summary | |
---|---|
void |
addExtension(EPPCodecComponent aExtension)
Adds a command extension object. |
void |
addStatus(EPPNameWatchStatus aStatus)
Adds a status for use in calling sendUpdate . |
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 NameWatch expiration date. |
java.util.Vector |
getExtensions()
Gets the command extensions. |
java.lang.String |
getFreq()
Gets NameWatch report frequency, which should be one of the FREQ_ constant values. |
java.lang.String |
getName()
Gets the NameWatch Name |
int |
getPeriodLength()
Gets the registration period. |
java.lang.String |
getPeriodUnit()
Gets the registration period unit. |
java.lang.String |
getRegistrant()
Gets the registrant. |
EPPResponse |
getResponse()
Gets the response associated with the last command. |
java.lang.String |
getRoid()
Gets the NameWatch Roid |
java.lang.String |
getRptTo()
Gets NameWatch e-mail address to report to. |
void |
removeStatus(EPPNameWatchStatus aStatus)
Removes a status for use in calling sendUpdate . |
EPPNameWatchCreateResp |
sendCreate()
Sends a NameWatch Create Command to the server. |
EPPResponse |
sendDelete()
Sends a NameWatch Delete Command to the server. |
EPPNameWatchInfoResp |
sendInfo()
Sends a NameWatch Info Command to the server. |
EPPNameWatchRenewResp |
sendRenew()
Sends a NameWatch Renew Command to the server. |
EPPNameWatchTransferResp |
sendTransfer()
Sends a NameWatch Transfer Command to the server. |
EPPResponse |
sendUpdate()
Sends a NameWatch Update Command to the server. |
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 NameWatch expiration date. |
void |
setExtension(EPPCodecComponent aExtension)
Deprecated. Replaced by addExtension(EPPCodecComponent) . This
method will add the extension as is done in addExtension(EPPCodecComponet) . |
void |
setExtensions(java.util.Vector aExtensions)
Sets the command extension objects. |
void |
setFreq(java.lang.String aFreq)
Sets the NameWatch report frequency, which should be one of the FREQ_ constant values. |
void |
setName(java.lang.String newName)
Sets the NameWatch Name |
void |
setPeriodLength(int newPeriodLength)
Sets the registration period. |
void |
setPeriodUnit(java.lang.String newPeriodUnit)
Sets the registration period unit. |
void |
setRegistrant(java.lang.String newRegistrant)
Sets the registrant. |
void |
setRoid(java.lang.String newRoid)
Sets the NameWatch roid |
void |
setRptTo(java.lang.String aRptTo)
Sets NameWatch e-mail address to report to. |
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 java.lang.String STATUS_OK
public static final java.lang.String STATUS_SERVER_HOLD
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_HOLD
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 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 FREQ_DAILY
public static final java.lang.String FREQ_WEEKLY
public static final java.lang.String FREQ_MONTHLY
public static final java.lang.String PERIOD_MONTH
public static final java.lang.String PERIOD_YEAR
Constructor Detail |
---|
public EPPNameWatch(EPPSession newSession)
EPPNameWatch
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(EPPCodecComponet)
.
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 setRoid(java.lang.String newRoid)
newRoid
- NameWatch roidpublic java.lang.String getRoid()
public void setExpirationDate(java.util.Date newExpirationDate)
newExpirationDate
- NameWatch expiration datepublic java.util.Date getExpirationDate()
public java.lang.String getName()
public void setName(java.lang.String newName)
newName
- NameWatch Namepublic void setTransferOpCode(java.lang.String newTransferOpCode)
encodeTransfer
.
The transfer code must be set to one of the
EPPNameWatch.TRANSFER_
constants.
newTransferOpCode
- One of the EPPNameWatch.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 java.lang.String getRegistrant()
null
otherwise.public void setRegistrant(java.lang.String newRegistrant)
newRegistrant
- NameWatch registrantpublic java.lang.String getRptTo()
null
otherwise.public void setRptTo(java.lang.String aRptTo)
aRptTo
- addressString
.public java.lang.String getFreq()
FREQ_
constant values.
null
otherwise.public void setFreq(java.lang.String aFreq)
FREQ_
constant values.
aFreq
- One of the FREQ_
constant values.public EPPNameWatchCreateResp sendCreate() throws EPPCommandException
setName
- Sets the namewatch name to create.
setAuthString
- Sets the namewatch authorization
setRegistrant
- Sets the Registrant for the namewatch.
string.
setRptTo
- Sets e-mail address to report to.
setFreq
- Sets the frequency of the report
setTransId
- Sets the client transaction identifier
setPeriodLength
- Sets the registration period (default = 1)
setPeriodUnit
- Sets the registration period unit (default
=PERIOD_YEAR
)
EPPNameWatchCreateResp
containing the namewatch
create result. Use EPPNameWatchCreateResp.getRoid
to get the ROID required for the rest of the
EPPNameWatch
operations.
EPPCommandException
- Error executing the create command. Use
getResponse
to get the associated server error
response.public EPPResponse sendUpdate() throws EPPCommandException
setRoid
- Sets the namewatch ROID. string.
setTransId
- Sets the client transaction identifier
addStatus
- Adds a status to the namewatch. More than one
status can be added.
removeStatus
- Removes a status from the namewatch. More
than one status can be removed.
setRegistrant
- Sets the Registrant for the namewatch.
setAuthString
- Sets the namewatch authorization
setRptTo
- Sets e-mail address to report to.
setFreq
- Sets the frequency of the report
EPPNameWatchCreateResp
containing the namewatch
create result. Use EPPNameWatchCreateResp.getRoid
to get the ROID required for the rest of the
EPPNameWatch
operations.
EPPCommandException
- Error executing the create command. Use
getResponse
to get the associated server error
response.public EPPNameWatchTransferResp sendTransfer() throws EPPCommandException
setRoid
- Sets the namewatch ROID.
setTransferOpCode
- Sets the namewatch transfer operation.
setAuthString
- Sets the namewatch authorization string. setTransId
- Sets the client transaction identifier
setPeriodLength
- Sets the registration period (default = 1)
setPeriodUnit
- Sets the registration period unit (default
=PERIOD_YEAR
)
EPPNameWatchTransferResp
containing the namewatch
transfer result.
EPPCommandException
- Error executing the create command. Use
getResponse
to get the associated server error
response.public EPPNameWatchRenewResp sendRenew() throws EPPCommandException
setRoid
- Sets the namewatch 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
)
EPPNameWatchRenewResp
containing the namewatch
renew result.
EPPCommandException
- Error executing the renew command. Use
getResponse
to get the associated server error
response.public EPPNameWatchInfoResp sendInfo() throws EPPCommandException
setRoid
- Sets the namewatch ROID.
setTransId
- Sets the client transaction identifier
EPPNameWatchInfoResp
containing the namewatch
information.
EPPCommandException
- Error executing the info command. Use
getResponse
to get the associated server error
response.public EPPResponse sendDelete() throws EPPCommandException
setRoid
- Sets the namewatch 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 EPPResponse getResponse()
public int getPeriodLength()
getPeriodUnit
.
0
otherwisepublic void setPeriodLength(int newPeriodLength)
setPeriodUnit
.
newPeriodLength
- DOCUMENT ME!public java.lang.String getPeriodUnit()
PERIOD_MONTH
or PERIOD_YEAR
.
0
otherwisepublic void setPeriodUnit(java.lang.String newPeriodUnit)
newPeriodUnit
- DOCUMENT ME!public void addStatus(EPPNameWatchStatus aStatus)
sendUpdate
.
aStatus
- Status to add to namewatch.public void removeStatus(EPPNameWatchStatus aStatus)
sendUpdate
.
aStatus
- Status to add to namewatch.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |