Package org.apache.hadoop.yarn.service.webapp

Class ApiServer

java.lang.Object

org.apache.hadoop.yarn.service.webapp.ApiServer

@Path("/v1")
public class ApiServer
extends Object

The rest API endpoints for users to manage services on YARN.

Constructor Summary

Constructors

Constructor	Description
ApiServer()
ApiServer(org.apache.hadoop.conf.Configuration conf)

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	createService(javax.servlet.http.HttpServletRequest request, org.apache.hadoop.yarn.service.api.records.Service service)
javax.ws.rs.core.Response	deleteService(javax.servlet.http.HttpServletRequest request, String appName)
javax.ws.rs.core.Response	getComponentInstances(javax.servlet.http.HttpServletRequest request, String serviceName, List<String> componentNames, String version, List<String> containerStates)
javax.ws.rs.core.Response	getService(javax.servlet.http.HttpServletRequest request, String appName)
javax.ws.rs.core.Response	getVersion()
void	setServiceClient(org.apache.hadoop.yarn.service.client.ServiceClient mockServerClient)	Used by negative test case.
javax.ws.rs.core.Response	updateComponent(javax.servlet.http.HttpServletRequest request, String appName, String componentName, org.apache.hadoop.yarn.service.api.records.Component component)
javax.ws.rs.core.Response	updateComponentInstance(javax.servlet.http.HttpServletRequest request, String serviceName, String componentName, String compInstanceName, org.apache.hadoop.yarn.service.api.records.Container reqContainer)
javax.ws.rs.core.Response	updateComponentInstances(javax.servlet.http.HttpServletRequest request, String serviceName, List<org.apache.hadoop.yarn.service.api.records.Container> requestContainers)
javax.ws.rs.core.Response	updateComponents(javax.servlet.http.HttpServletRequest request, String serviceName, List<org.apache.hadoop.yarn.service.api.records.Component> requestComponents)
javax.ws.rs.core.Response	updateService(javax.servlet.http.HttpServletRequest request, String appName, org.apache.hadoop.yarn.service.api.records.Service updateServiceData)

Methods inherited from class java.lang.Object

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

Constructor Details

ApiServer

public ApiServer()

ApiServer

@Inject
public ApiServer(org.apache.hadoop.conf.Configuration conf)

Method Details

getVersion

@GET
@Path("/services/version")
@Consumes("application/json")
@Produces("application/json;charset=utf-8")
public javax.ws.rs.core.Response getVersion()

createService

@POST
@Path("/services")
@Consumes("application/json")
@Produces("application/json;charset=utf-8")
public javax.ws.rs.core.Response createService(@Context
 javax.servlet.http.HttpServletRequest request,
 org.apache.hadoop.yarn.service.api.records.Service service)

getService

@GET
@Path("/services/{service_name}")
@Consumes("application/json")
@Produces("application/json;charset=utf-8")
public javax.ws.rs.core.Response getService(@Context
 javax.servlet.http.HttpServletRequest request,
 @PathParam("service_name")
 String appName)

deleteService

@DELETE
@Path("/services/{service_name}")
@Consumes("application/json")
@Produces("application/json;charset=utf-8")
public javax.ws.rs.core.Response deleteService(@Context
 javax.servlet.http.HttpServletRequest request,
 @PathParam("service_name")
 String appName)

updateComponents

@PUT
@Path("/services/{service_name}/components")
@Consumes("application/json")
@Produces({"application/json;charset=utf-8","text/plain"})
public javax.ws.rs.core.Response updateComponents(@Context
 javax.servlet.http.HttpServletRequest request,
 @PathParam("service_name")
 String serviceName,
 List<org.apache.hadoop.yarn.service.api.records.Component> requestComponents)

updateComponent

@PUT
@Path("/services/{service_name}/components/{component_name}")
@Consumes("application/json")
@Produces({"application/json;charset=utf-8","text/plain"})
public javax.ws.rs.core.Response updateComponent(@Context
 javax.servlet.http.HttpServletRequest request,
 @PathParam("service_name")
 String appName,
 @PathParam("component_name")
 String componentName,
 org.apache.hadoop.yarn.service.api.records.Component component)

updateService

@PUT
@Path("/services/{service_name}")
@Consumes("application/json")
@Produces("application/json;charset=utf-8")
public javax.ws.rs.core.Response updateService(@Context
 javax.servlet.http.HttpServletRequest request,
 @PathParam("service_name")
 String appName,
 org.apache.hadoop.yarn.service.api.records.Service updateServiceData)

updateComponentInstance

@PUT
@Path("/services/{service_name}/components/{component_name}/component-instances/{component_instance_name}")
@Consumes("application/json")
@Produces({"application/json;charset=utf-8","text/plain"})
public javax.ws.rs.core.Response updateComponentInstance(@Context
 javax.servlet.http.HttpServletRequest request,
 @PathParam("service_name")
 String serviceName,
 @PathParam("component_name")
 String componentName,
 @PathParam("component_instance_name")
 String compInstanceName,
 org.apache.hadoop.yarn.service.api.records.Container reqContainer)

updateComponentInstances

@PUT
@Path("/services/{service_name}/component-instances")
@Consumes("application/json")
@Produces({"application/json;charset=utf-8","text/plain"})
public javax.ws.rs.core.Response updateComponentInstances(@Context
 javax.servlet.http.HttpServletRequest request,
 @PathParam("service_name")
 String serviceName,
 List<org.apache.hadoop.yarn.service.api.records.Container> requestContainers)

getComponentInstances

@GET
@Path("/services/{service_name}/component-instances")
@Produces("application/json;charset=utf-8")
public javax.ws.rs.core.Response getComponentInstances(@Context
 javax.servlet.http.HttpServletRequest request,
 @PathParam("service_name")
 String serviceName,
 @QueryParam("componentName")
 List<String> componentNames,
 @QueryParam("version")
 String version,
 @QueryParam("containerState")
 List<String> containerStates)

setServiceClient

public void setServiceClient(org.apache.hadoop.yarn.service.client.ServiceClient mockServerClient)

Used by negative test case.

Parameters:

mockServerClient - - A mocked version of ServiceClient