org.apache.ambari.server.api.services

Class SettingService

java.lang.Object

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

org.apache.ambari.server.api.services.SettingService

public class SettingService
extends BaseService

Service responsible for setting resource requests.

Field Summary

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
SettingService() Construct a SettingService.

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	createSetting(String body, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo ui) Handles: POST /settings Create a specific setting.
protected ResourceInstance	createSettingResource(String settingName) Create a setting resource instance.
javax.ws.rs.core.Response	deleteSetting(javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo ui, String settingName) Handles: DELETE /settings/{settingName} Delete a specific setting.
javax.ws.rs.core.Response	getSetting(String body, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo ui, String settingName) Handles: GET /settings/{settingName} Get a specific setting.
javax.ws.rs.core.Response	getSettings(String body, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo ui) Handles: GET /settings Get all clusters.
javax.ws.rs.core.Response	updateSetting(String body, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo ui, String settingName) Handles: PUT /settings/{settingName} Update a specific setting.

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

Constructor Detail

SettingService

public SettingService()

Construct a SettingService.

Method Detail

getSettings

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

Handles: GET /settings Get all clusters.

Parameters:

headers - http headers

ui - uri info

Returns:

setting collection resource representation

getSetting

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

Handles: GET /settings/{settingName} Get a specific setting.

Parameters:

headers - http headers

ui - uri info

settingName - settingName

Returns:

setting instance representation

createSetting

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

Handles: POST /settings Create a specific setting.

Parameters:

headers - http headers

ui - uri info

Returns:

information regarding the created setting

updateSetting

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

Handles: PUT /settings/{settingName} Update a specific setting.

Parameters:

headers - http headers

ui - uri info

settingName - setting name

Returns:

information regarding the updated setting

deleteSetting

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

Handles: DELETE /settings/{settingName} Delete a specific setting.

Parameters:

headers - http headers

ui - uri info

settingName - setting name

Returns:

information regarding the deleted setting

createSettingResource

protected ResourceInstance createSettingResource(String settingName)

Create a setting resource instance.

Parameters:

settingName - setting name

Returns:

a setting resource instance