Red Hat Training

A Red Hat training course is available for Red Hat JBoss Operations Network

Development: Remote APIs

Red Hat JBoss Operations Network 3.3

Contains the javadoc for the Red Hat JBoss Operations Network Remote API

Edition 3.3

Jared Morgan

Zach Rhoads

Ella Deon Ballard

Abstract

This is the javadoc of the Red Hat JBoss Operations Network remote API, with a list of changes between releases of the API.

Chapter 1. Javadocs

For the matching domain classes please see the Domain javadoc.

Chapter 2. Changes from 3.2 to 3.3

2.1. Changed Class: BundleManagerRemote

Table 2.1. Changed Methods

Old Method Updated Method
BundleDestination createBundleDestination(Subject subject, int bundleId, String name, String description, String destBaseDirName, String deployDir, Integer groupId) throws Exception;
BundleDestination createBundleDestination(Subject subject, int bundleId, String name, String description, String destinationSpecification, String deployDir, Integer groupId) throws Exception;

2.2. Changed Class: StorageNodeManagerRemote

Table 2.2. Removed Methods

Removed Method
void updateAddress(int storageNodeId, String address);

2.3. New Class: AgentManagerRemote

Table 2.3. New Methods

New Method
void deleteAgent(Subject subject, Agent agent);
PageList<Agent> findAgentsByCriteria(Subject subject, AgentCriteria criteria);

2.4. Changed Class: RemoteInstallManagerRemote

Table 2.4. New Methods

New Method
void checkSSHConnection(Subject subject, RemoteAccessInfo remoteAccessInfo) throws SSHSecurityException;
AgentInstallInfo installAgent(Subject subject, RemoteAccessInfo remoteAccessInfo, CustomAgentInstallData customData);
String uninstallAgent(Subject subject, RemoteAccessInfo remoteAccessInfo, String agentInstallPath);
void addBundleGroupsToRole(Subject subject, int roleId, int[] bundleGroupIds);

Table 2.5. Deprecated Methods

Deprecated Method
AgentInstallInfo installAgent(Subject subject, RemoteAccessInfo remoteAccessInfo, String parentPath);

2.5. Changed Class: CallTimeDataManagerRemote

Table 2.6. New Methods

New Method
PageList<CallTimeDataComposite> findCallTimeDataRawForResource(Subject subject, int scheduleId, long beginTime, long endTime, PageControl pc);

2.6. Changed Class: MeasurementDataManagerRemote

Table 2.7. New Methods

New Method
MeasurementAggregate getAggregate(Subject subject, int groupId, int definitionId, long startTime, long endTime);

2.7. New Class: ServerPluginManagerRemote

Table 2.8. New Methods

New Method
void restartMasterPluginContainer(Subject subject);
List<ServerPlugin> getServerPlugins(Subject subject);
List<PluginKey> enableServerPlugins(Subject subject, List<Integer> pluginIds) throws Exception;
List<PluginKey> disableServerPlugins(Subject subject, List<Integer> pluginIds) throws Exception;
List<PluginKey> deleteServerPlugins(Subject subject, List<Integer> pluginIds) throws Exception;
ControlResults invokeServerPluginControl(Subject subject, PluginKey pluginKey, String controlName, Configuration params) throws Exception;

2.8. New Class: PluginManagerRemote

Table 2.9. New Methods

New Method
void update(Subject subject) throws Exception;
String schedulePluginUpdateOnAgents(Subject subject, long delayInMilliseconds) throws Exception;
boolean isPluginUpdateOnAgentsFinished(Subject subject, String handle);
List<Plugin> deployUsingBytes(Subject subject, String pluginJarName, byte[] pluginJarBytes) throws Exception;
List<Plugin> deployUsingContentHandle(Subject subject, String pluginJarName, String handle) throws Exception;
PageList<Plugin> findPluginsByCriteria(Subject subject, PluginCriteria criteria);
void enablePlugins(Subject subject, List<Integer> pluginIds) throws Exception;
void disablePlugins(Subject subject, List<Integer> pluginIds) throws Exception;
void deletePlugins(Subject subject, List<Integer> pluginIds) throws Exception;

Appendix A. Document History

Revision History
Revision 3.3.1-5February 18, 2015Jared Morgan
Prepared for JBoss ON 3.3.1.GA Release
Revision 3.3-10November 17, 2014Jared Morgan
Updated for JBoss ON 3.3 GA

Legal Notice

Copyright © 2015 Red Hat, Inc..
This document is licensed by Red Hat under the Creative Commons Attribution-ShareAlike 3.0 Unported License. If you distribute this document, or a modified version of it, you must provide attribution to Red Hat, Inc. and provide a link to the original. If the document is modified, all Red Hat trademarks must be removed.
Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.
Red Hat, Red Hat Enterprise Linux, the Shadowman logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.
Linux® is the registered trademark of Linus Torvalds in the United States and other countries.
Java® is a registered trademark of Oracle and/or its affiliates.
XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.
MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.
Node.js® is an official trademark of Joyent. Red Hat Software Collections is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.
The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation's permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.
All other trademarks are the property of their respective owners.