EsriTestBase.java

/**
 * Copyright (C) 2012 52°North Initiative for Geospatial Open Source Software GmbH
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.n52.sos.it;

import java.io.File;
import java.io.IOException;
import java.util.Map;
import java.util.logging.Logger;

import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.n52.sos.db.impl.AccessGDBImpl;
import org.n52.sos.handler.OGCOperationRequestHandler;
import org.n52.util.CommonUtilities;

import com.esri.arcgis.interop.AutomationException;
import com.esri.arcgis.server.json.JSONObject;
import com.esri.arcgis.system.AoInitialize;
import com.esri.arcgis.system.EngineInitializer;
import com.esri.arcgis.system.esriLicenseProductCode;
import com.esri.arcgis.system.esriLicenseStatus;

/**
 * @author <a href="mailto:broering@52north.org">Arne Broering</a>
 */
public class EsriTestBase {

    private static Logger LOGGER = Logger.getLogger(EsriTestBase.class.getName());
    
    protected AoInitialize aoInit;
    
    protected AccessGDBImpl gdb;
    
    /**
     * @throws java.lang.Exception
     */
    @Before
    public void setUp() throws Exception
    {
        // Initialize engine console application
        EngineInitializer.initializeEngine();

        // Initialize ArcGIS license
        aoInit = new AoInitialize();
        initializeArcGISLicenses();
        
        gdb = new AccessGDBImpl();
    }
    
    @After
    public void tearDown() throws Exception
    {
        // Ensure any ESRI libraries are unloaded in the correct order
        aoInit.shutdown();
    }
    
    /**
     * Checks to see if an ArcGIS Engine Runtime license or an ArcView License
     * is available. If so, then the appropriate ArcGIS License is initialized.
     * 
     * @throws IOException
     * @throws AutomationException
     */
    private void initializeArcGISLicenses() throws AutomationException, IOException
    {
        LOGGER.info("Initializing ArcGIS licenses...");

        if (aoInit.isProductCodeAvailable(esriLicenseProductCode.esriLicenseProductCodeEngine) == esriLicenseStatus.esriLicenseAvailable){
            aoInit.initialize(esriLicenseProductCode.esriLicenseProductCodeEngine);
            LOGGER.info("Using ArcEngine license.");
        }
        else if (aoInit.isProductCodeAvailable(esriLicenseProductCode.esriLicenseProductCodeArcServer) == esriLicenseStatus.esriLicenseAvailable){
            aoInit.initialize(esriLicenseProductCode.esriLicenseProductCodeArcServer);
            LOGGER.info("Using ArcServer license.");
        }
        else if (aoInit.isProductCodeAvailable(esriLicenseProductCode.esriLicenseProductCodeAdvanced) == esriLicenseStatus.esriLicenseAvailable){
            aoInit.initialize(esriLicenseProductCode.esriLicenseProductCodeAdvanced);
            LOGGER.info("Using Advanced license.");
        }
        else if (aoInit.isProductCodeAvailable(esriLicenseProductCode.esriLicenseProductCodeStandard) == esriLicenseStatus.esriLicenseAvailable){
            aoInit.initialize(esriLicenseProductCode.esriLicenseProductCodeStandard);
            LOGGER.info("Using Standard license.");
        }
        else if (aoInit.isProductCodeAvailable(esriLicenseProductCode.esriLicenseProductCodeBasic) == esriLicenseStatus.esriLicenseAvailable){
            aoInit.initialize(esriLicenseProductCode.esriLicenseProductCodeBasic);
            LOGGER.info("Using Basic license.");
        }
        else {
            // System.exit(-1);
            throw new IOException("Could not initialize a license. Exiting application.");
        }
    }
    
    protected void fail() {
    	Assert.fail();
	}
    
    /**
     * Helper method used by the subclasses to execute an OGC operation.
     */
    public void executeOGCOperation(OGCOperationRequestHandler opHandler, Map<String, String> kvp, File outputFile)
    {
        JSONObject inputObject = new JSONObject();
        String[] responseProperties = new String[1];
        
        // read key value pairs and put into JSONObject
        for (String key : kvp.keySet()) {
        	inputObject = inputObject.put(key, kvp.get(key));
        }
        
        // now try executing:
        try {
            String result = new String(opHandler.invokeOGCOperation(gdb, inputObject, responseProperties));
            
            //LOGGER.info(result);
            
            CommonUtilities.saveFile(outputFile, result);
            
        } catch (Exception e) {
        	LOGGER.severe(e.getLocalizedMessage());
        	e.printStackTrace();
            fail();
        }
    }
}