Package google.registry.monitoring.blackbox.message

Class EppRequestMessage

java.lang.Object

google.registry.monitoring.blackbox.message.EppMessage

google.registry.monitoring.blackbox.message.EppRequestMessage

All Implemented Interfaces:

OutboundMessageType

public class EppRequestMessage
extends EppMessage
implements OutboundMessageType

EppMessage subclass that implements OutboundMessageType, which represents an outbound Epp message.

In modifying the getReplacements field of EppRequestMessage and the template, we can represent the the 5 basic EPP commands we are attempting to probe. The original 5 are: LOGIN, CREATE, CHECK, DELETE, LOGOUT.

In turn, we equivalently create 10 different EPP commands probed: Hello - checks for Greeting response, Login expecting success, Login expecting Failure, Create expecting Success, Create expecting Failure, Check that the domain exists, Check that the domain doesn't exist, Delete expecting Success, Delete expecting Failure, and Logout expecting Success.

The main difference is that we added a hello command that simply waits for the server to send a greeting, then moves on to the Login action.

Stores a clTRID and domainName which is modified each time the token calls modifyMessage. These will also modify the EPP request sent to the server.

Field Summary

Fields inherited from class google.registry.monitoring.blackbox.message.EppMessage

CLIENT_ID_KEY, CLIENT_PASSWORD_KEY, CLIENT_TRID_KEY, DOMAIN_KEY, HEADER_LENGTH, message, SERVER_TRID_KEY, XFAIL_EXPRESSION, XPASS_EXPRESSION

Constructor Summary

Constructors

Constructor	Description
EppRequestMessage(String name, EppResponseMessage expectedResponse, String template, BiFunction<String,String,Map<String,String>> getReplacements)	Private constructor for EppRequestMessage that its subclasses use for instantiation.

Method Summary

Modifier and Type	Method	Description
io.netty.buffer.ByteBuf	bytes()	Converts the current Document message to a ByteBuf with the requisite bytes
EppResponseMessage	getExpectedResponse()	Returns the EppResponseMessage we expect.
EppRequestMessage	modifyMessage(String... args)	From the input clTrid and domainName, modifies the template EPP XML document and the expectedResponse to reflect new parameters.
String	name()	Necessary to inform metrics collector what kind of message is sent down ChannelPipeline.
String	responseName()	Necessary to inform metrics collector what kind of message is sent inbound ChannelPipeline.
String	toString()	Returns a String representation using the name(), responseName(), and EppMessage.message (if non-null).

Methods inherited from class google.registry.monitoring.blackbox.message.EppMessage

byteArrayToXmlDoc, eppValidate, getElementValue, getElementValue, getEppDocFromTemplate, verifyEppResponse, xmlDocToByteArray, xmlDocToString

Methods inherited from class java.lang.Object

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

Constructor Details

EppRequestMessage

public EppRequestMessage(String name,
 EppResponseMessage expectedResponse,
 String template,
 BiFunction<String,String,Map<String,String>> getReplacements)

Private constructor for EppRequestMessage that its subclasses use for instantiation.

Method Details

modifyMessage

public EppRequestMessage modifyMessage(String... args)
                                throws EppClientException

From the input clTrid and domainName, modifies the template EPP XML document and the expectedResponse to reflect new parameters.

Specified by:

modifyMessage in interface OutboundMessageType

Parameters:

args - - should always be two Strings: The first one is clTrid and the second one is domainName.

Returns:

the current EppRequestMessage instance.

Throws:

EppClientException - - On the occasion that the prober can't appropriately modify the EPP XML document, the blame falls on the prober, not the server, so it throws an EppClientException, which is a subclass of the UndeterminedStateException.

bytes

public io.netty.buffer.ByteBuf bytes()
                              throws EppClientException

Converts the current Document message to a ByteBuf with the requisite bytes

Returns:

the ByteBuf instance that stores the bytes representing the requisite EPP Request

Throws:

EppClientException - On the occasion that the prober can't appropriately convert the EPP XML document to a ByteBuf, the blame falls on the prober, not the server, so it throws an EppClientException, which is a subclass of the UndeterminedStateException.

getExpectedResponse

public EppResponseMessage getExpectedResponse()

Returns the EppResponseMessage we expect.

name

public String name()

Description copied from interface: OutboundMessageType

Necessary to inform metrics collector what kind of message is sent down ChannelPipeline. Not equivalent to toString, as to different instances will have the same name if they perform the same action.

Specified by:

name in interface OutboundMessageType

responseName

public String responseName()

Description copied from interface: OutboundMessageType

Necessary to inform metrics collector what kind of message is sent inbound ChannelPipeline. Equivalent to name but for InboundMessageType.

Specified by:

responseName in interface OutboundMessageType

toString

public String toString()

Returns a String representation using the name(), responseName(), and EppMessage.message (if non-null).

This is primarily for parameterized test case usage, which requires a sensible toString for the purposes of test method naming.

Overrides:

toString in class EppMessage