Package: RequestProcessor

RequestProcessor

Coverage

1: /*
2: * #%L
3: * *********************************************************************************************************************
4: *
5: * NorthernWind - lightweight CMS
6: * http://northernwind.tidalwave.it - git clone https://bitbucket.org/tidalwave/northernwind-src.git
7: * %%
8: * Copyright (C) 2011 - 2023 Tidalwave s.a.s. (http://tidalwave.it)
9: * %%
10: * *********************************************************************************************************************
11: *
12: * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
13: * the License. You may obtain a copy of the License at
14: *
15: * http://www.apache.org/licenses/LICENSE-2.0
16: *
17: * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
18: * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
19: * specific language governing permissions and limitations under the License.
20: *
21: * *********************************************************************************************************************
22: *
23: *
24: * *********************************************************************************************************************
25: * #L%
26: */
27: package it.tidalwave.northernwind.core.model;
28:
29: import javax.annotation.Nonnull;
30: import java.io.IOException;
31: import it.tidalwave.util.NotFoundException;
32:
33: /***********************************************************************************************************************
34: *
35: * Processing of a request also involves running through a pipeline of processors, each one implementing this interface.
36: * Each processor can be just another stage of the pipeline or be the final processor, in function of the result of
37: * its invocation.
38: *
39: * @author Fabrizio Giudici
40: *
41: **********************************************************************************************************************/
42: @FunctionalInterface
43: public interface RequestProcessor
44: {
45: public enum Status
46: {
47: CONTINUE, BREAK
48: }
49:
50: /*******************************************************************************************************************
51: *
52: * Try to process the current request.
53: *
54: * @param request the request
55: * @return {@code CONTINUE} if the next processor should be called, {@code BREAK} if this was the final processor
56: * of this request
57: *
58: ******************************************************************************************************************/
59: @Nonnull
60: public Status process (@Nonnull Request request)
61: throws NotFoundException, IOException, HttpStatusException;
62: }