org.weakref.jmx.ObjectNames Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jmxutils Show documentation
Exporting JMX mbeans made easy
There is a newer version: 1.26
package org.weakref.jmx;

import com.google.inject.name.Named;

import java.lang.annotation.Annotation;

import static java.lang.String.format;

/**
 * Generate JMX object names.
 */
public class ObjectNames {

  /**
   * Produce a standardized JMX object name.
   * 
   * @param clazz
   * @return JMX object name of the form "[package_name]:name=[class_name]"
   */
  public static String generatedNameOf(Class clazz) {
    return format("%s:name=%s", 
        clazz.getPackage().getName(),
        clazz.getSimpleName());
  }
  
  /**
   * Produce a generated JMX object name.
   * 
   * @param clazz
   * @param annotation
   * @return JMX object name of the form "[package_name]:type=[class_name],name=[ann_class_name]"
   */
  public static String generatedNameOf(Class clazz, Annotation annotation) {
    return format("%s:type=%s,name=%s", 
        clazz.getPackage().getName(),
        clazz.getSimpleName(),
        annotation.annotationType().getSimpleName());
  }
  
  /**
   * Produce a generated JMX object name.
   * 
   * @param clazz
   * @param annotationClass
   * @return JMX object name of the form "[package_name]:type=[class_name],name=[ann_class_name]"
   */
  public static String generatedNameOf(Class clazz, Class annotationClass) {
    return format("%s:type=%s,name=%s", 
        clazz.getPackage().getName(),
        clazz.getSimpleName(),
        annotationClass.getSimpleName());
  }
  
  /**
   * Produce a generated JMX object name.
   * 
   * @param clazz
   * @param named
   * @return JMX object name of the form "[package_name]:type=[class_name],name=[named_value]"
   */
  public static String generatedNameOf(Class clazz, Named named)
  {
      return generatedNameOf(clazz, named.value());
  }

    /**
     * Produce a generated JMX object name.
     *
     * @param clazz
     * @param name
     * @return JMX object name of the form "[package_name]:type=[class_name],name=[named_value]"
     */
    public static String generatedNameOf(Class clazz, String name)
    {
        return format("%s:type=%s,name=%s",
                clazz.getPackage().getName(),
                clazz.getSimpleName(),
                quoteValueIfNecessary(name));
    }

    static String quoteValueIfNecessary(String name)
    {
        boolean needQuote = false;
        StringBuilder builder = new StringBuilder("\"");
        for (int i = 0; i < name.length(); ++i) {
            char c = name.charAt(i);
            switch (c) {
                case ':':
                case ',':
                case '=':
                    needQuote = true;
                    builder.append(c);
                    break;
                case '\"':
                case '?':
                case '*':
                    needQuote = true;
                    builder.append('\\');
                    builder.append(c);
                    break;
                case '\n':
                    needQuote = true;
                    builder.append("\\n");
                    break;
                case '\\':
                    builder.append("\\\\");
                    break;
                default:
                    builder.append(c);
            }
        }

        if (needQuote) {
            name = builder.append('\"').toString();
        }
        return name;
    }

    public static ObjectNameBuilder builder(Class clazz)
    {
        return new ObjectNameBuilder(clazz.getPackage().getName())
                .withProperty("name", clazz.getSimpleName());
    }

    public static ObjectNameBuilder builder(Class clazz, Annotation annotation)
    {
        return new ObjectNameBuilder(clazz.getPackage().getName())
                .withProperty("type", clazz.getSimpleName())
                .withProperty("name", annotation.annotationType().getSimpleName());
    }

    public static ObjectNameBuilder builder(Class clazz, Class annotationClass)
    {
        return new ObjectNameBuilder(clazz.getPackage().getName())
                .withProperty("type", clazz.getSimpleName())
                .withProperty("name", annotationClass.getSimpleName());
    }

    public static ObjectNameBuilder builder(Class clazz, Named named)
    {
        return new ObjectNameBuilder(clazz.getPackage().getName())
                .withProperty("type", clazz.getSimpleName())
                .withProperty("name", named.value());
    }
}