org.rhq.enterprise.server.cloud

Class StorageNodeManagerBean

java.lang.Object

org.rhq.enterprise.server.cloud.StorageNodeManagerBean

All Implemented Interfaces:

StorageNodeManagerLocal, StorageNodeManagerRemote

public class StorageNodeManagerBean
extends Object
implements StorageNodeManagerLocal, StorageNodeManagerRemote

Author:

Stefan Negrea, Jiri Kremser

Field Summary

Fields inherited from interface org.rhq.enterprise.server.cloud.StorageNodeManagerLocal

STORAGE_NODE_GROUP_NAME, STORAGE_NODE_PLUGIN_NAME, STORAGE_NODE_RESOURCE_TYPE_NAME

Constructor Summary

Constructors

Constructor and Description
StorageNodeManagerBean()

Method Summary

Methods

Modifier and Type	Method and Description
org.rhq.core.domain.cloud.StorageNode	createStorageNode(org.rhq.core.domain.resource.Resource resource, org.rhq.core.domain.cloud.StorageClusterSettings clusterSettings)
void	deployStorageNode(org.rhq.core.domain.auth.Subject subject, 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.
Map<Integer,Integer>	findResourcesWithAlertDefinitions() Find ids for all resources and sub-resources of Storage Nodes that have alert definitions.
Integer[]	findResourcesWithAlertDefinitions(org.rhq.core.domain.cloud.StorageNode storageNode) Find ids for all resources and sub-resources, of the specified storage node, that have alert definitions.
org.rhq.core.domain.cloud.StorageNode	findStorageNodeByAddress(InetAddress address)
Map<String,List<org.rhq.core.domain.measurement.composite.MeasurementDataNumericHighLowComposite>>	findStorageNodeLoadDataForLast(org.rhq.core.domain.auth.Subject subject, org.rhq.core.domain.cloud.StorageNode node, long beginTime, long endTime, int numPoints)
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.
List<org.rhq.core.domain.cloud.StorageNode>	getClusterNodes()
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.util.PageList<org.rhq.core.domain.cloud.StorageNodeLoadComposite>	getStorageNodeComposites()
List<org.rhq.core.domain.cloud.StorageNode>	getStorageNodes()
void	linkResource(org.rhq.core.domain.resource.Resource resource)
void	prepareNodeForUpgrade(org.rhq.core.domain.auth.Subject subject, org.rhq.core.domain.cloud.StorageNode storageNode) Prepares the node for subsequent upgrade.
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	scheduleOperationInNewTransaction(org.rhq.core.domain.auth.Subject subject, org.rhq.core.domain.operation.bean.ResourceOperationSchedule schedule)
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.
void	updateConfigurationAsync(org.rhq.core.domain.auth.Subject subject, org.rhq.core.domain.cloud.StorageNodeConfigurationComposite storageNodeConfiguration)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StorageNodeManagerBean

public StorageNodeManagerBean()

Method Detail

linkResource

public void linkResource(org.rhq.core.domain.resource.Resource resource)

Specified by:

linkResource in interface StorageNodeManagerLocal

createStorageNode

public org.rhq.core.domain.cloud.StorageNode createStorageNode(org.rhq.core.domain.resource.Resource resource,
                                                      org.rhq.core.domain.cloud.StorageClusterSettings clusterSettings)

Specified by:

createStorageNode in interface StorageNodeManagerLocal

deployStorageNode

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

Description copied from interface: StorageNodeManagerRemote

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.

Specified by:

deployStorageNode in interface StorageNodeManagerLocal

Specified by:

deployStorageNode in interface StorageNodeManagerRemote

Parameters:

subject - user that must have proper permissions

storageNode - storage node to be deployed to the cluster

See Also:

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

undeployStorageNode

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

Description copied from interface: StorageNodeManagerRemote

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.

Specified by:

undeployStorageNode in interface StorageNodeManagerLocal

Specified by:

undeployStorageNode in interface StorageNodeManagerRemote

Parameters:

subject - user that must have proper permissions

storageNode - storage node to be deployed to the cluster

See Also:

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

getLoad

public 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)

Description copied from interface: StorageNodeManagerLocal

Returns the summary of load of the storage node.

the subject needs to have MANAGE_SETTINGS permissions.

Specified by:

getLoad in interface StorageNodeManagerLocal

Specified by:

getLoad in interface StorageNodeManagerRemote

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

getStorageNodes

public List<org.rhq.core.domain.cloud.StorageNode> getStorageNodes()

Specified by:

getStorageNodes in interface StorageNodeManagerLocal

Returns:

All storage nodes, including those that are not part of the cluster.

getClusterNodes

public List<org.rhq.core.domain.cloud.StorageNode> getClusterNodes()

Specified by:

getClusterNodes in interface StorageNodeManagerLocal

Returns:

All storage nodes that are part of the cluster.

getStorageNodeComposites

public org.rhq.core.domain.util.PageList<org.rhq.core.domain.cloud.StorageNodeLoadComposite> getStorageNodeComposites()

Specified by:

getStorageNodeComposites in interface StorageNodeManagerLocal

findStorageNodesByCriteria

public 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)

Description copied from interface: StorageNodeManagerLocal

Fetches the list of StorageNode entities based on provided criteria. the subject needs to have MANAGE_SETTINGS permissions.

Specified by:

findStorageNodesByCriteria in interface StorageNodeManagerLocal

Specified by:

findStorageNodesByCriteria in interface StorageNodeManagerRemote

Parameters:

subject - caller

criteria - the criteria

Returns:

list of nodes

findStorageNodeByAddress

public org.rhq.core.domain.cloud.StorageNode findStorageNodeByAddress(InetAddress address)

