You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tomcat.apache.org by ho...@apache.org on 2002/08/09 04:07:12 UTC
cvs commit: jakarta-tomcat-catalina/catalina/src/share/org/apache/catalina/core StandardContext.java LocalStrings.properties
horwat 2002/08/08 19:07:12
Modified: catalina/src/share/org/apache/catalina/valves
LocalStrings.properties
catalina/src/share/org/apache/catalina/mbeans
mbeans-descriptors.xml
catalina/src/share/org/apache/catalina/core
StandardContext.java LocalStrings.properties
Added: catalina/src/share/org/apache/catalina/valves
RequestListenerValve.java
Log:
Add a valve to handle the servlet request lifecycle events.
Revision Changes Path
1.2 +2 -0 jakarta-tomcat-catalina/catalina/src/share/org/apache/catalina/valves/LocalStrings.properties
Index: LocalStrings.properties
===================================================================
RCS file: /home/cvs/jakarta-tomcat-catalina/catalina/src/share/org/apache/catalina/valves/LocalStrings.properties,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- LocalStrings.properties 18 Jul 2002 16:47:42 -0000 1.1
+++ LocalStrings.properties 9 Aug 2002 02:07:12 -0000 1.2
@@ -6,6 +6,8 @@
interceptorValve.notStarted=Interceptor Valve has not yet been started
requestFilterValve.next=No 'next' valve has been configured
requestFilterValve.syntax=Syntax error in request filter pattern {0}
+requestListenerValve.requestInit=Exception sending request initialized lifecycle event to listener instance of class {0}
+requestListenerValve.requestDestroy=Exception sending request destroyed lifecycle event to listener instance of class {0}
valveBase.noNext=Configuration error: No 'next' valve configured
# Error report valve
1.1 jakarta-tomcat-catalina/catalina/src/share/org/apache/catalina/valves/RequestListenerValve.java
Index: RequestListenerValve.java
===================================================================
/*
* $Header: /home/cvs/jakarta-tomcat-catalina/catalina/src/share/org/apache/catalina/valves/RequestListenerValve.java,v 1.1 2002/08/09 02:07:12 horwat Exp $
* $Revision: 1.1 $
* $Date: 2002/08/09 02:07:12 $
*
* ====================================================================
*
* The Apache Software License, Version 1.1
*
* Copyright (c) 1999-2001 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution, if
* any, must include the following acknowlegement:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowlegement may appear in the software itself,
* if and wherever such third-party acknowlegements normally appear.
*
* 4. The names "The Jakarta Project", "Tomcat", and "Apache Software
* Foundation" must not be used to endorse or promote products derived
* from this software without prior written permission. For written
* permission, please contact apache@apache.org.
*
* 5. Products derived from this software may not be called "Apache"
* nor may "Apache" appear in their names without prior written
* permission of the Apache Group.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*
* [Additional notices, if required by prior licensing conditions]
*
*/
package org.apache.catalina.valves;
import java.io.IOException;
import javax.servlet.ServletException;
import javax.servlet.ServletRequestEvent;
import javax.servlet.ServletRequestListener;
import org.apache.catalina.Logger;
import org.apache.catalina.Request;
import org.apache.catalina.Response;
import org.apache.catalina.ValveContext;
import org.apache.catalina.core.StandardContext;
import org.apache.catalina.util.StringManager;
/**
*
* <p>Implementation of a Valve that handles the servlet request lifecycle
* events (initilization and destroy).</p>
*
* <p>This Valve should be attached to a Context.</p>
*
* <p><b>WARNING</b>: This valve is necessary for Servlet 2.4 API compliance.</p>
*
* @author Justyna Horwat
* @version $Revision: 1.1 $ $Date: 2002/08/09 02:07:12 $
*/
public class RequestListenerValve
extends ValveBase {
// ----------------------------------------------------- Instance Variables
/**
* The descriptive information related to this implementation.
*/
private static final String info =
"org.apache.catalina.valves.RequestListenerValve/1.0";
/**
* The StringManager for this package.
*/
protected static StringManager sm =
StringManager.getManager(Constants.Package);
// ------------------------------------------------------------- Properties
/**
* Return descriptive information about this Valve implementation.
*/
public String getInfo() {
return (info);
}
// --------------------------------------------------------- Public Methods
/**
* Log the interesting request parameters, invoke the next Valve in the
* sequence, and log the interesting response parameters.
*
* @param request The servlet request to be processed
* @param response The servlet response to be created
* @param context The valve context used to invoke the next valve
* in the current processing pipeline
*
* @exception IOException if an input/output error occurs
* @exception ServletException if a servlet error occurs
*/
public void invoke(Request request, Response response,
ValveContext context)
throws IOException, ServletException {
//Valve should only be invoked if there are registered
//application listeners
Object instances[] =
((StandardContext) container).getApplicationListeners();
ServletRequestEvent event = new ServletRequestEvent(
((StandardContext) container).getServletContext(), request.getRequest());
// create pre-service event
for (int i = 0; i < instances.length; i++) {
if (instances[i] == null)
continue;
if (!(instances[i] instanceof ServletRequestListener))
continue;
ServletRequestListener listener =
(ServletRequestListener) instances[i];
try {
listener.requestInitialized(event);
} catch (Throwable t) {
log(sm.getString("requestListenerValve.requestInit",
instances[i].getClass().getName()), t);
}
}
// Perform the request
context.invokeNext(request, response);
// create post-service event
for (int i = 0; i < instances.length; i++) {
if (instances[i] == null)
continue;
if (!(instances[i] instanceof ServletRequestListener))
continue;
ServletRequestListener listener =
(ServletRequestListener) instances[i];
try {
listener.requestDestroyed(event);
} catch (Throwable t) {
log(sm.getString("requestListenerValve.requestDestroy",
instances[i].getClass().getName()), t);
}
}
}
/**
* Return a String rendering of this object.
*/
public String toString() {
StringBuffer sb = new StringBuffer("RequestListenerValve[");
if (container != null)
sb.append(container.getName());
sb.append("]");
return (sb.toString());
}
// ------------------------------------------------------ Protected Methods
/**
* Log a message on the Logger associated with our Container (if any).
*
* @param message Message to be logged
*/
protected void log(String message) {
Logger logger = container.getLogger();
if (logger != null)
logger.log(this.toString() + ": " + message);
else
System.out.println(this.toString() + ": " + message);
}
/**
* Log a message on the Logger associated with our Container (if any).
*
* @param message Message to be logged
* @param throwable Associated exception
*/
protected void log(String message, Throwable throwable) {
Logger logger = container.getLogger();
if (logger != null)
logger.log(this.toString() + ": " + message, throwable);
else {
System.out.println(this.toString() + ": " + message);
throwable.printStackTrace(System.out);
}
}
}
1.2 +19 -1 jakarta-tomcat-catalina/catalina/src/share/org/apache/catalina/mbeans/mbeans-descriptors.xml
Index: mbeans-descriptors.xml
===================================================================
RCS file: /home/cvs/jakarta-tomcat-catalina/catalina/src/share/org/apache/catalina/mbeans/mbeans-descriptors.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- mbeans-descriptors.xml 18 Jul 2002 16:48:01 -0000 1.1
+++ mbeans-descriptors.xml 9 Aug 2002 02:07:12 -0000 1.2
@@ -11,6 +11,24 @@
<mbeans-descriptors>
+ <mbean name="RequestListenerValve"
+ className="org.apache.catalina.mbeans.ClassNameMBean"
+ description="Valve that handles request initialization and destroy events"
+ domain="Catalina"
+ group="Valve"
+ type="org.apache.catalina.valves.RequestListenerValve">
+
+ <attribute name="className"
+ description="Fully qualified class name of the managed object"
+ type="java.lang.String"
+ writeable="false"/>
+
+ <attribute name="debug"
+ description="The debugging detail level for this component"
+ type="int"/>
+
+ </mbean>
+
<mbean name="AccessLogValve"
className="org.apache.catalina.mbeans.ClassNameMBean"
1.3 +74 -4 jakarta-tomcat-catalina/catalina/src/share/org/apache/catalina/core/StandardContext.java
Index: StandardContext.java
===================================================================
RCS file: /home/cvs/jakarta-tomcat-catalina/catalina/src/share/org/apache/catalina/core/StandardContext.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- StandardContext.java 2 Aug 2002 01:37:43 -0000 1.2
+++ StandardContext.java 9 Aug 2002 02:07:12 -0000 1.3
@@ -81,6 +81,7 @@
import javax.servlet.ServletContextEvent;
import javax.servlet.ServletContextListener;
import javax.servlet.ServletException;
+import javax.servlet.ServletRequestListener;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.naming.NamingException;
@@ -116,8 +117,10 @@
import org.apache.catalina.LifecycleListener;
import org.apache.catalina.Loader;
import org.apache.catalina.Mapper;
+import org.apache.catalina.Pipeline;
import org.apache.catalina.Request;
import org.apache.catalina.Response;
+import org.apache.catalina.Valve;
import org.apache.catalina.Wrapper;
import org.apache.catalina.deploy.ApplicationParameter;
import org.apache.catalina.deploy.ContextEjb;
@@ -140,6 +143,7 @@
import org.apache.catalina.util.RequestUtil;
+
/**
* Standard implementation of the <b>Context</b> interface. Each
* child container must be a Wrapper implementation to process the
@@ -2502,6 +2506,13 @@
}
}
+ // Create request listener valve
+ if (ok) {
+ if (!requestListenerConfig()) {
+ log(sm.getString("standardContext.requestListenerStartFailed"));
+ }
+ }
+
// Restore the "Welcome Files" and "Resources" context attributes
postResources();
postWelcomeFiles();
@@ -3507,6 +3518,13 @@
ok = false;
}
+ // Create request listener lifecycle valve
+ if (ok) {
+ if (!requestListenerConfig()) {
+ log(sm.getString("standardContext.requestListenerStartFailed"));
+ }
+ }
+
// Load and initialize all "load on startup" servlets
if (ok)
loadOnStartup(findChildren());
@@ -3986,5 +4004,57 @@
}
+
+ /**
+ * Create and deploy a Valve to handle request linitialization and
+ * destroy listener lifecycle events. If there are no request listeners
+ * registered to receive notifications do not instantiate valve.
+ */
+ private boolean requestListenerConfig() {
+ // Only install this valive if there is a registered RequestListener.
+ Object instances[] = getApplicationListeners();
+ boolean registered = false;
+ boolean ok = true;
+
+ if (instances != null) {
+ for (int i = 0; i < instances.length; i++) {
+ if (instances[i] instanceof ServletRequestListener) {
+ registered = true;
+ break;
+ }
+ }
+ }
+
+ if (!registered) {
+ return ok;
+ }
+
+ // Instantiate a new CertificatesValve if possible
+ Valve requestListener = null;
+ try {
+ Class clazz =
+ Class.forName("org.apache.catalina.valves.RequestListenerValve");
+ requestListener = (Valve) clazz.newInstance();
+ } catch (Throwable t) {
+ return false;
+ }
+
+ // Add this Valve to our Pipeline
+ try {
+ if (this instanceof ContainerBase) {
+ Pipeline pipeline = ((ContainerBase) this).getPipeline();
+ if (pipeline != null) {
+ ((ContainerBase) this).addValve(requestListener);
+ log(sm.getString
+ ("standardContext.requestListenerConfig.added"));
+ }
+ }
+ } catch (Throwable t) {
+ log(sm.getString("standardContext.requestListenerConfig.error"), t);
+ ok = false;
+ }
+ return ok;
+
+ }
}
1.3 +3 -0 jakarta-tomcat-catalina/catalina/src/share/org/apache/catalina/core/LocalStrings.properties
Index: LocalStrings.properties
===================================================================
RCS file: /home/cvs/jakarta-tomcat-catalina/catalina/src/share/org/apache/catalina/core/LocalStrings.properties,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- LocalStrings.properties 30 Jul 2002 03:58:27 -0000 1.2
+++ LocalStrings.properties 9 Aug 2002 02:07:12 -0000 1.3
@@ -42,6 +42,9 @@
standardContext.filterMap.pattern=Invalid <url-pattern> {0} in filter mapping
standardContext.filterStart=Exception starting filter {0}
standardContext.filterStartFailed=Failed to start application Filters successfully
+standardContext.requestListenerStartFailed=Failed to start request listener valve successfully
+standardContext.requestListenerConfig.added=Added request listener Valve
+standardContext.requestListenerConfig.error=Exception adding request listener Valve: {0}
standardContext.isUnavailable=This application is not currently available
standardContext.listenerStart=Exception sending context initialized event to listener instance of class {0}
standardContext.listenerStartFailed=Failed to start application Listeners successfully
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>