org.restheart.plugins.Service 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.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;

import org.restheart.exchange.CORSHeaders;
import org.restheart.exchange.Response;
import org.restheart.exchange.ServiceRequest;
import org.restheart.exchange.ServiceResponse;
import org.restheart.utils.HttpStatus;

import io.undertow.server.HttpServerExchange;

/**
 * Services allow to extend the API adding web services
 *
 * @param  Request the request type
 * @param  Response the response type
 * @see https://restheart.org/docs/plugins/core-plugins/#services
 * @author Andrea Di Cesare {@literal }
 */
public interface Service, S extends ServiceResponse> extends HandlingPlugin, ConfigurablePlugin, CORSHeaders {
        /**
         * handles the request
         *
         * the handling logic can also be provided overriding handle()
         *
         * @param request
         * @param response
         * @throws Exception
         */
        public default void handle(final R request, final S response) throws Exception {
            handle().accept(request, response);
        }

        /**
         * BiConsumer that handles the request
         *
         * Allows to provide the handlig logic with functional style
         *
         * @throws Exception
         * @return the BiConsumer that handles the request
         */
        public default BiConsumer handle() throws Exception {
            return (r,s) -> {
                throw new UnsupportedOperationException("handle function not implemented");
            };
        }

        /**
         *
         * @return the Consumer used to instantiate the request object
         */
        public Consumer requestInitializer();

        /**
         *
         * @return the Consumer used to instantiate the response object
         */
        public Consumer responseInitializer();

        /**
         *
         * @return the Function used to retrieve the request object
         */
        public Function request();

        /**
         *
         * @return the Function used to retrieve the response object
         */
        public Function response();

        /**
         * helper method to handle OPTIONS requests
         *
         * @param request
         * @throws Exception
         */
        default void handleOptions(final R request) {
            var exchange = request.getExchange();
            var response = Response.of(exchange);

            response.getHeaders()
                .put(ACCESS_CONTROL_ALLOW_METHODS, accessControlAllowMethods(request))
                .put(ACCESS_CONTROL_ALLOW_HEADERS, accessControlAllowHeaders(request));

            response.setStatusCode(HttpStatus.SC_OK);
            exchange.endExchange();
        }

        /**
         * helper BiConsumer to handle OPTIONS requests
         *
         * @param request
         * @throws Exception
         */
        default BiConsumer handleOptions() {
            return (r,s) -> handleOptions(r);
        }
}