weblogic.management.utils

Annotation Type Description

@Documented
 @Retention(value=RUNTIME)
 @Target(value={java.lang.annotation.ElementType.TYPE, java.lang.annotation.ElementType.METHOD, java.lang.annotation.ElementType.PARAMETER})
public @interface Description

Annotation used to specify localized descriptions for MBean, MBean attributes, MBean operations, MBean operation parameters and MBean notifications. See example below:

   @Description(resourceKey="myapp.resources.TestMXBean.description",
                   resourceBundleBaseName="myapp.resources.MBeanResources")
   public interface TestMXBean {
 
      @Description(resourceKey="myapp.resources.TestMXBean.threshold.description",
                      resourceBundleBaseName="myapp.resources.MBeanResources"  )
      public int getthreshold();
 
      @Description(resourceKey="myapp.resources.TestMXBean.reset.description",
                      resourceBundleBaseName="myapp.resources.MBeanResources")
      public int reset(
          @Description(resourceKey="myapp.resources.TestMXBean.reset.id.description",
                          resourceBundleBaseName="myapp.resources.MBeanResources",
                          displayNameKey="myapp.resources.TestMXBean.reset.id.displayName.description")
          int id);
  }
  

If an attribute is read/write, and therefore exposes both a getter and setter method, then it should only annotate one of those two methods.

Excluded in public API Reference.

Field Summary

Fields

Modifier and Type	Fields and Description
static java.lang.String	DESCRIPTION_DISPLAY_NAME_KEY
static java.lang.String	DESCRIPTION_RESOURCE_BUNDLE_BASE_NAME
static java.lang.String	DESCRIPTION_RESOURCE_KEY

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.String	resourceKey Contains the name of the resource key.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String	displayNameKey Contains the name of the key for displayName.
java.lang.String	resourceBundleBaseName Contains the fully qualified name for the resource bundle that contains the resource specified using the resourceKey.

Field Detail

DESCRIPTION_RESOURCE_KEY

public static final java.lang.String DESCRIPTION_RESOURCE_KEY

DESCRIPTION_DISPLAY_NAME_KEY

public static final java.lang.String DESCRIPTION_DISPLAY_NAME_KEY

DESCRIPTION_RESOURCE_BUNDLE_BASE_NAME

public static final java.lang.String DESCRIPTION_RESOURCE_BUNDLE_BASE_NAME

Element Detail

resourceKey

@DescriptorKey(value="descriptionResourceKey")
public abstract java.lang.String resourceKey

Contains the name of the resource key. This name should be prefixed by the fully qualified name for the MBean interface, For instance: "myapp.resources.TestMXBean.reset.description

displayNameKey

@DescriptorKey(value="descriptionDisplayNameKey")
public abstract java.lang.String displayNameKey

Contains the name of the key for displayName. This name should be prefixed by the fully qualified name for the MBean interface, For instance: "myapp.resources.TestMXBean.reset.displayName.description

Default:

""

resourceBundleBaseName

@DescriptorKey(value="descriptionResourceBundleBaseName")
public abstract java.lang.String resourceBundleBaseName

Contains the fully qualified name for the resource bundle that contains the resource specified using the resourceKey. For instance: myapp.resources.MBeanResources If the annotation doesn't apply to the MBean interface, then the resourceBundleBaseName can be omitted, in which case the resource bundle defined at the MBean interface level will be used.

Default:

""