AbstractJmxModule.java

/*
 * Licensed to ElasticSearch and Shay Banon under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. ElasticSearch 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.elasticsearch.jmx;

import org.elasticsearch.common.inject.AbstractModule;
import org.elasticsearch.common.settings.Settings;

/**
 * Simple based class for JMX related services with {@link #doConfigure()} only being called if
 * jmx is enabled.
 */
public abstract class AbstractJmxModule extends AbstractModule {

    private final Settings settings;

    protected AbstractJmxModule(Settings settings) {
        this.settings = settings;
    }

    @Override
    protected void configure() {
        if (JmxService.shouldExport(settings)) {
            doConfigure();
        }
    }

    protected abstract void doConfigure();
}