org.apache.ambari.server.api.services.views

Class ViewInstanceService

java.lang.Object

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

org.apache.ambari.server.api.services.views.ViewInstanceService

public class ViewInstanceService
extends BaseService

Service responsible for instances resource requests.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ViewInstanceService.NotFoundResponse Stub class for 404 error response

Field Summary

Fields

Modifier and Type	Field and Description
static String	VIEW_INSTANCE_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
ViewInstanceService()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	createService(String body, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo ui, String viewName, String version, String instanceName) Handles: POST /views/{viewName}/versions/{version}/instances/{instanceId} Create a specific instance.
javax.ws.rs.core.Response	createServices(String body, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo ui, String viewName, String version) Handles: POST /views/{viewName}/versions/{version}/instances Create multiple instances.
javax.ws.rs.core.Response	deleteService(javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo ui, String viewName, String version, String instanceName) Handles: DELETE /views/{viewName}/versions/{version}/instances/{instanceId} Delete a specific instance.
Object	getResourceHandler(javax.ws.rs.core.Request request, String viewName, String version, String instanceName, String resources) Get the sub-resource
javax.ws.rs.core.Response	getService(String body, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo ui, String viewName, String version, String instanceName) Handles URL: /views/{viewName}/versions/{version}/instances/{instanceID} Get a specific instance.
javax.ws.rs.core.Response	getServices(String body, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo ui, String viewName, String version) Handles URL: /views/{viewName}/versions/{version}/instances Get all instances for a view.
javax.ws.rs.core.Response	updateService(String body, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo ui, String viewName, String version, String instanceName) Handles: PUT /views/{viewName}/versions/{version}/instances/{instanceId} Update a specific instance.
javax.ws.rs.core.Response	updateServices(String body, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo ui, String viewName, String version) Handles: PUT /views/{viewName}/versions/{version}/instances Update multiple instances.

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

VIEW_INSTANCE_REQUEST_TYPE

public static final String VIEW_INSTANCE_REQUEST_TYPE

See Also:

Constant Field Values

Constructor Detail

ViewInstanceService

public ViewInstanceService()

Method Detail

getServices

public javax.ws.rs.core.Response getServices(String body,
                                             @Context
                                             javax.ws.rs.core.HttpHeaders headers,
                                             @Context
                                             javax.ws.rs.core.UriInfo ui,
                                             String viewName,
                                             String version)
                                      throws AuthorizationException

Handles URL: /views/{viewName}/versions/{version}/instances Get all instances for a view.

Parameters:

headers - http headers

ui - uri info

viewName - view id

version - version id

Returns:

instance collection resource representation

Throws:

AuthorizationException

getService

public javax.ws.rs.core.Response getService(String body,
                                            @Context
                                            javax.ws.rs.core.HttpHeaders headers,
                                            @Context
                                            javax.ws.rs.core.UriInfo ui,
                                            String viewName,
                                            String version,
                                            String instanceName)
                                     throws AuthorizationException

Handles URL: /views/{viewName}/versions/{version}/instances/{instanceID} Get a specific instance.

Parameters:

headers - http headers

ui - uri info

viewName - view id

version - version id

instanceName - instance id

Returns:

instance resource representation

Throws:

AuthorizationException

createService

public javax.ws.rs.core.Response createService(String body,
                                               @Context
                                               javax.ws.rs.core.HttpHeaders headers,
                                               @Context
                                               javax.ws.rs.core.UriInfo ui,
                                               String viewName,
                                               String version,
                                               String instanceName)
                                        throws AuthorizationException

Handles: POST /views/{viewName}/versions/{version}/instances/{instanceId} Create a specific instance.

Parameters:

body - http body

headers - http headers

ui - uri info

viewName - view id

version - version id

instanceName - instance id

Returns:

information regarding the created instance

Throws:

AuthorizationException

createServices

public javax.ws.rs.core.Response createServices(String body,
                                                @Context
                                                javax.ws.rs.core.HttpHeaders headers,
                                                @Context
                                                javax.ws.rs.core.UriInfo ui,
                                                String viewName,
                                                String version)
                                         throws AuthorizationException

Handles: POST /views/{viewName}/versions/{version}/instances Create multiple instances.

Parameters:

body - http body

headers - http headers

ui - uri info

viewName - view id

version - version id

Returns:

information regarding the created instances

Throws:

AuthorizationException

updateService

public javax.ws.rs.core.Response updateService(String body,
                                               @Context
                                               javax.ws.rs.core.HttpHeaders headers,
                                               @Context
                                               javax.ws.rs.core.UriInfo ui,
                                               String viewName,
                                               String version,
                                               String instanceName)
                                        throws AuthorizationException

Handles: PUT /views/{viewName}/versions/{version}/instances/{instanceId} Update a specific instance.

Parameters:

body - http body

headers - http headers

ui - uri info

viewName - view id

version - version id

instanceName - instance id

Returns:

information regarding the updated instance

Throws:

AuthorizationException

updateServices

public javax.ws.rs.core.Response updateServices(String body,
                                                @Context
                                                javax.ws.rs.core.HttpHeaders headers,
                                                @Context
                                                javax.ws.rs.core.UriInfo ui,
                                                String viewName,
                                                String version)
                                         throws AuthorizationException

Handles: PUT /views/{viewName}/versions/{version}/instances Update multiple instances.

Parameters:

body - http body

headers - http headers

ui - uri info

viewName - view id

version - version id

Returns:

information regarding the updated instance

Throws:

AuthorizationException

deleteService

public javax.ws.rs.core.Response deleteService(@Context
                                               javax.ws.rs.core.HttpHeaders headers,
                                               @Context
                                               javax.ws.rs.core.UriInfo ui,
                                               String viewName,
                                               String version,
                                               String instanceName)
                                        throws AuthorizationException

Handles: DELETE /views/{viewName}/versions/{version}/instances/{instanceId} Delete a specific instance.

Parameters:

headers - http headers

ui - uri info

viewName - view id

version - version id

instanceName - instance id

Returns:

information regarding the deleted instance

Throws:

AuthorizationException

getResourceHandler

public Object getResourceHandler(@Context
                                 javax.ws.rs.core.Request request,
                                 String viewName,
                                 String version,
                                 String instanceName,
                                 String resources)

Get the sub-resource

Parameters:

instanceName - the instance id

Returns:

the service