org.apache.ambari.server.api.services

Class RootServiceComponentConfigurationService

java.lang.Object

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

org.apache.ambari.server.api.services.RootServiceComponentConfigurationService

public class RootServiceComponentConfigurationService
extends BaseService

Rest endpoint for managing ambari root service component configurations. Supports CRUD operations. Ambari configurations are resources that relate to the ambari server instance even before a cluster is provisioned.

Ambari configuration resources may be shared with components and services in the cluster (by recommending them as default values)

Eg. LDAP configuration is stored as Configuration. The request payload has the form:

      {
        "Configuration": {
          "service_name": "AMBARI",
          "component_name": "AMBARI_SERVER",
          "category": "ldap-configuration",
          "properties": {
             "authentication.ldap.primaryUrl": "localhost:33389"
             "authentication.ldap.secondaryUrl": "localhost:333"
             "authentication.ldap.baseDn": "dc=ambari,dc=apache,dc=org"
             // ......
          }
        }
      }
 

Field Summary

Fields

Modifier and Type	Field and Description
static String	DIRECTIVE_OPERATION
static Map<BaseResourceDefinition.DirectiveType,Set<String>>	DIRECTIVES_MAP

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
RootServiceComponentConfigurationService(String serviceName, String componentName)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	createConfiguration(String body, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo uri) Creates a root service component configuration resource.
javax.ws.rs.core.Response	deleteConfiguration(String body, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo uri, String category)
javax.ws.rs.core.Response	getConfiguration(String body, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo uri, String category)
javax.ws.rs.core.Response	getConfigurations(String body, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo uri)
javax.ws.rs.core.Response	updateConfiguration(String body, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo uri, String category)

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

DIRECTIVE_OPERATION

public static final String DIRECTIVE_OPERATION

See Also:

Constant Field Values

DIRECTIVES_MAP

public static final Map<BaseResourceDefinition.DirectiveType,Set<String>> DIRECTIVES_MAP

Constructor Detail

RootServiceComponentConfigurationService

public RootServiceComponentConfigurationService(String serviceName,
                                                String componentName)

Method Detail

createConfiguration

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

Creates a root service component configuration resource.

Parameters:

body - the payload in json format

headers - http headers

uri - request uri information

Returns:

getConfigurations

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

getConfiguration

public javax.ws.rs.core.Response getConfiguration(String body,
                                                  @Context
                                                  javax.ws.rs.core.HttpHeaders headers,
                                                  @Context
                                                  javax.ws.rs.core.UriInfo uri,
                                                  String category)

updateConfiguration

public javax.ws.rs.core.Response updateConfiguration(String body,
                                                     @Context
                                                     javax.ws.rs.core.HttpHeaders headers,
                                                     @Context
                                                     javax.ws.rs.core.UriInfo uri,
                                                     String category)

deleteConfiguration

public javax.ws.rs.core.Response deleteConfiguration(String body,
                                                     @Context
                                                     javax.ws.rs.core.HttpHeaders headers,
                                                     @Context
                                                     javax.ws.rs.core.UriInfo uri,
                                                     String category)