9.8. Methods Available to Proxy Resources

The ProxyFactory classes provide shortcuts for a lot of common resource management tasks, such as viewing monitoring data, running operations, or changing the resource or plug-in configuration. These methods are not in the regular API, but they can be used both by the JBoss ON CLI and by JBoss ON server-side scripts.

The shortcuts and methods available through ProxyFactory are different, depending on the resource type. Methods are only available if the resource type supports that functional area.

This section lists the three most common resource types:

TIP

Use tab-complete in the interactive CLI to find the specific methods available for a resource type or to get the method signatures for individual methods.

Using proxy resources is covered in Section 10.2, “Using Resource Proxies”.

Expand

Table 9.1. Proxy Methods for Platforms
Information Methods
measurements	Displays a pretty-print list of the available metrics, current values, and description of all measurements for the platform resource.
operations	Lists the available operations for the resource type.

Table 9.1. Proxy Methods for Platforms
Shortcut Metric Methods
OSName	OSVersion	architecture	createdDate
description	distributionName	distributionVersion	freeMemory
freeSwapSpace	hostname	idle	totalMemory
systemLoad	totalSwapSpace	usedSwapSpace	usedMemory
userLoad	modifiedDate	waitLoad	version

Table 9.1. Proxy Methods for Platforms
Shortcut Resource Entry Methods
id (inventory ID number)	resourceType	name (inventory name)

Table 9.1. Proxy Methods for Platforms
Shortcut Operation Methods
manualAutodiscovery	cleanYumMetadataCache	viewProcessList

Table 9.1. Proxy Methods for Platforms
Shortcut Configuration Methods
editPluginConfiguration()	pluginConfiguration
pluginConfigurationDefinition

Table 9.1. Proxy Methods for Platforms
Shortcut Content Methods
contentTypes

Table 9.1. Proxy Methods for Platforms
Shortcut Inventory Methods
children

Table 9.1. Proxy Methods for Platforms
Method	Signature
platform.getChild	`ResourceClientProxy getChild(String)` Copy to Clipboard Toggle word wrap
platform.getMeasurement	`Measurement getMeasurement(String)` Copy to Clipboard Toggle word wrap
platform.updatePluginConfiguration	`PluginConfigurationUpdate updatePluginConfiguration(Configuration)` Copy to Clipboard Toggle word wrap
platform.toString	`String toString()` Copy to Clipboard Toggle word wrap

Expand

Table 9.2. Proxy Methods for JBoss AS/EAP Servers
Information Methods
measurements	Displays a pretty-print list of the available metrics, current values, and description of all measurements for the JBoss resource.
operations	Lists the available operations for the resource type.

Table 9.2. Proxy Methods for JBoss AS/EAP Servers
Shortcut Metric Methods
JVMFreeMemory	JVMMaxMemory	JVMTotalMemory	activeThreadCount
activeThreadGroupCount	buildDate	createdDate	description
modifiedDate	startDate	totalTransactions	totalTransactionsperMinute
transactionsCommitted	transactionsCommittedperMinute	transactionsRolledback	transactionsRolledbackperMinute
partitionName	versionName	version

Table 9.2. Proxy Methods for JBoss AS/EAP Servers
Shortcut Resource Entry Methods
id (inventory ID number)	resourceType	name (inventory name)

Table 9.2. Proxy Methods for JBoss AS/EAP Servers
Shortcut Operation Methods
restart	shutdown	start

Table 9.2. Proxy Methods for JBoss AS/EAP Servers
Shortcut Configuration Methods
editPluginConfiguration()	pluginConfiguration
pluginConfigurationDefinition

Table 9.2. Proxy Methods for JBoss AS/EAP Servers
Shortcut Content Methods
contentTypes

Table 9.2. Proxy Methods for JBoss AS/EAP Servers
Shortcut Inventory Methods
children

Table 9.2. Proxy Methods for JBoss AS/EAP Servers
Method	Signature
jbossas.getChild	`ResourceClientProxy getChild(String)` Copy to Clipboard Toggle word wrap
jbossas.getMeasurement	`Measurement getMeasurement(String)` Copy to Clipboard Toggle word wrap
jbossas.updatePluginConfiguration	`PluginConfigurationUpdate updatePluginConfiguration(Configuration)` Copy to Clipboard Toggle word wrap
jbossas.toString	`String toString()` Copy to Clipboard Toggle word wrap

Expand

Table 9.3. Proxy Methods for Content Sources (EARs, WARs, JARs)
Information Methods
measurements	Displays a pretty-print list of the available metrics, current values, and description of all measurements for the content resource.
operations	Lists the available operations for the resource type.

Table 9.3. Proxy Methods for Content Sources (EARs, WARs, JARs)
Shortcut Metric Methods
createdDate	modifiedDate	description
path	version	exploded

Table 9.3. Proxy Methods for Content Sources (EARs, WARs, JARs)
Shortcut Resource Entry Methods
id (inventory ID number)	resourceType	name (inventory name)

Table 9.3. Proxy Methods for Content Sources (EARs, WARs, JARs)
Shortcut Operation Methods
revert

Table 9.3. Proxy Methods for Content Sources (EARs, WARs, JARs)
Shortcut Configuration Methods
editPluginConfiguration()	pluginConfiguration
pluginConfigurationDefinition

Table 9.3. Proxy Methods for Content Sources (EARs, WARs, JARs)
Shortcut Content Methods
contentTypes	backingContent

Table 9.3. Proxy Methods for Content Sources (EARs, WARs, JARs)
Shortcut Inventory Methods
children

Table 9.3. Proxy Methods for Content Sources (EARs, WARs, JARs)
Method	Signature
content.getChild	`ResourceClientProxy getChild(String)` Copy to Clipboard Toggle word wrap
content.getMeasurement	`Measurement getMeasurement(String)` Copy to Clipboard Toggle word wrap
content.updatePluginConfiguration	`PluginConfigurationUpdate updatePluginConfiguration(Configuration)` Copy to Clipboard Toggle word wrap
content.toString	`String toString()` Copy to Clipboard Toggle word wrap
content.retrieveBackingContent	`retrieveBackingContent(String fileName)` Copy to Clipboard Toggle word wrap
content.updateBackingContent	`updateBackingContent(String filename, String displayVersion)` Copy to Clipboard Toggle word wrap

Report a bug

Retour au début

Ce contenu n'est pas disponible dans la langue sélectionnée.

9.8. Methods Available to Proxy Resources

Apprendre

Essayez, achetez et vendez

Communautés

À propos de la documentation Red Hat

Rendre l’open source plus inclusif

À propos de Red Hat

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links