fiftyone.pipeline.web.services.FlowDataProviderCore Maven / Gradle / Ivy

Go to download
/* *********************************************************************
 * This Original Work is copyright of 51 Degrees Mobile Experts Limited.
 * Copyright 2023 51 Degrees Mobile Experts Limited, Davidson House,
 * Forbury Square, Reading, Berkshire, United Kingdom RG1 3EU.
 *
 * This Original Work is licensed under the European Union Public Licence
 * (EUPL) v.1.2 and is subject to its terms as set out below.
 *
 * If a copy of the EUPL was not distributed with this file, You can obtain
 * one at https://opensource.org/licenses/EUPL-1.2.
 *
 * The 'Compatible Licences' set out in the Appendix to the EUPL (as may be
 * amended by the European Commission) shall be deemed incompatible for
 * the purposes of the Work and the provisions of the compatibility
 * clause in Article 5 of the EUPL shall not apply.
 *
 * If using the Work as, or as part of, a network application, by
 * including the attribution notice(s) required under Article 5 of the EUPL
 * in the end user terms of the application under an appropriate heading,
 * such notice(s) shall fulfill the requirements of that article.
 * ********************************************************************* */

package fiftyone.pipeline.web.services;

import fiftyone.pipeline.core.data.FlowData;

import javax.servlet.http.HttpServletRequest;

import static fiftyone.pipeline.web.Constants.HTTPCONTEXT_FLOWDATA;

/**
 * Provider to be injected into controllers to get the pre-processed
 * {@link FlowData} for the request being serviced.
 */
public interface FlowDataProviderCore {

    /**
     * Get the {@link FlowData} associated with the HTTP request.
     * @param request the {@link HttpServletRequest} to get the {@link FlowData}
     *                from
     * @return a {@link FlowData} object containing the data values that have
     * been populated by the configured Pipeline
     */
    FlowData getFlowData(HttpServletRequest request);

    /**
     * Default implementation of the {@link FlowDataProviderCore} service.
     */
    class Default implements FlowDataProviderCore {

        @Override
        public FlowData getFlowData(HttpServletRequest request) {
            return (FlowData) request.getAttribute(HTTPCONTEXT_FLOWDATA);
        }
    }
}