View Javadoc
1   /*
2    * Copyright 2014 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    *   http://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.netty.handler.ssl;
17  
18  import javax.net.ssl.SSLEngine;
19  import java.util.List;
20  import java.util.Set;
21  
22  /**
23   * Provides a means to filter the supplied cipher suite based upon the supported and default cipher suites.
24   */
25  public interface CipherSuiteFilter {
26      /**
27       * Filter the requested {@code ciphers} based upon other cipher characteristics.
28       * @param ciphers The requested ciphers
29       * @param defaultCiphers The default recommended ciphers for the current {@link SSLEngine} as determined by Netty
30       * @param supportedCiphers The supported ciphers for the current {@link SSLEngine}
31       * @return The filter list of ciphers. Must not return {@code null}.
32       */
33      String[] filterCipherSuites(Iterable<String> ciphers, List<String> defaultCiphers, Set<String> supportedCiphers);
34  }