org.rhq.enterprise.server.cloud

Interface StorageNodeManagerRemote

All Known Subinterfaces:

StorageNodeManagerLocal

All Known Implementing Classes:

StorageNodeManagerBean

public interface StorageNodeManagerRemote

Remote interface to the manager responsible for creating and managing storage nodes.

Author:

Jirka Kremser

Method Summary

Methods

Modifier and Type	Method and Description
void	deployStorageNode(org.rhq.core.domain.auth.Subject sbubject, org.rhq.core.domain.cloud.StorageNode storageNode) Runs the deploy operations on the given storage node.
org.rhq.core.domain.util.PageList<org.rhq.core.domain.alert.Alert>	findAllStorageNodeAlerts(org.rhq.core.domain.auth.Subject subject) Fetches all the Storage Node related alerts.
org.rhq.core.domain.util.PageList<org.rhq.core.domain.alert.Alert>	findAllStorageNodeAlerts(org.rhq.core.domain.auth.Subject subject, org.rhq.core.domain.cloud.StorageNode storageNode) Fetches all the Storage Node related alerts for the specified storage node.
org.rhq.core.domain.util.PageList<org.rhq.core.domain.alert.Alert>	findNotAcknowledgedStorageNodeAlerts(org.rhq.core.domain.auth.Subject subject) Fetches the list of Storage Node related alerts that have not yet been acknowledged.
org.rhq.core.domain.util.PageList<org.rhq.core.domain.alert.Alert>	findNotAcknowledgedStorageNodeAlerts(org.rhq.core.domain.auth.Subject subject, org.rhq.core.domain.cloud.StorageNode storageNode) Fetches the list of Storage Node related alerts that have not yet been acknowledged for the specified storage node.
org.rhq.core.domain.util.PageList<org.rhq.core.domain.cloud.StorageNode>	findStorageNodesByCriteria(org.rhq.core.domain.auth.Subject subject, org.rhq.core.domain.criteria.StorageNodeCriteria criteria) Fetches the list of StorageNode entities based on provided criteria.
org.rhq.core.domain.cloud.StorageNodeLoadComposite	getLoad(org.rhq.core.domain.auth.Subject subject, org.rhq.core.domain.cloud.StorageNode node, long beginTime, long endTime) Returns the summary of load of the storage node.
org.rhq.core.domain.cloud.StorageNodeConfigurationComposite	retrieveConfiguration(org.rhq.core.domain.auth.Subject subject, org.rhq.core.domain.cloud.StorageNode storageNode) Returns the current configuration of the storage node.
void	runClusterMaintenance(org.rhq.core.domain.auth.Subject subject) Schedules read repair to run on the storage cluster.
void	undeployStorageNode(org.rhq.core.domain.auth.Subject subject, org.rhq.core.domain.cloud.StorageNode storageNode) Runs the undeploy operations on the given storage node.
boolean	updateConfiguration(org.rhq.core.domain.auth.Subject subject, org.rhq.core.domain.cloud.StorageNodeConfigurationComposite storageNodeConfiguration) Updates the current configuration of the storage node.

Method Detail

getLoad

org.rhq.core.domain.cloud.StorageNodeLoadComposite getLoad(org.rhq.core.domain.auth.Subject subject,
                                                         org.rhq.core.domain.cloud.StorageNode node,
                                                         long beginTime,
                                                         long endTime)

Returns the summary of load of the storage node.

The subject needs to have MANAGE_SETTINGS permissions.

Parameters:

subject - user that must have proper permissions

node - storage node entity (it can be a new object, but the id should be set properly)

beginTime - the start time

endTime - the end time

Returns:

instance of StorageNodeLoadComposite with the aggregate measurement data of selected metrics

retrieveConfiguration

org.rhq.core.domain.cloud.StorageNodeConfigurationComposite retrieveConfiguration(org.rhq.core.domain.auth.Subject subject,
                                                                                org.rhq.core.domain.cloud.StorageNode storageNode)

Returns the current configuration of the storage node.

For updating the configuration see retrieveConfiguration(Subject,StorageNode).

The subject needs to have MANAGE_SETTINGS permissions.

Parameters:

subject - user that must have proper permissions

storageNode - the storage node for which we want to get the configuration

Returns:

instance of StorageNodeConfigurationComposite with the configuration properties

Since:

4.9

updateConfiguration

boolean updateConfiguration(org.rhq.core.domain.auth.Subject subject,
                          org.rhq.core.domain.cloud.StorageNodeConfigurationComposite storageNodeConfiguration)

Updates the current configuration of the storage node.

For retrieving the configuration see updateConfiguration(Subject,StorageNodeConfigurationComposite).

The subject needs to have MANAGE_SETTINGS permissions.

Parameters:

subject - user that must have proper permissions

storageNodeConfiguration - instance of StorageNodeConfigurationComposite with the configuration properties

