All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.efaps.rest.EFapsResourceConfig Maven / Gradle / Ivy

Go to download

eFaps is a framework used to map objects with or without attached files to a relational database and optional file systems (only for attaches files). Configurable access control can be provided down to object and attribute level depending on implementation and use case. Depending on requirements, events (like triggers) allow to implement business logic and to separate business logic from user interface. The framework includes integrations (e.g. webdav, full text search) and a web application as 'simple' configurable user interface. Some best practises, example web application modules (e.g. team work module) support administrators and implementers using this framework.

There is a newer version: 3.2.0
Show newest version
/*
 * Copyright 2003 - 2012 The eFaps Team
 *
 * 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.
 *
 * Revision:        $Rev: 7740 $
 * Last Changed:    $Date: 2012-07-03 18:40:05 -0500 (Tue, 03 Jul 2012) $
 * Last Changed By: $Author: [email protected] $
 */

package org.efaps.rest;

import java.io.BufferedInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.lang.annotation.Annotation;
import java.util.HashSet;
import java.util.Set;

import javax.ws.rs.Path;
import javax.ws.rs.ext.Provider;

import org.efaps.admin.program.esjp.EFapsClassLoader;
import org.efaps.ci.CIAdminProgram;
import org.efaps.db.Checkout;
import org.efaps.db.InstanceQuery;
import org.efaps.db.QueryBuilder;
import org.efaps.util.EFapsException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.sun.jersey.api.core.DefaultResourceConfig;
import com.sun.jersey.core.spi.scanning.Scanner;
import com.sun.jersey.core.spi.scanning.ScannerException;
import com.sun.jersey.core.spi.scanning.ScannerListener;
import com.sun.jersey.core.util.Closing;
import com.sun.jersey.spi.container.ReloadListener;
import com.sun.jersey.spi.scanning.AnnotationScannerListener;
import com.sun.jersey.spi.scanning.PathProviderScannerListener;

/**
 * TODO comment!
 *
 * @author The eFaps Team
 * @version $Id: EFapsResourceConfig.java 7740 2012-07-03 23:40:05Z [email protected] $
 */
public class EFapsResourceConfig
    extends DefaultResourceConfig
    implements ReloadListener
{

    /**
     * Logging instance used in this class.
     */
    private static final Logger LOG = LoggerFactory.getLogger(EFapsResourceConfig.class);

    /**
     * Scanner for the class files.
     */
    private final Scanner scanner = new EfapsResourceScanner();

    /**
     * Cached classes.
     */
    private final Set> cachedClasses = new HashSet>();

    /**
     * Constructo.
     */
    public EFapsResourceConfig()
    {
        init();
    }

    /**
     * Initialize and scan for root resource and provider classes using a scanner.
     */
    public void init()
    {
        final AnnotationScannerListener asl = new PathProviderScannerListener(EFapsClassLoader.getInstance());

        this.scanner.scan(asl);

        getClasses().addAll(asl.getAnnotatedClasses());
        getClasses().add(Compile.class);
        getClasses().add(Update.class);
        if (EFapsResourceConfig.LOG.isInfoEnabled() && !getClasses().isEmpty()) {
            final Set> rootResourceClasses = get(Path.class);
            if (rootResourceClasses.isEmpty()) {
                EFapsResourceConfig.LOG.info("No root resource classes found.");
            } else {
                logClasses("Root resource classes found:", rootResourceClasses);
            }

            final Set> providerClasses = get(Provider.class);
            if (providerClasses.isEmpty()) {
                EFapsResourceConfig.LOG.info("No provider classes found.");
            } else {
                logClasses("Provider classes found:", providerClasses);
            }
        }
        this.cachedClasses.clear();
        this.cachedClasses.addAll(getClasses());
    }

    /**
     * Perform a new search for resource classes and provider classes.
     */
    @Override
    public void onReload()
    {
        final Set> classesToRemove = new HashSet>();
        final Set> classesToAdd = new HashSet>();

        for (final Class c : getClasses()) {
            if (!this.cachedClasses.contains(c)) {
                classesToAdd.add(c);
            }
        }

        for (final Class c : this.cachedClasses) {
            if (!getClasses().contains(c)) {
                classesToRemove.add(c);
            }
        }

        getClasses().clear();

        init();

        getClasses().addAll(classesToAdd);
        getClasses().removeAll(classesToRemove);
    }

    /**
     * @param _annoclass    Annotation class
     * @return  set of classes implementing Annotation class
     */
    private Set> get(final Class _annoclass)
    {
        final Set> s = new HashSet>();
        for (final Class c : getClasses()) {
            if (c.isAnnotationPresent(_annoclass)) {
                s.add(c);
            }
        }
        return s;
    }

    /**
     * @param _text     text to log
     * @param _classes  classes to log
     */
    private void logClasses(final String _text,
                            final Set> _classes)
    {
        final StringBuilder b = new StringBuilder();
        b.append(_text);
        for (final Class c : _classes) {
            b.append('\n').append("  ").append(c);
        }
        EFapsResourceConfig.LOG.info(b.toString());
    }

    /**
     * Scanner for esjps.
     */
    public static class EfapsResourceScanner
        implements Scanner
    {

        /**
         * Scan the esjps for annotations.
         * @param _sl   scan listener
         */
        @Override
        public void scan(final ScannerListener _sl)
        {
            try {
                final QueryBuilder queryBldr = new QueryBuilder(CIAdminProgram.JavaClass);
                final InstanceQuery query = queryBldr.getQuery();
                query.executeWithoutAccessCheck();
                while (query.next()) {
                    final Checkout checkout = new Checkout(query.getCurrentValue());
                    final InputStream in = checkout.execute();
                    final String fileName = checkout.getFileName();
                    new Closing(new BufferedInputStream(in)).f(new Closing.Closure()
                    {
                        public void f(final InputStream _in)
                            throws IOException
                        {
                            EFapsResourceConfig.LOG.debug("Scanning '{}' for annotations.", fileName);
                            _sl.onProcess(fileName, _in);
                        }
                    });
                }
            } catch (final IOException e) {
                throw new ScannerException("IO error when scanning file ", e);
            } catch (final EFapsException e) {
                throw new ScannerException("EFapsException when scanning file ", e);
            }
        }
    }
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy