org.apache.ambari.server.api.services

Class BlueprintService

java.lang.Object

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

org.apache.ambari.server.api.services.BlueprintService

public class BlueprintService
extends BaseService

Service responsible for handling REST requests for the /blueprints endpoint. This blueprint resource is a blueprint template meaning that it doesn't contain any cluster specific information. Updates are not permitted as blueprints are immutable.

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	createBlueprint(String body, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo ui, String blueprintName) Handles: POST /blueprints/{blueprintID} Create a specific blueprint.
javax.ws.rs.core.Response	deleteBlueprint(javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo ui, String blueprintName) Handles: DELETE /blueprints/{blueprintID} Delete a specific blueprint.
javax.ws.rs.core.Response	deleteBlueprints(javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo ui) Handles: DELETE /blueprints Delete a set of blueprints that match a predicate.
javax.ws.rs.core.Response	getBlueprint(String body, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo ui, String blueprintName) Handles: GET /blueprints/{blueprintID} Get a specific blueprint.
javax.ws.rs.core.Response	getBlueprints(String body, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo ui) Handles: GET /blueprints Get all blueprints.

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

BLUEPRINT_REQUEST_TYPE

public static final String BLUEPRINT_REQUEST_TYPE

See Also:

Constant Field Values

Constructor Detail

BlueprintService

public BlueprintService()

Method Detail

getBlueprints

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

Handles: GET /blueprints Get all blueprints.

Parameters:

headers - http headers

ui - uri info

Returns:

blueprint collection resource representation

getBlueprint

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

Handles: GET /blueprints/{blueprintID} Get a specific blueprint.

Parameters:

headers - http headers

ui - uri info

blueprintName - blueprint id

Returns:

blueprint instance representation

createBlueprint

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

Handles: POST /blueprints/{blueprintID} Create a specific blueprint.

Parameters:

headers - http headers

ui - uri info

blueprintName - blueprint id

Returns:

information regarding the created blueprint

deleteBlueprint

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

Handles: DELETE /blueprints/{blueprintID} Delete a specific blueprint.

Parameters:

headers - http headers

ui - uri info

blueprintName - blueprint name

Returns:

information regarding the deleted blueprint

deleteBlueprints

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

Handles: DELETE /blueprints Delete a set of blueprints that match a predicate.

Parameters:

headers - http headers

ui - uri info

Returns:

information regarding the deleted blueprint