Examples of mx4j.tools.i18n.I18NStandardMBean

mx4j.tools.i18n.I18NStandardMBean
An extension of StandardMBean to support internationalization.

The I18N information is taken from a property bundle named MyImplMBeanResources where "MyImpl" is the fully qualified class implementing the MBean.
These bundles are nested following the class hierachy of the implementation class. This means that a superclass of the real implementing class can define the resource bundle for the common attributes and operations.
The resource bundle naming rules defined by {@link java.util.ResourceBundle}are used; in particular :
- If a class called MyPackage.MyImplMBeanResources_localInfo exists it is used (programmatic methd)
- Otherwise the file called MyPackage.MyImplMBeanResources_localInfo.properties is used.
localInfo consists of one or more sections of "language_country_variant" (eg en_GB or fr_FR).
The locale to be used is determined by one of the following mechanisms (in this order)
- The locale object explicitly passed to the constructor (if not null)
- The static method {@link #setDefaultLocale}
- The system property "mx4j.descriptionLocale"
- The current system default locale
The bundle should contain keys as described below :
Global bean description
The global bean description is given by the single key "descr":
```
 descr=The MBean Description 
```
Attributes
Attribute desciptions are given by keys of form "attr.Name" where Name is the attribute name (the method name minus the get/set prefix) :
```
 attr.Counter=The counter 
```
Constructors

Non ambiguous case
All constructors having a different number of arguments may be described in this way:
```
 cons.N=desciption of constructor N cons.N.param.1=Description of first parameter of constructor N cons.N.paramName.1=paramName1 cons.N.param.2=Description of first parameter of constructor N cons.N.paramName.2=paramName2 
```
Where N is a sequential number starting at one.

Ambiguous case
Where several constructors exist with the same number of arguments an explicit signature must be given. The signature is a comma separated list of class descriptions (as returned by {@link java.lang.Class#getName} and has the key cons.N.sig :
```
cons.N.sig=int,java.lang.Object cons.N.param.1=The int parameter cons.N.param.2=The Object parameter 
```
Operations

No overloading
When no overloaded versions of an operation exist (same method name but different parameters) the simplest case shown below can be used :
```
 op.operationName=The description op.operationName.param.1=The first parameter op.operationName.paramName.1=param1 
```
Non ambiguous overloading case
When operation overloading is used but the overloaded versions differ in the number of parameters the format below can be used :
```
 op.operationName.1=The first version of operationName op.operationName.1.param.1=parameter for first version op.operationName.1.paramName.1=param1 op.operationName.2=The second version of operationName op.operationName.2.paramName.1=param1 op.operationName.2.param.1=first parameter for second version op.operationName.2.param.2=second parameter for second version op.operationName.2.paramName.2=param2 
```
Ambiguous overloading case
When operations with the same name have the same number of arguments an explicit signature must be used :
```
 op.operationName.1.sig=int op.operationName.1=The first version of operationName (takes int) op.operationName.1.param.1=parameter for first version op.operationName.1.paramName.1=param1 op.operationName.2.sig=java.lang.Object op.operationName.2=The second version of operationName (take Object) op.operationName.2.paramName.1=param1 op.operationName.2.param.1=first parameter for second version 
```
Restrictions
Parameter names must only contain characters allowed in a Java identifier (in particular spaces are not allowed). This is required by the JMX specifications. No such restrictions exist for the other descriptions.

Behaviour with missing data
If no resource bunde exists for the MBean a java.util.MissingResourceException will be thrown by the constructor.

If the resouce bundle is found but the bean description, constructor description or parameter name is missing the String "??(key)" will be returned instead (eg "??(op.myOperation)".

If a paramName key is missing (for constructor or operation) the version normally given by StandardMBean is used (generally "pN").

If a non ambiguous description cannot be determined the fixed (non translatable) descriptions "ambiguous constructor", "parameter for ambiguous constructor", "ambiguous operation", "parameter for ambiguous operation" are returned.

    */
   public void testSubclassSource() throws Exception
   {
      // No system property, standard locale with no I18N => default file
      setDefaultLocale(Locale.ITALY); // no I18N files for this
      I18NStandardMBean mbean =
              new I18NStandardMBeanSupport.SubclassNameOnly();
      MBeanInfo info = mbean.getMBeanInfo();
      assertEquals(info.getDescription(),
                   "The default subclassed name only MBean description");


      // Explicitly requested locale (overrides system default locale)
      setDefaultLocale(Locale.ENGLISH);
      mbean = new I18NStandardMBeanSupport.SubclassNameOnly(Locale.FRENCH);
      info = mbean.getMBeanInfo();
      assertEquals(info.getDescription(),
                   "The French subclassed name only MBean description");


      // system default locale
      mbean = new I18NStandardMBeanSupport.SubclassNameOnly();
      info = mbean.getMBeanInfo();
      assertEquals(info.getDescription(),
                   "The English subclassed name only MBean description");


      // system property (overrides default locale)
      setLocaleProp("fr_FR");
      mbean = new I18NStandardMBeanSupport.SubclassNameOnly();
      info = mbean.getMBeanInfo();
      assertEquals(info.getDescription(),
                   "The French subclassed name only MBean description");


      // static setLocale method (overrides default locale)
      I18NStandardMBean.setDefaultLocale(Locale.ENGLISH);
      mbean = new I18NStandardMBeanSupport.SubclassNameOnly();
      info = mbean.getMBeanInfo();
      assertEquals(info.getDescription(),
                   "The English subclassed name only MBean description");
   }

View Full Code Here

      I18NStandardMBeanSupport.ImplementationNameOnly impl =
              new I18NStandardMBeanSupport.ImplementationNameOnly();


      // No system property, standard locale with no I18N => default file
      setDefaultLocale(Locale.ITALY); // no I18N files for this
      I18NStandardMBean mbean =
              new I18NStandardMBean(impl,
                                    I18NStandardMBeanSupport.FullManagement.class);
      MBeanInfo info = mbean.getMBeanInfo();
      assertEquals(info.getDescription(),
                   "The default direct implementation name only MBean description");


      // Explicitly requested locale (overrides system default locale)
      setDefaultLocale(Locale.ENGLISH);
      mbean =
      new I18NStandardMBean(impl,
                            I18NStandardMBeanSupport.FullManagement.class,
                            Locale.FRENCH);
      info = mbean.getMBeanInfo();
      assertEquals(info.getDescription(),
                   "The French direct implementation name only MBean description");


      // system default locale
      mbean =
      new I18NStandardMBean(impl,
                            I18NStandardMBeanSupport.FullManagement.class);
      info = mbean.getMBeanInfo();
      assertEquals(info.getDescription(),
                   "The English direct implementation name only MBean description");


      // system property (overrides default locale)
      setLocaleProp("fr_FR");
      mbean =
      new I18NStandardMBean(impl,
                            I18NStandardMBeanSupport.FullManagement.class);
      info = mbean.getMBeanInfo();
      assertEquals(info.getDescription(),
                   "The French direct implementation name only MBean description");


      // static setLocale method (overrides default locale)
      I18NStandardMBean.setDefaultLocale(Locale.ENGLISH);
      mbean =
      new I18NStandardMBean(impl,
                            I18NStandardMBeanSupport.FullManagement.class);
      info = mbean.getMBeanInfo();
      assertEquals(info.getDescription(),
                   "The English direct implementation name only MBean description");
   }

View Full Code Here

    * Locale switching already tested above so just use a single locale here.
    * Only test "simple" constuctors and operations that do not require signatures.
    */
   public void testAllKeys() throws Exception
   {
      I18NStandardMBean mbean =
              new I18NStandardMBeanSupport.SubclassComplete();
      MBeanInfo info = mbean.getMBeanInfo();
      info = mbean.getMBeanInfo(); // ensure cache OK
      assertEquals(info.getDescription(),
                   "The default subclassed complete MBean description");
      MBeanAttributeInfo attrInfo = info.getAttributes()[0];
      assertEquals(attrInfo.getDescription(), "The attribute description");
      MBeanOperationInfo opInfo = info.getOperations()[0];

View Full Code Here

   /**
    * Various tests of constructors that need to be destinguished by their signatures.
    */
   public void testOverloadedConstructors() throws Exception
   {
      I18NStandardMBean mbean =
              new I18NStandardMBeanSupport.SubclassOverload();
      MBeanInfo info = mbean.getMBeanInfo();
      info = mbean.getMBeanInfo(); // ensure cache OK
      //dumpConstructors(info);
      MBeanConstructorInfo[] cstrs = info.getConstructors();
      assertEquals(cstrs.length, 6);
      Map mapCstrForDesc = makeFeatureMap(cstrs);

View Full Code Here

    * Various tests of ambiguous constructors
    */
   public void testAmbiguousConstructors() throws Exception
   {
      System.out.println("****");
      I18NStandardMBean mbean =
              new I18NStandardMBeanSupport.SubclassAmbiguousConstructors();
      MBeanInfo info = mbean.getMBeanInfo();
      info = mbean.getMBeanInfo(); // ensure cache OK
      //dumpConstructors(info);


      MBeanConstructorInfo[] cstrs = info.getConstructors();
      assertEquals(cstrs.length, 7);
      Map mapCstrForDesc = makeFeatureMap(cstrs);

View Full Code Here

   /**
    * Various tests of operations that need to be destinguished by their signatures.
    */
   public void testOverloadedOperations() throws Exception
   {
      I18NStandardMBean mbean =
              new I18NStandardMBeanSupport.SubclassOverload();
      MBeanInfo info = mbean.getMBeanInfo();
      info = mbean.getMBeanInfo(); // ensure cache OK
      MBeanOperationInfo[] ops = info.getOperations();
      //dumpOperations(info);
      assertEquals(ops.length, 8);
      Map mapOpsForDesc = makeFeatureMap(ops);

View Full Code Here

   /**
    * Various tests of ambiguous operations.
    */
   public void testAmbiguousOperations() throws Exception
   {
      I18NStandardMBean mbean =
              new I18NStandardMBeanSupport.SubclassAmbiguousOperation();
      MBeanInfo info = mbean.getMBeanInfo();
      info = mbean.getMBeanInfo(); // ensure cache OK
      //dumpOperations(info);
      MBeanOperationInfo[] ops = info.getOperations();
      assertEquals(ops.length, 8);
      Map mapOpsForDesc = makeFeatureMap(ops);
      assertEquals(mapOpsForDesc.size(), 3); // 5 ambiguous mapped to same

View Full Code Here

    * Tests missing translations (but bundle found).
    */
   public void testPartialDesciptions() throws Exception
   {
      setDefaultLocale(Locale.ITALY); // no I18N files for this
      I18NStandardMBean mbean =
              new I18NStandardMBeanSupport.SubclassNameOnly();
      MBeanInfo info = mbean.getMBeanInfo();
      info = mbean.getMBeanInfo(); // ensure cache OK
      assertEquals(info.getDescription(),
                   "The default subclassed name only MBean description");
      MBeanAttributeInfo attrInfo = info.getAttributes()[0];
      assertEquals(attrInfo.getDescription(), "??(attr.Attrib)");
      MBeanOperationInfo opInfo = info.getOperations()[0];

View Full Code Here

    */
   public void testMissingBundle() throws Exception
   {
      try
      {
         I18NStandardMBean mbean =
                 new I18NStandardMBeanSupport.SubclassNoBundle();
         assertTrue(false);
      }
      catch (MissingResourceException e)
      {
      }


      try
      {
         I18NStandardMBeanSupport.ImplementationNoBundle impl =
                 new I18NStandardMBeanSupport.ImplementationNoBundle();
         I18NStandardMBean mbean =
                 new I18NStandardMBean(impl,
                                       I18NStandardMBeanSupport.FullManagement.class);
         MBeanInfo info = mbean.getMBeanInfo();
         assertTrue(false);
      }
      catch (MissingResourceException e)
      {
      }

View Full Code Here

TOP

Related Classes of mx4j.tools.i18n.I18NStandardMBean

test.mx4j.tools.i18n.I18NStandardMBeanTest

javax.management.MBeanInfo

java.util.MissingResourceException

javax.management.MBeanOperationInfo

java.util.StringTokenizer

java.util.Locale

javax.management.MBeanConstructorInfo

java.util.ResourceBundle

java.util.HashSet

java.util.HashMap

All source code are property of their respective owners. Java is a trademark of Sun Microsystems, Inc and owned by ORACLE Inc. Contact coftware#gmail.com.

Examples of mx4j.tools.i18n.I18NStandardMBean

Global bean description

Attributes

Constructors

Non ambiguous case

Ambiguous case

Operations

No overloading

Non ambiguous overloading case

Ambiguous overloading case

Restrictions

Behaviour with missing data

Related Classes of mx4j.tools.i18n.I18NStandardMBean