public class EPPLaunch
extends java.lang.Object
EPPLaunch
is the primary client interface class used for launch
EPP extension. This interface class is only used for sending the Claims Check
Command via the sendCheck()
method. An instance of
EPPLaunch
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 response returned from the send action methods are
either instances of EPPResponse
or instances of response classes
in the com.verisign.epp.codec.launch
package.EPPResponse
,
EPPLaunchChkData
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
PHASE_CLAIMS
Trademark claims phase 1 as defined by Trademark Clearinghouse model of
displaying a claims notice to clients for domain names that match
trademarks.
|
static java.lang.String |
PHASE_CUSTOM
Post launch phase that is also referred to as "steady state".
|
static java.lang.String |
PHASE_LANDRUSH
Post sunrise phase when non-trademark holders are allowed to register
domain names with steps taken to address a large volume of initial
registrations.
|
static java.lang.String |
PHASE_OPEN
Post launch phase that is also referred to as "steady state".
|
static java.lang.String |
PHASE_SUNRISE
Phase when trademark holders can submit registrations or applications
with trademark information that can be validated by.
|
static java.lang.String |
TYPE_AVAILABILITY
Constant used to specify the availability check form type
|
static java.lang.String |
TYPE_CLAIMS
Constant used to specify the claims check form type
|
Constructor and Description |
---|
EPPLaunch(EPPSession aSession)
Constructs an
EPPLaunch given an initialized EPP session. |
Modifier and Type | Method and Description |
---|---|
void |
addDomainName(java.lang.String aDomain)
Adds a domain name for use with
sendCheck() method. |
void |
addExtension(EPPCodecComponent aExtension)
Adds a command extension object.
|
java.util.Vector |
getExtensions()
Gets the command extensions.
|
EPPResponse |
getResponse()
Gets the response associated with the last command.
|
protected void |
resetLaunch()
Resets the domain instance to its initial state.
|
EPPResponse |
sendCheck()
Sends a Claim Check Command, which is an extension of the Domain Check
with the
EPPLaunchCheck extension and the type set to the
whether to execute a claims check command or an availability check
command for a given phase. |
void |
setExtensions(java.util.Vector aExtensions)
Sets the command extension objects.
|
void |
setPhase(java.lang.String aPhase)
Sets the phase value.
|
void |
setPhaseName(java.lang.String aPhaseName)
Sets the phase name value.
|
void |
setTransId(java.lang.String aTransId)
Sets the client transaction identifier.
|
void |
setType(java.lang.String aType)
Sets the check form type.
|
public static final java.lang.String PHASE_SUNRISE
public static final java.lang.String PHASE_LANDRUSH
public static final java.lang.String PHASE_CLAIMS
public static final java.lang.String PHASE_OPEN
public static final java.lang.String PHASE_CUSTOM
public static final java.lang.String TYPE_CLAIMS
public static final java.lang.String TYPE_AVAILABILITY
public EPPLaunch(EPPSession aSession)
EPPLaunch
given an initialized EPP session.aSession
- Server session to use.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 addDomainName(java.lang.String aDomain)
sendCheck()
method.aDomain
- Domain name to addpublic EPPResponse sendCheck() throws EPPCommandException
EPPLaunchCheck
extension and the type set to the
whether to execute a claims check command or an availability check
command for a given phase.addDomainName
- Adds a domain name to check if there is a
matching trademark that requires a claims notice. More than one domain
name can be checked in sendCheck
.setPhase
- Sets the Claims Check Command phase. The value
should be set to PHASE_CLAIMS
when type is set to
TYPE_CLAIMS
; otherwise when type is set to
TYPE_AVAILABILITY
the availability check will be executed in the
context of the defined phase.
setType
- Sets the type of the check as either a
TYPE_CLAIMS
for a claims check command or
TYPE_AVAILABILITY
for an availability check for a specific
phase. The default type is TYPE_CLAIMS
.setTransId
- Sets the client transaction identifierEPPResponse
containing EPPLaunchChkData
extension when the type attribute is TYPE_CLAIMS
or
EPPDomainCheckResp
when the type attribute is
TYPE_AVAILABILITY
.EPPCommandException
- Error executing the check command. Use
getResponse
to get the associated server
error response.protected void resetLaunch()
public EPPResponse getResponse()
public void setTransId(java.lang.String aTransId)
aTransId
- Client transaction identifierpublic void setPhase(java.lang.String aPhase)
aPhase
- Phase value, which should be one of the PHASE
constants.public void setPhaseName(java.lang.String aPhaseName)
aPhaseName
- Phase namepublic void setType(java.lang.String aType)
TYPE_CLAIMS
if undefined.aType
- TYPE_CLAIMS
or TYPE_AVAILABILITY
Copyright © VeriSign Inc. All Rights Reserved.