/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
*
* Portions Copyright Apache Software Foundation.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can obtain
* a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
* or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
* Sun designates this particular file as subject to the "Classpath" exception
* as provided by Sun in the GPL Version 2 section of the License file that
* accompanied this code. If applicable, add the following below the License
* Header, with the fields enclosed by brackets [] replaced by your own
* identifying information: "Portions Copyrighted [year]
* [name of copyright owner]"
*
* Contributor(s):
*
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package org.apache.catalina.valves;
import java.io.IOException;
import javax.servlet.ServletException;
import javax.management.ObjectName;
import javax.management.MBeanRegistration;
import javax.management.MBeanServer;
import javax.management.MalformedObjectNameException;
import org.apache.catalina.Contained;
import org.apache.catalina.Container;
// START CR 6411114
import org.apache.catalina.Lifecycle;
import org.apache.catalina.LifecycleEvent;
import org.apache.catalina.LifecycleException;
import org.apache.catalina.LifecycleListener;
// END CR 6411114
import org.apache.catalina.Request;
import org.apache.catalina.Response;
import org.apache.catalina.Valve;
import org.apache.catalina.Pipeline;
import org.apache.catalina.Engine;
import org.apache.catalina.Service;
import org.apache.catalina.Host;
import org.apache.catalina.Context;
import org.apache.catalina.Wrapper;
import org.apache.catalina.core.ContainerBase;
// START CR 6411114
import org.apache.catalina.core.StandardContext;
import org.apache.catalina.core.StandardWrapper;
import org.apache.catalina.util.LifecycleSupport;
// END CR 6411114
import org.apache.catalina.util.StringManager;
import com.sun.org.apache.commons.logging.Log;
import com.sun.org.apache.commons.logging.LogFactory;
// START CR 6411114
import com.sun.org.apache.commons.modeler.Registry;
// END CR 6411114
/**
* Convenience base class for implementations of the <b>Valve</b> interface.
* A subclass <strong>MUST</strong> implement an <code>invoke()</code>
* method to provide the required functionality, and <strong>MAY</strong>
* implement the <code>Lifecycle</code> interface to provide configuration
* management and lifecycle support.
*
* @author Craig R. McClanahan
* @version $Revision: 1.8 $ $Date: 2007/07/17 23:07:02 $
*/
public abstract class ValveBase
/** CR 6411114
implements Contained, Valve, MBeanRegistration {
*/
// START CR 6411114
implements Contained, Lifecycle, Valve, MBeanRegistration {
// END CR 6411114
private static Log log = LogFactory.getLog(ValveBase.class);
//------------------------------------------------------ Instance Variables
/**
* The Container whose pipeline this Valve is a component of.
*/
protected Container container = null;
/**
* The debugging detail level for this component.
*/
protected int debug = 0;
// START CR 6411114
/**
* Has this component been started yet?
*/
protected boolean started = false;
/**
* The lifecycle event support for this component.
*/
protected LifecycleSupport lifecycle = new LifecycleSupport(this);
// END CR 6411114
/**
* Descriptive information about this Valve implementation. This value
* should be overridden by subclasses.
*/
protected static final String info =
"org.apache.catalina.core.ValveBase/1.0";
/**
* The string manager for this package.
*/
protected final static StringManager sm =
StringManager.getManager(Constants.Package);
//-------------------------------------------------------------- Properties
/**
* Return the Container with which this Valve is associated, if any.
*/
public Container getContainer() {
return (container);
}
/**
* Set the Container with which this Valve is associated, if any.
*
* @param container The new associated container
*/
public void setContainer(Container container) {
this.container = container;
}
/**
* Return the debugging detail level for this component.
*/
public int getDebug() {
return (this.debug);
}
/**
* Set the debugging detail level for this component.
*
* @param debug The new debugging detail level
*/
public void setDebug(int debug) {
this.debug = debug;
}
/**
* Return descriptive information about this Valve implementation.
*/
public String getInfo() {
return (info);
}
//---------------------------------------------------------- Public Methods
/**
* The implementation-specific logic represented by this Valve. See the
* Valve description for the normal design patterns for this method.
* <p>
* This method <strong>MUST</strong> be provided by a subclass.
*
* @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
*/
// START OF IASRI 4665318
public abstract int invoke(Request request, Response response)
throws IOException, ServletException;
/**
* A post-request processing implementation that does nothing.
*
* Very few Valves override this behaviour as most Valve logic
* is used for request processing.
*/
public void postInvoke(Request request, Response response)
throws IOException, ServletException {
}
// END OF IASRI 4665318
// START CR 6411114
// ------------------------------------------------------ Lifecycle Methods
/**
* Add a lifecycle event listener to this component.
*
* @param listener The listener to add
*/
public void addLifecycleListener(LifecycleListener listener) {
lifecycle.addLifecycleListener(listener);
}
/**
* Get the lifecycle listeners associated with this lifecycle. If this
* Lifecycle has no listeners registered, a zero-length array is returned.
*/
public LifecycleListener[] findLifecycleListeners() {
return lifecycle.findLifecycleListeners();
}
/**
* Remove a lifecycle event listener from this component.
*
* @param listener The listener to add
*/
public void removeLifecycleListener(LifecycleListener listener) {
lifecycle.removeLifecycleListener(listener);
}
/**
* Prepare for the beginning of active use of the public methods of this
* component. This method should be called after <code>configure()</code>,
* and before any of the public methods of the component are utilized.
*
* @exception LifecycleException if this component detects a fatal error
* that prevents this component from being used
*/
public void start() throws LifecycleException {
// Validate and update our current component state
if (started)
return;
lifecycle.fireLifecycleEvent(START_EVENT, null);
// Register the MBean when the valve is started
registerMBean();
started = true;
}
/**
* Gracefully terminate the active use of the public methods of this
* component. This method should be the last one called on a given
* instance of this component.
*
* @exception LifecycleException if this component detects a fatal error
* that needs to be reported
*/
public void stop() throws LifecycleException {
// Validate and update our current component state
if (!started)
return;
lifecycle.fireLifecycleEvent(STOP_EVENT, null);
// Deregister the MBean when the valve is stopped
unregisterMBean();
started = false;
}
// END CR 6411114
// -------------------- JMX and Registration --------------------
protected String domain;
protected ObjectName oname;
protected MBeanServer mserver;
protected ObjectName controller;
public ObjectName getObjectName() {
return oname;
}
public void setObjectName(ObjectName oname) {
this.oname = oname;
}
public String getDomain() {
return domain;
}
public ObjectName preRegister(MBeanServer server,
ObjectName name) throws Exception {
oname=name;
mserver=server;
domain=name.getDomain();
return name;
}
public void postRegister(Boolean registrationDone) {
}
public void preDeregister() throws Exception {
}
public void postDeregister() {
}
public ObjectName getController() {
return controller;
}
public void setController(ObjectName controller) {
this.controller = controller;
}
/** From the name, extract the parent object name
*
* @param valveName
* @return
*/
public ObjectName getParentName( ObjectName valveName ) {
return null;
}
public ObjectName createObjectName(String domain, ObjectName parent)
throws MalformedObjectNameException
{
Container container=this.getContainer();
if( container == null || ! (container instanceof ContainerBase) )
return null;
ContainerBase containerBase=(ContainerBase)container;
Pipeline pipe=containerBase.getPipeline();
Valve valves[]=pipe.getValves();
/* Compute the "parent name" part */
String parentName="";
if (container instanceof Engine) {
} else if (container instanceof Host) {
parentName=",host=" +container.getName();
} else if (container instanceof Context) {
String path = ((Context)container).getPath();
if (path.length() < 1) {
path = "/";
}
Host host = (Host) container.getParent();
parentName=",path=" + path + ",host=" + host.getName();
} else if (container instanceof Wrapper) {
Context ctx = (Context) container.getParent();
String path = ctx.getPath();
if (path.length() < 1) {
path = "/";
}
Host host = (Host) ctx.getParent();
parentName=",servlet=" + container.getName() +
",path=" + path + ",host=" + host.getName();
}
log.debug("valve parent=" + parentName + " " + parent);
String className=this.getClass().getName();
int period = className.lastIndexOf('.');
if (period >= 0)
className = className.substring(period + 1);
int seq=0;
for( int i=0; i<valves.length; i++ ) {
// Find other valves with the same name
if (valves[i]==this) {
break;
}
if( valves[i]!=null &&
valves[i].getClass() == this.getClass()) {
log.debug("Duplicate " + valves[i] + " " + this + " " + container);
seq++;
}
}
String ext="";
if( seq > 0 ) {
ext=",seq=" + seq;
}
ObjectName objectName =
new ObjectName( domain + ":type=Valve,name=" + className + ext + parentName);
log.debug("valve objectname = "+objectName);
return objectName;
}
// -------------------- JMX data --------------------
public ObjectName getContainerName() {
if( container== null) return null;
return ((ContainerBase)container).getJmxName();
}
// START CR 6411114
private void registerMBean() {
if ((getObjectName() == null) && (container != null)) {
try {
String domain=((ContainerBase)container).getDomain();
if (container instanceof StandardContext) {
domain=((StandardContext)container).getEngineName();
}
if (container instanceof StandardWrapper) {
Container ctx=((StandardWrapper)container).getParent();
domain=((StandardContext)ctx).getEngineName();
}
ObjectName vname=createObjectName(domain,
((ContainerBase)container).getJmxName());
if (vname != null) {
setObjectName(vname);
setController(vname);
Registry.getRegistry().registerComponent(this, vname, getClass().getName());
}
} catch( Throwable t ) {
log.info( "Can't register valve " + this , t );
}
}
}
private void unregisterMBean() {
try {
if ((oname != null) && (oname == controller)) {
Registry.getRegistry().getMBeanServer().unregisterMBean(oname);
setObjectName(null);
setController(null);
}
} catch( Throwable t ) {
log.info( "Can't unregister valve " + this , t );
}
}
// END CR 6411114
}
|
