org.apache.ambari.server.api.services

Class ComponentService

java.lang.Object

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

org.apache.ambari.server.api.services.ComponentService

public class ComponentService
extends BaseService

Service responsible for components 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
ComponentService(String clusterName, String serviceName) Constructor.

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	createComponent(String body, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo ui, String componentName) Handles: POST /clusters/{clusterID}/services/{serviceID}/components/{componentID} Create a specific component.
javax.ws.rs.core.Response	createComponents(String body, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo ui) Handles: POST /clusters/{clusterID}/services/{serviceID}/components Create components by specifying an array of components in the http body.
javax.ws.rs.core.Response	deleteComponent(javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo ui, String componentName) Handles: DELETE /clusters/{clusterID}/services/{serviceID}/components/{componentID} Delete a specific component.
javax.ws.rs.core.Response	getComponent(String body, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo ui, String componentName, String format) Handles GET: /clusters/{clusterID}/services/{serviceID}/components/{componentID} Get a specific component.
javax.ws.rs.core.Response	getComponents(String body, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo ui, String format) Handles GET: /clusters/{clusterID}/services/{serviceID}/components Get all components for a service.
javax.ws.rs.core.Response	updateComponent(String body, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo ui, String componentName) Handles: PUT /clusters/{clusterID}/services/{serviceID}/components/{componentID} Update a specific component.
javax.ws.rs.core.Response	updateComponents(String body, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo ui) Handles: PUT /clusters/{clusterID}/services/{serviceID}/components Update multiple components.

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

ComponentService

public ComponentService(String clusterName,
                        String serviceName)

Constructor.

Parameters:

clusterName - cluster id

serviceName - service id

Method Detail

getComponent

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

Handles GET: /clusters/{clusterID}/services/{serviceID}/components/{componentID} Get a specific component.

Parameters:

headers - http headers

ui - uri info

componentName - component id

Returns:

a component resource representation

getComponents

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

Handles GET: /clusters/{clusterID}/services/{serviceID}/components Get all components for a service.

Parameters:

headers - http headers

ui - uri info

Returns:

component collection resource representation

createComponents

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

Handles: POST /clusters/{clusterID}/services/{serviceID}/components Create components by specifying an array of components in the http body. This is used to create multiple components in a single request.

Parameters:

body - http body

headers - http headers

ui - uri info

Returns:

status code only, 201 if successful

createComponent

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

Handles: POST /clusters/{clusterID}/services/{serviceID}/components/{componentID} Create a specific component.

Parameters:

body - http body

headers - http headers

ui - uri info

componentName - component id

Returns:

information regarding the created component

updateComponent

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

Handles: PUT /clusters/{clusterID}/services/{serviceID}/components/{componentID} Update a specific component.

Parameters:

body - http body

headers - http headers

ui - uri info

componentName - component id

Returns:

information regarding the updated component

updateComponents

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

Handles: PUT /clusters/{clusterID}/services/{serviceID}/components Update multiple components.

Parameters:

body - http body

headers - http headers

ui - uri info

Returns:

information regarding the updated component

deleteComponent

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

Handles: DELETE /clusters/{clusterID}/services/{serviceID}/components/{componentID} Delete a specific component.

Parameters:

headers - http headers

ui - uri info

componentName - cluster id

Returns:

information regarding the deleted cluster