Package org.apache.catalina.valves

Class RemoteCIDRValve

java.lang.Object

org.apache.catalina.util.LifecycleBase

org.apache.catalina.util.LifecycleMBeanBase

org.apache.catalina.valves.ValveBase

org.apache.catalina.valves.RequestFilterValve

org.apache.catalina.valves.RemoteCIDRValve

All Implemented Interfaces:

javax.management.MBeanRegistration, Contained, JmxEnabled, Lifecycle, Valve

public final class RemoteCIDRValve
extends RequestFilterValve

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.catalina.Lifecycle

Lifecycle.SingleUse

Field Summary

Fields inherited from class org.apache.catalina.valves.RequestFilterValve

allowValid, allowValue, denyStatus, denyValid, denyValue

Fields inherited from class org.apache.catalina.valves.ValveBase

asyncSupported, container, containerLog, next, sm

Fields inherited from interface org.apache.catalina.Lifecycle

AFTER_DESTROY_EVENT, AFTER_INIT_EVENT, AFTER_START_EVENT, AFTER_STOP_EVENT, BEFORE_DESTROY_EVENT, BEFORE_INIT_EVENT, BEFORE_START_EVENT, BEFORE_STOP_EVENT, CONFIGURE_START_EVENT, CONFIGURE_STOP_EVENT, PERIODIC_EVENT, START_EVENT, STOP_EVENT

Constructor Summary

Constructors

Constructor	Description
RemoteCIDRValve()

Method Summary

Modifier and Type	Method	Description
java.lang.String	getAllow()	Return a string representation of the NetMask list in #allow.
java.lang.String	getDeny()	Return a string representation of the NetMask list in #deny.
protected Log	getLog()
void	invoke(Request request, Response response)	Extract the desired request property, and pass it (along with the specified request and response objects) to the protected process() method to perform the actual filtering.
boolean	isAllowed(java.lang.String property)	Perform the test implemented by this Valve, matching against the specified request property value.
void	setAllow(java.lang.String input)	Fill the #allow list with the list of netmasks provided as an argument, if any.
void	setDeny(java.lang.String input)	Fill the #deny list with the list of netmasks provided as an argument, if any.

Methods inherited from class org.apache.catalina.valves.RequestFilterValve

denyRequest, getAddConnectorPort, getDenyStatus, getInvalidAuthenticationWhenDeny, getUsePeerAddress, initInternal, isAllowValid, isDenyValid, process, setAddConnectorPort, setDenyStatus, setInvalidAuthenticationWhenDeny, setUsePeerAddress, startInternal

Methods inherited from class org.apache.catalina.valves.ValveBase

backgroundProcess, getContainer, getDomainInternal, getNext, getObjectNameKeyProperties, isAsyncSupported, setAsyncSupported, setContainer, setNext, stopInternal, toString

Methods inherited from class org.apache.catalina.util.LifecycleMBeanBase

destroyInternal, getDomain, getObjectName, postDeregister, postRegister, preDeregister, preRegister, register, setDomain, unregister, unregister

Methods inherited from class org.apache.catalina.util.LifecycleBase

addLifecycleListener, destroy, findLifecycleListeners, fireLifecycleEvent, getState, getStateName, getThrowOnFailure, init, removeLifecycleListener, setState, setState, setThrowOnFailure, start, stop

Methods inherited from class java.lang.Object

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

Constructor Detail

RemoteCIDRValve

public RemoteCIDRValve()

Method Detail

getAllow

public java.lang.String getAllow()

Return a string representation of the NetMask list in #allow.

Overrides:

getAllow in class RequestFilterValve

Returns:

the #allow list as a string, without the leading '[' and trailing ']'

setAllow

public void setAllow(java.lang.String input)

Fill the #allow list with the list of netmasks provided as an argument, if any. Calls #fillFromInput.

Overrides:

setAllow in class RequestFilterValve

Parameters:

input - The list of netmasks, as a comma separated string

Throws:

java.lang.IllegalArgumentException - One or more netmasks are invalid

getDeny

public java.lang.String getDeny()

Return a string representation of the NetMask list in #deny.

Overrides:

getDeny in class RequestFilterValve

Returns:

the #deny list as a string, without the leading '[' and trailing ']'

setDeny

public void setDeny(java.lang.String input)

Fill the #deny list with the list of netmasks provided as an argument, if any. Calls #fillFromInput.

Overrides:

setDeny in class RequestFilterValve

Parameters:

input - The list of netmasks, as a comma separated string

Throws:

java.lang.IllegalArgumentException - One or more netmasks are invalid

invoke

public void invoke(Request request,
                   Response response)
            throws java.io.IOException,
                   ServletException

Description copied from class: RequestFilterValve

Extract the desired request property, and pass it (along with the specified request and response objects) to the protected process() method to perform the actual filtering. This method must be implemented by a concrete subclass.

Specified by:

invoke in interface Valve

Specified by:

invoke in class RequestFilterValve

Parameters:

request - The servlet request to be processed

response - The servlet response to be created

Throws:

java.io.IOException - if an input/output error occurs

ServletException - if a servlet error occurs

isAllowed

public boolean isAllowed(java.lang.String property)

Description copied from class: RequestFilterValve

Perform the test implemented by this Valve, matching against the specified request property value. This method is public so that it can be called through JMX, e.g. to test whether certain IP address is allowed or denied by the valve configuration.

Overrides:

isAllowed in class RequestFilterValve

Parameters:

property - The request property value on which to filter

Returns:

true if the request is allowed

getLog

protected Log getLog()

Specified by:

getLog in class RequestFilterValve