com.axonivy.jmx

Annotation Type MOperation

@Retention(value=RUNTIME)
 @Target(value=METHOD)
 @Inherited
public @interface MOperation

Use this annotation to manage a method as operation of a MBean.

Example:

  @MBean
 public class MyBean
 {
   private int count;

    @MOperation
   private void increaseCounter()
   {
     return count++;
   }
 }

This bean provides an operation increaseCounter

You can use EL expressions to dynamically resolve the name and description of the managed operation.
E.g. #{name} will be replaced by the value of the field name if it exists or the value returned by method getName().
Also complex expressions like #{pmv.application.name} works.

Example:

   @MBean(value="Test:type=TestType")
  public class TestBean
  {
     @MInclude
    private Counter errors = new Counter("errors");
  }

  public static class Counter
  {
    private int cnt=0;

    private String name;

    public Counter(String name)
    {
      this.name = name;
    }

    public String getCapitalizedName()
    {
      return StringUtils.capitalize(name);
    }

     @MOperation(name="reset#{capitalizedName}", description="Resets the #{name} counter")
    public void resetCnt()
    {
      cnt = 0;
    }
  }
 

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	description
MOperation.Impact	impact
String	name
String[]	paramDescriptions
String[]	params

Element Detail

name

public abstract String name

Default:

""

description

public abstract String description

Default:

""

params

public abstract String[] params

Returns:

names of the operation's parameters

Default:

{}

paramDescriptions

public abstract String[] paramDescriptions

Returns:

descriptions of the operation's parameters

Default:

{}

impact

public abstract MOperation.Impact impact

Returns:

impact of the operation

See Also:

MBeanOperationInfo.getImpact()

Default:

com.axonivy.jmx.MOperation.Impact.UNKNOWN