io.hekate.core.jmx.JmxServiceFactory Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hekate-all Show documentation
Java library for cluster communications and computing.
There is a newer version: 4.1.3
/*
 * Copyright 2020 The Hekate Project
 *
 * The Hekate Project 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 io.hekate.core.jmx;

import io.hekate.core.jmx.internal.DefaultJmxService;
import io.hekate.core.service.ServiceFactory;
import io.hekate.util.format.ToString;
import java.lang.management.ManagementFactory;
import javax.management.MBeanServer;
import javax.management.ObjectName;

/**
 * Factory for {@link JmxService}.
 */
public class JmxServiceFactory implements ServiceFactory {
    /** Default value ({@value}) for {@link #setDomain(String)}. */
    public static final String DEFAULT_DOMAIN = "io.hekate";

    /** See {@link #setDomain(String)}. */
    private String domain = DEFAULT_DOMAIN;

    /** See {@link #setServer(MBeanServer)}. */
    private MBeanServer server = defaultServer();

    @Override
    public JmxService createService() {
        return new DefaultJmxService(this);
    }

    /**
     * Returns the JMX domain (see {@link #setDomain(String)}).
     *
     * @return JMX domain.
     */
    public String getDomain() {
        return domain;
    }

    /**
     * Sets the JMX domain.
     *
     * 
     * Value of this parameter is used as a JMX domain name when constructing {@link ObjectName}s for JMX components.
     * 
     *
     * 
     * Default value of this parameter is {@value #DEFAULT_DOMAIN}.
     * 
     *
     * @param domain JMX domain.
     */
    public void setDomain(String domain) {
        this.domain = domain;
    }

    /**
     * Fluent-style version of {@link #setDomain(String)}.
     *
     * @param domain JMX domain.
     *
     * @return This instance.         T
     */
    public JmxServiceFactory withDomain(String domain) {
        setDomain(domain);

        return this;
    }

    /**
     * Returns the MBean server (see {@link MBeanServer}).
     *
     * @return MBean server.
     */
    public MBeanServer getServer() {
        return server;
    }

    /**
     * Sets the MBean server that should be used by the {@link JmxService} to register JMX beans.
     *
     * 
     * This parameter is optional and if not specified then the {@link ManagementFactory#getPlatformMBeanServer()} will be used by default.
     * 
     *
     * @param server MBean server.
     */
    public void setServer(MBeanServer server) {
        this.server = server == null ? defaultServer() : server;
    }

    /**
     * Fluent-style version of {@link #setServer(MBeanServer)}.
     *
     * @param server MBean server.
     *
     * @return This instance.
     */
    public JmxServiceFactory withServer(MBeanServer server) {
        setServer(server);

        return this;
    }

    private static MBeanServer defaultServer() {
        return ManagementFactory.getPlatformMBeanServer();
    }

    @Override
    public String toString() {
        return ToString.format(this);
    }
}