Namespace: OpenEdge.ApplicationServer
Type: Class AgentInfo
Parent Classes:
Inherits: Progress.Lang.Object


Copyright (c) 2014,2017-2018,2021-2022 by Progress Software Corporation. All rights reserved.
File:AgentInfo.cls
Description:Used by the Server Broker tools to manage the agent & sessions.
Author(s):aherbstr, dugrau
Created:Tuesday July 8 2014
Notes:Requests originate from Java MBeans which are utilized by the
OEJMX utility or oemanager WebApp via the following sources:
pasoe/com.progress.appserv.clientrt/
src/main/java/com/progress/appserv/clientrt/admin/
AdminConstants.java (CLASS_AGENTINFO)
AgentAdminUtil.java
pasoe/com.progress.appserv.manager/
src/main/java/com/progress/appserv/manager/admin/
AgentManager.java
AgentAdminUtil.java
src/main/java/com/progress/appserv/manager/jmx/
AgentManagerJmx.java
BrokerServiceManagerJmx.java
src/main/java/com/progress/appserv/manager/rest/
AgentManagerService.java
BrokerManagerService.java
The ABL code utilizes Progress.ApplicationServer.* classes written in C:
src/biosys/biopasainit.c (CLASS Progress.ApplicationServer.AgentInfo)
src/biosys/biopasa.c (bioPASAgentInfo)



Method Summary
  Options Name Purpose
  clearAgentStatData () /* Empties the cached agent request stats */
  getAgentActiveRequestData (character, table-handle) /* Returns the active request(s) for a given SessionID @param character SessionID @param table-handle Request info for the given SessionID */
  LOGICAL getAgentConnectionData (table-handle) /* Returns the agent connection data @param table-handle Agent connection data @return logical Valid table-handle present */
  LOGICAL getAgentRequestData (table-handle) /* Returns the last 1000 requests for this agent This method used to give all the requests that are running on the agent. But because of the Issue:PSC00364863, we limited the API to return only last 1000 requests information. @param table-handle Agent request data @return logical Valid table-handle present */
  INT64 getAgentRequestQty () /* Returns the number of active agent requests @return int64 Number of (active) agent requests. Returns -1 if not enabled */
  LOGICAL getAgentSessionData (integer, table-handle) /* Returns the status of a specific agent session @param character Agent SessionID @param table-handle Agent session data @return logical Valid table-handle present */
  LOGICAL getAgentSessionData (table-handle) /* Returns the status of all agent sessions @param table-handle Agent session data @return logical Valid table-handle present */
  INTEGER getAgentSessionID (character) /* Returns an Agent SessionID given a Client SessionID @param character Client SessionID @return integer Agent SessionID */
  LOGICAL getAgentSessionStack (character, longchar) /* Returns the agent call stack for a given SessionID @param character SessionID for which to return a call stack @param longchar JSON representation of the stack information @return logical Success/Failure */
  LOGICAL getAgentSessionStack (integer, longchar) /* Returns the agent call stack for a given Agent SessionID @param integer Agent SessionID for which to return a call stack @param longchar JSON representation of the stack information @return logical Success/Failure */
  LOGICAL getAgentStacks (longchar) /* Returns the agent call stack for all sessions @param longchar JSON representation of the stack information @return logical Success/Failure */
  LOGICAL getAgentStatData (table-handle) /* Returns the agent statistics @param table-handle Agent statistics data @return logical Valid table-handle present */
  LOGICAL getAgentThreadData (table-handle) /* Return current agent thread data @param table-handle Agent thread data @return logical Valid table-handle present */
  LOGICAL getClientSessionID (integer, character) /* Returns a Client SessionID given an Agent SessionID @param integer SessionID @param character Client SessionID @return logical Success/Failure */
  LOGICAL GetDynamicABLSessionLimitInfo (longchar) /* Returns the agent dynamic ABL session limit @param longchar JSON representation of the session information @return logical Success/Failure */
  logMessage (character)
  LOGICAL setArchiveAgentStats (logical) /* Toggles the agent stats archive on and off. If we turn gathering stats OFF (a FALSE parameter) then we also empty the cached stats @param logical TRUE to enabled archiving; FALSE to disable @return logical TRUE when stats are archived, FALSE otherwise */

