ePages 6.17.13 - DE_EPAGES/WebInterface/API/ServerConfig.pm

Package DE_EPAGES::WebInterface::API::ServerConfig

This module contains functions to load the server xml config file

@EXPORT_OK
ServerConfig

Functions

ServerConfig
appServerGroup
appServerGroups
asPoolDBCacheServers
fallbackMessageCenters
messageCenter
pool
pools
requestRouter
requestRouterMonitors
requestRouters

ServerConfig

get xml object of ServerConfig.xml

Syntax
$ServerConfig = ServerConfig();
Return
$ServerConfig (DE_EPAGES::WebInterface::API::ServerConfig)
config object

appServerGroup

Returns the application application server group data by hostname and port

Syntax
$hGroup = $ServerConfig->appServerGroup($Hostname, $Port);
Input
$Hostname (string)
hostname or ip address as specified in ServerConfig.xml
$Port (integer)
port number
Return
$hGroup (ref.hash)
  • Name - group name - string
  • Host - host name or ip address - string
  • Ports - port numbers of the application servers - string
  • PoolName - pool name - string
  • Priority - priority (optional) - int
  • MaxMemory - maximimum RAM per AS in MBytes (optional) - int

appServerGroups

Returns all application application server groups.

Syntax
$hhGroups = $ServerConfig->appServerGroups;
Return
$hhGroups (ref.hash.hash)
{ $Name => $hGroup }, see appServerGroup

asPoolDBCacheServers

Returns hosts and ports of the ASPoolDB Cache Server.

Syntax
$aCacheServers = $ServerConfig->asPoolDBCacheServers;
Return
$aServers (ref.array.ref.hash)
array of server IPs/host names and port numbers
[ { Host => IP, Port => port }, ... ]

fallbackMessageCenters

Returns the fallback MessageCenters for the application server pool.

Syntax
$aMCs = $ServerConfig->fallbackMessageCenters($PoolName);
Input
$PoolName (string)
application server pool name
Return
$aMCs (ref.array.array.string)
MessageCenters hosts and port numbers
[ [ Host, Port ], [Host, Port ], ... ]

messageCenter

Returns the host and MessageCenter port of the primary request router.

Syntax
($Host, $Port) = $ServerConfig->messageCenter($PoolName);
Input
$PoolName (string)
application server pool name
Return
$Host (string)
MessageCenter host name or IP address
$Port (integer)
MessageCenter port

pool

Returns the application application server pool data by pool name.

Syntax
$hPool = $ServerConfig->pool( $PoolName );
Input
$PoolName (string)
application server pool name
Return
$hPool (ref.hash)
  • Name - pool name - string
  • RequestRouters - list of request router names - ref.array.string
  • AppServers - hash of application server groups ($Name => $hGroup) - ref.hash.hash

pools

Returns all application application server pools.

Syntax
$hhPools = $ServerConfig->pools;
Return
$hhPools (ref.hash.hash)
{ $Name => $hPool }, see pool

requestRouter

Returns a request router by name.

Syntax
$hRequestRouter = $ServerConfig->requestRouter($Name);
Input
$Name (string)
request router name
Return
$hRequestRouter (ref.hash)
RequestRouter structure
  • Name - request router name - string
  • Host - host name or IP address - string
  • Port - request router port - string
  • MessageCenterPort - message center port - string
  • MonitorPort - (optional) monitor port - string

requestRouterMonitors

Read ServerConfig.xml and find all RequestRouter IP addresses and monitor ports.

Syntax
$aMonitors = $ServerConfig->requestRouterMonitors;
Return
$aMonitors (ref.array.array.string)
RequestRouter IP addresses and monitor port numbers
[ [ IP, port ], [IP, port ], ... ]

requestRouters

Returns all request routers.

Syntax
$hhRequestRouters = $ServerConfig->requestRouters;
Return
$hhRequestRouters (ref.hash.hash)
Hash of { $Name => $hRequestRouter } structures,
see requestRouter