it.geosolutions.geoserver.rest.decoder.RESTDataStore 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.
The newest version!
/*
 *  GeoServer-Manager - Simple Manager Library for GeoServer
 *  
 *  Copyright (C) 2007,2014 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.decoder;

import it.geosolutions.geoserver.rest.decoder.utils.JDOMBuilder;

import java.util.HashMap;
import java.util.List;
import java.util.Map;

import org.jdom.Element;

/**
 * Parse DataStores returned as XML REST objects.
 * 
 * This is the XML document returned by GeoServer when requesting a DataStore:
 * 
 * {@code
 *
 *    sf
 *    true
 *    
 *        sf
 *        
 *    
 *    
 *        http://www.openplans.org/spearfish
 *        file:data/sf
 *    
 *    
 *        
 *    
 *
 * }
 * 
 * Note: the whole XML fragment is stored in memory. At the moment, there are
 * methods to retrieve only the more useful data.
 *
 * @author etj
 * @version $Id: $
 */
public class RESTDataStore {

    private final Element dsElem;

    public enum DBType {

        POSTGIS("postgis"),
        ORACLE("oracle"),
        SHP("shp"),
        UNKNOWN(null);
        private final String restName;

        private DBType(String restName) {
            this.restName = restName;
        }

        public static DBType get(String restName) {
            for (DBType type : values()) {
                if (type == UNKNOWN) {
                    continue;
                }
                if (type.restName.equals(restName)) {
                    return type;
                }
            }
            return UNKNOWN;
        }
    };

    /**
     * build
     *
     * @param xml a {@link java.lang.String} object.
     * @return a {@link it.geosolutions.geoserver.rest.decoder.RESTDataStore} object.
     */
    public static RESTDataStore build(String xml) {
        if (xml == null) {
            return null;
        }

        Element e = JDOMBuilder.buildElement(xml);
        if (e != null) {
            return new RESTDataStore(e);
        } else {
            return null;
        }
    }

    /**
     * Constructor for RESTDataStore.
     *
     * @param dsElem a {@link org.jdom.Element} object.
     */
    protected RESTDataStore(Element dsElem) {
        this.dsElem = dsElem;
    }

    /**
     * getName
     *
     * @return a {@link java.lang.String} object.
     */
    public String getName() {
        return dsElem.getChildText("name");
    }
    
    /**
     * getStoreType
     *
     * @return a {@link java.lang.String} object.
     */
    public String getStoreType() {
    	return dsElem.getChildText("type");
    }
    
    /**
     * getDescription
     *
     * @return a {@link java.lang.String} object.
     */
    public String getDescription() {
        return dsElem.getChildText("description");
    }

    /**
     * isEnabled
     *
     * @return a boolean.
     */
    public boolean isEnabled() {
    	return Boolean.parseBoolean(dsElem.getChildText("enabled"));
    }
    
    /**
     * getWorkspaceName
     *
     * @return a {@link java.lang.String} object.
     */
    public String getWorkspaceName() {
        return dsElem.getChild("workspace").getChildText("name");
    }
    
    /**
     * getConnectionParameters
     *
     * @return a {@link java.util.Map} object.
     */
    public Map getConnectionParameters() {
        Element elConnparm = dsElem.getChild("connectionParameters");
        if (elConnparm != null) {
        	@SuppressWarnings("unchecked")
			List elements = (List)elConnparm.getChildren("entry");
        	Map params = new HashMap(elements.size());
            for (Element element : elements) {
                String key = element.getAttributeValue("key");
                String value = element.getTextTrim();
                params.put(key, value);
            }
            return params;
        }
        return null;
    }

	/**
	 * getConnectionParameter
	 *
	 * @param paramName a {@link java.lang.String} object.
	 * @return a {@link java.lang.String} object.
	 */
	@SuppressWarnings("unchecked")
	protected String getConnectionParameter(String paramName) {
        Element elConnparm = dsElem.getChild("connectionParameters");
        if (elConnparm != null) {
        	for (Element entry : (List) elConnparm.getChildren("entry")) {
                String key = entry.getAttributeValue("key");
                if (paramName.equals(key)) {
                    return entry.getTextTrim();
                }
            }
        }

        return null;
    }
	
    /**
     * getType
     *
     * @return a {@link it.geosolutions.geoserver.rest.decoder.RESTDataStore.DBType} object.
     */
    public DBType getType() {
        return DBType.get(getConnectionParameter("dbtype"));
    }
}