View Javadoc
1   /*
2    * Copyright 2019 The Netty Project
3    *
4    * The Netty Project licenses this file to you under the Apache License,
5    * version 2.0 (the "License"); you may not use this file except in compliance
6    * with the License. You may obtain a copy of the License at:
7    *
8    *   https://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12   * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13   * License for the specific language governing permissions and limitations
14   * under the License.
15   */
16  package io.netty5.handler.codec.http.websocketx.extensions;
17  
18  /**
19   * Extension filter provider that is responsible to provide filters for a certain {@link WebSocketExtension} extension.
20   */
21  public interface WebSocketExtensionFilterProvider {
22  
23      WebSocketExtensionFilterProvider DEFAULT = new WebSocketExtensionFilterProvider() {
24          @Override
25          public WebSocketExtensionFilter encoderFilter() {
26              return WebSocketExtensionFilter.NEVER_SKIP;
27          }
28  
29          @Override
30          public WebSocketExtensionFilter decoderFilter() {
31              return WebSocketExtensionFilter.NEVER_SKIP;
32          }
33      };
34  
35      /**
36       * Returns the extension filter for {@link WebSocketExtensionEncoder} encoder.
37       */
38      WebSocketExtensionFilter encoderFilter();
39  
40      /**
41       * Returns the extension filter for {@link WebSocketExtensionDecoder} decoder.
42       */
43      WebSocketExtensionFilter decoderFilter();
44  
45  }