Development: Remote APIs

JBoss Operations Network 3.2

javadoc for the JBoss Operations Network remote API

Edition 3.2

December 4, 2013

Abstract

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

Chapter 2. Changes from 3.1.2 to 3.2

2.1. Changed Class: RoleManagerRemote

Table 2.1. New Methods

New Method 
void addBundleGroupsToRole(Subject subject, int roleId, int[] bundleGroupIds);


void addRolesToBundleGroup(Subject subject, int bundleGroupId, int[] roleIds);


void setAssignedBundleGroups(Subject subject, int roleId, int[] bundleGroupIds);


void removeBundleGroupsFromRole(Subject subject, int roleId, int[] bundleGroupIds);


void removeRolesFromBundleGroup(Subject subject, int bundleGroupId, int[] roleIds);

2.2. Changed Class: BundleManagerRemote

Table 2.2. New Methods

New Method 
BundleFile addBundleFileViaURL(Subject subject, int bundleVersionId, String name, String version,
    Architecture architecture, String bundleFileUrl, String userName, String password) throws Exception;

void assignBundlesToBundleGroups(Subject subject, int[] bundleGroupIds, int[] bundleIds);
BundleGroup createBundleGroup(Subject subject, BundleGroup bundleGroup) throws Exception;
BundleVersion createInitialBundleVersionViaRecipe(Subject subject, int[] bundleGroupIds, String recipe)
    throws Exception;
BundleVersion createInitialBundleVersionViaFile(Subject subject, int[] bundleGroupIds, File distributionFile)
        throws Exception;
BundleVersion createInitialBundleVersionViaContentHandle(Subject subject, int[] bundleGroupIds,
    String temporaryContentHandle) throws Exception;
BundleVersion createInitialBundleVersionViaByteArray(Subject subject, int[] bundleGroupIds, byte[] fileBytes)
        throws Exception;
BundleVersion createInitialBundleVersionViaURL(Subject subject, int[] bundleGroupIds, String distributionFileUrl)
        throws Exception;
BundleVersion createBundleVersionViaURL(Subject subject, String distributionFileUrl, String username,
    String password) throws Exception;
BundleVersion createInitialBundleVersionViaURL(Subject subject, int[] bundleGroupIds, String distributionFileUrl,
    String username, String password) throws Exception;
void deleteBundleGroups(Subject subject, int[] ids) throws Exception;
PageList<BundleGroup> findBundleGroupsByCriteria(Subject subject, BundleGroupCriteria criteria);
Set<String> getBundleVersionFilenames(Subject subject, int bundleVersionId, boolean withoutBundleFileOnly)
    throws Exception;
void unassignBundlesFromBundleGroups(Subject subject, int[] bundleGroupIds, int[] bundleIds);
BundleGroup updateBundleGroup(Subject subject, BundleGroup bundleGroup) throws Exception;

Table 2.3. Removed Methods

Removed Method 
Map<String, Boolean> getAllBundleVersionFilenames(Subject subject, int bundleVersionId) throws Exception;

2.3. New Class: StorageNodeManagerRemote

Table 2.4. New Methods

New Method 
StorageNodeLoadComposite getLoad(Subject subject, StorageNode node, long beginTime, long endTime);
StorageNodeConfigurationComposite retrieveConfiguration(Subject subject, StorageNode storageNode);
boolean updateConfiguration(Subject subject, StorageNodeConfigurationComposite storageNodeConfiguration);
PageList<StorageNode> findStorageNodesByCriteria(Subject subject, StorageNodeCriteria criteria);
PageList<Alert> findNotAcknowledgedStorageNodeAlerts(Subject subject);
PageList<Alert> findNotAcknowledgedStorageNodeAlerts(Subject subject, StorageNode storageNode);
PageList<Alert> findAllStorageNodeAlerts(Subject subject);
PageList<Alert> findAllStorageNodeAlerts(Subject subject, StorageNode storageNode);
void deployStorageNode(Subject sbubject, StorageNode storageNode);
void undeployStorageNode(Subject subject, StorageNode storageNode);
void runClusterMaintenance(Subject subject);

