org.eclipse.milo.opcua.stack.server.transport

Class RateLimitingHandler

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

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

org.eclipse.milo.opcua.stack.server.transport.RateLimitingHandler

All Implemented Interfaces:

io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler

@ChannelHandler.Sharable
public class RateLimitingHandler
extends io.netty.handler.ipfilter.AbstractRemoteAddressFilter<InetSocketAddress>

A shared, stack-wide, one-per-application-regardless-of-how-many-server-instances-you-have handler that is added to the beginning of every server pipeline to handle rate limiting and connection limits.

Any configuration changes must be made before UaStackServer.startup() is called for the first time, application-wide. Once the instance has been created further configuration changes will have no effect.

Nested Class Summary

Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler

io.netty.channel.ChannelHandler.Sharable

Field Summary

Fields

Modifier and Type	Field and Description
static AtomicLong	CUMULATIVE_CONNECTIONS_REJECTED Cumulative count of all connection rejections for the lifetime of the server.

Method Summary

Modifier and Type	Method and Description
protected boolean	accept(io.netty.channel.ChannelHandlerContext ctx, InetSocketAddress isa)
protected void	channelAccepted(io.netty.channel.ChannelHandlerContext ctx, InetSocketAddress remoteAddress)
static RateLimitingHandler	getInstance() Get the shared RateLimitingHandler instance.

Methods inherited from class io.netty.handler.ipfilter.AbstractRemoteAddressFilter

channelActive, channelRegistered, channelRejected

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

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

Methods inherited from class 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 io.netty.channel.ChannelHandler

handlerAdded, handlerRemoved

Field Detail

CUMULATIVE_CONNECTIONS_REJECTED

public static final AtomicLong CUMULATIVE_CONNECTIONS_REJECTED

Cumulative count of all connection rejections for the lifetime of the server.

Method Detail

getInstance

public static RateLimitingHandler getInstance()

Get the shared RateLimitingHandler instance.

The values of Stack.ConnectionLimits#RATE_LIMIT_ENABLED, Stack.ConnectionLimits#RATE_LIMIT_MAX_ATTEMPTS, Stack.ConnectionLimits#RATE_LIMIT_WINDOW_MS, Stack.ConnectionLimits#RATE_LIMIT_MAX_CONNECTIONS, and Stack.ConnectionLimits#RATE_LIMIT_MAX_CONNECTIONS_PER_ADDRESS will be locked in whenever the first invocation of this method occurs.

Returns:

the shared RateLimitingHandler instance.

accept

protected boolean accept(io.netty.channel.ChannelHandlerContext ctx,
                         InetSocketAddress isa)

Specified by:

accept in class io.netty.handler.ipfilter.AbstractRemoteAddressFilter<InetSocketAddress>

channelAccepted

protected void channelAccepted(io.netty.channel.ChannelHandlerContext ctx,
                               InetSocketAddress remoteAddress)

Overrides:

channelAccepted in class io.netty.handler.ipfilter.AbstractRemoteAddressFilter<InetSocketAddress>