Java CAPS Management and Monitoring APIs

Runtime Management Service

The Runtime Management Service:

Table 3 Runtime Management Service Method Names and Descriptions

API Method Name 

Description 

isTargetUp 

Checks to see if the target (server, cluster) is up or down. 

listServiceEngines 

Lists the service engines. 

listBindingComponents 

Lists the binding components. 

listSharedLibraries 

Lists the shared libraries. 

listServiceAssemblies 

Lists the service assemblies. 

showServiceEngine 

Shows the service engine conforming to various options. 

showBindingComponent 

Shows the binding component conforming to various options. 

showSharedLibrary 

Shows the shared library conforming to various options. 

showServiceAssembly 

Shows the service assembly conforming to various options. 

listComponents 

Retrieves a list of components. 

getState 

Retrieves the state of the runtime component (such as UP/DOWN/UNKNOWN/etc.). 

getProperties 

Retrieves a list of the component's properties. 

startComponent 

Starts the component. 

stopComponent 

Stops the component. 

restartComponent 

Restarts the component. 

shutdownComponent 

Shuts down the component. 

startServiceAssembly 

Starts service assembly. 

stopServiceAssembly 

Stops the service assembly. 

shutdownServiceAssembly 

Shuts down the service assembly. 

listCompositeApplications 

Retrieves a list of composite applications. 

getRuntimeComponentProperties 

Obtains a list of the runtime unit's properties. 

getRuntimeComponentStatus 

Obtains the state of the runtime component, that is, UP/DOWN/UNKNOWN/etc. 

startRuntimeComponent 

Starts the runtime component. 

restartRuntimeComponent 

Restarts the runtime component. 

stopRuntimecomponent 

Stops the runtime component. 

listTargets 

Returns all deployable targets in this domain. All groups and all servers (servers that are not part of any groups). 

listLifecycleModules 

Lists the lifecycle modules. 

listExtensionModules 

Lists the extension modules. 

listSystemConnectors 

Lists the system connectors modules. 

listAppclientModules 

Returns all deployed modules of specified type and on specified target. 

listConnectorModules 

Returns an array of deployed connectors. 

listEjbModules 

Returns all deployed modules of specified type and on specified target. 

listWebModules 

Returns all deployed modules of specified type and on specified target. 

listJavaEEApplications 

Returns a list of deployed JavaEE Applications. These are the applications that are deployed to a domain, and are registered under. 

enableJavaEEApplication 

Enables an application or module on the specified target. In case of a cluster, the application references of the server instances in that cluster are also enabled. 

enableAppclientModule 

Enables an application or module on the specified target. In case of a cluster, the application references of the server instances in that cluster are also enabled. 

enableConnectorModule 

Enables an application or module on the specified target. In case of a cluster, the application references of the server instances in that cluster are also enabled. 

enableEjbModule 

Enables an application or module on the specified target. In case of a cluster, the application references of the server instances in that cluster are also enabled. 

enableWebModule 

Enables an application or module on the specified target. In case of a cluster, the application references of the server instances in that cluster are also enabled. 

disableJavaEEApplication 

Disables an application or module on the specified target. In case of a cluster, the application references of the server instances in that cluster are also disabled. 

disableAppclientModule 

Disables an application or module on the specified target. In case of a cluster, the application references of the server instances in that cluster are also disabled. 

disableConnectorModule 

Disables an application or module on the specified target. In case of a cluster, the application references of the server instances in that cluster are also disabled. 

disableEjbModule 

Disables an application or module on the specified target. In case of a cluster, the application references of the server instances in that cluster are also disabled. 

disableWebModule 

Disables an application or module on the specified target. In case of a cluster, the application references of the server instances in that cluster are also disabled. 

isJavaEEComponentEnabled 

Returns the status of the application as in configuration. If the specified target is null/blank/"domain", only the enabled flag of the actual application is used. Otherwise, the enabled flag of the application reference is used to determine the enabled status.