org.mycore.frontend.jersey.feature.MCRJerseyBaseFeature Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of mycore-base Show documentation
There is a newer version: 2024.05
/*
 * This file is part of ***  M y C o R e  ***
 * See http://www.mycore.de/ for details.
 *
 * MyCoRe is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * MyCoRe is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with MyCoRe.  If not, see .
 */

package org.mycore.frontend.jersey.feature;

import java.lang.reflect.Method;
import java.util.Arrays;
import java.util.List;

import javax.ws.rs.WebApplicationException;
import javax.ws.rs.container.DynamicFeature;
import javax.ws.rs.core.FeatureContext;
import javax.ws.rs.core.Response;

import org.mycore.common.config.MCRConfiguration2;
import org.mycore.frontend.jersey.MCRStaticContent;
import org.mycore.frontend.jersey.filter.access.MCRResourceAccessChecker;
import org.mycore.frontend.jersey.filter.access.MCRResourceAccessCheckerFactory;
import org.mycore.frontend.jersey.filter.access.MCRResourceAccessFilter;
import org.mycore.frontend.jersey.filter.access.MCRRestrictedAccess;

public abstract class MCRJerseyBaseFeature implements DynamicFeature {

    /**
     * Checks if the class/method is annotated by {@link MCRStaticContent}.
     * 
     * @param resourceClass the class to check
     * @param resourceMethod the method to check
     * @return true if one of both is annotated as static
     */
    protected boolean isStaticContent(Class resourceClass, Method resourceMethod) {
        return resourceClass.getAnnotation(MCRStaticContent.class) != null
            || resourceMethod.getAnnotation(MCRStaticContent.class) != null;
    }

    /**
     * Returns a list of packages which will be used to scan for components.
     * 
     * @return a list of java package names
     */
    protected List getPackages() {
        String propertyString = MCRConfiguration2.getString("MCR.Jersey.Resource.Packages")
            .orElse("org.mycore.frontend.jersey.resources");
        return Arrays.asList(propertyString.split(","));
    }

    /**
     * Register a MCRRestrictedAccess filter to the context.
     * 
     * @param context the context to add the restricted access too
     * @param restrictedAccess the restricted access
     */
    protected void addFilter(FeatureContext context, MCRRestrictedAccess restrictedAccess) {
        MCRResourceAccessChecker accessChecker;
        try {
            accessChecker = MCRResourceAccessCheckerFactory.getInstance(restrictedAccess.value());
        } catch (ReflectiveOperationException e) {
            throw new WebApplicationException(e, Response.Status.INTERNAL_SERVER_ERROR);
        }
        context.register(new MCRResourceAccessFilter(accessChecker));
    }
}