org.apache.ambari.server.orm.dao

Class HostRoleCommandDAO

java.lang.Object

org.apache.ambari.server.orm.dao.HostRoleCommandDAO

public class HostRoleCommandDAO
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HostRoleCommandDAO.LastServiceCheckDTO A simple DTO for storing the most recent service check time for a given Role.

Field Summary

Fields

Modifier and Type	Field and Description
static String	HRC_STATUS_SUMMARY_CACHE_ENABLED
static String	HRC_STATUS_SUMMARY_CACHE_EXPIRY_DURATION_MINUTES
static String	HRC_STATUS_SUMMARY_CACHE_SIZE

Constructor Summary

Constructors

Constructor and Description
HostRoleCommandDAO(boolean hostRoleCommandStatusSummaryCacheEnabled, long hostRoleCommandStatusSummaryCacheLimit, long hostRoleCommandStatusSummaryCacheExpiryDurationMins)

Method Summary

Modifier and Type	Method and Description
void	create(HostRoleCommandEntity entity)
Map<Long,HostRoleCommandStatusSummaryDTO>	findAggregateCounts(Long requestId) Finds the counts of tasks for a request and groups them by stage id.
List<HostRoleCommandEntity>	findAll()
List<HostRoleCommandEntity>	findAll(Request request, Predicate predicate) Finds all HostRoleCommandEntity that match the provided predicate.
List<HostRoleCommandEntity>	findByHostId(Long hostId)
List<HostRoleCommandEntity>	findByHostRole(String hostName, long requestId, long stageId, String role)
HostRoleCommandEntity	findByPK(long taskId)
List<HostRoleCommandEntity>	findByPKs(Collection<Long> taskIds)
List<HostRoleCommandEntity>	findByRequest(long requestId)
List<HostRoleCommandEntity>	findByRequest(long requestId, boolean refreshHint)
List<HostRoleCommandEntity>	findByRequestAndTaskIds(Collection<Long> requestIds, Collection<Long> taskIds)
List<HostRoleCommandEntity>	findByRequestIdAndStatuses(Long requestId, Collection<HostRoleStatus> statuses)
List<HostRoleCommandEntity>	findByRequestIds(Collection<Long> requestIds)
List<HostRoleCommandEntity>	findByStatus(Collection<HostRoleStatus> statuses) Gets the commands in a particular status.
List<HostRoleCommandEntity>	findByStatusBetweenStages(long requestId, HostRoleStatus status, long minStageId, long maxStageId) Finds all the HostRoleCommandEntitys for the given request that are between the specified stage IDs and have the specified status.
HostRoleCommandEntity	findMostRecentFailure(Long requestId) During Rolling and Express Upgrade, want to bubble up the error of the most recent failure, i.e., greatest task id, assuming that there are no other completed tasks after it.
List<HostRoleCommandEntity>	findSortedCommandsByRequestIdAndCustomCommandName(Long requestId, String customCommandName)
Map<String,List<HostRoleCommandEntity>>	findSortedCommandsByStage(StageEntity stageEntity)
List<HostRoleCommandEntity>	findSortedCommandsByStageAndHost(StageEntity stageEntity, HostEntity hostEntity)
List<Long>	findTaskIdsByHostRoleAndStatus(String hostname, String role, HostRoleStatus status)
List<Long>	findTaskIdsByRequest(long requestId)
List<Long>	findTaskIdsByRequestAndTaskIds(Collection<Long> requestIds, Collection<Long> taskIds)
List<Long>	findTaskIdsByRequestIds(Collection<Long> requestIds)
Set<Long>	findTaskIdsByRequestStageIds(List<RequestDAO.StageEntityPK> requestStageIds)
List<Long>	findTaskIdsByRoleAndStatus(String role, HostRoleStatus status)
List<Long>	findTaskIdsByStage(long requestId, long stageId)
List<String>	getBlockingHostsForRequest(long lowerRequestIdInclusive, long requestId) Gets a lists of hosts with commands in progress which occurr before the specified request ID.
List<Long>	getCompletedRequests(int maxResults, boolean ascOrder)
Number	getCountByStatus(Collection<HostRoleStatus> statuses) Gets the number of commands in a particular status.
Map<Long,Integer>	getHostIdToCountOfCommandsWithStatus(Collection<HostRoleStatus> statuses)
List<HostRoleCommand>	getHostRoleCommands(Collection<HostRoleCommandEntity> entities)
List<String>	getHostsWithPendingTasks(long iLowestRequestIdInProgress, long iHighestRequestIdInProgress) Gets a lists of hosts with commands in progress given a range of requests.
List<HostRoleCommandDAO.LastServiceCheckDTO>	getLatestServiceChecksByRole(long clusterId) Gets the most recently run service check grouped by the command's role (which is the only way to identify the service it was for!?)
List<Long>	getRequestsByTaskStatus(Collection<HostRoleStatus> statuses, int maxResults, boolean ascOrder) Gets requests that have tasks in any of the specified statuses.
protected void	invalidateHostRoleCommandStatusSummaryCache(HostRoleCommandEntity hostRoleCommandEntity) Invalidates those entries in host role command status cache which are dependent on the passed HostRoleCommandEntity entity.
protected void	invalidateHostRoleCommandStatusSummaryCache(Long requestId) Invalidates the host role command status summary cache entry that corresponds to the given request.
protected void	invalidateHostRoleCommandStatusSummaryCache(Set<Long> requestIds) Invalidates the host role command status summary cache entry that corresponds to each request.
HostRoleCommandEntity	merge(HostRoleCommandEntity entity)
List<HostRoleCommandEntity>	mergeAll(Collection<HostRoleCommandEntity> entities)
HostRoleCommandEntity	mergeWithoutPublishEvent(HostRoleCommandEntity entity)
void	publishTaskCreateEvent(List<HostRoleCommand> hostRoleCommands)
void	publishTaskUpdateEvent(List<HostRoleCommand> hostRoleCommands)
void	remove(HostRoleCommandEntity entity)
void	removeByHostId(Long hostId)
void	removeByPK(int taskId)
void	updateAutomaticSkipOnFailure(long requestId, boolean skipOnFailure, boolean skipOnServiceCheckFailure) Updates the HostRoleCommandEntity.isFailureAutoSkipped() flag for all commands for the given request.
int	updateStatusByRequestId(long requestId, HostRoleStatus target, Collection<HostRoleStatus> sources) NB: You cannot rely on return value if batch write is enabled

