org.apache.ambari.server.api.services

Class HostService

java.lang.Object

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

org.apache.ambari.server.api.services.HostService

public class HostService
extends BaseService

Service responsible for hosts resource requests.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	createHost(String body, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo ui, String hostName) Handles POST /clusters/{clusterID}/hosts/{hostID} Create a specific host.
javax.ws.rs.core.Response	createHosts(String body, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo ui) Handles POST /clusters/{clusterID}/hosts Create hosts by specifying an array of hosts in the http body.
javax.ws.rs.core.Response	deleteHost(javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo ui, String hostName) Handles DELETE /clusters/{clusterID}/hosts/{hostID} Deletes a specific host.
javax.ws.rs.core.Response	getHost(javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo ui, String hostName) Handles GET /clusters/{clusterID}/hosts/{hostID} and /hosts/{hostID} Get a specific host.
HostComponentService	getHostComponentHandler(String hostName) Get the host_components sub-resource.
javax.ws.rs.core.Response	getHosts(javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo ui) Handles GET /clusters/{clusterID}/hosts and /hosts Get all hosts for a cluster.
javax.ws.rs.core.Response	updateHost(String body, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo ui, String hostName) Handles PUT /clusters/{clusterID}/hosts/{hostID} Updates a specific host.
javax.ws.rs.core.Response	updateHosts(String body, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo ui) Handles PUT /clusters/{clusterID}/hosts Updates multiple hosts.

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

getBodyParser, getResultSerializer, handleRequest

Methods inherited from class java.lang.Object

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

Constructor Detail

HostService

public HostService()

Constructor.

HostService

public HostService(String clusterName)

Constructor.

Parameters:

clusterName - cluster id

Method Detail

getHost

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

Handles GET /clusters/{clusterID}/hosts/{hostID} and /hosts/{hostID} Get a specific host.

Parameters:

headers - http headers

ui - uri info

hostName - host id

Returns:

host resource representation

getHosts

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

Handles GET /clusters/{clusterID}/hosts and /hosts Get all hosts for a cluster.

Parameters:

headers - http headers

ui - uri info

Returns:

host collection resource representation

createHosts

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

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

Parameters:

body - http body

headers - http headers

ui - uri info

Returns:

status code only, 201 if successful

createHost

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

Handles POST /clusters/{clusterID}/hosts/{hostID} Create a specific host.

Parameters:

body - http body

headers - http headers

ui - uri info

hostName - host id

Returns:

host resource representation

updateHost

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

Handles PUT /clusters/{clusterID}/hosts/{hostID} Updates a specific host.

Parameters:

body - http body

headers - http headers

ui - uri info

hostName - host id

Returns:

information regarding updated host

updateHosts

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

Handles PUT /clusters/{clusterID}/hosts Updates multiple hosts.

Parameters:

body - http body

headers - http headers

ui - uri info

Returns:

information regarding updated host

deleteHost

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

Handles DELETE /clusters/{clusterID}/hosts/{hostID} Deletes a specific host.

Parameters:

headers - http headers

ui - uri info

hostName - host id

Returns:

host resource representation

getHostComponentHandler

public HostComponentService getHostComponentHandler(String hostName)

Get the host_components sub-resource.

Parameters:

hostName - host id

Returns:

the host_components service