Difference between revisions of "Jmx-call"

From GreenVulcano Wiki
Jump to: navigation, search
(Created page with "==Description== ''jmx-call'' is the JMX VCL plugin to invoke MBean methods or set/get attributes on local servers. =={{VULCON}} / {{GVCONSOLE}} Configuration== The ''jmx-call'...")
 
 
(7 intermediate revisions by 2 users not shown)
Line 6: Line 6:
  
 
The ''jmx-call'' Element is used by [[Channel]] and [[routed-call]]. It has the following attributes:
 
The ''jmx-call'' Element is used by [[Channel]] and [[routed-call]]. It has the following attributes:
 +
{|class="gvtable"
 +
! Attribute !! Type !! Description
 +
|-
 +
| type || fixed || This attribute must assume the value '''call'''.
 +
|-
 +
| class || fixed || This attribute must assume the value '''it.greenvulcano.gvesb.virtual.jmx.JMXCallOperation'''.
 +
|-
 +
| name || required || Operation name. Used in the 'Flow' section to associate workflow nodes to VCL operations.
 +
|-
 +
| object-name || required || Defines an object name filter to invoke/set/get via JMX server. Can contains [[placeholders]]
 +
|}
  
−
* ''type'': call.
+
It subelements are:  
−
* ''class'': it.greenvulcano.gvesb.virtual.jmx.JMXCallOperation.
 
−
* ''name'': Operation name. Used in the 'Flow' section to associate workflow nodes to VCL operations.
 
−
* ''object-name'': Defines an object name filter to invoke/set/get via JMX server. Can contains [[placeholders]]
 
−
 
 
−
and the subelements:  
 
−
 
 
 
* Description,
 
