From: markt Date: Mon, 10 Aug 2009 10:28:16 +0000 (+0000) Subject: Expose filters via JMX. Filter config is now available via JMX in read-only form. X-Git-Url: https://git.internetallee.de/?a=commitdiff_plain;h=fdb3551dcc3b8fc3a0a60b3f92001b9d3ba4aabc;p=tomcat7.0 Expose filters via JMX. Filter config is now available via JMX in read-only form. Based on a patch provided by Xie Xiaodong as part of GSOC2009. git-svn-id: https://svn.apache.org/repos/asf/tomcat/trunk@802727 13f79535-47bb-0310-9956-ffa450edef68 --- diff --git a/java/org/apache/catalina/core/ApplicationFilterConfig.java b/java/org/apache/catalina/core/ApplicationFilterConfig.java index 56eddaaa4..350c2028b 100644 --- a/java/org/apache/catalina/core/ApplicationFilterConfig.java +++ b/java/org/apache/catalina/core/ApplicationFilterConfig.java @@ -22,10 +22,12 @@ package org.apache.catalina.core; import java.io.Serializable; import java.lang.reflect.InvocationTargetException; import java.util.ArrayList; +import java.util.Collections; import java.util.Enumeration; import java.util.HashMap; import java.util.Map; +import javax.management.ObjectName; import javax.naming.NamingException; import javax.servlet.Filter; import javax.servlet.FilterConfig; @@ -37,9 +39,11 @@ import org.apache.catalina.Globals; import org.apache.catalina.deploy.FilterDef; import org.apache.catalina.security.SecurityUtil; import org.apache.catalina.util.Enumerator; +import org.apache.juli.logging.LogFactory; import org.apache.tomcat.util.res.StringManager; import org.apache.tomcat.InstanceManager; import org.apache.tomcat.util.log.SystemLogHandler; +import org.apache.tomcat.util.modeler.Registry; /** @@ -51,12 +55,15 @@ import org.apache.tomcat.util.log.SystemLogHandler; * @version $Revision$ $Date$ */ -final class ApplicationFilterConfig implements FilterConfig, Serializable { +public final class ApplicationFilterConfig implements FilterConfig, Serializable { protected static StringManager sm = StringManager.getManager(Constants.Package); + private static org.apache.juli.logging.Log log = + LogFactory.getLog(ApplicationFilterConfig.class); + // ----------------------------------------------------------- Constructors @@ -79,7 +86,7 @@ final class ApplicationFilterConfig implements FilterConfig, Serializable { * @throws NamingException * @throws InvocationTargetException */ - public ApplicationFilterConfig(Context context, FilterDef filterDef) + ApplicationFilterConfig(Context context, FilterDef filterDef) throws ClassCastException, ClassNotFoundException, IllegalAccessException, InstantiationException, ServletException, InvocationTargetException, NamingException { @@ -117,6 +124,10 @@ final class ApplicationFilterConfig implements FilterConfig, Serializable { */ private transient InstanceManager instanceManager; + /** + * JMX registration name + */ + private ObjectName oname; // --------------------------------------------------- FilterConfig Methods @@ -125,11 +136,15 @@ final class ApplicationFilterConfig implements FilterConfig, Serializable { * Return the name of the filter we are configuring. */ public String getFilterName() { - return (filterDef.getFilterName()); - } + /** + * Return the class of the filter we are configuring. + */ + public String getFilterClass() { + return filterDef.getFilterClass(); + } /** * Return a String containing the value of the named @@ -154,8 +169,8 @@ final class ApplicationFilterConfig implements FilterConfig, Serializable { * parameters for this Filter. */ public Enumeration getInitParameterNames() { - Map map = filterDef.getParameterMap(); + if (map == null) return (new Enumerator(new ArrayList())); else @@ -189,6 +204,11 @@ final class ApplicationFilterConfig implements FilterConfig, Serializable { } + // --------------------------------------------------------- Public Methods + + public Map getFilterInitParameterMap() { + return Collections.unmodifiableMap(filterDef.getParameterMap()); + } // -------------------------------------------------------- Package Methods @@ -233,9 +253,12 @@ final class ApplicationFilterConfig implements FilterConfig, Serializable { } else { filter.init(this); } + + // Expose filter via JMX + registerJMX(); + return (this.filter); - } @@ -254,6 +277,8 @@ final class ApplicationFilterConfig implements FilterConfig, Serializable { */ void release() { + unregsiterJMX(); + if (this.filter != null) { if (Globals.IS_SECURITY_ENABLED) { @@ -352,4 +377,54 @@ final class ApplicationFilterConfig implements FilterConfig, Serializable { return instanceManager; } + private void registerJMX() { + String parentName = context.getName(); + parentName = ("".equals(parentName)) ? "/" : parentName; + + String hostName = context.getParent().getName(); + hostName = (hostName == null) ? "DEFAULT" : hostName; + + // domain == engine name + String domain = context.getParent().getParent().getName(); + + String webMod = "//" + hostName + parentName; + String onameStr = null; + if (context instanceof StandardContext) { + StandardContext standardContext = (StandardContext) context; + onameStr = domain + ":j2eeType=Filter,name=" + + filterDef.getFilterName() + ",WebModule=" + webMod + + ",J2EEApplication=" + + standardContext.getJ2EEApplication() + ",J2EEServer=" + + standardContext.getJ2EEServer(); + } else { + onameStr = domain + ":j2eeType=Filter,name=" + + filterDef.getFilterName() + ",WebModule=" + webMod; + } + try { + oname = new ObjectName(onameStr); + Registry.getRegistry(null, null).registerComponent(this, oname, + null); + } catch (Exception ex) { + log.info(sm.getString("applicationFilterConfig.jmxRegsiterFail", + getFilterClass(), getFilterName()), ex); + } + } + + private void unregsiterJMX() { + // unregister this component + if (oname != null) { + try { + Registry.getRegistry(null, null).unregisterComponent(oname); + if(log.isDebugEnabled()) + log.debug(sm.getString( + "applicationFilterConfig.jmxUnregsiter", + getFilterClass(), getFilterName())); + } catch(Exception ex) { + log.error(sm.getString( + "applicationFilterConfig.jmxUnregsiterFail", + getFilterClass(), getFilterName()), ex); + } + } + + } } diff --git a/java/org/apache/catalina/core/LocalStrings.properties b/java/org/apache/catalina/core/LocalStrings.properties index 0734862d9..4d02b6615 100644 --- a/java/org/apache/catalina/core/LocalStrings.properties +++ b/java/org/apache/catalina/core/LocalStrings.properties @@ -33,6 +33,9 @@ applicationDispatcher.isUnavailable=Servlet {0} is currently unavailable applicationDispatcher.serviceException=Servlet.service() for servlet {0} threw exception applicationDispatcher.specViolation.request=Original SevletRequest or wrapped original ServletRequest not passed to RequestDispatcher in violation of SRV.8.2 and SRV.14.2.5.1 applicationDispatcher.specViolation.response=Original SevletResponse or wrapped original ServletResponse not passed to RequestDispatcher in violation of SRV.8.2 and SRV.14.2.5.1 +applicationFilterConfig.jmxRegisterFail=JMX registration failed for filter of type [{0}] and name [{1}] +applicationFilterConfig.jmxUnregister=JMX de-registration complete for filter of type [{0}] and name [{1}] +applicationFilterConfig.jmxUnregisterFail=JMX de-registration failed for filter of type [{0}] and name [{1}] applicationRequest.badParent=Cannot locate parent Request implementation applicationRequest.badRequest=Request is not a javax.servlet.ServletRequestWrapper applicationResponse.badParent=Cannot locate parent Response implementation diff --git a/java/org/apache/catalina/core/mbeans-descriptors.xml b/java/org/apache/catalina/core/mbeans-descriptors.xml index 16117a2dc..05f3917d5 100644 --- a/java/org/apache/catalina/core/mbeans-descriptors.xml +++ b/java/org/apache/catalina/core/mbeans-descriptors.xml @@ -17,6 +17,29 @@ --> + + + + + + + + + +