%CSP.Mgr.GatewayMgrImpl

If this method returns an error then the object will not be created.

It is passed the arguments provided in the %New call. When customizing this method, override the arguments with whatever variables and types you expect to receive from %New(). For example, if you're going to call %New, passing 2 arguments, %OnNew's signature could be:

Method %OnNew(dob as %Date = "", name as %Name = "") as %Status If instead of returning a %Status code this returns an oref and this oref is a subclass of the current class then this oref will be the one returned to the caller of %New method.

Security: To call this method, you must hold the %Admin_Manage:Use privilege.

Security: To call this method, you must hold the %Admin_Manage:Use privilege.

The values of clearFilenames determines the exact action of the method.

1. An empty or undefined value indicates that the entire cache should be cleared.
2. A list of the file names to be purged from the cache.
3. A file name may contain a wildcard, '*'.

   1.  Clear all forms named 'zenutils.js', regardless of path: */zenutils.js
   2.  Clear all forms from the '/csp/samples/images/' location: /csp/samples/images/*
   3.  Clear all forms whose path/name contains the '/Zen_' token: */Zen* 

Security: To call this method, you must hold the %Admin_Manage:Use privilege.

connections specifies which connections are to be closed:

Security: To call this method, you must hold the %Admin_Manage:Use privilege.

path indicates the application path whose parameters are being requested. See the GetApplicationPaths()() method to obtain a list of the application paths defined for this Gateway.

configAry [name,value] pairs are returned in local array

See SetApplicationParams() for a list of parameters.

Security: To call this method, you must hold the %Admin_Operate:Use or %Admin_Manage:Use privilege.

appPaths is a list of strings, each an application path.

Security: To call this method, you must hold the %Admin_Operate:Use or %Admin_Manage:Use privilege.

format is the return format:
"array" - return as an array.
"stream" - returns as a %Stream.GlobalCharacter.

cspIni

If format="array", tke values are returned in a two-level array. A partial example:

cspini("[APP_PATH:/]", "Default_Server" ) = "LOCAL"
cspini("[APP_PATH:/csp]", "Default_Server") = "LOCAL"
cspini("[APP_PATH:/csp]", "GZIP_Minimum_File_Size") = "0"
cspini("[LOCAL]", "Ip_Address") = "127.0.0.1"
cspini("[LOCAL]", "Maximum_Server_Connections") = "4"
cspini("[LOCAL]", "Maximum_Session_Connections") = "3"
cspini("[LOCAL]", "Minimum_Server_Connections") = "30"
cspini("[LOCAL]", "Username") = "CSPSystem"

If format="stream", the data is returend as a %Stream.GlobalCharacter object which allows the CSP Ini text to be parsed directly.

Security: To call this method, you must hold the %Admin_Operate:Use or %Admin_Manage:Use privilege.

cspLogStream is a %Stream.GlobalCharacter stream from which you can read the lines of the returned from the event log When you close the stream, the temporary data from the server will be removed.

startDateTime the time from which to start returning events. The format the date one of the following:

   C format: e.g.:         Fri Apr 01 22:28:23 2011 
  RFC1123 format: e.g.:   Mon, 26 Jul 2010 15:09:28 GMT

The value "now" [default] will be replaced by the current date and time.

direction the direction to scan for events: 1 -> forward; -1 -> backward

nEvents the number of Events to return from the event file. Each event consists of one line in a structured name-value pair format. Caution: The CSP Log file contains tens of thousands of lines of text. If you request too many events in one call, GetCSPLog() will timeout waiting for the Gateway to finish transfering all the data.

Security: To call this method, you must hold the %Admin_Operate:Use or %Admin_Manage:Use privilege.

config values are returned as named parameters of the object. See SetDefaultParams() for a list of parameters.

configAry [name,value] pairs are returned in local array

Security: To call this method, you must hold the %Admin_Operate:Use or %Admin_Manage:Use privilege.

format is the return format:
"object" - return as %CSP.Mgr.GatewayInformation object;
"stream" - returns as the information as XML in a %Stream.GlobalCharacter.

info
if format="object" this is an instance of the %CSP.Mgr.GatewayInformation class.
if format="stream", this is a %Stream.GlobalCharacter containing the information as XML

<?xml version="1.0" encoding="UTF-8" ?>
<GatewayInformation>
<Version>2011.2.0.202.0</Version>
<Build>1102.1226</Build>
<WebServerName>localhost</WebServerName>
<WebServerPort>57773</WebServerPort>
<WebServerSoftware>Apache Cache_Server_Pages-Apache_Module/2011.2.0.202.0-1102.1226</WebServerSoftware>
<ActiveInterface>apapi</ActiveInterface>
</GatewayInformation>

Security: To call this method, you must hold the %Admin_Operate:Use or %Admin_Manage:Use privilege.

server indicates that server path whose values are being requested. See the GetServers()() method to obtain a list of the servers defined for this Gateway.

configAry [name,value] pairs are returned in local array

See SetServerParams() for a list of parameters.

Security: To call this method, you must hold the %Admin_Operate:Use or %Admin_Manage:Use privilege.

