org.restheart.plugins.PluginsRegistry Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of restheart-commons Show documentation
RESTHeart Commons - Common classes for core components and plugins.
There is a newer version: 8.1.7
/*-
 * ========================LICENSE_START=================================
 * restheart-commons
 * %%
 * Copyright (C) 2019 - 2024 SoftInstigate
 * %%
 * 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.
 * =========================LICENSE_END==================================
 */
package org.restheart.plugins;

import java.util.List;
import java.util.Set;

import org.restheart.configuration.ConfigurationException;
import org.restheart.exchange.PipelineInfo;
import org.restheart.exchange.ServiceRequest;
import org.restheart.exchange.ServiceResponse;
import org.restheart.handlers.PipelinedHandler;
import org.restheart.plugins.RegisterPlugin.MATCH_POLICY;
import org.restheart.plugins.security.AuthMechanism;
import org.restheart.plugins.security.Authenticator;
import org.restheart.plugins.security.Authorizer;
import org.restheart.plugins.security.TokenManager;
import org.restheart.security.BaseAclPermissionTransformer;

import io.undertow.server.handlers.PathHandler;

/**
 *
 * @author Andrea Di Cesare {@literal }
 */
public interface PluginsRegistry {
    /**
     * @return the authMechanisms
     */
    public Set> getAuthMechanisms();

    /**
     * @return the authenticators
     */
    public Set> getAuthenticators();

    /**
     *
     * @param name the name of the authenticator
     * @return the authenticator
     * @throws org.restheart.configuration.ConfigurationException
     */
    public PluginRecord getAuthenticator(String name) throws ConfigurationException;

    /**
     * @return the authenticators
     */
    public PluginRecord getTokenManager();

    /**
     * @return the authenticators
     */
    public Set> getAuthorizers();

    /**
     * @return the permission transformers
     */
    public Set getPermissionTransformers();

    /**
     * @return the initializers
     */
    public Set> getInitializers();

    /**
     * @return the providers
     */
    public Set>> getProviders();

    /**
     * @param i
     */
    public void addInterceptor(PluginRecord> i);

    /**
     * @param filter
     * @return remove all interceptors that match the filter predicate
     */
    public boolean removeInterceptorIf(java.util.function.Predicate>> filter);

    /**
     * @return the services
     */
    public Set>> getServices();

    public Set>> getInterceptors();

    /**
     * @return the interceptors of the service srv
     * @param srv
     * @param interceptPoint
     *
     */
    public List> getServiceInterceptors(Service srv, InterceptPoint interceptPoint);

    /**
     * @return the interceptors of the proxy
     * @param interceptPoint
     *
     */
    public List> getProxyInterceptors(InterceptPoint interceptPoint);

    /**
     * Gets the RESTHeart root handler
     *
     * Avoid adding handlers using PathHandler.addPrefixPath() or
     * PathHandler.addExactPath(). Instead use PluginsRegistry.plug() which sets
     * also the correct PipelineInfo
     *
     * @return the RESTHeart root handler
     */
    public PathHandler getRootPathHandler();

    /**
     * Plugs a pipeline into the root handler binding it to the path; also sets its
     * PipelineInfo.
     *
     * @param path    If the request contains this path, run the pipeline
     * @param handler The handler which is activated upon match
     * @param info    The PipelineInfo describing the handling pipeline
     */
    public void plugPipeline(String path, PipelinedHandler handler, PipelineInfo info);

    /**
     * unplugs an handler from the root handler
     *
     * @param uri
     * @param mp
     */
    public void unplug(String uri, MATCH_POLICY mp);

    /**
     * Plugs a service into the root handler binding it to the path
     *
     * @param srv       The service to plug
     * @param uri       The URI to bind the service to
     * @param mp        The match policy, either exact or prefix
     * @param secured   true to invoke the service only after authentication and authorization succeed
     */
    public void plugService(PluginRecord, ? extends ServiceResponse>> srv, final String uri, MATCH_POLICY mp, boolean secured);

    /**
     * @param path
     * @return the PipelineInfo of the pipeline handling the request
     */
    public PipelineInfo getPipelineInfo(String path);

}