Methods inherited from class java.lang.Object

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

Field Detail

HRC_STATUS_SUMMARY_CACHE_SIZE

public static final String HRC_STATUS_SUMMARY_CACHE_SIZE

See Also:

Constant Field Values

HRC_STATUS_SUMMARY_CACHE_EXPIRY_DURATION_MINUTES

public static final String HRC_STATUS_SUMMARY_CACHE_EXPIRY_DURATION_MINUTES

See Also:

Constant Field Values

HRC_STATUS_SUMMARY_CACHE_ENABLED

public static final String HRC_STATUS_SUMMARY_CACHE_ENABLED

See Also:

Constant Field Values

Constructor Detail

HostRoleCommandDAO

@Inject
public HostRoleCommandDAO(boolean hostRoleCommandStatusSummaryCacheEnabled,
                                  long hostRoleCommandStatusSummaryCacheLimit,
                                  long hostRoleCommandStatusSummaryCacheExpiryDurationMins)

Method Detail

invalidateHostRoleCommandStatusSummaryCache

protected void invalidateHostRoleCommandStatusSummaryCache(Long requestId)

Invalidates the host role command status summary cache entry that corresponds to the given request.

Parameters:

requestId - the key of the cache entry to be invalidated.

invalidateHostRoleCommandStatusSummaryCache

protected void invalidateHostRoleCommandStatusSummaryCache(Set<Long> requestIds)

Invalidates the host role command status summary cache entry that corresponds to each request.

Parameters:

requestIds - the requests to invalidate

invalidateHostRoleCommandStatusSummaryCache

protected void invalidateHostRoleCommandStatusSummaryCache(HostRoleCommandEntity hostRoleCommandEntity)

Invalidates those entries in host role command status cache which are dependent on the passed HostRoleCommandEntity entity.

Parameters:

hostRoleCommandEntity -

findByPK

public HostRoleCommandEntity findByPK(long taskId)

findByPKs

public List<HostRoleCommandEntity> findByPKs(Collection<Long> taskIds)

findByHostId

