Package org.apache.mina.filter.firewall

Class BlacklistFilter

java.lang.Object

org.apache.mina.core.filterchain.IoFilterAdapter

org.apache.mina.filter.firewall.BlacklistFilter

All Implemented Interfaces:

IoFilter

public class BlacklistFilter
extends IoFilterAdapter

A IoFilter which blocks connections from blacklisted remote address.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.mina.core.filterchain.IoFilter

IoFilter.NextFilter

Field Summary

Fields

Modifier and Type	Field	Description
private java.util.List<Subnet>	blacklist	The list of blocked addresses
private static org.slf4j.Logger	LOGGER	A logger for this class

Constructor Summary

Constructors

Constructor	Description
BlacklistFilter()

Method Summary

Modifier and Type	Method	Description
void	block(java.net.InetAddress address)	Blocks the specified endpoint.
void	block(Subnet subnet)	Blocks the specified subnet.
private void	blockSession(IoSession session)
void	event(IoFilter.NextFilter nextFilter, IoSession session, FilterEvent event)	Propagate an event up to the IoHandler
private boolean	isBlocked(IoSession session)
void	messageReceived(IoFilter.NextFilter nextFilter, IoSession session, java.lang.Object message)	Filters IoHandler.messageReceived(IoSession,Object) event.
void	messageSent(IoFilter.NextFilter nextFilter, IoSession session, WriteRequest writeRequest)	Filters IoHandler.messageSent(IoSession,Object) event.
void	sessionCreated(IoFilter.NextFilter nextFilter, IoSession session)	Filters IoHandler.sessionCreated(IoSession) event.
void	sessionIdle(IoFilter.NextFilter nextFilter, IoSession session, IdleStatus status)	Filters IoHandler.sessionIdle(IoSession,IdleStatus) event.
void	sessionOpened(IoFilter.NextFilter nextFilter, IoSession session)	Filters IoHandler.sessionOpened(IoSession) event.
void	setBlacklist(java.lang.Iterable<java.net.InetAddress> addresses)	Sets the addresses to be blacklisted.
void	setBlacklist(java.net.InetAddress[] addresses)	Sets the addresses to be blacklisted.
void	setSubnetBlacklist(java.lang.Iterable<Subnet> subnets)	Sets the subnets to be blacklisted.
void	setSubnetBlacklist(Subnet[] subnets)	Sets the subnets to be blacklisted.
void	unblock(java.net.InetAddress address)	Unblocks the specified endpoint.
void	unblock(Subnet subnet)	Unblocks the specified subnet.

Methods inherited from class org.apache.mina.core.filterchain.IoFilterAdapter

destroy, exceptionCaught, filterClose, filterWrite, init, inputClosed, onPostAdd, onPostRemove, onPreAdd, onPreRemove, sessionClosed, toString

Methods inherited from class java.lang.Object

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

Field Detail

blacklist

private final java.util.List<Subnet> blacklist

The list of blocked addresses

LOGGER

private static final org.slf4j.Logger LOGGER

A logger for this class

Constructor Detail

BlacklistFilter

public BlacklistFilter()

Method Detail

setBlacklist

public void setBlacklist(java.net.InetAddress[] addresses)

Sets the addresses to be blacklisted. NOTE: this call will remove any previously blacklisted addresses.

Parameters:

addresses - an array of addresses to be blacklisted.

setSubnetBlacklist

public void setSubnetBlacklist(Subnet[] subnets)

Sets the subnets to be blacklisted. NOTE: this call will remove any previously blacklisted subnets.

Parameters:

subnets - an array of subnets to be blacklisted.

setBlacklist

public void setBlacklist(java.lang.Iterable<java.net.InetAddress> addresses)

Sets the addresses to be blacklisted. NOTE: this call will remove any previously blacklisted addresses.

Parameters:

addresses - a collection of InetAddress objects representing the addresses to be blacklisted.

Throws:

java.lang.IllegalArgumentException - if the specified collections contains non-InetAddress objects.

setSubnetBlacklist