2.4. Changed Class: ConfigurationManagerRemote

Table 2.5. New Methods

New Method 
ageList<GroupPluginConfigurationUpdate> findGroupPluginConfigurationUpdatesByCriteria(Subject subject,
    GroupPluginConfigurationUpdateCriteria criteria);
PageList<GroupResourceConfigurationUpdate> findGroupResourceConfigurationUpdatesByCriteria(Subject subject,
    GroupResourceConfigurationUpdateCriteria criteria);

Table 2.6. Deprecated Methods

Deprecated Method 
GroupPluginConfigurationUpdate getGroupPluginConfigurationUpdate(Subject subject, int configurationUpdateId);
GroupResourceConfigurationUpdate getGroupResourceConfigurationUpdate(Subject subject, int configurationUpdateId);
Configuration translateResourceConfiguration(Subject subject, int resourceId, Configuration configuration,
    boolean fromStructured) throws ResourceNotFoundException;

2.5. Changed Class: ContentManagerRemote

Table 2.7. New Methods

New Method 
String createTemporaryContentHandle();

void uploadContentFragment(String temporaryContentHandle, byte[] fragment, int off, int len);

PackageVersion createPackageVersionWithDisplayVersion(Subject subject, String packageName, int packageTypeId,
    String version, String displayVersion, Integer architectureId, String temporaryContentHandle);

Table 2.8. Changed Methods

Old Method Updated Method 
byte[] getPackageBytes(Subject user, int resourceId,
    int installedPackageId);
 
byte[] getPackageBytes(Subject subject, int resourceId, int installedPackageId);

2.6. Changed Class: RepoManagerRemote

Table 2.9. New Methods

New Method 
byte[] getPackageVersionBytes(Subject subject, int repoId, int packageVersionId);

2.7. Changed Class: DiscoveryBossRemote

Table 2.10. New Methods

New Method 
void unignoreAndImportResources(Subject subject, int[] resourceIds);

2.8. Changed Class: MeasurementDataManagerRemote

Table 2.11. New Methods

New Method 
MeasurementAggregate getMeasurementAggregate(Subject subject, int scheduleId, long startTime, long endTime)
    throws MeasurementException;

Note

The org.rhq.enterprise.server.measurement.MeasurementDataManagerRemote#getAggregate class has been changed from org.rhq.core.domain.measurement.MeasurementAggregate to org.rhq.enterprise.server.measurement.MeasurementAggregate. This is the same class; only the package is different. Command-line scripts will be unaffected by this. For Java clients which depend on the EJB API, the clients imports should be updated and then recompiled.

Table 2.12. Removed Methods

Removed Method 
MeasurementAggregate getAggregate(Subject subject, int scheduleId, long startTime, long endTime);

Table 2.13. Deprecated Methods

Deprecated Method 
org.rhq.enterprise.server.measurement.MeasurementAggregate getAggregate(Subject subject, int scheduleId,
    long startTime, long endTime);
Set<MeasurementData> findLiveData(Subject subject, int resourceId, int[] definitionIds);
Set<MeasurementData> findLiveData(Subject subject, int resourceId, int[] definitionIds);
Set<MeasurementData> findLiveDataForGroup(Subject subject, int groupId, int[] resourceIds, int[] definitionIds);

2.9. Changed Class: MeasurementScheduleManagerRemote

Table 2.14. Deprecated Methods

Deprecated Method 
void disableMeasurementTemplates(Subject subject, int[] measurementDefinitionIds);

2.10. Changed Class: OperationManagerRemote

Table 2.15. New Methods

New Method 
ResourceOperationSchedule scheduleResourceOperationUsingCron(Subject subject, int resourceId, String operationName,
    String cronExpression, int timeout, Configuration parameters, String description) throws ScheduleException;
