org.apache.ambari.server.orm.dao

Class AlertDispatchDAO

java.lang.Object

org.apache.ambari.server.orm.dao.AlertDispatchDAO

public class AlertDispatchDAO
extends Object

The AlertDispatchDAO class manages the AlertTargetEntity, AlertGroupEntity, and the associations between them.

Constructor Summary

Constructors

Constructor and Description
AlertDispatchDAO()

Method Summary

Modifier and Type	Method and Description
void	create(AlertGroupEntity group) Persists a new alert group.
void	create(AlertGroupEntity group, boolean fireEvent) Persists a new alert group.
void	create(AlertNoticeEntity alertNotice) Persists a new notification.
void	create(AlertTargetEntity alertTarget) Persists a new alert target.
AlertGroupEntity	createDefaultGroup(long clusterId, String serviceName) Creates a default group in the specified cluster and service.
void	createGroups(List<AlertGroupEntity> entities) Persists new alert groups.
List<AlertNoticeEntity>	createNotices(List<AlertNoticeEntity> entities) Creates new alert notices using the EntityManager.merge(Object) method to ensure that the associated AlertTargetEntity instances are also updated.
void	createTargets(List<AlertTargetEntity> entities) Persists new alert targets.
List<AlertTargetEntity>	findAllGlobalTargets() Gets all global alert targets stored in the database.
List<AlertGroupEntity>	findAllGroups() Gets all alert groups stored in the database across all clusters.
List<AlertGroupEntity>	findAllGroups(long clusterId) Gets all alert groups stored in the database for the specified cluster.
List<AlertNoticeEntity>	findAllNotices() Gets all alert notifications stored in the database.
List<AlertNoticeEntity>	findAllNotices(AlertNoticeRequest request) Gets all alert notifications stored in the database that match the given predicate, pagination, and sorting.
List<AlertTargetEntity>	findAllTargets() Gets all alert targets stored in the database.
AlertGroupEntity	findDefaultServiceGroup(long clusterId, String serviceName) Gets the default group for the specified cluster and service.
AlertGroupEntity	findGroupById(long groupId) Gets an alert group with the specified ID.
AlertGroupEntity	findGroupByName(long clusterId, String groupName) Gets an alert group with the specified name for the given cluster.
List<AlertGroupEntity>	findGroupsByDefinition(AlertDefinitionEntity definitionEntity) Gets all of the AlertGroupEntity instances that include the specified alert definition.
List<AlertGroupEntity>	findGroupsById(List<Long> groupIds) Gets all of the alert groups for the list of IDs given.
AlertNoticeEntity	findNoticeById(long noticeId) Gets a notification with the specified ID.
AlertNoticeEntity	findNoticeByUuid(String uuid) Gets a notification with the specified UUID.
List<AlertNoticeEntity>	findPendingNotices() Gets all AlertNoticeEntity instances that are NotificationState.PENDING and not yet dispatched.
AlertTargetEntity	findTargetById(long targetId) Gets an alert target with the specified ID.
AlertTargetEntity	findTargetByName(String targetName) Gets an alert target with the specified name.
List<AlertTargetEntity>	findTargetsById(List<Long> targetIds) Gets all of the alert targets for the list of IDs given.
int	getNoticesCount(Predicate predicate) Gets the total count of all AlertNoticeEntity rows that match the specified Predicate.
AlertGroupEntity	merge(AlertGroupEntity alertGroup) Merge the speicified alert group with the existing group in the database.
AlertNoticeEntity	merge(AlertNoticeEntity alertNotice) Merge the specified notification with the existing target in the database.
AlertTargetEntity	merge(AlertTargetEntity alertTarget) Merge the speicified alert target with the existing target in the database.
void	refresh(AlertGroupEntity alertGroup) Refresh the state of the alert group from the database.
void	refresh(AlertNoticeEntity alertNotice) Refresh the state of the notification from the database.
void	refresh(AlertTargetEntity alertTarget) Refresh the state of the alert target from the database.
void	remove(AlertGroupEntity alertGroup) Removes the specified alert group from the database.
void	remove(AlertGroupEntity alertGroup, boolean fireEvent) Removes the specified alert group from the database.
void	remove(AlertNoticeEntity alertNotice) Removes the specified notification from the database.
void	remove(AlertTargetEntity alertTarget) Removes the specified alert target from the database.
void	removeAllGroups(long clusterId) Removes all AlertDefinitionEntity that are associated with the specified cluster ID.
void	removeNoticeByDefinitionId(long definitionId) Removes notifications for the specified alert definition ID.

