io.netty.handler.ipfilter

类 AbstractRemoteAddressFilter<T extends java.net.SocketAddress>

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.handler.ipfilter.AbstractRemoteAddressFilter<T>

所有已实现的接口:

ChannelHandler, ChannelInboundHandler

直接已知子类:

RuleBasedIpFilter, UniqueIpFilter

public abstract class AbstractRemoteAddressFilter<T extends java.net.SocketAddress>
extends ChannelInboundHandlerAdapter

This class provides the functionality to either accept or reject new Channels based on their IP address.

You should inherit from this class if you would like to implement your own IP-based filter. Basically you have to implement accept(ChannelHandlerContext, SocketAddress) to decided whether you want to accept or reject a connection from the remote address.

Furthermore overriding channelRejected(ChannelHandlerContext, SocketAddress) gives you the flexibility to respond to rejected (denied) connections. If you do not want to send a response, just have it return null. Take a look at RuleBasedIpFilter for details.

嵌套类概要

从接口继承的嵌套类/接口 io.netty.channel.ChannelHandler

ChannelHandler.Sharable

构造器概要

构造器

构造器和说明
AbstractRemoteAddressFilter()

方法概要

方法

限定符和类型	方法和说明
protected abstract boolean	accept(ChannelHandlerContext ctx, T remoteAddress) This method is called immediately after a Channel gets registered.
protected void	channelAccepted(ChannelHandlerContext ctx, T remoteAddress) This method is called if remoteAddress gets accepted by accept(ChannelHandlerContext, SocketAddress).
void	channelActive(ChannelHandlerContext ctx) Calls ChannelHandlerContext.fireChannelActive() to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	channelRegistered(ChannelHandlerContext ctx) Calls ChannelHandlerContext.fireChannelRegistered() to forward to the next ChannelInboundHandler in the ChannelPipeline.
protected ChannelFuture	channelRejected(ChannelHandlerContext ctx, T remoteAddress) This method is called if remoteAddress gets rejected by accept(ChannelHandlerContext, SocketAddress).

从类继承的方法 io.netty.channel.ChannelInboundHandlerAdapter

channelInactive, channelRead, channelReadComplete, channelUnregistered, channelWritabilityChanged, exceptionCaught, userEventTriggered

从类继承的方法 io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, handlerAdded, handlerRemoved, isSharable

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 io.netty.channel.ChannelHandler

handlerAdded, handlerRemoved

构造器详细资料

AbstractRemoteAddressFilter

public AbstractRemoteAddressFilter()

方法详细资料

channelRegistered

public void channelRegistered(ChannelHandlerContext ctx)
                       throws java.lang.Exception

从类复制的说明: ChannelInboundHandlerAdapter

Calls ChannelHandlerContext.fireChannelRegistered() to forward to the next ChannelInboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

指定者:

channelRegistered 在接口中 ChannelInboundHandler

覆盖:

channelRegistered 在类中 ChannelInboundHandlerAdapter

抛出:

java.lang.Exception

channelActive

public void channelActive(ChannelHandlerContext ctx)
                   throws java.lang.Exception

从类复制的说明: ChannelInboundHandlerAdapter

Calls ChannelHandlerContext.fireChannelActive() to forward to the next ChannelInboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

指定者:

channelActive 在接口中 ChannelInboundHandler

覆盖:

channelActive 在类中 ChannelInboundHandlerAdapter

抛出:

java.lang.Exception

accept

protected abstract boolean accept(ChannelHandlerContext ctx,
             T remoteAddress)
                           throws java.lang.Exception

This method is called immediately after a Channel gets registered.

返回:

Return true if connections from this IP address and port should be accepted. False otherwise.

抛出:

java.lang.Exception

channelAccepted

protected void channelAccepted(ChannelHandlerContext ctx,
                   T remoteAddress)

This method is called if remoteAddress gets accepted by accept(ChannelHandlerContext, SocketAddress). You should override it if you would like to handle (e.g. respond to) accepted addresses.

channelRejected

protected ChannelFuture channelRejected(ChannelHandlerContext ctx,
                            T remoteAddress)

This method is called if remoteAddress gets rejected by accept(ChannelHandlerContext, SocketAddress). You should override it if you would like to handle (e.g. respond to) rejected addresses.

返回:

A ChannelFuture if you perform I/O operations, so that the Channel can be closed once it completes. Null otherwise.