Red Hat Training
A Red Hat training course is available for Red Hat JBoss Operations Network
Chapter 7. Available Implicit Variables in the JBoss ON API
In the Java programming language, classes in the java.lang package do not have to be imported; they are automatically made available. Classes in other packages, however, have to be explicitly imported.
In the JBoss ON CLI, there are a number of classes, particularly from the domain API, that are used routinely. To simplify using the JBoss ON CLI, everything under the
org.rhq.core.domain
class is automatically imported, which makes it easier to use the CLI for managing resources, alerts, and other configuration areas. For example, the class org.rhq.core.domain.criteria.ResourceCriteria
is commonly used to query resources. The entire class path can be given when calling that class:
var criteria = new org.rhq.core.domain.criteria.ResourceCriteria(); var resource = new org.rhq.core.domain.resource.Resource();
Because the domain class is already imported, this can be more succinctly written as:
var criteria = new ResourceCriteria(); var resource = new Resource();
Common variables used with the CLI scripts are listed in Table 7.1, “Variables Available by Default to the JBoss ON CLI”. Methods and other information about these variables are in Chapter 8, Methods Specific to the JBoss ON CLI.
Table 7.1. Variables Available by Default to the JBoss ON CLI
Variable | Type | Description | Access Requires Login |
---|---|---|---|
rhq | org.rhq.enterprise.client.Controller | Provides built-in commands to the interactive CLI: login, logout, quit, exec, and version. Two of these methods, login and logout, can be called in server script files, such as rhq.login('rhqadmin', 'rhqadmin') . | YES |
subject | org.rhq.core.domain.auth.Subject | Represents the current, logged in user. For security purposes, all remote service invocations require the subject to be passed; however, the CLI will implicitly pass the subject for you. | YES |
Assert | org.rhq.bindings.util.ScriptAssert | Provides assertion utilities for CLI scripts. | NO |
pretty |
org.rhq.enterprise.client.TabularWriter
| Provides for tabular-formatted printed and handles converting objects, particularly domain objects in the packages under org.rhq.core.domain, into a format suitable for display in the console. | NO |
unlimitedPC | org.rhq.core.domain.util.PageControl | NO | |
pageControl | org.rhq.core.domain.util.PageControl | Used to specify paging and sorting on data retrieval operations | NO |
exporter |
org.rhq.enterprise.client.Exporter
| Used to export output to a file. Supported formats are plain text in tabular format and CSV. | NO |
ProxyFactory |
org.rhq.bindings.client
| NO | |
scriptUtil |
org.rhq.enterprise.client.utility.ScriptUtil
| Provides methods that can be useful when writing scripts. | NO |
AlertManager | org.rhq.enterprise.server.alert.AlertManagerRemote | Provides an interface into the alerts subsystem. | YES |
AlertDefinitionManager | org.rhq.enterprise.server.alert.AlertDefinitionManagerRemote | Provides an interface into the alerts definition subsystem. | YES |
AvailabilityManager | org.rhq.enterprise.server.measurement.AvailabilityManagerRemote | Provides an interface into the measurement subsystem that can be used to determine resources' availability. | YES |
CallTimeDataManager | org.rhq.enterprise.server.measurement.CallTimeDataManagerRemote | Provides an interface into the measurement subsystem for retrieving call-time metric data. | YES |
RepoManager | org.rhq.enterprise.server.content.RepoManagerRemote | Provides an interface into the content subsystem for working with repositories. | YES |
ConfigurationManager | org.rhq.enterprise.server.configuration.ConfigurationManagerRemote | Provides an interface into the configuration subsystem. | YES |
DataAccessManager | org.rhq.enterprise.server.report.DataAccessRemote | Provides an interface for executing user-defined queries. | YES |
EventManager | org.rhq.enterprise.server.event.EventManagerRemote | Provides an interface into the events subsystem. | YES |
MeasurementBaselineManager | org.rhq.enterprise.server.measurement.MeasurementBaselineManagerRemote | Provides an interface into the measurement subsystem for working with measurement baselines. | YES |
MeasurementDataManager | org.rhq.enterprise.server.measurement.MeasurementDataManagerRemote | Provides an interface into the measurement subsystem for working with measurement data. | YES |
MeasurementDefinitionManager | org.rhq.enterprise.server.measurement.MeasurementDefinitionManagerRemote | Provides an interface into the measurement subsystem for working with measurement definitions. | YES |
MeasurementScheduleManager | org.rhq.enterprise.server.measurement.MeasurementScheduleManagerRemote | Provides an interface into the measurement subsystem for working with measurement schedules. | YES |
OperationManager | org.rhq.enterprise.server.operation.OperationManagerRemote | Provides an interface into the operation subsystem. | YES |
ResourceManager | org.rhq.enterprise.server.resource.ResourceManagerRemote | Provides an interface into the resource subsystem. | YES |
ResourceGroupManager | org.rhq.enterprise.server.resource.group.ResourceGroupManagerRemote | Provides an interface into the resource group subsystem. | YES |
GroupDefinitionManager | org.rhq.enterprise.server.resource.group.definition.GroupDefinitionManagerRemote | Provides an interface for creating and managing dynagroups. | YES |
ResourceTypeManager | org.rhq.enterprise.server.resource.ResourceTypeManagerRemote | Provides an interface into the resource subsystem for working with resource types. | YES |
RoleManager | org.rhq.enterprise.server.authz.RoleManagerRemote | Provides an interface into the security subsystem for working with security rules and roles. | YES |
SubjectManager | org.rhq.enterprise.server.auth.SubjectManagerRemote | Provides an interface into the security subsystem for working with users. | YES |
SupportManager | org.rhq.enterprise.server.support.SupportManagerRemote | Provides an interface into the reporting subsystem for getting reports of managed resources. | YES |