com.verisign.epp.codec.gen

Class EPPXmlMsgPollMessageFilter

java.lang.Object

com.verisign.epp.codec.gen.EPPXmlMsgPollMessageFilter

All Implemented Interfaces:

EPPPollMessageFilter

public class EPPXmlMsgPollMessageFilter
extends java.lang.Object
implements EPPPollMessageFilter

EPPXmlMsgPollMessageFilter is a utility class used to filter poll message EPPResponse instances against the list of client-specified object services and extension services. Any non-supported services (object or extension) will be removed from the poll message and the XML namepace will be encoded in the <msgQ><msg> element with the ABNF:

 msg                   = msg-text *LWSP *(not-supported-service *LWSP)
 msg-text              = *VCHAR
 not-supported-service = “<notSupported>” service-namespace “</notSupported>”
 service-namespace     = 1*VCHAR
 

The class does support a no-operation option to simply identify and log non-supported services without removing them from the poll message or encoding the <msgQ><msg> element.

Constructor Summary

Constructors

Constructor and Description
EPPXmlMsgPollMessageFilter()

Method Summary

Modifier and Type	Method and Description
EPPResponse	filter(EPPResponse aResponse, java.util.List<EPPService> aServices, java.util.List<EPPService> aExtServices) Filter any poll messages that are not supported by the client based on the passed in login services (object extensions) and extension services (command response extensions) from the poll message and encode their XML namespaces in the message queue message element.
EPPResponse	filter(EPPResponse aResponse, java.util.List<EPPService> aServices, java.util.List<EPPService> aExtServices, boolean aNoOp) Filter any poll messages that are not supported by the client based on the passed in login services (object extensions) and extension services (command response extensions) from the poll message and encode their XML namespaces in the message queue message element.

Methods inherited from class java.lang.Object

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

Constructor Detail

EPPXmlMsgPollMessageFilter

public EPPXmlMsgPollMessageFilter()

Method Detail

filter

public EPPResponse filter(EPPResponse aResponse,
                          java.util.List<EPPService> aServices,
                          java.util.List<EPPService> aExtServices)
                   throws EPPException

Filter any poll messages that are not supported by the client based on the passed in login services (object extensions) and extension services (command response extensions) from the poll message and encode their XML namespaces in the message queue message element.

Specified by:

filter in interface EPPPollMessageFilter

Parameters:

aResponse - Source poll message

aServices - List of EPPService login services (object extensions) supported by the client.

aExtServices - List of EPPService login extension services (command response extensions) supported by the client.

Returns:

Filtered poll message EPPResponse that contains extensions that the client supports.

Throws:

EPPException - Exception filtering the poll message

filter

public EPPResponse filter(EPPResponse aResponse,
                          java.util.List<EPPService> aServices,
                          java.util.List<EPPService> aExtServices,
                          boolean aNoOp)
                   throws EPPException

Filter any poll messages that are not supported by the client based on the passed in login services (object extensions) and extension services (command response extensions) from the poll message and encode their XML namespaces in the message queue message element.

Specified by:

filter in interface EPPPollMessageFilter

Parameters:

aResponse - Source poll message

aServices - List of EPPService login services (object extensions) supported by the client.

aExtServices - List of EPPService login extension services (command response extensions) supported by the client.

aNoOp - Set to true to only identify unsupported services by logging them and not removing them or encoding them in the <msgQ><msg> value.

Returns:

Filtered poll message EPPResponse that contains extensions that the client supports.

Throws:

EPPException - Exception filtering the poll message