GetServerStatus() retrieves the 'online' status for either a single or a specified range of InterSystems IRIS servers

path is the application path as defined in the Gateway Configuration (or "*" for all)
server is the InterSystems IRIS server name as defined in the Gateway configuration (or "*" for all)

An array of servers and their status is returned as follows:

statusAry(path,server_number)=$List(server, status)

Where status is '1' for online and '0' for offline

Security: To call this method, you must hold the %Admin_Operate:Use or %Admin_Manage:Use privilege.

serverList is a list of strings, each the name of a configured server.

Security: To call this method, you must hold the %Admin_Operate:Use or %Admin_Manage:Use privilege.

metricsAry [name,value] pairs are returned in local array

Security: No privileges are necessary to call this method.

GetSystemStatus() gets the System Status.

format is the return format:
"object" - return as an object;
"stream" - returns as the information as XML.

systemStatus
if format="object" returned as an instance of a %CSP.Mgr.GatewaySystemStatus object. There are the following main sections to the status: Connections, Servers, Application Paths, Alternative Servers, and Cached Form.
if format="stream", this is a %Stream.GlobalCharacter containing the information as XML

<?xml version="1.0" encoding="UTF-8" ?> 
  <GatewaySystemStatus>
     <Connections>
        <Connection Number="0">
           <WebServerPID>5936</WebServerPID> 
           <CacheServerName>APPSERVER1</CacheServerName> 
           <IpAddress>127.0.0.1</IpAddress> 
           <TcpPort>56773</TcpPort> 
           <CacheServerPID>3304</CacheServerPID> 
           <Status>Free</Status> 
           <IdleTime>0/0</IdleTime> 
           <Activity>19</Activity> 
        </Connection>
        <Connection Number="1">
           <WebServerPID>5936</WebServerPID> 
           <CacheServerName>APPSERVER1</CacheServerName> 
           <IpAddress>127.0.0.1</IpAddress> 
           <TcpPort>56773</TcpPort> 
           <CacheServerPID>3428</CacheServerPID> 
           <Status>Free</Status> 
           <IdleTime>0/0</IdleTime> 
           <Activity>12</Activity> 
        </Connection>
     </Connections>
     <CacheServers>
        <CacheServer Number="2">
           <CacheServerName>APPSERVER1</CacheServerName> 
           <IpAddress>127.0.0.1</IpAddress> 
           <TCPPort>56773</TCPPort> 
           <TotalConnections>6</TotalConnections> 
            <ConnectionsInUse>0</ConnectionsInUse> 
          <PrivateConnections>0</PrivateConnections> 
           <Activity>75</Activity> 
           <QueuedRequests>0</QueuedRequests> 
         </CacheServer>
     </CacheServers>
     <ApplicationPaths>
        <ApplicationPath Number="1">
           <Path>/csp</Path> 
           <AlternativeServer Number="0">
           <CacheServerName>APPSERVER1</CacheServerName> 
           <Activity>75</Activity> 
           <Status>Enabled (Master)</Status> 
        </AlternativeServer>
        <AlternativeServer Number="1">
           <CacheServerName>APPSERVER2</CacheServerName> 
           <Activity>0</Activity> 
           <Status>Disabled</Status> 
        </AlternativeServer>
     </ApplicationPath>
  </ApplicationPaths>
  <CachedForms>
     <FormsInCache>1</FormsInCache> 
     <CachedData>6584</CachedData> 
     <CacheActivity>3</CacheActivity> 
     <Form id="/csp/samples/images/zenLogo.svg">
       <Size>6584</Size> 
       <Activity>3</Activity> 
     </Form>
  </CachedForms>
  </GatewaySystemStatus>

Security: To call this method, you must hold the %Admin_Operate:Use or %Admin_Manage:Use privilege.

serversAry [number,name] pairs are returned in local array

Security: To call this method, you must hold the %Admin_Operate:Use or %Admin_Manage:Use privilege.

path indicates that application path being updated. See the GetApplicationPaths()() method to obtain a list of the application paths defined for this Gateway.

configUpdates a local array whose [name,value] pairs are used to update the configuration.

Security: To call this method, you must hold the %Admin_Manage:Use privilege.

configUpdates a local array whose [name,value] pairs are used to update the configuration.

Security: To call this method, you must hold the %Admin_Manage:Use privilege.

server indicates that server path being updated. See the GetServers()() method to obtain a list of the servers configured on this Gateway.

configUpdates a local array whose [name,value] pairs are used to update the configuration.

Alternative Servers should be saved as a contiguous set of alternative servers as follows:

Alternative_Server_1=APPSERVER1
Alternative_Server_1_Status=Enabled
Alternative_Server_2=APPSERVER2
Alternative_Server_2=Disabled

Security: To call this method, you must hold the %Admin_Manage:Use privilege.

SetServerStatus() sets the 'online' status for either a single or a specified range of InterSystems IRIS servers

path is the application path as defined in the Gateway Configuration (or "*" for all)
server is the InterSystems IRIS server name as defined in the Gateway configuration (or "*" for all)
status is '1' for online and '0' for offline

Security: To call this method, you must hold the %Admin_Manage:Use privilege.