io.uhndata.cards.vocabularies.internal.VocabularyZipLoader Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of cards-vocabularies Show documentation
There is a newer version: 0.9.25
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 io.uhndata.cards.vocabularies.internal;

import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.util.zip.ZipInputStream;

import org.apache.commons.io.FileUtils;
import org.apache.http.client.ClientProtocolException;
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClientBuilder;

import io.uhndata.cards.vocabularies.spi.VocabularyIndexException;

/**
 * Utility class to load zip files.
 *
 * @version $Id: 82b5c25a264d2cb763a2c9b64d408e3feb044e02 $
 */
public class VocabularyZipLoader
{
    /**
     * Loads zip file from a url into a temporary zip file by making a http GET request.
     *
     * @param path url of the zip file
     * @param temporaryFile file object representing the temporary file to be created from the response information
     * @throws VocabularyIndexException thrown upon failure of zip file to load
     */
    public void loadZipHttp(String path, File temporaryFile)
        throws VocabularyIndexException
    {
        // GET request
        HttpGet httpget = new HttpGet(path);
        httpget.setHeader("Content-Type", "application/json");

        try (CloseableHttpClient httpclient = HttpClientBuilder.create().build();
            CloseableHttpResponse httpresponse = httpclient.execute(httpget)) {

            if (httpresponse.getStatusLine().getStatusCode() < 400) {
                // If the http request is successful

                // Write all of the contents of the request to the OutputStream
                ZipInputStream input = new ZipInputStream(httpresponse.getEntity().getContent());
                input.getNextEntry();
                FileUtils.copyInputStreamToFile(input, temporaryFile);

                input.close();
            } else {
                // If http request is not successful, close the client and response and throw an exception
                String message = "Failed to load zip: " + httpresponse.getStatusLine().getStatusCode() + " http error";
                throw new VocabularyIndexException(message);
            }
        } catch (ClientProtocolException e) {
            String message = "Failed to load zip: " + e.getMessage();
            throw new VocabularyIndexException(message, e);
        } catch (IOException e) {
            String message = "Failed to load zip: " + e.getMessage();
            throw new VocabularyIndexException(message, e);
        }
    }

    /**
     * Loads a local zip file to a temporary zip file based on a path relative to the VocabularyZipLoader instance.
     *
     * @param path path of the local file to be accessed relative to the VocabularyZipLoader
     * @param temporaryFile file object representing the temporary file to which the information will be copied
     * @throws VocabularyIndexException thrown upon failure of zip file to load
     */
    public void loadZipLocal(String path, File temporaryFile)
        throws VocabularyIndexException
    {
        try {
            // InputStreams for reading the new file
            FileInputStream fileInputStream = new FileInputStream(path);
            ZipInputStream zipInputStream = new ZipInputStream(fileInputStream);

            // Set InputStream at first zipped file
            zipInputStream.getNextEntry();

            try {
                FileUtils.copyInputStreamToFile(zipInputStream, temporaryFile);
            } finally {
                // Close InputStreams and OutputStreams
                fileInputStream.close();
                zipInputStream.close();
            }
        } catch (IOException e) {
            String message = "Error: Failed to load zip vocabulary locally. " + e.getMessage();
            throw new VocabularyIndexException(message, e);
        }
    }
}