org.eclipse.dirigible.components.api.http.HttpUploadFacade Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2023 SAP SE or an SAP affiliate company and Eclipse Dirigible contributors
 *
 * All rights reserved. This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v2.0 which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v20.html
 *
 * SPDX-FileCopyrightText: 2023 SAP SE or an SAP affiliate company and Eclipse Dirigible
 * contributors SPDX-License-Identifier: EPL-2.0
 */
package org.eclipse.dirigible.components.api.http;

import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import org.apache.commons.fileupload2.core.DiskFileItemFactory;
import org.apache.commons.fileupload2.core.FileItem;
import org.apache.commons.fileupload2.core.FileUploadException;
import org.apache.commons.fileupload2.jakarta.JakartaServletFileUpload;
import org.eclipse.dirigible.commons.api.context.InvalidStateException;
import org.springframework.stereotype.Component;
import jakarta.servlet.http.HttpServletRequest;

/**
 * Java facade for working uploading files.
 */
@Component
public class HttpUploadFacade {

    /** The Constant NO_VALID_REQUEST. */
    private static final String NO_VALID_REQUEST = "Trying to use HTTP Upload Facade without a valid Request";


    /**
     * Checks if the request contains multipart content.
     *
     * @return true, if the request contains is multipart content
     */
    public static final boolean isMultipartContent() {

        HttpServletRequest request = HttpRequestFacade.getRequest();
        if (request == null) {
            return false;
        }

        return JakartaServletFileUpload.isMultipartContent(request);
    }

    /**
     * Parses the request.
     *
     * @return A list of FileItem instances parsed from the request, in the order that they were
     *         transmitted.
     * @throws FileUploadException if there is a problem parsing the request
     */
    public static final List parseRequest() throws FileUploadException {
        DiskFileItemFactory diskFileItemFactory = DiskFileItemFactory.builder()
                                                                     .get();
        JakartaServletFileUpload JakartaServletFileUpload = new JakartaServletFileUpload(diskFileItemFactory);
        HttpServletRequest request = HttpRequestFacade.getRequest();
        if (request == null) {
            throw new InvalidStateException(NO_VALID_REQUEST);
        }
        return JakartaServletFileUpload.parseRequest(request);
    }

    /**
     * Converts header names iterator object to list object.
     *
     * @param headerNames header names iterator
     * @return A list of String elements which represent the name of the multipart request headers.
     */
    public static final List headerNamesToList(Iterator headerNames) {
        List headerNamesList = new ArrayList();
        while (headerNames.hasNext()) {
            headerNamesList.add(headerNames.next());
        }
        return headerNamesList;
    }

}