public List<HostRoleCommandEntity> findByHostId(Long hostId)

findByRequestIds

public List<HostRoleCommandEntity> findByRequestIds(Collection<Long> requestIds)

findByRequestIdAndStatuses

public List<HostRoleCommandEntity> findByRequestIdAndStatuses(Long requestId,
                                                              Collection<HostRoleStatus> statuses)

findTaskIdsByRequestIds

public List<Long> findTaskIdsByRequestIds(Collection<Long> requestIds)

findByRequestAndTaskIds

public List<HostRoleCommandEntity> findByRequestAndTaskIds(Collection<Long> requestIds,
                                                           Collection<Long> taskIds)

findTaskIdsByRequestAndTaskIds

public List<Long> findTaskIdsByRequestAndTaskIds(Collection<Long> requestIds,
                                                 Collection<Long> taskIds)

findTaskIdsByHostRoleAndStatus

public List<Long> findTaskIdsByHostRoleAndStatus(String hostname,
                                                 String role,
                                                 HostRoleStatus status)

findTaskIdsByRoleAndStatus

public List<Long> findTaskIdsByRoleAndStatus(String role,
                                             HostRoleStatus status)

findSortedCommandsByRequestIdAndCustomCommandName

public List<HostRoleCommandEntity> findSortedCommandsByRequestIdAndCustomCommandName(Long requestId,
                                                                                     String customCommandName)

findSortedCommandsByStageAndHost

public List<HostRoleCommandEntity> findSortedCommandsByStageAndHost(StageEntity stageEntity,
                                                                    HostEntity hostEntity)

findSortedCommandsByStage

public Map<String,List<HostRoleCommandEntity>> findSortedCommandsByStage(StageEntity stageEntity)

findTaskIdsByStage

public List<Long> findTaskIdsByStage(long requestId,
                                     long stageId)

getHostIdToCountOfCommandsWithStatus

public Map<Long,Integer> getHostIdToCountOfCommandsWithStatus(Collection<HostRoleStatus> statuses)

findByHostRole

public List<HostRoleCommandEntity> findByHostRole(String hostName,
                                                  long requestId,
                                                  long stageId,
                                                  String role)

findByRequest

public List<HostRoleCommandEntity> findByRequest(long requestId)

findByRequest

public List<HostRoleCommandEntity> findByRequest(long requestId,
                                                 boolean refreshHint)

findTaskIdsByRequest

public List<Long> findTaskIdsByRequest(long requestId)

findByStatus

public List<HostRoleCommandEntity> findByStatus(Collection<HostRoleStatus> statuses)

Gets the commands in a particular status.

Parameters:

statuses - the statuses to include (not null).

Returns:

the commands in the given set of statuses.

getCountByStatus

public Number getCountByStatus(Collection<HostRoleStatus> statuses)

Gets the number of commands in a particular status.

Parameters:

statuses - the statuses to include (not null).

Returns:

the count of commands in the given set of statuses.

findAll

public List<HostRoleCommandEntity> findAll()

findByStatusBetweenStages

public List<HostRoleCommandEntity> findByStatusBetweenStages(long requestId,
                                                             HostRoleStatus status,
                                                             long minStageId,
                                                             long maxStageId)

Finds all the HostRoleCommandEntitys for the given request that are between the specified stage IDs and have the specified status.

Parameters:

requestId - the request ID

status - the command status to query for (not null).

minStageId - the lowest stage ID to requests tasks for.

maxStageId - the highest stage ID to request tasks for.

Returns:

the tasks that satisfy the specified parameters.

getRequestsByTaskStatus

public List<Long> getRequestsByTaskStatus(Collection<HostRoleStatus> statuses,
                                          int maxResults,
                                          boolean ascOrder)

Gets requests that have tasks in any of the specified statuses.

Parameters:

statuses -

maxResults -

ascOrder -

Returns:

getCompletedRequests

public List<Long> getCompletedRequests(int maxResults,
                                       boolean ascOrder)

updateStatusByRequestId

public int updateStatusByRequestId(long requestId,
                                   HostRoleStatus target,
                                   Collection<HostRoleStatus> sources)

NB: You cannot rely on return value if batch write is enabled

create

public void create(HostRoleCommandEntity entity)

merge

