org.apache.ambari.server.api.services

Class RequestService

java.lang.Object

org.apache.ambari.server.api.services.BaseService

org.apache.ambari.server.api.services.RequestService

public class RequestService
extends BaseService

Service responsible for request resource requests.

Field Summary

Fields inherited from class org.apache.ambari.server.api.services.BaseService

DATA_TYPE_INT, DATA_TYPE_STRING, DEFAULT_FROM, DEFAULT_PAGE_SIZE, FIELDS_SEPARATOR, MEDIA_TYPE_TEXT_CSV_TYPE, MSG_CLUSTER_NOT_FOUND, MSG_CLUSTER_OR_HOST_NOT_FOUND, MSG_INVALID_ARGUMENTS, MSG_INVALID_REQUEST, MSG_NOT_AUTHENTICATED, MSG_PERMISSION_DENIED, MSG_REQUEST_ACCEPTED, MSG_RESOURCE_ALREADY_EXISTS, MSG_RESOURCE_NOT_FOUND, MSG_SERVER_ERROR, MSG_SUCCESSFUL_OPERATION, MSG_VIEW_NOT_FOUND, PARAM_TYPE_BODY, PARAM_TYPE_QUERY, QUERY_FIELDS, QUERY_FILTER_DESCRIPTION, QUERY_FROM, QUERY_FROM_DESCRIPTION, QUERY_FROM_VALUES, QUERY_PAGE_SIZE, QUERY_PAGE_SIZE_DESCRIPTION, QUERY_PREDICATE, QUERY_PREDICATE_DESCRIPTION, QUERY_SORT, QUERY_SORT_DESCRIPTION, QUERY_TO, QUERY_TO_DESCRIPTION, QUERY_TO_TYPE, QUERY_TO_VALUES, requestAuditLogger, RESPONSE_CONTAINER_LIST

Constructor Summary

Constructors

Constructor and Description
RequestService()
RequestService(String clusterName) Constructor.

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	createRequests(String body, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo ui) Handles: POST /clusters/{clusterId}/requests or /requests Create multiple requests.
javax.ws.rs.core.Response	getRequest(String body, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo ui, String requestId) Handles URL: /clusters/{clusterID}/requests/{requestID} or /requests/{requestId} Get a specific request.
javax.ws.rs.core.Response	getRequests(String body, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo ui) Handles URL: /clusters/{clusterId}/requests or /requests Get all requests for a cluster.
StageService	getStageHandler(String requestId) Gets the stage sub-resource.
TaskService	getTaskHandler(String requestId) Gets the tasks sub-resource.
javax.ws.rs.core.Response	updateRequests(String body, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo ui, String requestId) Handles: PUT /clusters/{clusterId}/requests/{requestId} or /requests/{requestId} Change state of existing requests.

Methods inherited from class org.apache.ambari.server.api.services.BaseService

createResource, getBodyParser, getResultSerializer, getResultSerializer, handleRequest, handleRequest, init

Methods inherited from class java.lang.Object

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

Constructor Detail

RequestService

public RequestService()

RequestService

public RequestService(String clusterName)

Constructor.

Parameters:

clusterName - cluster id

Method Detail

getRequest

public javax.ws.rs.core.Response getRequest(String body,
                                            @Context
                                            javax.ws.rs.core.HttpHeaders headers,
                                            @Context
                                            javax.ws.rs.core.UriInfo ui,
                                            String requestId)

Handles URL: /clusters/{clusterID}/requests/{requestID} or /requests/{requestId} Get a specific request.

Parameters:

headers - http headers

ui - uri info

requestId - request id

Returns:

request resource representation

getRequests

public javax.ws.rs.core.Response getRequests(String body,
                                             @Context
                                             javax.ws.rs.core.HttpHeaders headers,
                                             @Context
                                             javax.ws.rs.core.UriInfo ui)

Handles URL: /clusters/{clusterId}/requests or /requests Get all requests for a cluster.

Parameters:

headers - http headers

ui - uri info

Returns:

request collection resource representation

getStageHandler

public StageService getStageHandler(String requestId)

Gets the stage sub-resource.

getTaskHandler

public TaskService getTaskHandler(String requestId)

Gets the tasks sub-resource.

updateRequests

public javax.ws.rs.core.Response updateRequests(String body,
                                                @Context
                                                javax.ws.rs.core.HttpHeaders headers,
                                                @Context
                                                javax.ws.rs.core.UriInfo ui,
                                                String requestId)

Handles: PUT /clusters/{clusterId}/requests/{requestId} or /requests/{requestId} Change state of existing requests. Usually used to cancel running requests

Parameters:

body - http body

headers - http headers

ui - uri info

Returns:

information regarding the updated requests

createRequests

public javax.ws.rs.core.Response createRequests(String body,
                                                @Context
                                                javax.ws.rs.core.HttpHeaders headers,
                                                @Context
                                                javax.ws.rs.core.UriInfo ui)

Handles: POST /clusters/{clusterId}/requests or /requests Create multiple requests.

Parameters:

body - http body

headers - http headers

ui - uri info

Returns:

information regarding the created requests