org.apache.catalina.mbeans.ClassNameMBean Maven / Gradle / Ivy
/*
* 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.catalina.mbeans;
import javax.management.MBeanException;
import javax.management.RuntimeOperationsException;
import org.apache.tomcat.util.modeler.BaseModelMBean;
/**
* A convenience base class for ModelMBean implementations
* where the underlying base class (and therefore the set of supported
* properties) is different for varying implementations of a standard
* interface. For Catalina, that includes at least the following:
* Connector, Logger, Realm, and Valve. This class creates an artificial
* MBean attribute named className, which reports the fully
* qualified class name of the managed object as its value.
*
* @author Craig R. McClanahan
* @version $Id: ClassNameMBean.java 939305 2010-04-29 13:43:39Z kkolinko $
*/
public class ClassNameMBean extends BaseModelMBean {
// ---------------------------------------------------------- Constructors
/**
* Construct a ModelMBean with default
* ModelMBeanInfo information.
*
* @exception MBeanException if the initialize of an object
* throws an exception
* @exception RuntimeOperationsException if an IllegalArgumentException
* occurs
*/
public ClassNameMBean()
throws MBeanException, RuntimeOperationsException {
super();
}
// ------------------------------------------------------------ Properties
/**
* Return the fully qualified Java class name of the managed object
* for this MBean.
*/
@Override
public String getClassName() {
return (this.resource.getClass().getName());
}
}