EMBasicXMLInvoker and EMXML Invoker class

The EMXMLInvoker class is the primary class of the API. Its methods are used to initiate and stop the API, get and set API properties, and send requests to Control‑M/EM. The EMBasicXMLInvoker class is inherited from the EMXMLInvoker class and shares many of the methods of that class. For more information, see Control-M/EM API requests.

The EMBasicXMLInvoker and the EMXMLInvoker classes use the following methods:

Method

Description

BuildPasswordString

Encodes a given text string for use in a Registration request.

done

Stops Control‑M/EM API services by breaking the connection with the CORBA processes.

encodePassword

Use the BuildPasswordString method instead of the encodePassword method to encode a given text string for use in a Registration request. The encodePassword method is no longer supported in Control‑M/EM API version 6.4.01 and above.

getProperties

Obtains for example, the Control‑M/EM GUI Server names from the ctmem.properties file.

setProperties

Specifies, for example, the Control‑M/EM GUI Server names and a location from which to obtain them.

Init

Starts the Control‑M/EM API services and initializes CORBA with default values or with values specified with its optional parameters.

invoke

Enables you to send a request to Control‑M/EM as a XML text string. When the invoke method is used with the EMBasicXMLInvoker class, polling for responses from Control‑M/EM is automatic. When the invoke method is used with the EMXMLInvoker class, the user must activate polling to receive a response from Control‑M/EM

setPollRequestIntervalMilli

(EMBasic XMLInvoker only) Determines the interval, in milliseconds, between automatic poll requests.

setPollRequestTimeoutMilli

(EMBasic XLMInvoker only) Determines the total time, in milliseconds, allotted for polling following a request.

Parent Topic

Control-M/EM API Class references