net.sf.ehcache.hibernate.management.impl.EhcacheHibernateMbeanNames Maven / Gradle / Ivy

/**
 *  Copyright Terracotta, Inc.
 *
 *  Licensed 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 net.sf.ehcache.hibernate.management.impl;

import javax.management.MalformedObjectNameException;
import javax.management.ObjectName;

/**
 * Utility class used for getting {@link ObjectName}'s for ehcache hibernate MBeans
 *
 * 
 *
 * @author Abhishek Sanoujam
 * @since 1.7
 *
 */
public abstract class EhcacheHibernateMbeanNames {

    /**
     * Group id for all sampled mbeans registered
     */
    public static final String GROUP_ID = "net.sf.ehcache.hibernate";

    /**
     * Type for the ehcache backed hibernate second level cache statistics mbean
     */
    public static final String EHCACHE_HIBERNATE_TYPE = "EhcacheHibernateStats";

    /**
     * Filter out invalid ObjectName characters from s.
     *
     * @param s
     * @return A valid JMX ObjectName attribute value.
     */
    public static String mbeanSafe(String s) {
        return s == null ? "" : s.replaceAll(",|:|=|\n", ".");
      }

    /**
     * Returns an ObjectName for the passed name
     *
     * @param name
     * @return An {@link ObjectName} using the input name of cache manager
     * @throws MalformedObjectNameException
     */
    public static ObjectName getCacheManagerObjectName(String cacheManagerClusterUUID, String name) throws MalformedObjectNameException {
        ObjectName objectName = new ObjectName(GROUP_ID + ":type=" + EHCACHE_HIBERNATE_TYPE + ",name=" + mbeanSafe(name)
                + getBeanNameSuffix(cacheManagerClusterUUID));
        return objectName;
    }

    private static String getBeanNameSuffix(String cacheManagerClusterUUID) {
        String suffix = "";
        if (!isBlank(cacheManagerClusterUUID)) {
            suffix = ",node=" + cacheManagerClusterUUID;
        }
        return suffix;
    }

    private static boolean isBlank(String param) {
        return param == null || "".equals(param.trim());
    }
}