src/main/java/org/apache/flume/http/source/HTTPSourceHandler.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to you 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.
 */
package org.apache.flume.http.source;

import java.util.List;

import org.apache.flume.Event;
import org.apache.flume.conf.Configurable;

import jakarta.servlet.http.HttpServletRequest;

/**
 *
 */
public interface HTTPSourceHandler extends Configurable {

    /**
     * Takes an {@linkplain HttpServletRequest} and returns a list of Flume
     * Events. If this request cannot be parsed into Flume events based on the
     * format this method will throw an exception. This method may also throw an
     * exception if there is some sort of other error. <p>
     *
     * @param request The request to be parsed into Flume events.
     * @return List of Flume events generated from the request.
     * @throws HTTPBadRequestException If the was not parsed correctly into an
     * event because the request was not in the expected format.
     * @throws Exception If there was an unexpected error.
     */
    public List<Event> getEvents(HttpServletRequest request) throws HTTPBadRequestException, Exception;
}