com.verisign.epp.codec.gen

## Interface EPPPollMessageFilter

- All Known Implementing Classes:
    EPPExtValuePollMessageFilter, EPPFullExtValuePollMessageFilter, EPPXmlMsgPollMessageFilter

      public interface EPPPollMessageFilter

  Interface 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 reflected in the `EPPResponse` by the implementing class. The interface does support a no-operation option to simply identify and log non-supported services without removing them from the poll message.

- - ### Method Summary

    All Methods Instance Methods Abstract Methods
    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 into the response the information associated with the unsupported extensions (object or command / response).
    `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 into the response the information associated with the unsupported extensions (object or command / response).

- - ### Method Detail

    - #### filter

          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 into the response the information associated with the unsupported extensions (object or command / response).
      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

          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 into the response the information associated with the unsupported extensions (object or command / response).
      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 another way in the response.
      Returns:
        Filtered poll message `EPPResponse` that contains extensions that the client supports.
      Throws:
        `EPPException` - Exception filtering the poll message

Copyright © VeriSign Inc. All Rights Reserved.