ProtectedapiAPI base path (e.g., '/maximo/api')
ProtectedloggerProtectedhttpThe HTTP client for making requests
Returns the current logger used by this service instance.
ProtectedformatOptionalproperties: string | string[]ProtectedhandleError handler
the error to process
Returns the JVM that answered this call, as reported by
/mmi/members/thisserver. Useful for verifying that a pinned
client actually landed on the requested node.
Enumerates every member of the cluster.
Primary source is /mmi/members. If opts.userId is supplied and
the autoscript is installed, the call is augmented so each entry
carries a userActive flag.
Returns the first JVM that holds an HttpSession for the given user, or null if none currently do. Use findUserJvms for the multi-session variant (a user can be logged into more than one JVM).
Returns every JVM that currently holds an HttpSession for userId.
Returns version + node info from the script's ?action=ping endpoint,
or null if the script is not installed.
ping does no Mbo or DNS work, so this is the canonical cheap probe.
Result is memoised for the lifetime of the service instance.
Forward compatibility: if ping returns 400 (Unknown action) the
script is installed but predates the ping handler. We fall back to a
?action=nodes probe to confirm presence and return a versionKnown: false placeholder.
Probe whether the MAXIMOMIZE.CLUSTER autoscript is installed on the
deployment. Cheap (one ?action=ping round-trip, no Mbo work) and
memoised. Equivalent to (await getScriptInfo()) !== null.
Resolve a user-supplied identifier (nodeName, serverHost, or jvmTag)
to a concrete MaximoJvm entry. Throws ClusterError.UnknownNode
if no entry matches.
Executes an action on an arbitrary endpoint Useful for service endpoints that don't follow the standard resource/ID pattern Supports both GET and POST methods based on payload presence
The endpoint to call the action on (e.g., 'service/logging')
The name of the action to execute (e.g., 'wsmethod:streamLog')
Optionalpayload: anyOptional payload data for the action (if provided, uses POST, otherwise GET)
OptionalreturnProperties: string | string[]Optional properties to return in the response
A promise resolving to a response object containing success status and optional data
Service that discovers cluster topology and locates user sessions across JVMs.
Discovery uses a layered strategy:
/mmi/membersfor node enumeration — always preferred; native and requires no script install.MXAPIMAXSESSIONover OSLC for user-session lookup, when the object structure is exposed on the deployment.MAXIMOMIZE.CLUSTERautoscript as a fallback for both, used whenMXAPIMAXSESSIONis not exposed.Pinning a client to a chosen node is performed by
MaximoClient.pinTo(), not by this service; this layer is purely informational.