public void setSubnetBlacklist(java.lang.Iterable<Subnet> subnets)

Sets the subnets to be blacklisted. NOTE: this call will remove any previously blacklisted subnets.

Parameters:

subnets - an array of subnets to be blacklisted.

block

public void block(java.net.InetAddress address)

Blocks the specified endpoint.

Parameters:

address - The address to block

block

public void block(Subnet subnet)

Blocks the specified subnet.

Parameters:

subnet - The subnet to block

unblock

public void unblock(java.net.InetAddress address)

Unblocks the specified endpoint.

Parameters:

address - The address to unblock

unblock

public void unblock(Subnet subnet)

Unblocks the specified subnet.

Parameters:

subnet - The subnet to unblock

event

public void event(IoFilter.NextFilter nextFilter,
                  IoSession session,
                  FilterEvent event)
           throws java.lang.Exception

Propagate an event up to the IoHandler

Specified by:

event in interface IoFilter

Overrides:

event in class IoFilterAdapter

Parameters:

nextFilter - the IoFilter.NextFilter for this filter. You can reuse this object until this filter is removed from the chain.

session - The IoSession which has to process this invocation

event - The event to propagate

Throws:

java.lang.Exception - If an error occurred while processing the event

sessionCreated

public void sessionCreated(IoFilter.NextFilter nextFilter,
                           IoSession session)

Filters IoHandler.sessionCreated(IoSession) event.

Specified by:

sessionCreated in interface IoFilter

Overrides:

sessionCreated in class IoFilterAdapter

Parameters:

nextFilter - the IoFilter.NextFilter for this filter. You can reuse this object until this filter is removed from the chain.

session - The IoSession which has received this event

sessionOpened

public void sessionOpened(IoFilter.NextFilter nextFilter,
                          IoSession session)
                   throws java.lang.Exception

Filters IoHandler.sessionOpened(IoSession) event.

Specified by:

sessionOpened in interface IoFilter

Overrides:

sessionOpened in class IoFilterAdapter

Parameters:

nextFilter - the IoFilter.NextFilter for this filter. You can reuse this object until this filter is removed from the chain.

session - The IoSession which has received this event

Throws:

java.lang.Exception - If an error occurred while processing the event

sessionIdle

public void sessionIdle(IoFilter.NextFilter nextFilter,
                        IoSession session,
                        IdleStatus status)
                 throws java.lang.Exception

Filters IoHandler.sessionIdle(IoSession,IdleStatus) event.

Specified by:

sessionIdle in interface IoFilter

Overrides:

sessionIdle in class IoFilterAdapter

Parameters:

nextFilter - the IoFilter.NextFilter for this filter. You can reuse this object until this filter is removed from the chain.

session - The IoSession which has received this event

status - The IdleStatus type

Throws:

java.lang.Exception - If an error occurred while processing the event

messageReceived

public void messageReceived(IoFilter.NextFilter nextFilter,
                            IoSession session,
                            java.lang.Object message)

Filters IoHandler.messageReceived(IoSession,Object) event.

Specified by:

messageReceived in interface IoFilter

Overrides:

messageReceived in class IoFilterAdapter

Parameters:

nextFilter - the IoFilter.NextFilter for this filter. You can reuse this object until this filter is removed from the chain.

session - The IoSession which has received this event

message - The received message

messageSent

public void messageSent(IoFilter.NextFilter nextFilter,
                        IoSession session,
                        WriteRequest writeRequest)
                 throws java.lang.Exception

Filters IoHandler.messageSent(IoSession,Object) event.

Specified by:

messageSent in interface IoFilter

Overrides:

messageSent in class IoFilterAdapter

Parameters:

nextFilter - the IoFilter.NextFilter for this filter. You can reuse this object until this filter is removed from the chain.

session - The IoSession which has received this event

writeRequest - The WriteRequest that contains the sent message

Throws:

java.lang.Exception - If an error occurred while processing the event

blockSession

private void blockSession(IoSession session)

isBlocked

private boolean isBlocked(IoSession session)