001/*
002Copyright 2022 The OpenFunction Authors.
003
004Licensed under the Apache License, Version 2.0 (the "License");
005you may not use this file except in compliance with the License.
006You may obtain a copy of the License at
007
008    http://www.apache.org/licenses/LICENSE-2.0
009
010Unless required by applicable law or agreed to in writing, software
011distributed under the License is distributed on an "AS IS" BASIS,
012WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013See the License for the specific language governing permissions and
014limitations under the License.
015*/
016
017package dev.openfunction.functions;
018
019public interface HttpFunction {
020    /**
021     * Called to service an incoming HTTP request. This interface is implemented by user code to
022     * provide the action for a given function. If the method throws any exception (including any
023     * {@link Error}) then the HTTP response will have a 500 status code.
024     *
025     * @param request  a representation of the incoming HTTP request.
026     * @param response an object that can be used to provide the corresponding HTTP response.
027     * @throws Exception if thrown, the HTTP response will have a 500 status code.
028     */
029    void service(HttpRequest request, HttpResponse response) throws Exception;
030}