|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.catalina.valves.ValveBase
Convenience base class for implementations of the Valve interface.
A subclass MUST implement an invoke()
method to provide the required functionality, and MAY
implement the Lifecycle
interface to provide configuration
management and lifecycle support.
Field Summary | |
protected Container |
container
The Container whose pipeline this Valve is a component of. |
protected static java.lang.String |
info
Descriptive information about this Valve implementation. |
protected Valve |
next
The next Valve in the pipeline this Valve is a component of. |
protected Valve |
previous
The previous Valve in the pipeline this Valve is a component of. |
protected static StringManager |
sm
The string manager for this package. |
Constructor Summary | |
ValveBase()
|
Method Summary | |
Container |
getContainer()
Return the Container with which this Valve is associated, if any. |
java.lang.String |
getInfo()
Return descriptive information about this Valve implementation. |
Valve |
getNext()
Return the next Valve in this pipeline, or null if this
is the last Valve in the pipeline. |
Valve |
getPrevious()
Return the previous Valve in this pipeline, or null if
this is the first Valve in the pipeline. |
abstract void |
invoke(Request request,
Response response)
The implementation-specific logic represented by this Valve. |
void |
invokeNext(Request request,
Response response)
Invoke the next Valve in our pipeline, or complain if there is no such Valve remaining. |
void |
setContainer(Container container)
Set the Container with which this Valve is associated, if any. |
void |
setNext(Valve valve)
Set the Valve that follows this one in the pipeline it is part of. |
void |
setPrevious(Valve valve)
Set the Valve that preceeds this one in the pipeline it is part of. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected Container container
protected static java.lang.String info
protected Valve next
protected Valve previous
protected static final StringManager sm
Constructor Detail |
public ValveBase()
Method Detail |
public Container getContainer()
getContainer
in interface Valve
public void setContainer(Container container)
setContainer
in interface Valve
container
- The new associated containerpublic java.lang.String getInfo()
getInfo
in interface Valve
public Valve getNext()
null
if this
is the last Valve in the pipeline.getNext
in interface Valve
public void setNext(Valve valve)
setNext
in interface Valve
valve
- The new next valvepublic Valve getPrevious()
null
if
this is the first Valve in the pipeline.getPrevious
in interface Valve
public void setPrevious(Valve valve)
setPrevious
in interface Valve
valve
- The previous valvepublic abstract void invoke(Request request, Response response) throws java.io.IOException, javax.servlet.ServletException
This method MUST be provided by a subclass.
invoke
in interface Valve
request
- The servlet request to be processedresponse
- The servlet response to be createdjava.io.IOException
- if an input/output error occursjavax.servlet.ServletException
- if a servlet error occurspublic void invokeNext(Request request, Response response) throws java.io.IOException, javax.servlet.ServletException
request
- The servlet request to be processedresponse
- The servlet response to be createdjava.io.IOException
- if an input/output error occursjavax.servlet.ServletException
- if a servlet error occurs
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |