it.geosolutions.geoserver.rest.Util Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of geoserver-manager Show documentation
GeoServer Manager is a library to interact with GeoServer The scope of this library is to have a simple API, and use as few external libs as possible.
There is a newer version: 1.8.7
Show newest version
/*
 *  GeoServer-Manager - Simple Manager Library for GeoServer
 *
 *  Copyright (C) 2007 - 2016 GeoSolutions S.A.S.
 *  http://www.geo-solutions.it
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

package it.geosolutions.geoserver.rest;

import it.geosolutions.geoserver.rest.decoder.RESTStyle;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Map;

/**
 * Util class.
 *
 * @author ETj (etj at geo-solutions.it)
 * @version $Id: $
 */
public class Util {

/** Constant QUIET_ON_NOT_FOUND_PARAM="quietOnNotFound=" */
public static final String QUIET_ON_NOT_FOUND_PARAM = "quietOnNotFound="; 
    
    /** Constant DEFAULT_QUIET_ON_NOT_FOUND=true */
    public static final boolean DEFAULT_QUIET_ON_NOT_FOUND = true; 

    /**
     * Search for a stylename in global and in all workspaces.
     *
     * @param reader a {@link it.geosolutions.geoserver.rest.GeoServerRESTReader} object.
     * @param stylename a {@link java.lang.String} object.
     * @return a {@link java.util.List} object.
     */
    public static List searchStyles(GeoServerRESTReader reader, String stylename) {

        List styles = new ArrayList();

        RESTStyle style = reader.getStyle(stylename);

        // We don't want geoserver to be lenient here: take only the real global style if it exists
        if(style != null) {
            if(style.getWorkspace() == null || style.getWorkspace().isEmpty()) {
                styles.add(style);
            }
        }

        for (String workspace : reader.getWorkspaceNames()) {
            style = reader.getStyle(workspace, stylename);
            if(style != null)
                styles.add(style);
        }

        return styles;
    }
    
    /**
     * Append the quietOnNotFound parameter to the input URL
     *
     * @param quietOnNotFound parameter
     * @param url input url
     * @return a composed url with the parameter appended
     */
    public static String appendQuietOnNotFound(boolean quietOnNotFound, String url) {
        boolean contains = url.contains("?");
        String composed = url + (contains ? "&":"?") + QUIET_ON_NOT_FOUND_PARAM + quietOnNotFound;
        return composed;
    }

    /**
     * safeList
     *
     * @param list a {@link java.util.List} object.
     * @param  a T object.
     * @return a {@link java.util.List} object.
     */
    public static  List safeList(List list) {
        return list == null ? Collections.EMPTY_LIST : list;
    }

    /**
     * safeCollection
     *
     * @param collection a {@link java.util.Collection} object.
     * @param  a T object.
     * @return a {@link java.util.Collection} object.
     */
    public static  Collection safeCollection(Collection collection) {
        return collection == null ? Collections.EMPTY_SET : collection;
    }

    /**
     * safeMap
     *
     * @param map a {@link java.util.Map} object.
     * @param  a TK object.
     * @param  a TV object.
     * @return a {@link java.util.Map} object.
     */
    public static  Map safeMap(Map map) {
        return map == null ? Collections.EMPTY_MAP : map;
    }

    /**
     * getParameterSeparator
     *
     * @param url a {@link java.lang.String} object.
     * @return a char.
     */
    public static char getParameterSeparator(String url) {
        char parameterSeparator = '?';
        if (url.contains("?")) {
            parameterSeparator = '&';
        }
        return parameterSeparator;
    }

    /**
     * getParameterSeparator
     *
     * @param url a {@link java.lang.StringBuilder} object.
     * @return a char.
     */
    public static char getParameterSeparator(StringBuilder url) {
        char parameterSeparator = '?';
        if (url.indexOf("?") != -1) {
            parameterSeparator = '&';
        }
        return parameterSeparator;
    }

    /**
     * appendParameter
     *
     * @param url a {@link java.lang.StringBuilder} object.
     * @param parameterName a {@link java.lang.String} object.
     * @param parameterValue a {@link java.lang.String} object.
     * @return a boolean.
     */
    public static boolean appendParameter(StringBuilder url, String parameterName,
            String parameterValue) {
        boolean result = false;
        if (parameterName != null && !parameterName.isEmpty()
                && parameterValue != null && !parameterValue.isEmpty()) {
            char parameterSeparator = getParameterSeparator(url);
            url.append(parameterSeparator).append(parameterName.trim())
                    .append('=').append(parameterValue.trim());
        }
        return result;
    }
}