1 /*
2  * JBoss, Home of Professional Open Source.
3  * Copyright 2014 Red Hat, Inc., and individual contributors
4  * as indicated by the @author tags.
5  *
6  * Licensed under the Apache License, Version 2.0 (the "License");
7  * you may not use this file except in compliance with the License.
8  * You may obtain a copy of the License at
9  *
10  *     http://www.apache.org/licenses/LICENSE-2.0
11  *
12  *  Unless required by applicable law or agreed to in writing, software
13  *  distributed under the License is distributed on an "AS IS" BASIS,
14  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15  *  See the License for the specific language governing permissions and
16  *  limitations under the License.
17  */
18
19 package io.undertow.server;
20
21 import io.undertow.util.ConduitFactory;
22 import org.xnio.conduits.Conduit;
23
24 /**
25  * Interface that provides a means of wrapping a {@link Conduit}.  Every conduit wrapper has a chance
26  * to replace the conduit with a conduit which either wraps or replaces the passed in conduit.  However it is the responsibility
27  * of either the conduit wrapper instance or the conduit it creates to ensure that the original conduit is eventually
28  * cleaned up and shut down properly when the request is terminated.
29  *
30  * @author Stuart Douglas
31  */
32 public interface ConduitWrapper<T extends Conduit> {
33
34     /**
35      * Wrap the conduit.  The wrapper should not return {@code null}.  If no wrapping is desired, the original
36      * conduit should be returned.
37      *
38      * @param factory the original conduit
39      * @param exchange the in-flight HTTP exchange
40      * @return the replacement conduit
41      */
42     T wrap(final ConduitFactory<T> factory, final HttpServerExchange exchange);
43 }
44