org.carewebframework.smart.ui.SmartLocator.java Source code

Introduction

Here is the source code for org.carewebframework.smart.ui.SmartLocator.java

Source

/**
 * This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.
 * If a copy of the MPL was not distributed with this file, You can obtain one at
 * http://mozilla.org/MPL/2.0/.
 *
 * This Source Code Form is also subject to the terms of the Health-Related Additional
 * Disclaimer of Warranty and Limitation of Liability available at
 * http://www.carewebframework.org/licensing/disclaimer.
 */
package org.carewebframework.smart.ui;

import java.io.IOException;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

import org.carewebframework.common.StrUtil;
import org.carewebframework.shell.plugins.PluginDefinition;
import org.carewebframework.shell.plugins.PluginRegistry;
import org.carewebframework.smart.SmartManifest;

import org.springframework.beans.BeansException;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextAware;
import org.springframework.core.io.Resource;

/**
 * Locates SMART app manifests and registers them as CareWeb plugins. Manifests must end in the
 * extension ".smart" and be a valid JSON-ized manifest format.
 */
public class SmartLocator implements ApplicationContextAware {

    private static final Log log = LogFactory.getLog(SmartLocator.class);

    private static final String SMART_MANIFEST_PATTERN = "*.smart";

    private final PluginRegistry registry;

    public SmartLocator(PluginRegistry registry) {
        super();
        this.registry = registry;
    }

    /**
     * Called by the application context, allowing the enumeration of SMART application manifests in
     * the environment.
     */
    @Override
    public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
        log.info("Searching for SMART app manifests...");
        findSmartManifests(applicationContext, "classpath*:/META-INF/");
        findSmartManifests(applicationContext, "/WEB-INF/");
    }

    /**
     * Search for SMART manifests within the specified path root. Each discovered manifest will
     * result in the creation of a CareWeb plugin definition for the associated SMART app.
     *
     * @param appContext The application context.
     * @param root Root path for search.
     */
    private void findSmartManifests(ApplicationContext appContext, String root) {
        try {
            Resource[] resources = appContext.getResources(root + SMART_MANIFEST_PATTERN);

            for (Resource resource : resources) {
                PluginDefinition def = toDefinition(resource);

                if (def != null) {
                    registry.register(def);
                }
            }
        } catch (IOException e) {
            log.error("Error searching for SMART manifests.", e);
        }

    }

    /**
     * Synthesizes a plugin definition from a SMART manifest resource.
     *
     * @param resource A resource that represents a SMART manifest in JSON format.
     * @return A plugin definition.
     */
    private PluginDefinition toDefinition(Resource resource) {
        try {
            SmartManifest manifest = SmartContainerServices.manifestFromStream(resource.getInputStream());

            if (!"ui".equals(manifest.getValue("mode"))) {
                return null;
            }

            PluginDefinition definition = new PluginDefinition();
            String name = manifest.getValue("name");
            definition.setId(StrUtil.xlate(manifest.getValue("id"), " @", "__"));
            definition.setName(name);
            definition.setUrl(manifest.getValue("index"));
            definition.setClazz(SmartPlugin.class);
            definition.setDescription(manifest.getValue("description"));
            definition.setSource("SMART Platform");
            definition.setCreator(manifest.getValue("author"));
            definition.setVersion(manifest.getValue("version"));
            definition.setIcon(manifest.getValue("icon"));
            definition.setCategory("SMART apps");
            definition.getResources().add(new SmartResource(manifest));
            log.info("Found SMART Manifest for " + name);
            return definition;
        } catch (Exception e) {
            log.error("Error loading SMART manifest: " + resource, e);
        }

        return null;
    }

}