Returns:

true if the update was successful

Since:

4.9

findStorageNodesByCriteria

org.rhq.core.domain.util.PageList<org.rhq.core.domain.cloud.StorageNode> findStorageNodesByCriteria(org.rhq.core.domain.auth.Subject subject,
                                                                                                  org.rhq.core.domain.criteria.StorageNodeCriteria criteria)

Fetches the list of StorageNode entities based on provided criteria.

The subject needs to have MANAGE_SETTINGS permissions.

Parameters:

subject - user that must have proper permissions

criteria - the criteria

Returns:

list of nodes

findNotAcknowledgedStorageNodeAlerts

org.rhq.core.domain.util.PageList<org.rhq.core.domain.alert.Alert> findNotAcknowledgedStorageNodeAlerts(org.rhq.core.domain.auth.Subject subject)

Fetches the list of Storage Node related alerts that have not yet been acknowledged.

The subject needs to have MANAGE_SETTINGS permissions.

Parameters:

subject - user that must have proper permissions

Returns:

storage nodes alerts not acknowledged

Since:

4.9

findNotAcknowledgedStorageNodeAlerts

org.rhq.core.domain.util.PageList<org.rhq.core.domain.alert.Alert> findNotAcknowledgedStorageNodeAlerts(org.rhq.core.domain.auth.Subject subject,
                                                                                                      org.rhq.core.domain.cloud.StorageNode storageNode)

Fetches the list of Storage Node related alerts that have not yet been acknowledged for the specified storage node.

The subject needs to have MANAGE_SETTINGS permissions.

Parameters:

subject - user that must have proper permissions

storageNode - the storage node

Returns:

storage nodes alerts not acknowledged

Since:

4.9

findAllStorageNodeAlerts

org.rhq.core.domain.util.PageList<org.rhq.core.domain.alert.Alert> findAllStorageNodeAlerts(org.rhq.core.domain.auth.Subject subject)

Fetches all the Storage Node related alerts.

The subject needs to have MANAGE_SETTINGS permissions.

Parameters:

subject - user that must have proper permissions

Returns:

all storage nodes alerts

Since:

4.9

findAllStorageNodeAlerts

org.rhq.core.domain.util.PageList<org.rhq.core.domain.alert.Alert> findAllStorageNodeAlerts(org.rhq.core.domain.auth.Subject subject,
                                                                                          org.rhq.core.domain.cloud.StorageNode storageNode)

Fetches all the Storage Node related alerts for the specified storage node.

The subject needs to have MANAGE_SETTINGS permissions.

Parameters:

subject - user that must have proper permissions

storageNode - the storage node

Returns:

all storage nodes alerts

Since:

4.9

deployStorageNode

void deployStorageNode(org.rhq.core.domain.auth.Subject sbubject,
                     org.rhq.core.domain.cloud.StorageNode storageNode)

Runs the deploy operations on the given storage node. This operation should ensure the node will be part of the RHQ storage cluster.

This will move the storage node from operation mode INSTALLED to the mode NORMAL going through following phases:

1. ANNOUNCE
2. BOOTSTRAP
3. ADD_MAINTENANCE

This can be run also on a storage node that is in any intermediate modes mentioned above, because of some failure during the deployment process.

The subject needs to have MANAGE_SETTINGS permissions.

Parameters:

sbubject - user that must have proper permissions

storageNode - storage node to be deployed to the cluster

Since:

4.9

See Also:

https://docs.jboss.org/author/display/RHQ/Deploying+Storage+Nodes

undeployStorageNode

void undeployStorageNode(org.rhq.core.domain.auth.Subject subject,
                       org.rhq.core.domain.cloud.StorageNode storageNode)

Runs the undeploy operations on the given storage node. This operation should ensure the node will removed from the RHQ storage cluster.

This will move the storage node from operation mode NORMAL or any other mode to the mode UNINSTALL. At the end of the day, the node is removed also from the relational database. Currently there is no way to add it back.

WARNING: Run this operation only if you know what you are doing.

The subject needs to have MANAGE_SETTINGS permissions.

Parameters:

subject - user that must have proper permissions

storageNode - storage node to be deployed to the cluster

Since:

4.9

See Also:

https://docs.jboss.org/author/display/RHQ/Deploying+Storage+Nodes

runClusterMaintenance

void runClusterMaintenance(org.rhq.core.domain.auth.Subject subject)

Schedules read repair to run on the storage cluster. The repair operation is executed one node at a time. This method is invoked from StorageClusterReadRepairJob as part of regularly scheduled maintenance.

NOTE: Repair is one of the most resource-intensive operations that a storage node performs. Make sure you know what you are doing if you invoke this method outside of the regularly scheduled maintenance window.

the subject needs to have MANAGE_SETTINGS permissions.

Parameters:

subject - user that must have proper permissions

Since:

4.9