Constructor Summary
  Options Name Purpose
  AgentInfo () /* Constructor */

Property Summary
  Options Name Purpose
  OpenEdge.Logging.ILogWriter Logger


Method Detail
Top

clearAgentStatData ()

/* Empties the cached agent request stats
Top

getAgentActiveRequestData (character, table-handle)

/* Returns the active request(s) for a given SessionID
Parameters:
sessionId CHARACTER
 
hTTCopy TABLE-HANDLE
 
Top

LOGICAL getAgentConnectionData (table-handle)

/* Returns the agent connection data
Parameters:
pasThandle TABLE-HANDLE
 
Returns LOGICAL
  logical Valid table-handle present
Top

LOGICAL getAgentRequestData (table-handle)

/* Returns the last 1000 requests for this agent
This method used to give all the requests that are running on the agent.
But because of the Issue:PSC00364863, we limited the API to return only
last 1000 requests information.
Parameters:
hTTCopy TABLE-HANDLE
 
Returns LOGICAL
  logical Valid table-handle present
Top

INT64 getAgentRequestQty ()

/* Returns the number of active agent requests
Returns INT64
  int64 Number of (active) agent requests. Returns -1 if not enabled
Top

LOGICAL getAgentSessionData (integer, table-handle)

/* Returns the status of a specific agent session
Parameters:
agentSessId INTEGER
 
hTTCopy TABLE-HANDLE
 
Returns LOGICAL
  logical Valid table-handle present
Top

LOGICAL getAgentSessionData (table-handle)

/* Returns the status of all agent sessions
Parameters:
pasThandle TABLE-HANDLE
 
Returns LOGICAL
  logical Valid table-handle present
Top

INTEGER getAgentSessionID (character)

/* Returns an Agent SessionID given a Client SessionID
Parameters:
clsessid CHARACTER
 
Returns INTEGER
  integer Agent SessionID
Top

LOGICAL getAgentSessionStack (character, longchar)

/* Returns the agent call stack for a given SessionID
Parameters:
sessid CHARACTER
 
pStack LONGCHAR
 
Returns LOGICAL
  logical Success/Failure
Top

LOGICAL getAgentSessionStack (integer, longchar)

/* Returns the agent call stack for a given Agent SessionID
Parameters:
sessid INTEGER
 
pStack LONGCHAR
 
Returns LOGICAL
  logical Success/Failure
Top

LOGICAL getAgentStacks (longchar)

/* Returns the agent call stack for all sessions
Parameters:
pStacks LONGCHAR
 
Returns LOGICAL
  logical Success/Failure
Top

LOGICAL getAgentStatData (table-handle)

/* Returns the agent statistics
Parameters:
pasThandle TABLE-HANDLE
 
Returns LOGICAL
  logical Valid table-handle present
Top

LOGICAL getAgentThreadData (table-handle)

/* Return current agent thread data
Parameters:
pasThandle TABLE-HANDLE
 
Returns LOGICAL
  logical Valid table-handle present
Top

LOGICAL getClientSessionID (integer, character)

/* Returns a Client SessionID given an Agent SessionID
Parameters:
agentSessId INTEGER
 
clientSessId CHARACTER
 
Returns LOGICAL
  logical Success/Failure
Top

LOGICAL GetDynamicABLSessionLimitInfo (longchar)

/* Returns the agent dynamic ABL session limit
Parameters:
sessionInfo LONGCHAR
 
Returns LOGICAL
  logical Success/Failure
Top

logMessage (character)

Parameters:
msg CHARACTER
 
Top

LOGICAL setArchiveAgentStats (logical)

/* Toggles the agent stats archive on and off. If we turn gathering
stats OFF (a FALSE parameter) then we also empty the cached stats
Parameters:
setValue LOGICAL
 
Returns LOGICAL
  logical TRUE when stats are archived, FALSE otherwise


Constructor Detail
Top

AgentInfo ()

/* Constructor


Property Detail
Top

OpenEdge.Logging.ILogWriter Logger

Returns OpenEdge.Logging.ILogWriter