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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pipeline.web Show documentation
The newest version!
/* *********************************************************************
 * 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 fiftyone.pipeline.core.flowelements.Pipeline;

import javax.servlet.http.HttpServletRequest;

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

/**
 * Service used to process web requests through the Pipeline. This handles
 * populating the evidence and processing it. The results of the processing can
 * be retrieved using the {@link FlowDataProviderCore} service.
 */
public interface PipelineResultServiceCore {

    /**
     * Populate the evidence from the request and process through the Pipeline.
     * @param request the {@link HttpServletRequest} to process
     */
    void process(HttpServletRequest request);

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

        /**
         * Service used to populate the evidence from an
         * {@link HttpServletRequest}.
         */
        private final WebRequestEvidenceServiceCore evidenceService;

        /**
         * Pipeline used to process the evidence.
         */
        protected Pipeline pipeline;

        /**
         * Create a new instance.
         * @param evidenceService the service used to populate the evidence from
         *                        an {@link HttpServletRequest}
         * @param pipeline the Pipeline used to process the evidence
         */
        public Default(
            WebRequestEvidenceServiceCore evidenceService,
            Pipeline pipeline) {
            this.evidenceService = evidenceService;
            this.pipeline = pipeline;
        }

        @Override
        public void process(HttpServletRequest request) {
            // Create the flowData
            FlowData flowData = pipeline.createFlowData();
            // Extract the required pieces of evidence from the request
            evidenceService.addEvidenceFromRequest(flowData, request);
            // Start processing the data
            flowData.process();
            // Store the FlowData in the request
            request.setAttribute(HTTPCONTEXT_FLOWDATA, flowData);
        }
    }
}