/*
* Copyright 2011 Red Hat, Inc. and/or its affiliates.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
* 02110-1301 USA
*/
package org.infinispan.configuration.global;
import java.util.Properties;
import org.infinispan.jmx.MBeanServerLookup;
import org.infinispan.jmx.PlatformMBeanServerLookup;
import org.infinispan.util.TypedProperties;
import org.infinispan.util.Util;
/**
* Configures whether global statistics are gathered and reported via JMX for all caches under this cache manager.
*/
public class GlobalJmxStatisticsConfigurationBuilder extends AbstractGlobalConfigurationBuilder<GlobalJmxStatisticsConfiguration> {
private Properties properties = new Properties();
private String jmxDomain = "org.infinispan";
private Boolean allowDuplicateDomains= false;
private String cacheManagerName = "DefaultCacheManager";
private MBeanServerLookup mBeanServerLookupInstance = Util.getInstance(PlatformMBeanServerLookup.class);
private boolean enabled = false;
GlobalJmxStatisticsConfigurationBuilder(GlobalConfigurationBuilder globalConfig) {
super(globalConfig);
}
/**
* Sets properties which are then passed to the MBean Server Lookup implementation specified.
*
* @param properties properties to pass to the MBean Server Lookup
*/
public GlobalJmxStatisticsConfigurationBuilder withProperties(Properties properties) {
this.properties = properties;
return this;
}
public GlobalJmxStatisticsConfigurationBuilder addProperty(String key, String value) {
properties.put(key, value);
return this;
}
/**
* If JMX statistics are enabled then all 'published' JMX objects will appear under this name.
* This is optional, if not specified an object name will be created for you by default.
*
* @param jmxDomain
*/
public GlobalJmxStatisticsConfigurationBuilder jmxDomain(String jmxDomain) {
this.jmxDomain = jmxDomain;
return this;
}
/**
* If true, multiple cache manager instances could be configured under the same configured JMX
* domain. Each cache manager will in practice use a different JMX domain that has been
* calculated based on the configured one by adding an incrementing index to it.
*
* @param allowDuplicateDomains
*/
public GlobalJmxStatisticsConfigurationBuilder allowDuplicateDomains(Boolean allowDuplicateDomains) {
this.allowDuplicateDomains = allowDuplicateDomains;
return this;
}
/**
* If JMX statistics are enabled, this property represents the name of this cache manager. It
* offers the possibility for clients to provide a user-defined name to the cache manager
* which later can be used to identify the cache manager within a JMX based management tool
* amongst other cache managers that might be running under the same JVM.
*
* @param cacheManagerName
*/
public GlobalJmxStatisticsConfigurationBuilder cacheManagerName(String cacheManagerName) {
this.cacheManagerName = cacheManagerName;
return this;
}
/**
* Sets the instance of the {@link org.infinispan.jmx.MBeanServerLookup} class to be used to bound JMX MBeans to.
*
* @param mBeanServerLookupInstance An instance of {@link org.infinispan.jmx.MBeanServerLookup}
*/
public GlobalJmxStatisticsConfigurationBuilder mBeanServerLookup(MBeanServerLookup mBeanServerLookupInstance) {
this.mBeanServerLookupInstance = mBeanServerLookupInstance;
return this;
}
public GlobalJmxStatisticsConfigurationBuilder disable() {
this.enabled = false;
return this;
}
public GlobalJmxStatisticsConfigurationBuilder enable() {
this.enabled = true;
return this;
}
public GlobalJmxStatisticsConfigurationBuilder enabled(boolean enabled) {
this.enabled = enabled;
return this;
}
@Override
void validate() {
// No-op, no validation required
}
@Override
GlobalJmxStatisticsConfiguration create() {
return new GlobalJmxStatisticsConfiguration(enabled, jmxDomain, mBeanServerLookupInstance, allowDuplicateDomains, cacheManagerName, TypedProperties.toTypedProperties(properties));
}
@Override
GlobalJmxStatisticsConfigurationBuilder read(GlobalJmxStatisticsConfiguration template) {
this.allowDuplicateDomains = template.allowDuplicateDomains();
this.cacheManagerName = template.cacheManagerName();
this.enabled = template.enabled();
this.jmxDomain = template.domain();
this.mBeanServerLookupInstance = template.mbeanServerLookup();
this.properties = template.properties();
return this;
}
@Override
public String toString() {
return "GlobalJmxStatisticsConfigurationBuilder{" +
"allowDuplicateDomains=" + allowDuplicateDomains +
", properties=" + properties +
", jmxDomain='" + jmxDomain + '\'' +
", cacheManagerName='" + cacheManagerName + '\'' +
", mBeanServerLookupInstance=" + mBeanServerLookupInstance +
", enabled=" + enabled +
'}';
}
@Override
public boolean equals(Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
GlobalJmxStatisticsConfigurationBuilder that = (GlobalJmxStatisticsConfigurationBuilder) o;
if (enabled != that.enabled) return false;
if (allowDuplicateDomains != null ? !allowDuplicateDomains.equals(that.allowDuplicateDomains) : that.allowDuplicateDomains != null)
return false;
if (cacheManagerName != null ? !cacheManagerName.equals(that.cacheManagerName) : that.cacheManagerName != null)
return false;
if (jmxDomain != null ? !jmxDomain.equals(that.jmxDomain) : that.jmxDomain != null)
return false;
if (mBeanServerLookupInstance != null ? !mBeanServerLookupInstance.equals(that.mBeanServerLookupInstance) : that.mBeanServerLookupInstance != null)
return false;
if (properties != null ? !properties.equals(that.properties) : that.properties != null)
return false;
return true;
}
@Override
public int hashCode() {
int result = properties != null ? properties.hashCode() : 0;
result = 31 * result + (jmxDomain != null ? jmxDomain.hashCode() : 0);
result = 31 * result + (allowDuplicateDomains != null ? allowDuplicateDomains.hashCode() : 0);
result = 31 * result + (cacheManagerName != null ? cacheManagerName.hashCode() : 0);
result = 31 * result + (mBeanServerLookupInstance != null ? mBeanServerLookupInstance.hashCode() : 0);
result = 31 * result + (enabled ? 1 : 0);
return result;
}
}