* Description,
−
* (invoke-method | set-attribute | get-attribute)
+
* [[#invoke-method|invoke-method]] | [[#set-attribute|set-attribute]] | [[#get-attribute|get-attribute]]
  
−
==invoke-method==
+
===invoke-method===
  
 
This element invokes a method to the MBean. It is only used by ''jmx-call''.
 
This element invokes a method to the MBean. It is only used by ''jmx-call''.
  
 
It has the following attributes:
 
It has the following attributes:
 +
{|class="gvtable"
 +
! Attribute !! Type !! Description
 +
|-
 +
| type || fixed || This attribute must assume the value '''method'''.
 +
|-
 +
| class || fixed || This attribute must assume the value '''it.greenvulcano.gvesb.virtual.jmx.methods.JMXInvokeOperation'''
 +
|-
 +
| method || required || MBean's method to invoke.
 +
|}
 +
 +
Its subelement are:
 +
* [[#invoke-parameter|invoke-parameter]]
  
−
* ''type'': method.
+
====invoke-parameter====
−
* ''class'': it.greenvulcano.gvesb.virtual.jmx.methods.JMXInvokeOperation
 
−
* ''method'': MBean's method to invoke.
 
  
−
and the subelement:
+
This element specifies an invoker method parameter. It is only used by ''invoke-method''.
  
−
* invoke-parameter
+
It has the attributes:
 +
{|class="gvtable"
 +
! Attribute !! Type !! Description
 +
|-
 +
| type || required || Parameter type. Only used for ''invoke method''. Its admitted values are:
 +
* byte
 +
* boolean
 +
* char
 +
* double
 +
* float
 +
* int
 +
* long
 +
* short
 +
* String
 +
|-
 +
| value || required || Parameter value. Can contains the following placeholders. The attribute's admitted values are:
 +
* true
 +
* false
 +
|}
  
 +
===set-attribute===
  
−
===invoke-parameter===
+
Sets a MBean's attribute value. It is used only by ''jmx-call''.
  
−
This element specifies an invoker method parameter. It is only used by ''invoke-method''.
+
It has the following attributes:
 +
{|class="gvtable"
 +
! Attribute !! Type !! Description
 +
|-
 +
| type || fixed || This elements must assume the value '''method'''.
 +
|-
 +
| class || fixed || This elements must assume the value '''it.greenvulcano.gvesb.virtual.jmx.methods.JMXSetOperation'''.
 +
|-
 +
| name || required || Attribute name of the MBean.
 +
|-
 +
| value || required || Attribute value of the MBean to set. Can contain [[placeholders]].
 +
|-
 +
| value-type || required || Parameter type. Only used for invoke method. The attribute's admitted values are:
 +
* byte
 +
* boolean
 +
* char
 +
* double
 +
* float
 +
* int
 +
* long
 +
* short
 +
* String
 +
|}
  
−
It has the attributes:
+
===get-attribute===
  
−
* ''type'': Parameter type. Only used for ''invoke method''. Its admitted values are:
+
Gets a MBean's attribute value. It is used only by ''jmx-call''. It has the following attributes:
−
** byte
+
{|class="gvtable"
−
** boolean
+
! Attribute !! Type !! Description
−
** char
+
|-
−
** double
+
| type || fixed || This attribute must assume the value '''method'''.
−
** float
+
|-
−
** int
+
| class || fixed || This attribute must assume the value '''it.greenvulcano.gvesb.virtual.jmx.methods.JMXGetOperation'''.
−
** long
+
|-
−
** short
+
| attribute || required || Attribute of the MBean to get the value.
−
** String
+
|}
−
* ''value'': Parameter value. Can contains the following placeholders. The attribute's admitted values are:
 
−
** true
 
−
** false
 

Latest revision as of 16:53, 16 February 2012

Description

jmx-call is the JMX VCL plugin to invoke MBean methods or set/get attributes on local servers.

VulCon / GV Console Configuration

The jmx-call Element is used by Channel and routed-call. It has the following attributes:

Attribute Type Description
type fixed This attribute must assume the value call.
class fixed This attribute must assume the value it.greenvulcano.gvesb.virtual.jmx.JMXCallOperation.
name required Operation name. Used in the 'Flow' section to associate workflow nodes to VCL operations.
object-name required Defines an object name filter to invoke/set/get via JMX server. Can contains placeholders

It subelements are:

invoke-method

This element invokes a method to the MBean. It is only used by jmx-call.

It has the following attributes:

Attribute Type Description
type fixed This attribute must assume the value method.
class fixed This attribute must assume the value it.greenvulcano.gvesb.virtual.jmx.methods.JMXInvokeOperation
method required MBean's method to invoke.

Its subelement are:

invoke-parameter

This element specifies an invoker method parameter. It is only used by invoke-method.

It has the attributes:

Attribute Type Description
type required Parameter type. Only used for invoke method. Its admitted values are:
  • byte
  • boolean
  • char
  • double
  • float
  • int
  • long
  • short
  • String
value required Parameter value. Can contains the following placeholders. The attribute's admitted values are:
  • true
  • false

set-attribute

Sets a MBean's attribute value. It is used only by jmx-call.

It has the following attributes:

Attribute Type Description
type fixed This elements must assume the value method.
class fixed This elements must assume the value it.greenvulcano.gvesb.virtual.jmx.methods.JMXSetOperation.
name required Attribute name of the MBean.
value required Attribute value of the MBean to set. Can contain placeholders.
value-type required Parameter type. Only used for invoke method. The attribute's admitted values are:
  • byte
  • boolean
  • char
  • double
  • float
  • int
  • long
  • short
  • String

get-attribute

Gets a MBean's attribute value. It is used only by jmx-call. It has the following attributes:

Attribute Type Description
type fixed This attribute must assume the value method.
class fixed This attribute must assume the value it.greenvulcano.gvesb.virtual.jmx.methods.JMXGetOperation.
attribute required Attribute of the MBean to get the value.
Retrieved from "https://gvwiki.greenvulcano.com/gvwiki/index.php?title=Jmx-call&oldid=2338"