com.ausregistry.jtoolkit2.se.generic

Class DomainInfoKVResponseExtension

java.lang.Object

com.ausregistry.jtoolkit2.se.ResponseExtension

com.ausregistry.jtoolkit2.se.generic.DomainInfoKVResponseExtension

All Implemented Interfaces:

java.io.Serializable

public final class DomainInfoKVResponseExtension
extends ResponseExtension

Extension of the domain mapping of the EPP info response, as defined in RFC5730 and RFC5731, to generic domain names, the specification of which is in the XML schema definition urn:X-ar:params:xml:ns:kv-1.0. Instances of this class provide an interface to access all of the information available through EPP for a generic domain name. This relies on the instance first being initialised by a suitable EPP domain info response using the method fromXML(). For flexibility, this implementation extracts the data from the response using XPath queries.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.ausregistry.jtoolkit2.se.ResponseExtension

CHK_DATA, CREATE, DATA, EXTENSION_EXPR, INFO, RENEW, TRANSFER, UPDATE

Constructor Summary

Constructors

Constructor and Description
DomainInfoKVResponseExtension()

Method Summary

Modifier and Type	Method and Description
void	fromXML(XMLDocument xmlDoc) Initialises the instance from the given XML document.
java.lang.String	getItem(java.lang.String listName, java.lang.String key) Retrieves the value of a given key-value item.
java.util.Set<java.lang.String>	getListItems(java.lang.String listName) Retrieves the names of all item keys, for a specified key-value list name.
java.util.Set<java.lang.String>	getLists() Retrieves the names of all key-value lists that have been added to the object.
boolean	isInitialised() Indicates whether fromXML() completed successfully and the extension was successfully initialised from the EPP response.

Methods inherited from class com.ausregistry.jtoolkit2.se.ResponseExtension

replaceResponseType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DomainInfoKVResponseExtension

public DomainInfoKVResponseExtension()

Method Detail

getLists

public java.util.Set<java.lang.String> getLists()

Retrieves the names of all key-value lists that have been added to the object.

Returns:

the set of list names

getListItems

public java.util.Set<java.lang.String> getListItems(java.lang.String listName)

Retrieves the names of all item keys, for a specified key-value list name.

Parameters:

listName - the name of the key-value list

Returns:

the set of item keys

getItem

public java.lang.String getItem(java.lang.String listName,
                                java.lang.String key)

Retrieves the value of a given key-value item.

Parameters:

listName - the name of the key-value list

key - the key of the item

Returns:

the value of the item

fromXML

public void fromXML(XMLDocument xmlDoc)
             throws javax.xml.xpath.XPathExpressionException

Description copied from class: ResponseExtension

Initialises the instance from the given XML document.

Specified by:

fromXML in class ResponseExtension

Parameters:

xmlDoc - EPP Response XML

Throws:

javax.xml.xpath.XPathExpressionException

isInitialised

public boolean isInitialised()

Description copied from class: ResponseExtension

Indicates whether fromXML() completed successfully and the extension was successfully initialised from the EPP response.

Specified by:

isInitialised in class ResponseExtension

Returns:

true if the extension has been initialised, else false.