org.apache.ambari.server.orm.dao

Class AlertDefinitionDAO

java.lang.Object

org.apache.ambari.server.orm.dao.AlertDefinitionDAO

public class AlertDefinitionDAO
extends Object

The AlertDefinitionDAO class is used to manage the persistence and retrieval of AlertDefinitionEntity instances.

Constructor Summary

Constructors

Constructor and Description
AlertDefinitionDAO()

Method Summary

Modifier and Type	Method and Description
void	create(AlertDefinitionEntity alertDefinition) Persists a new alert definition, also creating the associated AlertGroupEntity relationship for the definition's service default group.
void	createOrUpdate(AlertDefinitionEntity alertDefinition) Creates or updates the specified entity.
List<AlertDefinitionEntity>	findAgentScoped(long clusterId) Gets all alert definitions that are not bound to a particular service.
List<AlertDefinitionEntity>	findAll() Gets all alert definitions stored in the database.
List<AlertDefinitionEntity>	findAll(long clusterId) Gets all alert definitions stored in the database.
List<AlertDefinitionEntity>	findAllEnabled(long clusterId) Gets all enabled alert definitions stored in the database for the specified cluster.
AlertDefinitionEntity	findById(long definitionId) Gets an alert definition with the specified ID.
List<AlertDefinitionEntity>	findByIds(List<Long> definitionIds) Gets all of the alert definitions for the list of IDs given.
AlertDefinitionEntity	findByName(long clusterId, String definitionName) Gets an alert definition with the specified name.
List<AlertDefinitionEntity>	findByService(long clusterId, String serviceName) Gets all alert definitions for the given service in the specified cluster.
List<AlertDefinitionEntity>	findByServiceComponent(long clusterId, String serviceName, String componentName) Gets all alert definitions that are not bound to a particular service.
List<AlertDefinitionEntity>	findByServiceMaster(long clusterId, Set<String> services) Gets all alert definitions for the specified services that do not have a component and do not belong to AGGREGATE source type.
List<AlertDefinitionEntity>	findBySourceType(Long clusterId, SourceType sourceType)
AlertDefinitionEntity	merge(AlertDefinitionEntity alertDefinition) Merge the speicified alert definition with the existing definition in the database.
void	refresh(AlertDefinitionEntity alertDefinition) Refresh the state of the alert definition from the database.
void	remove(AlertDefinitionEntity alertDefinition) Removes the specified alert definition and all related history and associations from the database.
void	removeAll(long clusterId) Removes all AlertDefinitionEntity that are associated with the specified cluster ID.

Methods inherited from class java.lang.Object

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

Constructor Detail

AlertDefinitionDAO

public AlertDefinitionDAO()

Method Detail

findById

public AlertDefinitionEntity findById(long definitionId)

Gets an alert definition with the specified ID.

Parameters:

definitionId - the ID of the definition to retrieve.

Returns:

the alert definition or null if none exists.

findByName

public AlertDefinitionEntity findByName(long clusterId,
                                        String definitionName)

Gets an alert definition with the specified name. Alert definition names are unique within a cluster.

Parameters:

clusterId - the ID of the cluster.

definitionName - the name of the definition (not null).

Returns:

the alert definition or null if none exists.

findAll

public List<AlertDefinitionEntity> findAll()

Gets all alert definitions stored in the database.

Returns:

all alert definitions or an empty list if none exist (never null).

findAll

public List<AlertDefinitionEntity> findAll(long clusterId)

Gets all alert definitions stored in the database.

Returns:

all alert definitions or empty list if none exist (never null).

findAllEnabled

public List<AlertDefinitionEntity> findAllEnabled(long clusterId)

Gets all enabled alert definitions stored in the database for the specified cluster.

Returns:

all enabled alert definitions or empty list if none exist (never null).

findByIds

public List<AlertDefinitionEntity> findByIds(List<Long> definitionIds)

Gets all of the alert definitions for the list of IDs given.

Parameters:

definitionIds - the IDs of the definitions to retrieve.

Returns:

the definition or an empty list (never null).

findByService

public List<AlertDefinitionEntity> findByService(long clusterId,
                                                 String serviceName)

Gets all alert definitions for the given service in the specified cluster.

Parameters:

clusterId - the ID of the cluster.

serviceName - the name of the service.

Returns:

all alert definitions for the service or empty list if none exist (never null).

findByServiceMaster

public List<AlertDefinitionEntity> findByServiceMaster(long clusterId,
                                                       Set<String> services)

Gets all alert definitions for the specified services that do not have a component and do not belong to AGGREGATE source type. These definitions are assumed to be run on the master hosts.

Parameters:

clusterId - the ID of the cluster.

services - the services to match on.

Returns:

all alert definitions for the services or empty list if none exist (never null).

findByServiceComponent

public List<AlertDefinitionEntity> findByServiceComponent(long clusterId,
                                                          String serviceName,
                                                          String componentName)

Gets all alert definitions that are not bound to a particular service. An example of this type of definition is a host capacity alert.

Parameters:

clusterId - the ID of the cluster.

serviceName - the name of the service (not null).

componentName - the name of the service component (not null).

Returns:

all alert definitions that are not bound to a service or an empty list (never null).

findAgentScoped

public List<AlertDefinitionEntity> findAgentScoped(long clusterId)

Gets all alert definitions that are not bound to a particular service. An example of this type of definition is a host capacity alert.

Parameters:

clusterId - the ID of the cluster.

Returns:

all alert definitions that are not bound to a service or an empty list (never null).

findBySourceType

public List<AlertDefinitionEntity> findBySourceType(Long clusterId,
                                                    SourceType sourceType)

Returns:

all definitions with the given sourceType

create

public void create(AlertDefinitionEntity alertDefinition)
            throws org.apache.ambari.server.AmbariException

Persists a new alert definition, also creating the associated AlertGroupEntity relationship for the definition's service default group. Fires an AlertDefinitionRegistrationEvent.

Parameters:

alertDefinition - the definition to persist (not null).

Throws:

org.apache.ambari.server.AmbariException

refresh

public void refresh(AlertDefinitionEntity alertDefinition)

Refresh the state of the alert definition from the database.

Parameters:

alertDefinition - the definition to refresh (not null).

merge

public AlertDefinitionEntity merge(AlertDefinitionEntity alertDefinition)

Merge the speicified alert definition with the existing definition in the database. Fires an AlertDefinitionChangedEvent.

Parameters:

alertDefinition - the definition to merge (not null).

Returns:

the updated definition with merged content (never null).

createOrUpdate

public void createOrUpdate(AlertDefinitionEntity alertDefinition)
                    throws org.apache.ambari.server.AmbariException

Creates or updates the specified entity. This method will check AlertDefinitionEntity.getDefinitionId() in order to determine whether the entity should be created or merged.

Parameters:

alertDefinition - the definition to create or update (not null).

Throws:

org.apache.ambari.server.AmbariException

remove

public void remove(AlertDefinitionEntity alertDefinition)

Removes the specified alert definition and all related history and associations from the database. Fires an AlertDefinitionDeleteEvent .

Parameters:

alertDefinition - the definition to remove.

removeAll

public void removeAll(long clusterId)

Removes all AlertDefinitionEntity that are associated with the specified cluster ID.

Parameters:

clusterId - the cluster ID.