GroupOperationSchedule scheduleGroupOperationUsingCron(Subject subject, int groupId,
    int[] executionOrderResourceIds, boolean haltOnFailure, String operationName, Configuration parameters,
    String cronExpression, int timeout, String description) throws ScheduleException;

2.11. Changed Class: ResourceFactoryManagerRemote

Table 2.16. New Methods

New Method 
CreateResourceHistory createPackageBackedResourceViaContentHandle(Subject subject, int parentResourceId,
    int newResourceTypeId, String newResourceName, Configuration pluginConfiguration, String packageName,
    String packageVersion, Integer architectureId, Configuration deploymentTimeConfiguration,
    String temporaryContentHandle, Integer timeout);

2.12. Changed Class: ResourceManagerRemote

Table 2.17. New Methods

New Method 
void uninventoryAllResourcesByAgent(Subject user, Agent doomedAgent);
void uninventoryResourcesOfResourceType(Subject subject, int resourceTypeId);

Table 2.18. Changed Methods

Old Method Updated Method 
Resource getResource(Subject subject, int resourceId);
 
Resource getResource(Subject subject, int resourceId) throws ResourceNotFoundException, PermissionException;
Resource getParentResource(Subject subject, int resourceId);
 
Resource getParentResource(Subject subject, int resourceId) throws ResourceNotFoundException, PermissionException;

2.13. Changed Class: ResourceTypeManagerRemote

Table 2.19. New Methods

New Method 
void setResourceTypeIgnoreFlagAndUninventoryResources(Subject subject, int resourceTypeId, boolean ignoreFlag);

2.14. Changed Class: ClusterManagerRemote

Table 2.20. Deprecated Methods

Deprecated Method 
ResourceGroup createAutoClusterBackingGroup(Subject subject, ClusterKey clusterKey, boolean addResources);
ResourceGroup getAutoClusterBackingGroup(Subject subject, ClusterKey clusterKey);
List<Resource> getAutoClusterResources(Subject subject, ClusterKey clusterKey);
ClusterFlyweight getClusterTree(Subject subject, int groupId);

2.15. Changed Class: RoleManagerRemote

Table 2.21. Changed Methods

Old Method Updated Method 
ResourceGroupComposite getResourceGroupComposite(Subject subject, int groupId);
 
ResourceGroupComposite getResourceGroupComposite(Subject subject, int groupId)
    throws ResourceGroupNotFoundException;

2.16. Changed Class: GroupDefinitionManagerRemote

Table 2.22. New Methods

New Method 
GroupDefinition createGroupDefinition(Subject subject, GroupDefinition newGroupDefinition)
    throws GroupDefinitionAlreadyExistsException, GroupDefinitionCreateException;
PageList<GroupDefinition> findGroupDefinitionsByCriteria(Subject subject, ResourceGroupDefinitionCriteria criteria);
void removeGroupDefinition(Subject subject, Integer groupDefinitionId) throws GroupDefinitionNotFoundException,
    GroupDefinitionDeleteException;
GroupDefinition updateGroupDefinition(Subject subject, GroupDefinition updated)
    throws GroupDefinitionAlreadyExistsException, GroupDefinitionUpdateException, InvalidExpressionException,
    ResourceGroupUpdateException;
void calculateGroupMembership(Subject subject, int groupDefinitionId) throws ResourceGroupDeleteException,
    GroupDefinitionDeleteException, GroupDefinitionNotFoundException, InvalidExpressionException;

Appendix A. Document History

Revision History
Revision 3.2-2January 13, 2014Ella Deon Ballard
Rebuilding with the domain API.
Revision 3.2-1December 11, 2013Ella Deon Ballard
Initial release for JBoss ON 3.2.

Legal Notice

Copyright © 2012 Red Hat, Inc..
This document is licensed by Red Hat under the Content from creativecommons.org is not included.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.