com.tucows.oxrs.epp0705.rtk.xml

Class EPPHostCheck

Implemented Interfaces:
epp_Action, epp_ActionOperations, epp_HostCheck, epp_HostCheckOperations, org.omg.CORBA.portable.IDLEntity, org.omg.CORBA.Object

public class EPPHostCheck
extends EPPHostBase
implements epp_HostCheck

Class for the EPP Host Check command and response. Extends the epp_HostCheck interface from the EPP IDLs to provide the XML translation for the EPP Host Check command. The Check command provides a way of telling if an object exists in the registry server. Usage is demonstrated in the com.tucows.oxrs.epp0705.rtk.example.HostExample class.
See Also:
HostExample, epp_Action, epp_HostCheck, epp_HostCheckReq, epp_HostCheckRsp, Host Spec for more information

Field Summary

Fields inherited from class com.tucows.oxrs.epp0705.rtk.xml.EPPHostBase

host_ip_to_type_hash_, host_status_hash_

Fields inherited from class com.tucows.oxrs.epp0705.rtk.xml.EPPXMLBase

auth_type_string_to_type_hash_, transfer_status_to_type_hash_, xml_

Fields inherited from class com.tucows.oxrs.epp0705.rtk.RTKBase

CRLF, DATE_FMT, DEBUG_LEVEL_ONE, DEBUG_LEVEL_THREE, DEBUG_LEVEL_TWO, DEBUG_NONE, RTK_VERSION, UTC_FMT

Constructor Summary

EPPHostCheck()
Default constructor
EPPHostCheck(String xml)
Constructor with response XML string to automatically parse.

Method Summary

void
fromXML(String xml)
Parses a new XML String and populates the response data member.
epp_HostCheckRsp
getResponseData()
Accessor method for the host check response data.
void
setRequestData(epp_HostCheckReq value)
Accessor method for the host check request data.
String
toXML()
Builds request XML from the request data.

Methods inherited from class com.tucows.oxrs.epp0705.rtk.xml.EPPHostBase

hostAddressTypeToString, hostStatusFromString, hostStatusToString, initHashes, initHostIpToTypeHash, initHostStatusHash, setCommonAttributes

Methods inherited from class com.tucows.oxrs.epp0705.rtk.xml.EPPXMLBase

addXMLElement, convertListToArray, convertListToStringArray, createDocRoot, createXMLFromDoc, createXMLSnippetFromDoc, getAvailResultFor, getCheckResultFor, getDocumentElement, getElement, getExtensionNode, getNode, getPanData, getTransID, getXML, initAuthInfoStringToTypeHash, initHashes, initTransferStatusToTypeHash, parseGenericCheckResults, parseGenericResult, prepareAuthInfo, prepareExtensionElement, stringListToXML, transferStatusFromString, transferStatusToString

Methods inherited from class com.tucows.oxrs.epp0705.rtk.RTKBase

_ids, debug, debug, getDebugLevel, getDebugPrintStream, getEasyProperty, getRTKProperties, setDebugLevel, setDebugLevel, setDebugPrintStream

Constructor Details

EPPHostCheck

public EPPHostCheck()
Default constructor

EPPHostCheck

public EPPHostCheck(String xml)
            throws epp_XMLException,
                   epp_Exception
Constructor with response XML string to automatically parse.
Parameters:
xml - The EPP Host Check response XML String
Throws:
epp_XMLException - if the response XML is not parsable or does not contain the expected data
epp_Exception - if the server has responded with an error code

Method Details

fromXML

public void fromXML(String xml)
            throws epp_XMLException,
                   epp_Exception
Parses a new XML String and populates the response data member. Implemented method from org.openrtk.idl.epp0705.epp_Action interface.
Specified by:
fromXML in interface epp_ActionOperations
Parameters:
Throws:
epp_XMLException - if the response XML is not parsable or does not contain the expected data
epp_Exception - if the server has responded with an error code
See Also:
epp_Action

getResponseData

public epp_HostCheckRsp getResponseData()
Accessor method for the host check response data.
Specified by:
getResponseData in interface epp_HostCheckOperations
Returns:
value org.openrtk.idl.epp0705.epp_HostCheckRsp

setRequestData

public void setRequestData(epp_HostCheckReq value)
Accessor method for the host check request data. Must be set to for this command.
Specified by:
setRequestData in interface epp_HostCheckOperations
Parameters:
value - org.openrtk.idl.epp0705.epp_HostCheckReq

toXML

public String toXML()
            throws epp_XMLException
Builds request XML from the request data. Implemented method from org.openrtk.idl.epp0705.epp_Action interface.
Specified by:
toXML in interface epp_ActionOperations
Throws:
epp_XMLException - if required data is missing

Copyright © 2001-2002 - Tucows, Inc., 2003 - LibertyRMS