org.apache.ambari.server.api.services

Class HostComponentService

java.lang.Object

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

org.apache.ambari.server.api.services.HostComponentService

public class HostComponentService
extends BaseService

Service responsible for host_components resource requests.

Field Summary

Fields

Modifier and Type	Field and Description
static String	HOST_ROLE_REQUEST_TYPE

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
HostComponentService(String clusterName, String hostName) Constructor.

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	createHostComponent(String body, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo ui, String hostComponentName) Handles POST /clusters/{clusterID}/hosts/{hostID}/host_components/{hostComponentID} Create a specific host_component.
javax.ws.rs.core.Response	createHostComponents(String body, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo ui) Handles POST /clusters/{clusterID}/hosts/{hostID}/host_components Create host components by specifying an array of host components in the http body.
javax.ws.rs.core.Response	deleteHostComponent(javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo ui, String hostComponentName) Handles DELETE /clusters/{clusterID}/hosts/{hostID}/host_components/{hostComponentID} Delete a specific host_component.
javax.ws.rs.core.Response	deleteHostComponents(String body, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo ui) Handles DELETE /clusters/{clusterID}/hosts/{hostID}/host_components Deletes multiple host_component resources.
javax.ws.rs.core.Response	getHostComponent(String body, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo ui, String hostComponentName, String format) Handles GET /clusters/{clusterID}/hosts/{hostID}/host_components/{hostComponentID} Get a specific host_component.
javax.ws.rs.core.Response	getHostComponents(String body, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo ui, String format) Handles GET /clusters/{clusterID}/hosts/{hostID}/host_components/ Get all host components for a host.
javax.ws.rs.core.Response	getProcesses(javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo ui, String hostComponentName)
javax.ws.rs.core.Response	updateHostComponent(String body, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo ui, String hostComponentName) Handles PUT /clusters/{clusterID}/hosts/{hostID}/host_components/{hostComponentID} Updates a specific host_component.
javax.ws.rs.core.Response	updateHostComponents(String body, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo ui) Handles PUT /clusters/{clusterID}/hosts/{hostID}/host_components Updates multiple host_component resources.

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

Field Detail

HOST_ROLE_REQUEST_TYPE

public static final String HOST_ROLE_REQUEST_TYPE

See Also:

Constant Field Values

Constructor Detail

HostComponentService

public HostComponentService(String clusterName,
                            String hostName)

Constructor.

Parameters:

clusterName - cluster id

hostName - host id

Method Detail

getHostComponent

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

Handles GET /clusters/{clusterID}/hosts/{hostID}/host_components/{hostComponentID} Get a specific host_component.

Parameters:

headers - http headers

ui - uri info

hostComponentName - host_component id

Returns:

host_component resource representation

getHostComponents

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

Handles GET /clusters/{clusterID}/hosts/{hostID}/host_components/ Get all host components for a host.

Parameters:

headers - http headers

ui - uri info

Returns:

host_component collection resource representation

createHostComponents

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

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

Parameters:

body - http body

headers - http headers

ui - uri info

Returns:

status code only, 201 if successful

createHostComponent

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

Handles POST /clusters/{clusterID}/hosts/{hostID}/host_components/{hostComponentID} Create a specific host_component.

Parameters:

body - http body

headers - http headers

ui - uri info

hostComponentName - host_component id

Returns:

host_component resource representation

updateHostComponent

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

Handles PUT /clusters/{clusterID}/hosts/{hostID}/host_components/{hostComponentID} Updates a specific host_component.

Parameters:

body - http body

headers - http headers

ui - uri info

hostComponentName - host_component id

Returns:

information regarding updated host_component

updateHostComponents

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

Handles PUT /clusters/{clusterID}/hosts/{hostID}/host_components Updates multiple host_component resources.

Parameters:

body - http body

headers - http headers

ui - uri info

Returns:

information regarding updated host_component resources

deleteHostComponent

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

Handles DELETE /clusters/{clusterID}/hosts/{hostID}/host_components/{hostComponentID} Delete a specific host_component.

Parameters:

headers - http headers

ui - uri info

hostComponentName - host_component id

Returns:

host_component resource representation

deleteHostComponents

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

Handles DELETE /clusters/{clusterID}/hosts/{hostID}/host_components Deletes multiple host_component resources.

Parameters:

headers - http headers

ui - uri info

Returns:

host_component resource representation

getProcesses

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