com.ausregistry.jtoolkit2.se

Class CheckResponse<I>

java.lang.Object

com.ausregistry.jtoolkit2.se.ReceiveSE

com.ausregistry.jtoolkit2.se.Response

com.ausregistry.jtoolkit2.se.DataResponse

com.ausregistry.jtoolkit2.se.CheckResponse<I>

Type Parameters:

I - the type of object identifier used in this check response

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

ContactCheckResponse, DomainCheckResponse, HostCheckResponse

public abstract class CheckResponse<I>
extends DataResponse

Representation of the EPP check response, as defined in RFC5730. Subclasses of this must specify the object to which the command is mapped. Instances of this class provide an interface to access availability information for each object identified in a CheckCommand. This relies on the instance first being initialised by a suitable EPP check response using the method fromXML. For flexibility, this implementation extracts the data from the response using XPath queries, the expressions for which are defined statically.

See Also:

CheckCommand, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	CHKDATA_AVAIL_EXPR
protected static java.lang.String	CHKDATA_COUNT_EXPR
protected static java.lang.String	CHKDATA_IDENT_EXPR
protected static java.lang.String	CHKDATA_IND_EXPR
protected static java.lang.String	CHKDATA_REASON_EXPR

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

OBJ, RES_DATA_EXPR

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

RESPONSE_EXPR, resultArray

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

debugLogger, maintLogger, userLogger

Constructor Summary

Constructors

Constructor and Description
CheckResponse(ObjectType objectType)

Method Summary

Modifier and Type	Method and Description
protected abstract java.lang.String	chkDataAvailExpr()
protected abstract java.lang.String	chkDataCountExpr()
protected abstract java.lang.String	chkDataIndexExpr()
protected abstract java.lang.String	chkDataReasonExpr()
protected abstract java.lang.String	chkDataTextExpr()
void	fromXML(XMLDocument xmlDoc) Set attribute values according to the given XML document.
boolean[]	getAvailableList()
protected abstract I	getKey(XMLDocument xmlDoc, java.lang.String qry) Returns an object identifier given an XPath expression for a check data element.
java.util.Set<I>	getNameIDs()
java.lang.String	getReason(I nameID)
java.lang.String	getReason(int index)
java.lang.String[]	getReasonList()
boolean	isAvailable(I nameID)
java.lang.String	toString()

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

getCmdType, getObjType

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

getCLTRID, getMessage, getMessageEnqueueDate, getMessageLanguage, getMsgCount, getMsgID, getResults, getSourceXMLString, getSVTRID, registerExtension

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

arrayToString, replaceIndex, toXML

Methods inherited from class java.lang.Object

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

Field Detail

CHKDATA_COUNT_EXPR

protected static final java.lang.String CHKDATA_COUNT_EXPR

See Also:

Constant Field Values

CHKDATA_IND_EXPR

protected static final java.lang.String CHKDATA_IND_EXPR

See Also:

Constant Field Values

CHKDATA_IDENT_EXPR

protected static final java.lang.String CHKDATA_IDENT_EXPR

See Also:

Constant Field Values

CHKDATA_AVAIL_EXPR

protected static final java.lang.String CHKDATA_AVAIL_EXPR

See Also:

Constant Field Values

CHKDATA_REASON_EXPR

protected static final java.lang.String CHKDATA_REASON_EXPR

See Also:

Constant Field Values

Constructor Detail

CheckResponse

public CheckResponse(ObjectType objectType)

Method Detail

isAvailable

public boolean isAvailable(I nameID)

getReason

public java.lang.String getReason(I nameID)

getReason

public java.lang.String getReason(int index)

getNameIDs

public java.util.Set<I> getNameIDs()

getAvailableList

public boolean[] getAvailableList()

getReasonList

public java.lang.String[] getReasonList()

fromXML

public void fromXML(XMLDocument xmlDoc)

Description copied from class: ReceiveSE

Set attribute values according to the given XML document.

Overrides:

fromXML in class Response

Parameters:

xmlDoc - the Document to parse

getKey

protected abstract I getKey(XMLDocument xmlDoc,
                            java.lang.String qry)
                     throws javax.xml.xpath.XPathExpressionException

Returns an object identifier given an XPath expression for a check data element.

Parameters:

xmlDoc - the EPP check response message

qry - the XPath query expression

Returns:

an object identifier

Throws:

javax.xml.xpath.XPathExpressionException

toString

public java.lang.String toString()

Overrides:

toString in class Response

chkDataCountExpr

protected abstract java.lang.String chkDataCountExpr()

chkDataIndexExpr

protected abstract java.lang.String chkDataIndexExpr()

chkDataTextExpr

protected abstract java.lang.String chkDataTextExpr()

chkDataAvailExpr

protected abstract java.lang.String chkDataAvailExpr()

chkDataReasonExpr

protected abstract java.lang.String chkDataReasonExpr()