Specified by:

findStorageNodeByAddress in interface StorageNodeManagerLocal

prepareNodeForUpgrade

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

Description copied from interface: StorageNodeManagerLocal

Prepares the node for subsequent upgrade.

CAUTION: this method will set the RHQ server to maintenance mode, RHQ storage flushes all the data to disk and backup of all the keyspaces is created

the subject needs to have MANAGE_SETTINGS and MANAGE_INVENTORY permissions.

Specified by:

prepareNodeForUpgrade in interface StorageNodeManagerLocal

Parameters:

subject - caller

storageNode - storage node on which the prepareForUpgrade operation should be run

runClusterMaintenance

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

Description copied from interface: StorageNodeManagerLocal

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.

Specified by:

runClusterMaintenance in interface StorageNodeManagerLocal

Specified by:

runClusterMaintenance in interface StorageNodeManagerRemote

Parameters:

subject - user that must have proper permissions

findNotAcknowledgedStorageNodeAlerts

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

Description copied from interface: StorageNodeManagerLocal

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

Specified by:

findNotAcknowledgedStorageNodeAlerts in interface StorageNodeManagerLocal

Specified by:

findNotAcknowledgedStorageNodeAlerts in interface StorageNodeManagerRemote

Parameters:

subject - subject

Returns:

storage nodes alerts not acknowledged

findNotAcknowledgedStorageNodeAlerts

public 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)

Description copied from interface: StorageNodeManagerLocal

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

Specified by:

findNotAcknowledgedStorageNodeAlerts in interface StorageNodeManagerLocal

Specified by:

findNotAcknowledgedStorageNodeAlerts in interface StorageNodeManagerRemote

Parameters:

subject - subject

Returns:

storage nodes alerts not acknowledged

findAllStorageNodeAlerts

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

Description copied from interface: StorageNodeManagerLocal

Fetches all the Storage Node related alerts.

Specified by:

findAllStorageNodeAlerts in interface StorageNodeManagerLocal

Specified by:

findAllStorageNodeAlerts in interface StorageNodeManagerRemote

Parameters:

subject - subject

Returns:

all storage nodes alerts

findAllStorageNodeAlerts

public 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)

Description copied from interface: StorageNodeManagerLocal

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

Specified by:

findAllStorageNodeAlerts in interface StorageNodeManagerLocal

Specified by:

findAllStorageNodeAlerts in interface StorageNodeManagerRemote

Parameters:

subject - subject

Returns:

all storage nodes alerts

findResourcesWithAlertDefinitions

public Map<Integer,Integer> findResourcesWithAlertDefinitions()

Description copied from interface: StorageNodeManagerLocal

Find ids for all resources and sub-resources of Storage Nodes that have alert definitions. This can be used by the resource criteria queries to find all alerts triggered for storage nodes resources.

Specified by:

findResourcesWithAlertDefinitions in interface StorageNodeManagerLocal

Returns:

map with resource (with defined alert) id as a key and storage node id as a value

findResourcesWithAlertDefinitions

public Integer[] findResourcesWithAlertDefinitions(org.rhq.core.domain.cloud.StorageNode storageNode)

Description copied from interface: StorageNodeManagerLocal

Find ids for all resources and sub-resources, of the specified storage node, that have alert definitions. This can be used by the resource criteria queries to find all alerts triggered for storage nodes resources. If storage node is null it find ids for all resources and sub-resources of Storage Nodes that have alert definitions. Please see StorageNodeManagerLocal.findResourcesWithAlertDefinitions() for more details.

Specified by:

findResourcesWithAlertDefinitions in interface StorageNodeManagerLocal

Parameters:

storageNode - storage node

Returns:

resource ids

retrieveConfiguration

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

Description copied from interface: StorageNodeManagerRemote

Returns the current configuration of the storage node.

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

The subject needs to have MANAGE_SETTINGS permissions.

Specified by:

retrieveConfiguration in interface StorageNodeManagerLocal

Specified by:

retrieveConfiguration in interface StorageNodeManagerRemote

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

updateConfigurationAsync

public void updateConfigurationAsync(org.rhq.core.domain.auth.Subject subject,
                            org.rhq.core.domain.cloud.StorageNodeConfigurationComposite storageNodeConfiguration)

Specified by:

updateConfigurationAsync in interface StorageNodeManagerLocal

updateConfiguration

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

Description copied from interface: StorageNodeManagerRemote

Updates the current configuration of the storage node.

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

The subject needs to have MANAGE_SETTINGS permissions.

Specified by:

updateConfiguration in interface StorageNodeManagerLocal

Specified by:

updateConfiguration in interface StorageNodeManagerRemote

Parameters:

subject - user that must have proper permissions

storageNodeConfiguration - instance of StorageNodeConfigurationComposite with the configuration properties

Returns:

true if the update was successful

scheduleOperationInNewTransaction

public void scheduleOperationInNewTransaction(org.rhq.core.domain.auth.Subject subject,
                                     org.rhq.core.domain.operation.bean.ResourceOperationSchedule schedule)

Specified by:

scheduleOperationInNewTransaction in interface StorageNodeManagerLocal

findStorageNodeLoadDataForLast

public Map<String,List<org.rhq.core.domain.measurement.composite.MeasurementDataNumericHighLowComposite>> findStorageNodeLoadDataForLast(org.rhq.core.domain.auth.Subject subject,
                                                                                                                                org.rhq.core.domain.cloud.StorageNode node,
                                                                                                                                long beginTime,
                                                                                                                                long endTime,
                                                                                                                                int numPoints)

Specified by:

findStorageNodeLoadDataForLast in interface StorageNodeManagerLocal