com.tucows.oxrs.epp.rtk.xml
Class EPPHostCheck

java.lang.Object
  |
  +--org.omg.CORBA.portable.ObjectImpl
        |
        +--com.tucows.oxrs.epp.rtk.RTKBase
              |
              +--com.tucows.oxrs.epp.rtk.xml.EPPXMLBase
                    |
                    +--com.tucows.oxrs.epp.rtk.xml.EPPHostBase
                          |
                          +--com.tucows.oxrs.epp.rtk.xml.EPPHostCheck

All Implemented Interfaces:

epp_Action, epp_ActionOperations, epp_HostCheck, epp_HostCheckOperations, org.omg.CORBA.portable.IDLEntity, org.omg.CORBA.Object, java.io.Serializable

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.epp.rtk.example.HostExample class.

See Also:

HostExample, epp_Action, epp_HostCheck, epp_HostCheckReq, epp_HostCheckRsp, Host Spec for more information, Serialized Form

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

host_ip_to_type_hash_, host_status_hash_

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

auth_type_string_to_type_hash_, auth_type_to_string_array_, transfer_op_to_string_array_, transfer_status_to_type_hash_, xml_

Fields inherited from class com.tucows.oxrs.epp.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(java.lang.String xml)
Constructor with response XML string to automatically parse.

Method Summary

void	fromXML(java.lang.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.
java.lang.String	toXML() Builds request XML from the request data.

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

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

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

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

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

_ids, debug, debug, getDebugLevel, getRTKProperties, setDebugLevel, setDebugLevel

Methods inherited from class org.omg.CORBA.portable.ObjectImpl

_create_request, _create_request, _duplicate, _get_delegate, _get_domain_managers, _get_interface_def, _get_policy, _hash, _invoke, _is_a, _is_equivalent, _is_local, _non_existent, _orb, _release, _releaseReply, _request, _request, _servant_postinvoke, _servant_preinvoke, _set_delegate, _set_policy_override, equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.omg.CORBA.Object

_create_request, _create_request, _duplicate, _get_domain_managers, _get_interface_def, _get_policy, _hash, _is_a, _is_equivalent, _non_existent, _release, _request, _set_policy_override

Constructor Detail

EPPHostCheck

public EPPHostCheck()

Default constructor

EPPHostCheck

public EPPHostCheck(java.lang.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

See Also:

fromXML(String)

Method Detail

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.epp.epp_HostCheckReq

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.epp.epp_HostCheckRsp

toXML

public java.lang.String toXML()
                       throws epp_XMLException

Builds request XML from the request data. Implemented method from org.openrtk.idl.epp.epp_Action interface.

Specified by:

toXML in interface epp_ActionOperations

Throws:

epp_XMLException - if required data is missing

See Also:

setRequestData(epp_HostCheckReq), epp_Action

fromXML

public void fromXML(java.lang.String xml)
             throws epp_XMLException,
                    epp_Exception

Parses a new XML String and populates the response data member. Implemented method from org.openrtk.idl.epp.epp_Action interface.

Specified by:

fromXML in interface epp_ActionOperations

Parameters:

A - new XML String to parse

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