Methods inherited from class java.lang.Object

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

Constructor Detail

AlertDispatchDAO

public AlertDispatchDAO()

Method Detail

findGroupById

public AlertGroupEntity findGroupById(long groupId)

Gets an alert group with the specified ID.

Parameters:

groupId - the ID of the group to retrieve.

Returns:

the group or null if none exists.

findGroupsById

public List<AlertGroupEntity> findGroupsById(List<Long> groupIds)

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

Parameters:

groupIds - the IDs of the groups to retrieve.

Returns:

the groups or an empty list (never null).

findTargetById

public AlertTargetEntity findTargetById(long targetId)

Gets an alert target with the specified ID.

Parameters:

targetId - the ID of the target to retrieve.

Returns:

the target or null if none exists.

findTargetsById

public List<AlertTargetEntity> findTargetsById(List<Long> targetIds)

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

Parameters:

targetIds - the IDs of the targets to retrieve.

Returns:

the targets or an empty list (never null).

findNoticeById

public AlertNoticeEntity findNoticeById(long noticeId)

Gets a notification with the specified ID.

Parameters:

noticeId - the ID of the notification to retrieve.

Returns:

the notification or null if none exists.

findNoticeByUuid

public AlertNoticeEntity findNoticeByUuid(String uuid)

Gets a notification with the specified UUID.

Parameters:

uuid - the UUID of the notification to retrieve.

Returns:

the notification or null if none exists.

findPendingNotices

public List<AlertNoticeEntity> findPendingNotices()

Gets all AlertNoticeEntity instances that are NotificationState.PENDING and not yet dispatched.

Returns:

the notices that are waiting to be dispatched, or an empty list (never null).

findGroupByName

public AlertGroupEntity findGroupByName(long clusterId,
                                        String groupName)

Gets an alert group with the specified name for the given cluster. Alert group names are unique within a cluster.

Parameters:

clusterId - the ID of the cluster.

groupName - the name of the group (not null).

Returns:

the alert group or null if none exists.

findTargetByName

public AlertTargetEntity findTargetByName(String targetName)

Gets an alert target with the specified name. Alert target names are unique across all clusters.

Parameters:

targetName - the name of the target (not null).

Returns:

the alert target or null if none exists.

findAllGroups

public List<AlertGroupEntity> findAllGroups()

Gets all alert groups stored in the database across all clusters.

Returns:

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

findAllGroups

public List<AlertGroupEntity> findAllGroups(long clusterId)

Gets all alert groups stored in the database for the specified cluster.

Returns:

all alert groups in the specified cluster or empty list if none exist (never null).

findAllTargets

public List<AlertTargetEntity> findAllTargets()

Gets all alert targets stored in the database.

Returns:

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

findAllGlobalTargets

public List<AlertTargetEntity> findAllGlobalTargets()

Gets all global alert targets stored in the database.

Returns:

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

findGroupsByDefinition

public List<AlertGroupEntity> findGroupsByDefinition(AlertDefinitionEntity definitionEntity)

Gets all of the AlertGroupEntity instances that include the specified alert definition. Service default groups will also be returned.

Parameters:

definitionEntity - the definition that the group must include (not null).

Returns:

all alert groups that have an association with the specified definition and the definition's service default group or empty list if none exist (never null).

findDefaultServiceGroup

public AlertGroupEntity findDefaultServiceGroup(long clusterId,
                                                String serviceName)

Gets the default group for the specified cluster and service.

Parameters:

clusterId - the cluster that the group belongs to

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

Returns:

the default group, or null if the service name is not valid for an installed service; otherwise null should not be possible.

findAllNotices

public List<AlertNoticeEntity> findAllNotices()

Gets all alert notifications stored in the database.

Returns:

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

findAllNotices

public List<AlertNoticeEntity> findAllNotices(AlertNoticeRequest request)

Gets all alert notifications stored in the database that match the given predicate, pagination, and sorting.

