org.apache.ambari.server.actionmanager

Interface ActionDBAccessor

All Known Implementing Classes:

ActionDBAccessorImpl

public interface ActionDBAccessor

Method Summary

Modifier and Type	Method and Description
void	abortHostRole(String host, long requestId, long stageId, String role) Mark the task as to have been aborted
void	abortHostRole(String host, long requestId, long stageId, String role, String reason) Mark the task as to have been aborted.
Collection<HostRoleCommandEntity>	abortOperation(long requestId) Abort all outstanding operations associated with the given request.
void	bulkAbortHostRole(Stage s, Map<ExecutionCommand,String> commands) Bulk abort commands
void	bulkHostRoleScheduled(Stage s, List<ExecutionCommand> commands) Bulk update scheduled commands
void	endRequest(long requestId)
List<Stage>	getAllStages(long requestId) Get all stages associated with a single request id
List<HostRoleCommand>	getAllTasksByRequestIds(Collection<Long> requestIds) Given a list of request ids, get all the tasks that belong to these requests
int	getCommandsInProgressCount() Gets the number of commands in progress.
List<Stage>	getFirstStageInProgressPerRequest() Returns the next stage which is in-progress for every in-progress request in the system.
long	getLastPersistedRequestIdWhenInitialized() Return the last persisted Request ID as seen when the DBAccessor object was initialized.
Request	getRequest(long requestId) Get request object by id.
Map<Long,String>	getRequestContext(List<Long> requestIds) Gets request contexts associated with the list of request id
String	getRequestContext(long requestId) Gets the request context associated with the request id
RequestEntity	getRequestEntity(long requestId) Gets the request entity by id.
List<Request>	getRequests(Collection<Long> requestIds) Gets request objects by ids
List<Long>	getRequestsByStatus(RequestStatus status, int maxResults, boolean ascOrder) Get first or last maxResults requests that are in the specified status
List<HostRoleCommand>	getRequestTasks(long requestId) Given a request id, get all the tasks that belong to this request
Stage	getStage(String actionId) Given an action id of the form requestId-stageId, retrieve the Stage
List<Stage>	getStagesInProgressForRequest(Long requestId) Returns all the pending stages in a request, including queued and not-queued.
HostRoleCommand	getTask(long taskId) Gets the host role command corresponding to the task id
Collection<HostRoleCommand>	getTasks(Collection<Long> taskIds) Given a list of task ids, get all the host role commands
List<HostRoleCommand>	getTasksByHostRoleAndStatus(String hostname, String role, HostRoleStatus status) Get a List of host role commands where the host, role and status are as specified
List<HostRoleCommand>	getTasksByRoleAndStatus(String role, HostRoleStatus status) Get a List of host role commands where the role and status are as specified
void	hostRoleScheduled(Stage s, String hostname, String roleStr) Updates scheduled stage.
void	persistActions(Request request) Persists all tasks for a given request
void	resubmitTasks(List<Long> taskIds) Resubmits a series of tasks
void	setSourceScheduleForRequest(long requestId, long scheduleId) Updates request with link to source schedule
void	startRequest(long requestId)
void	timeoutHostRole(String host, long requestId, long stageId, String role) Mark the task as to have timed out
void	timeoutHostRole(String host, long requestId, long stageId, String role, boolean skipSupported, boolean hostUnknownState) Mark the task as to have timed out
void	updateHostRoleState(String hostname, long requestId, long stageId, String role, CommandReport report) For the given host, update all the tasks based on the command report
void	updateHostRoleStates(Collection<CommandReport> reports) Update tasks according to command reports

Method Detail

getStage

Stage getStage(String actionId)

Given an action id of the form requestId-stageId, retrieve the Stage

getAllStages

List<Stage> getAllStages(long requestId)

Get all stages associated with a single request id

getRequestEntity

RequestEntity getRequestEntity(long requestId)

Gets the request entity by id. Will not load the entire Request/Stage/HostRoleCommand object hierarchy.

getRequest

Request getRequest(long requestId)

Get request object by id. USE WITH CAUTION! This method will result in loading the full object hierarchy, and can be expensive to construct.

Parameters:

requestId - the request id

Returns:

the Request instance, with all Stages and HostRoleCommands constructed from the database

abortOperation

Collection<HostRoleCommandEntity> abortOperation(long requestId)

Abort all outstanding operations associated with the given request. This method uses the HostRoleStatus.SCHEDULED_STATES to determine which HostRoleCommand instances to abort. Returns the list of the aborted operations.

timeoutHostRole

void timeoutHostRole(String host,
                     long requestId,
                     long stageId,
                     String role)

Mark the task as to have timed out

timeoutHostRole

void timeoutHostRole(String host,
                     long requestId,
                     long stageId,
                     String role,
                     boolean skipSupported,
                     boolean hostUnknownState)

