ActiveMatrix Host Microagent

The ActiveMatrix Host Microagent (com.tibco.hawk.amx.AMXHostMicroAgent) allows monitoring and managing of TIBCO ActiveMatrix Host Instance running in the local machine.

AMXHost Microagent Configuration File

File name: AMXHostPluginConfig.xml

Content: 

<?xml version="1.0" encoding="UTF-8"?>
<AMXHostConfiguration xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:noNamespaceSchemaLocation="AMXHostPluginConfig.xsd">
	<HPAClientConfigPropFile>%TIBCO_HAWK_HOME_ESC%/plugin/amx/hpaclientconfig.properties</HPAClientConfigPropFile>
	<MethodTimeout>10</MethodTimeout>
	<HostProcessPrefix>tibcohost*</HostProcessPrefix>
	<NodeProcessPrefix>tibamx_*</NodeProcessPrefix>
</AMXHostConfiguration>

XSD Configuration file: AMXHostPluginConfig.xsd

Content: 

<?xml version = "1.0" encoding = "UTF-8"?>
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">
	<xsd:element name="AMXHostConfiguration" type="AMXHostConfigurationType" />
	<xsd:complexType name="AMXHostConfigurationType">
		<xsd:sequence>
			<xsd:element ref="MicroAgentName" />
			<xsd:element ref="MicroAgentDisplayName" />
			<xsd:element ref="MicroAgentDesc" />
			<xsd:element ref="MethodTimeout" />
			<xsd:element ref="HPAClientConfigPropFile" />
			<xsd:element ref="HostProcessPrefix" />
			<xsd:element ref="NodeProcessPrefix" />
		</xsd:sequence>
	</xsd:complexType>
	<xsd:element name="MicroAgentName" type="xsd:string" default="" />
	<xsd:element name="MicroAgentDisplayName" type="xsd:string" default="" />
	<xsd:element name="MicroAgentDesc" type="xsd:string" default="" />
	<xsd:element name="HPAClientConfigPropFile" type="xsd:string" default="hpaclientconfig.properties" />
	<xsd:element name="MethodTimeout" type="xsd:string" default="10" />
	<xsd:element name="HostProcessPrefix" type="xsd:string" default="tibcohost*" />
	<xsd:element name="NodeProcessPrefix" type="xsd:string" default="tibamx_*" />
</xsd:schema>

AMX Host Microagent Configuration

For configuration of AMX Host Microagent, refer to the readme.txt available in plugin/amx.

Methods

The methods in the microagent provides the information for the host instance running on the machine.

  • isHostRunning
    The isHostRunning method pings the TIBCO ActiveMatrix Host and returns the value as true or false.
  • getHostInfo
    The getHostInfomethod returns the details of TIBCO ActiveMatrix Host instance running in the local machine.
  • getNodeInfo
    The getNodeInfo method returns the Node information by the Node Name.
  • onHostEvent
    The onHostEvent method provides notification of the changed run-time state of a TIBCO Host. This method supports only the subscribe mode.
  • onNodeEvent
    The onNodeEvent method provides notification of the run-time state of the node when changed of a particular node or all nodes associated with the TIBCO Host.
  • startNode
    The startNode method starts the TIBCO ActiveMatrix node, if not running.
  • stopNode
    The stopNode method stops the TIBCO ActiveMatrix node.