Parameters:

request -

Returns:

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

getNoticesCount

public int getNoticesCount(Predicate predicate)

Gets the total count of all AlertNoticeEntity rows that match the specified Predicate.

Parameters:

predicate - the predicate to apply, or null for none.

Returns:

the total count of rows that would be returned in a result set.

createGroups

public void createGroups(List<AlertGroupEntity> entities)

Persists new alert groups.

Parameters:

entities - the groups to persist (not null).

create

public void create(AlertGroupEntity group)

Persists a new alert group.

Parameters:

group - the group to persist (not null).

create

public void create(AlertGroupEntity group,
                   boolean fireEvent)

Persists a new alert group.

Parameters:

group - the group to persist (not null).

fireEvent - should alert group update event to be fired

createDefaultGroup

public AlertGroupEntity createDefaultGroup(long clusterId,
                                           String serviceName)
                                    throws org.apache.ambari.server.AmbariException

Creates a default group in the specified cluster and service. If the service is not valid, then this will throw an AmbariException.

Parameters:

clusterId - the cluster that the group is in.

serviceName - the name of the group which is also the service name.

Throws:

org.apache.ambari.server.AmbariException

refresh

public void refresh(AlertGroupEntity alertGroup)

Refresh the state of the alert group from the database.

Parameters:

alertGroup - the group to refresh (not null).

merge

public AlertGroupEntity merge(AlertGroupEntity alertGroup)

Merge the speicified alert group with the existing group in the database.

Parameters:

alertGroup - the group to merge (not null).

Returns:

the updated group with merged content (never null).

remove

public void remove(AlertGroupEntity alertGroup)

Removes the specified alert group from the database.

Parameters:

alertGroup - the group to remove.

remove

public void remove(AlertGroupEntity alertGroup,
                   boolean fireEvent)

Removes the specified alert group from the database.

Parameters:

alertGroup - the group to remove.

fireEvent - should alert group update event to be fired.

removeAllGroups

public void removeAllGroups(long clusterId)

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

Parameters:

clusterId - the cluster ID.

createTargets

public void createTargets(List<AlertTargetEntity> entities)

Persists new alert targets.

Parameters:

entities - the targets to persist (not null).

createNotices

public List<AlertNoticeEntity> createNotices(List<AlertNoticeEntity> entities)

Creates new alert notices using the EntityManager.merge(Object) method to ensure that the associated AlertTargetEntity instances are also updated.

The method returns the newly managed entities as the ones passed in will not be managed.

Parameters:

entities - the targets to create (not null).

create

public void create(AlertTargetEntity alertTarget)

Persists a new alert target.

Parameters:

alertTarget - the target to persist (not null).

refresh

public void refresh(AlertTargetEntity alertTarget)

Refresh the state of the alert target from the database.

Parameters:

alertTarget - the target to refresh (not null).

merge

public AlertTargetEntity merge(AlertTargetEntity alertTarget)

Merge the speicified alert target with the existing target in the database.

Parameters:

alertTarget - the target to merge (not null).

Returns:

the updated target with merged content (never null).

remove

public void remove(AlertTargetEntity alertTarget)

Removes the specified alert target from the database.

Parameters:

alertTarget - the target to remove.

create

public void create(AlertNoticeEntity alertNotice)

Persists a new notification.

Parameters:

alertNotice - the notification to persist (not null).

refresh

public void refresh(AlertNoticeEntity alertNotice)

Refresh the state of the notification from the database.

Parameters:

alertNotice - the notification to refresh (not null).

merge

public AlertNoticeEntity merge(AlertNoticeEntity alertNotice)

Merge the specified notification with the existing target in the database.

Parameters:

alertNotice - the notification to merge (not null).

Returns:

the updated notification with merged content (never null).

remove

public void remove(AlertNoticeEntity alertNotice)

Removes the specified notification from the database.

Parameters:

alertNotice - the notification to remove.

removeNoticeByDefinitionId

public void removeNoticeByDefinitionId(long definitionId)

Removes notifications for the specified alert definition ID. This will invoke EntityManager.clear() when completed since the JPQL statement will remove entries without going through the EM.

Parameters:

definitionId - the ID of the definition to remove.