Mark the task as to have timed out

getFirstStageInProgressPerRequest

List<Stage> getFirstStageInProgressPerRequest()

Returns the next stage which is in-progress for every in-progress request in the system. Since stages are always synchronous, there is no reason to return more than the most recent stage per request. Returning every single stage in the requesrt would be extremely inffecient and wasteful. However, since requests can run in parallel, this method must return the most recent stage for every request. The results will be sorted by request ID.

Use getCommandsInProgressCount() in order to determine if there are stages that are in progress before getting the stages from this method.

See Also:

HostRoleStatus.IN_PROGRESS_STATUSES

getStagesInProgressForRequest

List<Stage> getStagesInProgressForRequest(Long requestId)

Returns all the pending stages in a request, including queued and not-queued. A stage is considered in progress if it is in progress for any host.

The results will be sorted by stage ID making this call expensive in some scenarios. Use getCommandsInProgressCount() in order to determine if there are stages that are in progress before getting the stages from this method.

See Also:

HostRoleStatus.IN_PROGRESS_STATUSES

getCommandsInProgressCount

int getCommandsInProgressCount()

Gets the number of commands in progress.

Returns:

the number of commands in progress.

persistActions

void persistActions(Request request)
             throws org.apache.ambari.server.AmbariException

Persists all tasks for a given request

Parameters:

request - request object

Throws:

org.apache.ambari.server.AmbariException

startRequest

void startRequest(long requestId)

endRequest

void endRequest(long requestId)

setSourceScheduleForRequest

void setSourceScheduleForRequest(long requestId,
                                 long scheduleId)

Updates request with link to source schedule

updateHostRoleStates

void updateHostRoleStates(Collection<CommandReport> reports)

Update tasks according to command reports

updateHostRoleState

void updateHostRoleState(String hostname,
                         long requestId,
                         long stageId,
                         String role,
                         CommandReport report)

For the given host, update all the tasks based on the command report

abortHostRole

void abortHostRole(String host,
                   long requestId,
                   long stageId,
                   String role)

Mark the task as to have been aborted

abortHostRole

void abortHostRole(String host,
                   long requestId,
                   long stageId,
                   String role,
                   String reason)

Mark the task as to have been aborted. Reason should be specified manually.

getLastPersistedRequestIdWhenInitialized

long getLastPersistedRequestIdWhenInitialized()

Return the last persisted Request ID as seen when the DBAccessor object was initialized. Value should remain unchanged through the lifetime of the object instance.

Returns:

Request Id seen at init time

bulkHostRoleScheduled

void bulkHostRoleScheduled(Stage s,
                           List<ExecutionCommand> commands)

Bulk update scheduled commands

bulkAbortHostRole

void bulkAbortHostRole(Stage s,
                       Map<ExecutionCommand,String> commands)

Bulk abort commands

hostRoleScheduled

void hostRoleScheduled(Stage s,
                       String hostname,
                       String roleStr)

Updates scheduled stage.

getRequestTasks

List<HostRoleCommand> getRequestTasks(long requestId)

Given a request id, get all the tasks that belong to this request

getAllTasksByRequestIds

List<HostRoleCommand> getAllTasksByRequestIds(Collection<Long> requestIds)

Given a list of request ids, get all the tasks that belong to these requests

getTasks

Collection<HostRoleCommand> getTasks(Collection<Long> taskIds)

Given a list of task ids, get all the host role commands

getTasksByHostRoleAndStatus

List<HostRoleCommand> getTasksByHostRoleAndStatus(String hostname,
                                                  String role,
                                                  HostRoleStatus status)

Get a List of host role commands where the host, role and status are as specified

getTasksByRoleAndStatus

List<HostRoleCommand> getTasksByRoleAndStatus(String role,
                                              HostRoleStatus status)

Get a List of host role commands where the role and status are as specified

getTask

HostRoleCommand getTask(long taskId)

Gets the host role command corresponding to the task id

getRequestsByStatus

List<Long> getRequestsByStatus(RequestStatus status,
                               int maxResults,
                               boolean ascOrder)

Get first or last maxResults requests that are in the specified status

Parameters:

status - Desired request status

maxResults - maximal number of returned id's

ascOrder - defines sorting order for database query result

Returns:

First or last maxResults request id's if ascOrder is true or false, respectively

getRequestContext

Map<Long,String> getRequestContext(List<Long> requestIds)

Gets request contexts associated with the list of request id

getRequestContext

String getRequestContext(long requestId)

Gets the request context associated with the request id

getRequests

List<Request> getRequests(Collection<Long> requestIds)

Gets request objects by ids

resubmitTasks

void resubmitTasks(List<Long> taskIds)

Resubmits a series of tasks

Parameters:

taskIds -