org.mitre.mpf.mvc.util.ModelUtils.java Source code

Introduction

Here is the source code for org.mitre.mpf.mvc.util.ModelUtils.java

Source

/******************************************************************************
 * NOTICE                                                                     *
 *                                                                            *
 * This software (or technical data) was produced for the U.S. Government     *
 * under contract, and is subject to the Rights in Data-General Clause        *
 * 52.227-14, Alt. IV (DEC 2007).                                             *
 *                                                                            *
 * Copyright 2016 The MITRE Corporation. All Rights Reserved.                 *
 ******************************************************************************/

/******************************************************************************
 * Copyright 2016 The MITRE Corporation                                       *
 *                                                                            *
 * 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.mitre.mpf.mvc.util;

import java.io.File;
import java.nio.file.Paths;

import org.apache.commons.lang3.StringUtils;
import org.mitre.mpf.rest.api.InfoModel;
import org.mitre.mpf.rest.api.MarkupResultModel;
import org.mitre.mpf.rest.api.SingleJobInfo;
import org.mitre.mpf.wfm.data.entities.persistent.JobRequest;
import org.mitre.mpf.wfm.data.entities.persistent.MarkupResult;
import org.mitre.mpf.wfm.enums.JobStatus;
import org.mitre.mpf.wfm.util.PropertiesUtil;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.context.annotation.Scope;
import org.springframework.stereotype.Component;

@Component
@Scope("singleton")
public class ModelUtils {

    @Autowired
    @Qualifier(PropertiesUtil.REF)
    private PropertiesUtil propertiesUtil;

    // class variable for lazy initialization
    static InfoModel s_infoModel = null;

    //prevents needing org.mitre.mpf.** types in MarkupResultModel - this allows the api model classes
    //to be used in other projects without added dependencies
    public static MarkupResultModel converMarkupResult(MarkupResult markupResult) {
        boolean isImage = false;
        boolean fileExists = true;
        if (markupResult.getMarkupUri() != null) {
            String nonUrlPath = markupResult.getMarkupUri().replace("file:", "");
            String markupContentType = NIOUtils.getPathContentType(Paths.get(nonUrlPath));
            isImage = (markupContentType != null && StringUtils.startsWithIgnoreCase(markupContentType, "IMAGE"));
            fileExists = new File(nonUrlPath).exists();
        }

        //if the markup uri does not end with 'avi', the file is considered an image
        return new MarkupResultModel(markupResult.getId(), markupResult.getJobId(), markupResult.getPipeline(),
                markupResult.getMarkupUri(), markupResult.getSourceUri(), isImage, fileExists);
    }

    //this method is created for the same reason as converMarkupResult
    public static SingleJobInfo convertJobRequest(JobRequest jobRequest, float jobContainerProgress) {
        //terminal if status is JOB_CREATION_ERROR, COMPLETE, CANCELLED, or ERROR
        JobStatus jobStatus = jobRequest.getStatus();
        boolean isTerminal = (jobStatus != null && jobStatus.isTerminal());

        return new SingleJobInfo(jobRequest.getId(), jobRequest.getPipeline(), jobRequest.getPriority(),
                jobRequest.getStatus().toString(), jobContainerProgress, jobRequest.getTimeReceived(),
                jobRequest.getTimeCompleted(), jobRequest.getOutputObjectPath(), isTerminal);
    }

    // returns an InfoModel
    public InfoModel getInfoModel() {
        if (s_infoModel == null) {
            PropertiesUtil utils = propertiesUtil;
            if (utils != null) {
                s_infoModel = new InfoModel(/*app-family|appFamily*/ "Media Processing Framework",
                        /*app*/ "Workflow Manager", /*version*/ utils.getSemanticVersion(),
                        /*gitHash*/ utils.getGitHash(), /*gitBranch*/ utils.getGitBranch(),
                        /*buildNum*/ utils.getBuildNum());
            } else {
                s_infoModel = new InfoModel(/*app-family|appFamily*/ "Media Processing Framework",
                        /*app*/ "Workflow Manager", /*version*/ "x.x.x", /*gitHash*/ "???", /*gitBranch*/ "???",
                        /*buildNum*/ "0");
            }
        }
        return s_infoModel;
    }
}