com.afrigis.services.impl.GenericRequest Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of core Show documentation
Core Java library to ease use of AfriGIS Services
There is a newer version: 3.0.2
package com.afrigis.services.impl;

import java.util.ArrayList;
import java.util.Collection;

import com.afrigis.services.KeyValue;
import com.afrigis.services.Request;
import com.afrigis.services.Response;
import com.afrigis.services.exceptions.AfriGISServicesException;

/**
 * 
 * General use implementation of {@link Request}.
 * 
 * 
 * @author hendrikc
 *
 */
//CHECKSTYLE:OFF: AbstractClassName
public abstract class GenericRequest extends AbstractRequest
        implements Request {
    // CHECKSTYLE:ON: AbstractClassName

    /**
     * 
     * Method that will build a {@link Request} implementation for you.
     * 
     * 
     * @param serviceName
     *            the service name that you need to access
     * @return a {@link Request} implementation
     * @see com.afrigis.services.AfriGISService
     */
    public static Request build(final String serviceName) {
        return new GenericRequest() {

            @Override
            public String getServiceName() {
                return serviceName;
            }

            /**
             * Does nothing
             */
            @Override
            public void validate() throws AfriGISServicesException {
            }

            @Override
            protected
                    void completeRequestParamList(Collection input) {
                // Does nothing.

            }

        };
    }

    /**
     * 
     * Method that will build a {@link Request} implementation for you.
     * 
     * 
     * @param serviceName
     *            the service name that you need to access
     * @param params
     *            a {@link Collection} of {@link KeyValue} objects
     * @return a {@link Request} implementation
     * 
     * @see com.afrigis.services.AfriGISService
     */
    public static Request build(final String serviceName,
            final Collection params) {
        return new GenericRequest() {

            @Override
            public Collection getRequestParameters() {
                return params;
            }

            @Override
            public String getServiceName() {
                return serviceName;
            }

            /**
             * Does nothing.
             */
            @Override
            public void validate() throws AfriGISServicesException {
            }

            @Override
            protected
                    void completeRequestParamList(Collection input) {
                // Does nothing

            }
        };
    }

    /**
     * 
     * Builds a {@link Request} object from the provided service name and HTTP
     * query string.
     * 
     * 
     * I strongly urge you to rather look at {@link #build(String, Collection)},
     * in order to prevent unintended foot shootings.
     * 
     * 
     * @param serviceName
     *            the name of the service
     * @param params
     *            the query string parameter, NOT URL encoded
     * @return a valid {@link Request} object
     * @see com.afrigis.services.AfriGISService
     * @see Query
     *      String
     */
    public static Request build(final String serviceName, final String params) {
        return new GenericRequest() {

            @Override
            public Collection getRequestParameters() {
                return goFish(params);
            }

            /**
             * 
             * Breaks up provided query string on & character,
             * and then on = character in order to produce a result
             * that is digestable for the rest of the system.
             * 
             * 
             * @param params
             *            the query string
             * @return the processed key-value items
             */
            private Collection goFish(String params) {
                final Collection retList = new ArrayList<>();
                /*
                 * I suspect many things can go wrong here.
                 */
                final String[] keyVal = params.split("[&]");
                for (int i = 0; i < keyVal.length; i++) {
                    try {
                        final String[] splitted = keyVal[i].split("[=]");
                        final String key = splitted[0];
                        final String val = splitted[1];
                        retList.add(new KeyValue(key, val));
                    } catch (Exception e) {
                        log().warn(
                                "Exception encountered while breaking up the query string",
                                e);
                    }
                }
                return retList;
            }

            @Override
            public String getServiceName() {
                return serviceName;
            }

            /**
             * Does nothing.
             */
            @Override
            public void validate() throws AfriGISServicesException {
            }

            @Override
            protected
                    void completeRequestParamList(Collection input) {
                // Does nothting

            }
        };
    }

    @Override
    public Class getResponseType() {
        return GenericResponse.class;
    }

}