fish.payara.monitoring.rest.app.MBeanServerDelegate Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of payara-client Show documentation
Appclient for Payara Server
The newest version!
/**
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) [2016-2021] Payara Foundation and/or its affiliates. All rights reserved.
 *
 * 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://github.com/payara/Payara/blob/main/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/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * The Payara Foundation designates this particular file as subject to the "Classpath"
 * exception as provided by the Payara Foundation in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [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 fish.payara.monitoring.rest.app;

import static java.lang.management.ManagementFactory.getPlatformMBeanServer;

import jakarta.ejb.Startup;
import jakarta.inject.Singleton;
import javax.management.AttributeList;
import javax.management.AttributeNotFoundException;
import javax.management.InstanceNotFoundException;
import javax.management.IntrospectionException;
import javax.management.MBeanException;
import javax.management.MBeanInfo;
import javax.management.MBeanServer;
import javax.management.MalformedObjectNameException;
import javax.management.ObjectName;
import javax.management.ReflectionException;

/**
 *
 * @author Fraser Savage
 */
@Startup
@Singleton
public class MBeanServerDelegate {

    /**
     * The reference the delegate holds to the MBeanServer instance.
     */
    private final MBeanServer platformServer;

    public MBeanServerDelegate() {
        platformServer = getPlatformMBeanServer();
    }

    /**
     * Returns an {@link MBeanInfo} object. 
     * The mbeanname argument must be a valid {@link ObjectName}.
     * 
     * @param mbeanname The value of the MBean {@link ObjectName}.
     * @return The instance of {@link MBeanInfo} returned for the mbeanname provided.
     * @throws InstanceNotFoundException {@inheritDoc} 
     * @throws IntrospectionException {@inheritDoc}
     * @throws ReflectionException {@inheritDoc}
     * @throws MalformedObjectNameException {@inheritDoc}
     */
    public MBeanInfo getMBean(String mbeanname) throws InstanceNotFoundException, IntrospectionException, ReflectionException, MalformedObjectNameException {
        return platformServer.getMBeanInfo(getMBeanName(mbeanname));
    }
  
    /**
     * Returns an MBean attribute in the form of an {@link Object}. 
     * The mbeanname argument must be a valid {@link ObjectName}. The attributename
     * argument is a specifier relative to the mbeanname argument. 
     * 
     * @param mbeanname The value of the MBean {@link ObjectName}
     * @param attributename The name of the attribute to get from the mbeanname on the {@link MBeanServer}.
     * @return The {@link Object} representing the MBean attribute requested.
     * @throws MBeanException {@inheritDoc}
     * @throws AttributeNotFoundException {@inheriDoc}
     * @throws InstanceNotFoundException {@inheritDoc}
     * @throws ReflectionException {@inheritDoc}
     * @throws MalformedObjectNameException {@inheritDoc}
     */
    public Object getMBeanAttribute(String mbeanname, String attributename) throws MBeanException, AttributeNotFoundException, InstanceNotFoundException, ReflectionException, MalformedObjectNameException {
        return platformServer.getAttribute(getMBeanName(mbeanname), attributename);
    }

    /**
     * Retrieves the values of several attributes of a named MBean. The MBean is identified by its object name.
     * If one or more attributes cannot be retrieved for some reason, they will be omitted from the returned
     * {@code AttributeList}.
     *
     * @param mbeanname
     *            The object name of the MBean from which the attributes are retrieved.
     * @param attributenames
     *            A list of the attributes to be retrieved.
     * @return The list of the retrieved attributes.
     * @throws InstanceNotFoundException
     *             {@inheritDoc}
     * @throws MalformedObjectNameException
     *             {@inheritDoc}
     * @throws ReflectionException
     *             {@inheritDoc}
     */
    public AttributeList getMBeanAttributes(final String mbeanname, final String[] attributenames)
            throws InstanceNotFoundException, MalformedObjectNameException, ReflectionException {
        return platformServer.getAttributes(getMBeanName(mbeanname), attributenames);
    }

    /**
     * Returns an {@link ObjectName}.
     * The mbeanname argument must be a valid {@link ObjectName}.
     * 
     * @param mbeanname The value of the {@link ObjectName} to get an instance of.
     * @return The {@link ObjectName} corresponding to the mbeanname argument.
     * @throws MalformedObjectNameException {@inheritDoc}
     */
    private ObjectName getMBeanName(String mbeanname) throws MalformedObjectNameException {
        return new ObjectName(mbeanname); 
    }
}