cz.active24.client.fred.data.list.ListResultsHelper Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of fred-client Show documentation
A Java EPP client for FRED (Free Registry for ENUM and Domains)
There is a newer version: 2.50
package cz.active24.client.fred.data.list;

import cz.nic.xml.epp.fred_1.ExtcommandType;
import cz.nic.xml.epp.fred_1.InfoResponseT;
import cz.nic.xml.epp.fred_1.ResultsListT;
import cz.active24.client.fred.eppclient.EppClient;
import cz.active24.client.fred.eppclient.EppCommandHelper;
import cz.active24.client.fred.exception.FredClientException;
import ietf.params.xml.ns.epp_1.EppType;
import ietf.params.xml.ns.epp_1.ResponseType;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

import javax.xml.bind.JAXBElement;
import javax.xml.bind.JAXBIntrospector;

/**
 * Util class is used to retrieve a chunk of the results that were prepared in a previous step with a list command.
 *
 * @see FRED documentation
 */
public class ListResultsHelper {

    private static final Log log = LogFactory.getLog(ListResultsHelper.class);

    private EppClient client;

    private EppCommandHelper eppCommandHelper;

    public ListResultsHelper(EppClient client, EppCommandHelper eppCommandHelper) {
        this.client = client;
        this.eppCommandHelper = eppCommandHelper;
    }

    /**
     * Method call prepare command to server a if there are any objects prepared to retrieve, it retrieves them.
     *
     * @param extcommandType what to list.
     * @return listed items.
     * @throws FredClientException when call failed.
     */
    public ListResponse prepareListAndGetResults(ExtcommandType extcommandType) throws FredClientException {

        if (extcommandType == null){
            return new ListResultsResponse();
        }

        JAXBElement requestElement = eppCommandHelper.createFredExtensionEppCommand(extcommandType);

        ResponseType responseType = client.execute(requestElement);

        InfoResponseT countResponse = (InfoResponseT) JAXBIntrospector.getValue(responseType.getResData().getAny().get(0));

        // get results if count > 0
        if (countResponse.getCount().intValue() > 0) {
            return this.getResults(responseType.getTrID().getClTRID());
        }

        ListResultsResponse result = new ListResultsResponse();
        result.addResponseInfo(responseType);
        return result;
    }

    /**
     * This command is used to retrieve a chunk of the results that were prepared in a previous step with a list command.
     * The command must be called repeatedly to collect all results until the returned results list is empty.
     *
     * @param clientTransactionId from previous step with a list command
     * @return list with data or empty one
     * @throws FredClientException when call failed.
     */
    private ListResponse getResults(String clientTransactionId) throws FredClientException {
        log.debug("getResults called for client transaction id " + clientTransactionId);

        ListResultsResponse result = new ListResultsResponse();

        boolean returnedListEmpty = false;

        do {
            ExtcommandType extcommandType = new ExtcommandType();
            extcommandType.setGetResults("");
            extcommandType.setClTRID(clientTransactionId);

            JAXBElement requestElement = eppCommandHelper.createFredExtensionEppCommand(extcommandType);

            ResponseType responseType = client.execute(requestElement);

            result.addResponseInfo(responseType);

            if (responseType.getResData() != null){
                ResultsListT resultsListT = (ResultsListT)  JAXBIntrospector.getValue(responseType.getResData().getAny().get(0));

                result.getResults().addAll(resultsListT.getItem());

                returnedListEmpty = resultsListT.getItem().isEmpty();
            }
        } while (!returnedListEmpty);

        return result;
    }
}