-/*
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright ownership.
- * The ASF licenses this file to You under the Apache License, Version 2.0
- * (the "License"); you may not use this file except in compliance with
- * the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package org.apache.log4j.jmx;
-
-import org.apache.log4j.Appender;
-import org.apache.log4j.Layout;
-import org.apache.log4j.Level;
-import org.apache.log4j.Logger;
-import org.apache.log4j.Priority;
-import org.apache.log4j.helpers.OptionConverter;
-import org.apache.log4j.spi.OptionHandler;
-
-import javax.management.Attribute;
-import javax.management.AttributeNotFoundException;
-import javax.management.InvalidAttributeValueException;
-import javax.management.JMException;
-import javax.management.MBeanAttributeInfo;
-import javax.management.MBeanConstructorInfo;
-import javax.management.MBeanException;
-import javax.management.MBeanInfo;
-import javax.management.MBeanNotificationInfo;
-import javax.management.MBeanOperationInfo;
-import javax.management.MBeanParameterInfo;
-import javax.management.MBeanServer;
-import javax.management.MalformedObjectNameException;
-import javax.management.ObjectName;
-import javax.management.ReflectionException;
-import javax.management.RuntimeOperationsException;
-import java.beans.BeanInfo;
-import java.beans.IntrospectionException;
-import java.beans.Introspector;
-import java.beans.PropertyDescriptor;
-import java.lang.reflect.Constructor;
-import java.lang.reflect.InvocationTargetException;
-import java.lang.reflect.Method;
-import java.util.Hashtable;
-import java.util.Vector;
-import java.io.InterruptedIOException;
-
-public class AppenderDynamicMBean extends AbstractDynamicMBean {
-
- private MBeanConstructorInfo[] dConstructors = new MBeanConstructorInfo[1];
- private Vector dAttributes = new Vector();
- private String dClassName = this.getClass().getName();
-
- private Hashtable dynamicProps = new Hashtable(5);
- private MBeanOperationInfo[] dOperations = new MBeanOperationInfo[2];
- private String dDescription =
- "This MBean acts as a management facade for log4j appenders.";
-
- // This category instance is for logging.
- private static Logger cat = Logger.getLogger(AppenderDynamicMBean.class);
-
- // We wrap this appender instance.
- private Appender appender;
-
- public AppenderDynamicMBean(Appender appender) throws IntrospectionException {
- this.appender = appender;
- buildDynamicMBeanInfo();
- }
-
- private
- void buildDynamicMBeanInfo() throws IntrospectionException {
- Constructor[] constructors = this.getClass().getConstructors();
- dConstructors[0] = new MBeanConstructorInfo(
- "AppenderDynamicMBean(): Constructs a AppenderDynamicMBean instance",
- constructors[0]);
-
-
- BeanInfo bi = Introspector.getBeanInfo(appender.getClass());
- PropertyDescriptor[] pd = bi.getPropertyDescriptors();
-
- int size = pd.length;
-
- for(int i = 0; i < size; i++) {
- String name = pd[i].getName();
- Method readMethod = pd[i].getReadMethod();
- Method writeMethod = pd[i].getWriteMethod();
- if(readMethod != null) {
- Class returnClass = readMethod.getReturnType();
- if(isSupportedType(returnClass)) {
- String returnClassName;
- if(returnClass.isAssignableFrom(Priority.class)) {
- returnClassName = "java.lang.String";
- } else {
- returnClassName = returnClass.getName();
- }
-
- dAttributes.add(new MBeanAttributeInfo(name,
- returnClassName,
- "Dynamic",
- true,
- writeMethod != null,
- false));
- dynamicProps.put(name, new MethodUnion(readMethod, writeMethod));
- }
- }
- }
-
- MBeanParameterInfo[] params = new MBeanParameterInfo[0];
-
- dOperations[0] = new MBeanOperationInfo("activateOptions",
- "activateOptions(): add an appender",
- params,
- "void",
- MBeanOperationInfo.ACTION);
-
- params = new MBeanParameterInfo[1];
- params[0] = new MBeanParameterInfo("layout class", "java.lang.String",
- "layout class");
-
- dOperations[1] = new MBeanOperationInfo("setLayout",
- "setLayout(): add a layout",
- params,
- "void",
- MBeanOperationInfo.ACTION);
- }
-
- private
- boolean isSupportedType(Class clazz) {
- if(clazz.isPrimitive()) {
- return true;
- }
-
- if(clazz == String.class) {
- return true;
- }
-
-
- if(clazz.isAssignableFrom(Priority.class)) {
- return true;
- }
-
- return false;
-
-
- }
-
-
-
- public
- MBeanInfo getMBeanInfo() {
- cat.debug("getMBeanInfo called.");
-
- MBeanAttributeInfo[] attribs = new MBeanAttributeInfo[dAttributes.size()];
- dAttributes.toArray(attribs);
-
- return new MBeanInfo(dClassName,
- dDescription,
- attribs,
- dConstructors,
- dOperations,
- new MBeanNotificationInfo[0]);
- }
-
- public
- Object invoke(String operationName, Object params[], String signature[])
- throws MBeanException,
- ReflectionException {
-
- if(operationName.equals("activateOptions") &&
- appender instanceof OptionHandler) {
- OptionHandler oh = (OptionHandler) appender;
- oh.activateOptions();
- return "Options activated.";
- } else if (operationName.equals("setLayout")) {
- Layout layout = (Layout) OptionConverter.instantiateByClassName((String)
- params[0],
- Layout.class,
- null);
- appender.setLayout(layout);
- registerLayoutMBean(layout);
- }
- return null;
- }
-
- void registerLayoutMBean(Layout layout) {
- if(layout == null) {
- return;
- }
-
- String name = getAppenderName(appender)+",layout="+layout.getClass().getName();
- cat.debug("Adding LayoutMBean:"+name);
- ObjectName objectName = null;
- try {
- LayoutDynamicMBean appenderMBean = new LayoutDynamicMBean(layout);
- objectName = new ObjectName("log4j:appender="+name);
- if (!server.isRegistered(objectName)) {
- registerMBean(appenderMBean, objectName);
- dAttributes.add(new MBeanAttributeInfo("appender=" + name, "javax.management.ObjectName",
- "The " + name + " layout.", true, true, false));
- }
-
- } catch(JMException e) {
- cat.error("Could not add DynamicLayoutMBean for ["+name+"].", e);
- } catch(java.beans.IntrospectionException e) {
- cat.error("Could not add DynamicLayoutMBean for ["+name+"].", e);
- } catch(RuntimeException e) {
- cat.error("Could not add DynamicLayoutMBean for ["+name+"].", e);
- }
- }
-
- protected
- Logger getLogger() {
- return cat;
- }
-
-
- public
- Object getAttribute(String attributeName) throws AttributeNotFoundException,
- MBeanException,
- ReflectionException {
-
- // Check attributeName is not null to avoid NullPointerException later on
- if (attributeName == null) {
- throw new RuntimeOperationsException(new IllegalArgumentException(
- "Attribute name cannot be null"),
- "Cannot invoke a getter of " + dClassName + " with null attribute name");
- }
-
- cat.debug("getAttribute called with ["+attributeName+"].");
- if(attributeName.startsWith("appender="+appender.getName()+",layout")) {
- try {
- return new ObjectName("log4j:"+attributeName );
- } catch(MalformedObjectNameException e) {
- cat.error("attributeName", e);
- } catch(RuntimeException e) {
- cat.error("attributeName", e);
- }
- }
-
- MethodUnion mu = (MethodUnion) dynamicProps.get(attributeName);
-
- //cat.debug("----name="+attributeName+", b="+b);
-
- if(mu != null && mu.readMethod != null) {
- try {
- return mu.readMethod.invoke(appender, null);
- } catch(IllegalAccessException e) {
- return null;
- } catch(InvocationTargetException e) {
- if (e.getTargetException() instanceof InterruptedException
- || e.getTargetException() instanceof InterruptedIOException) {
- Thread.currentThread().interrupt();
- }
- return null;
- } catch(RuntimeException e) {
- return null;
- }
- }
-
-
-
- // If attributeName has not been recognized throw an AttributeNotFoundException
- throw(new AttributeNotFoundException("Cannot find " + attributeName +
- " attribute in " + dClassName));
-
- }
-
-
- public
- void setAttribute(Attribute attribute) throws AttributeNotFoundException,
- InvalidAttributeValueException,
- MBeanException,
- ReflectionException {
-
- // Check attribute is not null to avoid NullPointerException later on
- if (attribute == null) {
- throw new RuntimeOperationsException(
- new IllegalArgumentException("Attribute cannot be null"),
- "Cannot invoke a setter of " + dClassName +
- " with null attribute");
- }
- String name = attribute.getName();
- Object value = attribute.getValue();
-
- if (name == null) {
- throw new RuntimeOperationsException(
- new IllegalArgumentException("Attribute name cannot be null"),
- "Cannot invoke the setter of "+dClassName+
- " with null attribute name");
- }
-
-
-
- MethodUnion mu = (MethodUnion) dynamicProps.get(name);
-
- if(mu != null && mu.writeMethod != null) {
- Object[] o = new Object[1];
-
- Class[] params = mu.writeMethod.getParameterTypes();
- if(params[0] == org.apache.log4j.Priority.class) {
- value = OptionConverter.toLevel((String) value,
- (Level) getAttribute(name));
- }
- o[0] = value;
-
- try {
- mu.writeMethod.invoke(appender, o);
-
- } catch(InvocationTargetException e) {
- if (e.getTargetException() instanceof InterruptedException
- || e.getTargetException() instanceof InterruptedIOException) {
- Thread.currentThread().interrupt();
- }
- cat.error("FIXME", e);
- } catch(IllegalAccessException e) {
- cat.error("FIXME", e);
- } catch(RuntimeException e) {
- cat.error("FIXME", e);
- }
- } else if(name.endsWith(".layout")) {
-
- } else {
- throw(new AttributeNotFoundException("Attribute " + name +
- " not found in " +
- this.getClass().getName()));
- }
- }
-
- public
- ObjectName preRegister(MBeanServer server, ObjectName name) {
- cat.debug("preRegister called. Server="+server+ ", name="+name);
- this.server = server;
- registerLayoutMBean(appender.getLayout());
-
- return name;
- }
-
-
-}
-