Summary of Platform-Independent Microagents

The platform-independent microagents are as follows.

Platform-Independent Microagents

Microagent

Description

Common Methods

These methods are common to all microagents and provide release and trace-related functions. Methods are:

getReleaseVersion
getTraceLevel
setTraceLevel
getTraceParameters
setTraceParameters
_onUnsolicitedMsg

Self

Returns information from and takes actions that affect the TIBCO Hawk agent itself. Methods are:

Self:getMicroAgentInfo
Self:getAgentTimeZone
Self:getComponentInfo
Self:turnDiagnosticsOn
Self:turnDiagnosticsOff

SysInfo

Returns information on a network host: its name, address, type of computer and operating system. Methods are:

SysInfo:getOperatingSystem
SysInfo:getArchitecture
SysInfo:getHostName
SysInfo:getNetworkAddress

HawkEventService

This application reports on events generated by the TIBCO Hawk Agents across the network.

HawkEventService:onAgentAlive
HawkEventService:onAgentExpired
HawkEventService:onAlert
HawkEventService:onClear
HawkEventService:onMicroAgentChange
HawkEventService:onRulebaseChange

RuleBaseEngine

Returns information from rulebases and takes actions on rulebases that affect the TIBCO Hawk agent itself. The methods are:

RuleBaseEngine:deleteRuleBase
RuleBaseEngine:getExternalVariables
RuleBaseEngine:getRuleBaseNames
RuleBaseEngine:getScheduleNames
RuleBaseEngine:loadRuleBase
RuleBaseEngine:loadRuleBaseFromFile
RuleBaseEngine:unloadRuleBase
RuleBaseEngine:getConfigInfo
RuleBaseEngine:sendMail
RuleBaseEngine:onAlertCount
RuleBaseEngine:onAlertCountForRulebase
RuleBaseEngine:suspendAlert
RuleBaseEngine:suspendAllAlerts
RuleBaseEngine:resumeSuspendedAlerts
RuleBaseEngine:updateExternalVariables

Messaging

Responds to requests from TIBCO Hawk agents to send and receive messages using either TIBCO Rendezvous or TIBCO EMS. Methods are:

Messaging:sendMessage
Messaging:onMessage
Messaging:onTimeout
Messaging:onNumber

Repository

The Messaging microagent (on all platforms) responds to requests from TIBCO Hawk agents to send and receive messages using either TIBCO Rendezvous or TIBCO EMS.

Responds to configuration requests from TIBCO Hawk agents. Methods are:

Repository:getName
Repository:getScheduleNames
Repository:getRuleBaseName
Repository:onRepositoryEvent

Logfile

Returns new lines added to a log file. Methods are:

Logfile:onNewLine

Custom

Runs executable programs and scripts from within the TIBCO Hawk system. Methods are:

Custom:executeForString
Custom:executeForNumber
Custom:execute

FileStat

Returns information on files. Methods are:

FileStat:getFileStatus
FileStat:getFileCount

TibRendezvous

Subscribes to TIBCO Rendezvous system messages. Methods are:

TibRendezvous:onRvDaemonStatus
TibRendezvous:onRvDataLoss
TibRendezvous:onRvdDisconnectOrConnect
TibRendezvous:onRvLicenseExpire

TcpClusterStatus

The TcpClusterStatus microagent provides methods to monitor the health of the TIBCO Hawk TCP Transport cluster and its daemons. Methods are:

TcpClusterStatus:getDaemonStatus
TcpClusterStatus:getClusterStatus
TcpClusterStatus:getMemberCount
TcpClusterStatus:onMemberEvent

TcpMessaging

The TCPMessaging microagent provides methods to send and receive messages by using the TCP Transport for TIBCO Hawk. Methods are:

TcpMessaging:sendMessage
TcpMessaging:onMessage
TcpMessaging:onNumber
TcpMessaging:onTimeout