public HostRoleCommandEntity merge(HostRoleCommandEntity entity)

mergeWithoutPublishEvent

public HostRoleCommandEntity mergeWithoutPublishEvent(HostRoleCommandEntity entity)

removeByHostId

public void removeByHostId(Long hostId)

mergeAll

public List<HostRoleCommandEntity> mergeAll(Collection<HostRoleCommandEntity> entities)

getHostRoleCommands

public List<HostRoleCommand> getHostRoleCommands(Collection<HostRoleCommandEntity> entities)

Parameters:

entities -

publishTaskUpdateEvent

public void publishTaskUpdateEvent(List<HostRoleCommand> hostRoleCommands)

Parameters:

hostRoleCommands -

publishTaskCreateEvent

public void publishTaskCreateEvent(List<HostRoleCommand> hostRoleCommands)

Parameters:

hostRoleCommands -

remove

public void remove(HostRoleCommandEntity entity)

removeByPK

public void removeByPK(int taskId)

findAggregateCounts

public Map<Long,HostRoleCommandStatusSummaryDTO> findAggregateCounts(Long requestId)

Finds the counts of tasks for a request and groups them by stage id. If caching is enabled, this will first consult the cache. Cache misses will then defer to loading the data from the database and then caching the result.

Parameters:

requestId - the request id

Returns:

the map of stage-to-summary objects

findMostRecentFailure

public HostRoleCommandEntity findMostRecentFailure(Long requestId)

During Rolling and Express Upgrade, want to bubble up the error of the most recent failure, i.e., greatest task id, assuming that there are no other completed tasks after it.

Parameters:

requestId - upgrade request id

Returns:

Most recent task failure during stack upgrade, or null if one doesn't exist.

updateAutomaticSkipOnFailure

public void updateAutomaticSkipOnFailure(long requestId,
                                         boolean skipOnFailure,
                                         boolean skipOnServiceCheckFailure)

Updates the HostRoleCommandEntity.isFailureAutoSkipped() flag for all commands for the given request.

This will update each entity to ensure that the cache is maintained in a correct state. A batch update doesn't always reflect in JPA-managed entities.

Stages which do not support automatically skipped commands will be updated with a value of false.

Parameters:

requestId - the request ID of the commands to update

skipOnFailure - true to automatically skip failures, false otherwise.

skipOnServiceCheckFailure - true to skip service check failures

See Also:

StageEntity.isAutoSkipOnFailureSupported()

findAll

public List<HostRoleCommandEntity> findAll(Request request,
                                           Predicate predicate)

Finds all HostRoleCommandEntity that match the provided predicate. This method will make JPA do the heavy lifting of providing a slice of the result set.

Parameters:

request -

Returns:

getHostsWithPendingTasks

public List<String> getHostsWithPendingTasks(long iLowestRequestIdInProgress,
                                             long iHighestRequestIdInProgress)

Gets a lists of hosts with commands in progress given a range of requests. The range of requests should include all requests with at least 1 stage in progress.

Returns:

the list of hosts with commands in progress.

See Also:

HostRoleStatus.IN_PROGRESS_STATUSES

getBlockingHostsForRequest

public List<String> getBlockingHostsForRequest(long lowerRequestIdInclusive,
                                               long requestId)

Gets a lists of hosts with commands in progress which occurr before the specified request ID. This will only return commands which are not AgentCommand.AgentCommandType.BACKGROUND_EXECUTION_COMMAND as thsee commands do not block future requests.

Parameters:

lowerRequestIdInclusive - the lowest request ID to consider (inclusive) when getting any blocking hosts.

requestId - the request ID to calculate any blocking hosts for (essentially, the upper limit exclusive)

Returns:

the list of hosts from older running requests which will block those same hosts in the specified request ID.

See Also:

HostRoleStatus.IN_PROGRESS_STATUSES

getLatestServiceChecksByRole

public List<HostRoleCommandDAO.LastServiceCheckDTO> getLatestServiceChecksByRole(long clusterId)

Gets the most recently run service check grouped by the command's role (which is the only way to identify the service it was for!?)

Parameters:

clusterId - the ID of the cluster to get the service checks for.

findTaskIdsByRequestStageIds

public Set<Long> findTaskIdsByRequestStageIds(List<RequestDAO.StageEntityPK> requestStageIds)