Package com.verisign.epp.interfaces.v1_0
Class EPPMaintenance
- java.lang.Object
-
- com.verisign.epp.interfaces.v1_0.EPPMaintenance
-
public class EPPMaintenance extends java.lang.ObjectEPPMaintenanceis the primary client interface class used for the Maintenance EPP mapping. An instance ofEPPMaintenanceis created with an initializedEPPSession, 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 ofEPPResponseor instances of response classes in thecom.verisign.epp.codec.maintenancepackage.- See Also:
EPPMaintenanceInfoResp
-
-
Constructor Summary
Constructors Constructor Description EPPMaintenance(EPPSession aSession)Constructs anEPPMaintenancegiven an initialized EPP session.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddExtension(EPPCodecComponent aExtension)Adds a command extension object.java.util.VectorgetExtensions()Gets the command extensions.EPPMaintenanceInfoCmd.InfoTypegetInfoType()Gets the iinfoTypefor the info command.java.lang.StringgetMaintenanceId()Gets the maintenance identifier.EPPResponsegetResponse()Gets the response associated with the last command.protected voidresetMaintenance()Resets the Maintenance instance to its initial state.EPPMaintenanceInfoRespsendInfo()/** Sends a Maintenance Info Command to the server.
The optional attributes can be set with the following:
setTransId(String)- Sets the client transaction identifier.voidsetExtensions(java.util.Vector aExtensions)Sets the command extension objects.voidsetInfoType(EPPMaintenanceInfoCmd.InfoType aInfoType)Sets theinfoTypefor the info command.voidsetMaintenanceId(java.lang.String aMaintenanceId)Sets the maintenance identifier to send info for.voidsetTransId(java.lang.String aTransId)Sets the client transaction identifier.
-
-
-
Constructor Detail
-
EPPMaintenance
public EPPMaintenance(EPPSession aSession)
Constructs anEPPMaintenancegiven 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:
Vectorof concreteEPPCodecComponentassociated with the command if exists;nullotherwise.
-
setTransId
public void setTransId(java.lang.String aTransId)
Sets the client transaction identifier.- Parameters:
aTransId- Client transaction identifier
-
getInfoType
public EPPMaintenanceInfoCmd.InfoType getInfoType()
Gets the iinfoTypefor the info command.- Returns:
- the
infoTypefor the info command.
-
setInfoType
public void setInfoType(EPPMaintenanceInfoCmd.InfoType aInfoType)
Sets theinfoTypefor the info command. The maintenance notification identifier is used only when theinfoTypeis set toInfoType.id.- Parameters:
aInfoType- TheinfoTypefor the info command.
-
getMaintenanceId
public java.lang.String getMaintenanceId()
Gets the maintenance identifier.- Returns:
- The maintenance identifier if defined;
nullotherwise.
-
setMaintenanceId
public void setMaintenanceId(java.lang.String aMaintenanceId)
Sets the maintenance identifier to send info for.- Parameters:
aMaintenanceId- Maintenance identifier.
-
sendInfo
public EPPMaintenanceInfoResp sendInfo() throws EPPCommandException
/** Sends a Maintenance Info Command to the server.
The optional attributes can be set with the following:
setTransId(String)- Sets the client transaction identifier.setMaintenanceId(String)- Sets the maintenance identifier.
- Returns:
EPPMaintenanceInfoRespthat contains the maintenance information.- Throws:
EPPCommandException- On error
-
resetMaintenance
protected void resetMaintenance()
Resets the Maintenance 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
-
-