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.ipfilter;
17  
18  import java.net.InetSocketAddress;
19  
20  /**
21   * Implement this interface to create new rules.
22   */
23  public interface IpFilterRule {
24      /**
25       * @return This method should return true if remoteAddress is valid according to your criteria. False otherwise.
26       */
27      boolean matches(InetSocketAddress remoteAddress);
28  
29      /**
30       * @return This method should return {@link IpFilterRuleType#ACCEPT} if all
31       * {@link IpFilterRule#matches(InetSocketAddress)} for which {@link #matches(InetSocketAddress)}
32       * returns true should the accepted. If you want to exclude all of those IP addresses then
33       * {@link IpFilterRuleType#REJECT} should be returned.
34       */
35      IpFilterRuleType ruleType();
36  }