org.apache.flink.runtime.filters

Class AbstractRemoteAddressFilter<T extends SocketAddress>

java.lang.Object

org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandlerAdapter

org.apache.flink.shaded.netty4.io.netty.channel.ChannelInboundHandlerAdapter

org.apache.flink.runtime.filters.AbstractRemoteAddressFilter<T>

All Implemented Interfaces:

org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandler, org.apache.flink.shaded.netty4.io.netty.channel.ChannelInboundHandler

Direct Known Subclasses:

AcceptRuleBasedIpFilter

public abstract class AbstractRemoteAddressFilter<T extends SocketAddress>
extends org.apache.flink.shaded.netty4.io.netty.channel.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.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandler

org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandler.Sharable

Constructor Summary

Constructors

Constructor and Description
AbstractRemoteAddressFilter()

Method Summary

Modifier and Type	Method and Description
protected abstract boolean	accept(org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandlerContext ctx, T remoteAddress) This method is called immediately after a io.netty.channel.Channel gets registered.
protected void	channelAccepted(org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandlerContext ctx, T remoteAddress) This method is called if remoteAddress gets accepted by accept(ChannelHandlerContext, SocketAddress).
void	channelActive(org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandlerContext ctx)
void	channelRegistered(org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandlerContext ctx)
protected org.apache.flink.shaded.netty4.io.netty.channel.ChannelFuture	channelRejected(org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandlerContext ctx, T remoteAddress) This method is called if remoteAddress gets rejected by accept(ChannelHandlerContext, SocketAddress).

Methods inherited from class org.apache.flink.shaded.netty4.io.netty.channel.ChannelInboundHandlerAdapter

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

Methods inherited from class org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, handlerAdded, handlerRemoved, isSharable

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandler

handlerAdded, handlerRemoved

Constructor Detail

AbstractRemoteAddressFilter

public AbstractRemoteAddressFilter()

Method Detail

channelRegistered

public void channelRegistered(org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandlerContext ctx)
                       throws Exception

Specified by:

channelRegistered in interface org.apache.flink.shaded.netty4.io.netty.channel.ChannelInboundHandler

Overrides:

channelRegistered in class org.apache.flink.shaded.netty4.io.netty.channel.ChannelInboundHandlerAdapter

Throws:

Exception

channelActive

public void channelActive(org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandlerContext ctx)
                   throws Exception

Specified by:

channelActive in interface org.apache.flink.shaded.netty4.io.netty.channel.ChannelInboundHandler

Overrides:

channelActive in class org.apache.flink.shaded.netty4.io.netty.channel.ChannelInboundHandlerAdapter

Throws:

Exception

accept

protected abstract boolean accept(org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandlerContext ctx,
                                  T remoteAddress)
                           throws Exception

This method is called immediately after a io.netty.channel.Channel gets registered.

Returns:

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

Throws:

Exception

channelAccepted

protected void channelAccepted(org.apache.flink.shaded.netty4.io.netty.channel.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 org.apache.flink.shaded.netty4.io.netty.channel.ChannelFuture channelRejected(org.apache.flink.shaded.netty4.io.netty.channel.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.

Returns:

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