org.rhq.enterprise.server.cloud

Interface StorageNodeManagerLocal

All Known Implementing Classes:

StorageNodeManagerBean

public interface StorageNodeManagerLocal

Field Summary

Fields

Modifier and Type	Field and Description
static String	STORAGE_NODE_GROUP_NAME
static String	STORAGE_NODE_PLUGIN_NAME
static String	STORAGE_NODE_RESOURCE_TYPE_NAME

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)
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(String 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.
com.google.common.util.concurrent.ListenableFuture<List<org.rhq.core.domain.cloud.StorageNodeLoadComposite>>	getLoadAsync(org.rhq.core.domain.auth.Subject subject, org.rhq.core.domain.cloud.StorageNode node, long beginTime, long endTime)
org.rhq.core.domain.util.PageList<org.rhq.core.domain.cloud.StorageNodeLoadComposite>	getStorageNodeComposites(org.rhq.core.domain.auth.Subject subject)
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)
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)
boolean	updateConfiguration(org.rhq.core.domain.auth.Subject subject, org.rhq.core.domain.cloud.StorageNodeConfigurationComposite storageNodeConfiguration)
void	updateConfigurationAsync(org.rhq.core.domain.auth.Subject subject, org.rhq.core.domain.cloud.StorageNodeConfigurationComposite storageNodeConfiguration)

Field Detail

STORAGE_NODE_GROUP_NAME

static final String STORAGE_NODE_GROUP_NAME

See Also:

Constant Field Values

STORAGE_NODE_RESOURCE_TYPE_NAME

static final String STORAGE_NODE_RESOURCE_TYPE_NAME

See Also:

Constant Field Values

STORAGE_NODE_PLUGIN_NAME

static final String STORAGE_NODE_PLUGIN_NAME

See Also:

Constant Field Values

Method Detail

getStorageNodes

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

Returns:

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

getClusterNodes

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

Returns:

All storage nodes that are part of the cluster.

getStorageNodeComposites

org.rhq.core.domain.util.PageList<org.rhq.core.domain.cloud.StorageNodeLoadComposite> getStorageNodeComposites(org.rhq.core.domain.auth.Subject subject)

linkResource

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

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

getLoadAsync

com.google.common.util.concurrent.ListenableFuture<List<org.rhq.core.domain.cloud.StorageNodeLoadComposite>> getLoadAsync(org.rhq.core.domain.auth.Subject subject,
                                                                                                                        org.rhq.core.domain.cloud.StorageNode node,
                                                                                                                        long beginTime,
                                                                                                                        long endTime)

retrieveConfiguration

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

updateConfiguration

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

updateConfigurationAsync

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

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 - caller

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.

Parameters:

subject - subject

Returns:

storage nodes alerts not acknowledged

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.

Parameters:

subject - subject

Returns:

storage nodes alerts not acknowledged

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.

Parameters:

subject - subject

Returns:

all storage nodes alerts

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.

Parameters:

subject - subject

Returns:

all storage nodes alerts

findStorageNodeByAddress

org.rhq.core.domain.cloud.StorageNode findStorageNodeByAddress(String address)

findResourcesWithAlertDefinitions

Map<Integer,Integer> findResourcesWithAlertDefinitions()

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.

Returns:

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

findResourcesWithAlertDefinitions

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. 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 findResourcesWithAlertDefinitions() for more details.

Parameters:

storageNode - storage node

Returns:

resource ids

prepareNodeForUpgrade

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

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.

Parameters:

subject - caller

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

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

scheduleOperationInNewTransaction

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

findStorageNodeLoadDataForLast

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)

createStorageNode

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

deployStorageNode

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

undeployStorageNode

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