Module JMX- Add MBean Operations Action - UI Specification

Authors: Alexandre Neubert, Thomas Leveque,  Jean-Francois Denise

Add MBean Operations Action

This action helps user in generating code to add MBean operations to an existing MBean.

This action results in some generated code at the end of selected MBean class and the MBean interface.

The action is enabled for all MBean class which follow the Standard MBean design pattern.

Call the Action

Current module actions are located under Run menu. We could introduce a new Management menu if the set of actions requires it.
This ui spec defines a new Management menu. It could be replaced by a Management submenu under Tools.

• From contextual menu :
• The Add MBean Operations Emitter action is called by right click on a MBean class in the project view.
• Select Management submenu. Select the Add MBean Operations... item.

• From main menu :
• Management menu  then select the Add MBean Operations... item.

 

Scope of the action

This action should be accessible from any kind of project. 

Action Popup window

This popup windows allows user to provide for each added operation :

• A name
• A description
• A return type
• Some parameters
• Some exceptions
  

This popup appears with all already existing MBean operations These operations are not editable and the user can't select them.
The Remove Operation button is disabled.

A message notify the user that he have to add at least one new operation. The Add Operation button is enabled.

Ok button is enabled when at least one operation is specified and there aren't two operations with same names and signatures.

Add an Operation

The user can do it in two ways  :

• Click on Add Operation button.
• Type ALT + A keys.

A new Row appears with default values.

Remove an Operation

The user can do it in two ways after selecting the row to remove :

• Click on Remove Operation button.
• Type ALT + R keys.

The selected Row disappears and the next row is selected.

Specify Name

The user can directly type a new name in the TextField.

Specify Return Type

The user can do it in two ways  :

• Type a class name.
• Select one of proposed types.

Specify Description

The user can directly type a new description in the TextField.

Specify Parameters

The user is allowed to change the operation parameters.

He must click on the Edit button.

A popup titled Edit Parameters appears. It is the same workflow than in the MBean wizard.

Specify Exceptions

The user is allowed to change the operation exceptions.

He must click on the Edit button.

A popup titled Edit Exceptions appears. It is the same workflow than in the MBean wizard.

Special Case : A method for an operation already exists

A warning message appears in a new popup to notify the user.
The generation is performed only if the user click on Ok button.