org.apache.ambari.server.api.services

Class ClusterService

java.lang.Object

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

org.apache.ambari.server.api.services.ClusterService

public class ClusterService
extends BaseService

Service responsible for cluster 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

Modifier	Constructor and Description
	ClusterService() Construct a ClusterService.
protected	ClusterService(Clusters clusters) Construct a ClusterService.

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	createCluster(String body, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo ui, String clusterName) Handles: POST /clusters/{clusterID} Create a specific cluster.
javax.ws.rs.core.Response	createClusterArtifact(String body, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo ui, String clusterName, String artifactName) Handles: POST /clusters/{clusterID}/artifacts/{artifactName} Create a cluster artifact.
javax.ws.rs.core.Response	deleteCluster(javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo ui, String clusterName) Handles: DELETE /clusters/{clusterID} Delete a specific cluster.
javax.ws.rs.core.Response	deleteClusterArtifact(String body, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo ui, String clusterName, String artifactName) Handles: DELETE /clusters/{clusterID}/artifacts/{artifactName} Delete a specific artifact.
javax.ws.rs.core.Response	deleteClusterArtifacts(String body, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo ui, String clusterName) Handles: DELETE /clusters/{clusterID}/artifacts Delete all artifacts matching the provided predicate.
AlertDefinitionService	getAlertDefinitionService(javax.ws.rs.core.Request request, String clusterName) Gets the alert definition service
AlertGroupService	getAlertGroups(javax.ws.rs.core.Request request, String clusterName) Gets the alert group service.
AlertHistoryService	getAlertHistoryService(javax.ws.rs.core.Request request, String clusterName) Gets the alert history service
AlertNoticeService	getAlertNoticeService(javax.ws.rs.core.Request request, String clusterName) Gets the alert notice service
AlertService	getAlertService(javax.ws.rs.core.Request request, String clusterName) Gets the alert definition service
javax.ws.rs.core.Response	getCluster(String body, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo ui, String clusterName) Handles: GET /clusters/{clusterID} Get a specific cluster.
javax.ws.rs.core.Response	getClusterArtifact(String body, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo ui, String clusterName, String artifactName) Handles: GET /clusters/{clusterID}/artifacts/{artifactName} Get an artifact resource instance.
javax.ws.rs.core.Response	getClusterArtifacts(String body, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo ui, String clusterName) Handles: GET /clusters/{clusterID}/artifacts Get all artifacts associated with the cluster.
javax.ws.rs.core.Response	getClusters(String body, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo ui) Handles: GET /clusters Get all clusters.
ClusterStackVersionService	getClusterStackVersionService(javax.ws.rs.core.Request request, String clusterName) Gets the cluster stack versions service.
ComponentService	getComponentHandler(javax.ws.rs.core.Request request, String clusterName) Get the component resource without specifying the parent service.
ClusterKerberosDescriptorService	getCompositeKerberosDescriptor(javax.ws.rs.core.Request request, String clusterName) Handles: GET /clusters/{clusterID}/kerberos_descriptor Gets the composite Kerberos descriptor associated with the cluster.
ConfigGroupService	getConfigGroupService(javax.ws.rs.core.Request request, String clusterName) Gets the config group service
ConfigurationService	getConfigurationHandler(javax.ws.rs.core.Request request, String clusterName) Gets the configurations sub-resource.
CredentialService	getCredentials(javax.ws.rs.core.Request request, String clusterName) Gets the credentials service.
HostComponentService	getHostComponentHandler(javax.ws.rs.core.Request request, String clusterName) Get the host component resource without specifying the parent host component.
HostService	getHostHandler(javax.ws.rs.core.Request request, String clusterName) Get the hosts sub-resource
HostKerberosIdentityService	getHostKerberosIdentityHandler(javax.ws.rs.core.Request request, String clusterName) Get the host Kerberos identity resource without specifying the parent host component.
LoggingService	getLogging(javax.ws.rs.core.Request request, String clusterName) Gets the Logging Service
PreUpgradeCheckService	getPreUpgradeCheckService(javax.ws.rs.core.Request request, String clusterName) Gets the pre-upgrade checks service.
PrivilegeService	getPrivilegeService(javax.ws.rs.core.Request request, String clusterName) Gets the privilege service
RequestService	getRequestHandler(javax.ws.rs.core.Request request, String clusterName) Gets the requests sub-resource.
RequestScheduleService	getRequestScheduleService(javax.ws.rs.core.Request request, String clusterName) Gets the request schedule service
ServiceService	getServiceHandler(javax.ws.rs.core.Request request, String clusterName) Get the services sub-resource
UpgradeService	getUpgradeService(javax.ws.rs.core.Request request, String clusterName) Gets the services for upgrades.
UpgradeSummaryService	getUpgradeSummaryService(javax.ws.rs.core.Request request, String clusterName) Gets a list of upgrade summaries.
WidgetLayoutService	getWidgetLayoutService(javax.ws.rs.core.Request request, String clusterName) Gets the widget layout service
WidgetService	getWidgetService(javax.ws.rs.core.Request request, String clusterName) Gets the widget service
WorkflowService	getWorkflowHandler(javax.ws.rs.core.Request request, String clusterName) Gets the workflows sub-resource.
javax.ws.rs.core.Response	updateCluster(String body, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo ui, String clusterName) Handles: PUT /clusters/{clusterID} Update a specific cluster.
javax.ws.rs.core.Response	updateClusterArtifact(String body, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo ui, String clusterName, String artifactName) Handles: PUT /clusters/{clusterID}/artifacts/{artifactName} Update a specific artifact.
javax.ws.rs.core.Response	updateClusterArtifacts(String body, javax.ws.rs.core.HttpHeaders headers, javax.ws.rs.core.UriInfo ui, String clusterName) Handles: PUT /clusters/{clusterID}/artifacts Update all artifacts matching the provided predicate.

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

ClusterService

public ClusterService()

Construct a ClusterService.

ClusterService

protected ClusterService(Clusters clusters)

Construct a ClusterService.

Parameters:

clusters - the clusters utilities

Method Detail

getCluster

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

Handles: GET /clusters/{clusterID} Get a specific cluster.

Parameters:

headers - http headers

ui - uri info

clusterName - cluster id

Returns:

cluster instance representation

getClusters

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

Handles: GET /clusters Get all clusters.

Parameters:

headers - http headers

ui - uri info

Returns:

cluster collection resource representation

createCluster

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

Handles: POST /clusters/{clusterID} Create a specific cluster.

Parameters:

headers - http headers

ui - uri info

clusterName - cluster id

Returns:

information regarding the created cluster

updateCluster

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

Handles: PUT /clusters/{clusterID} Update a specific cluster.

Parameters:

headers - http headers

ui - uri info

clusterName - cluster id

Returns:

information regarding the updated cluster

deleteCluster

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

Handles: DELETE /clusters/{clusterID} Delete a specific cluster.

Parameters:

headers - http headers

ui - uri info

clusterName - cluster id

Returns:

information regarding the deleted cluster

getClusterArtifacts

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

Handles: GET /clusters/{clusterID}/artifacts Get all artifacts associated with the cluster.

Parameters:

body - request body

headers - http headers

ui - uri info

clusterName - cluster name

Returns:

artifact collection resource representation

getClusterArtifact

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

Handles: GET /clusters/{clusterID}/artifacts/{artifactName} Get an artifact resource instance.

Parameters:

body - request body

headers - http headers

ui - uri info

clusterName - cluster name

artifactName - artifact name

Returns:

artifact instance resource representation

createClusterArtifact

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

Handles: POST /clusters/{clusterID}/artifacts/{artifactName} Create a cluster artifact.

Parameters:

body - request body

headers - http headers

ui - uri info

clusterName - cluster name

artifactName - artifact name

updateClusterArtifacts

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

Handles: PUT /clusters/{clusterID}/artifacts Update all artifacts matching the provided predicate.

Parameters:

headers - http headers

ui - uri info

clusterName - cluster name

Returns:

information regarding the updated artifacts

updateClusterArtifact

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

Handles: PUT /clusters/{clusterID}/artifacts/{artifactName} Update a specific artifact.

Parameters:

headers - http headers

ui - uri info

clusterName - cluster name

artifactName - artifactName

Returns:

information regarding the updated artifact

deleteClusterArtifact

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

Handles: DELETE /clusters/{clusterID}/artifacts/{artifactName} Delete a specific artifact.

Parameters:

headers - http headers

ui - uri info

clusterName - cluster name

artifactName - artifactName

Returns:

information regarding the deleted artifact

deleteClusterArtifacts

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

Handles: DELETE /clusters/{clusterID}/artifacts Delete all artifacts matching the provided predicate.

Parameters:

headers - http headers

ui - uri info

clusterName - cluster name

Returns:

information regarding the deleted artifacts

getHostHandler

public HostService getHostHandler(@Context
                                  javax.ws.rs.core.Request request,
                                  String clusterName)

Get the hosts sub-resource

Parameters:

request - the request

clusterName - cluster id

Returns:

the hosts service

getServiceHandler

public ServiceService getServiceHandler(@Context
                                        javax.ws.rs.core.Request request,
                                        String clusterName)

Get the services sub-resource

Parameters:

request - the request

clusterName - cluster id

Returns:

the services service

getConfigurationHandler

public ConfigurationService getConfigurationHandler(@Context
                                                    javax.ws.rs.core.Request request,
                                                    String clusterName)

Gets the configurations sub-resource.

Parameters:

request - the request

clusterName - the cluster name

Returns:

the configuration service

getRequestHandler

public RequestService getRequestHandler(@Context
                                        javax.ws.rs.core.Request request,
                                        String clusterName)

Gets the requests sub-resource.

Parameters:

request - the request

clusterName - the cluster name

Returns:

the requests service

getHostComponentHandler

public HostComponentService getHostComponentHandler(@Context
                                                    javax.ws.rs.core.Request request,
                                                    String clusterName)

Get the host component resource without specifying the parent host component. Allows accessing host component resources across hosts.

Parameters:

request - the request

clusterName - the cluster name

Returns:

the host component service with no parent set

getHostKerberosIdentityHandler

public HostKerberosIdentityService getHostKerberosIdentityHandler(@Context
                                                                  javax.ws.rs.core.Request request,
                                                                  String clusterName)

Get the host Kerberos identity resource without specifying the parent host component. Allows accessing host Kerberos identity resources across hosts.

Parameters:

request - the request

clusterName - the cluster name

Returns:

the host component service with no parent set

getComponentHandler

public ComponentService getComponentHandler(@Context
                                            javax.ws.rs.core.Request request,
                                            String clusterName)

Get the component resource without specifying the parent service. Allows accessing component resources across services.

Parameters:

request - the request

clusterName - the cluster name

Returns:

the host component service with no parent set

getWorkflowHandler

public WorkflowService getWorkflowHandler(@Context
                                          javax.ws.rs.core.Request request,
                                          String clusterName)

Gets the workflows sub-resource.

Parameters:

request - the request

clusterName - the cluster name

Returns:

the workflow service

getConfigGroupService

public ConfigGroupService getConfigGroupService(@Context
                                                javax.ws.rs.core.Request request,
                                                String clusterName)

Gets the config group service

Parameters:

request - the request

clusterName - the cluster name

Returns:

the config group service

getRequestScheduleService

public RequestScheduleService getRequestScheduleService(@Context
                                                        javax.ws.rs.core.Request request,
                                                        String clusterName)

Gets the request schedule service

Parameters:

request - the request

clusterName - the cluster name

Returns:

the request schedule service

getAlertDefinitionService

public AlertDefinitionService getAlertDefinitionService(@Context
                                                        javax.ws.rs.core.Request request,
                                                        String clusterName)

Gets the alert definition service

Parameters:

request - the request

clusterName - the cluster name

Returns:

the alert definition service

getAlertGroups

public AlertGroupService getAlertGroups(@Context
                                        javax.ws.rs.core.Request request,
                                        String clusterName)

Gets the alert group service.

Parameters:

request - the request.

clusterName - the cluster name.

Returns:

the alert group service.

getPrivilegeService

public PrivilegeService getPrivilegeService(@Context
                                            javax.ws.rs.core.Request request,
                                            String clusterName)

Gets the privilege service

Parameters:

request - the request

clusterName - the cluster name

Returns:

the privileges service

getAlertService

public AlertService getAlertService(@Context
                                    javax.ws.rs.core.Request request,
                                    String clusterName)

Gets the alert definition service

Parameters:

request - the request

clusterName - the cluster name

Returns:

the alert definition service

getAlertHistoryService

public AlertHistoryService getAlertHistoryService(@Context
                                                  javax.ws.rs.core.Request request,
                                                  String clusterName)

Gets the alert history service

Parameters:

request - the request

clusterName - the cluster name

Returns:

the alert history service

getAlertNoticeService

public AlertNoticeService getAlertNoticeService(@Context
                                                javax.ws.rs.core.Request request,
                                                String clusterName)

Gets the alert notice service

Parameters:

request - the request

clusterName - the cluster name

Returns:

the alert notice service

getClusterStackVersionService

public ClusterStackVersionService getClusterStackVersionService(@Context
                                                                javax.ws.rs.core.Request request,
                                                                String clusterName)

Gets the cluster stack versions service.

Parameters:

request - the request

clusterName - the cluster name

Returns:

the cluster stack versions service

getUpgradeService

public UpgradeService getUpgradeService(@Context
                                        javax.ws.rs.core.Request request,
                                        String clusterName)

Gets the services for upgrades.

Parameters:

request - the request

clusterName - the cluster name

Returns:

the upgrade services

getUpgradeSummaryService

public UpgradeSummaryService getUpgradeSummaryService(@Context
                                                      javax.ws.rs.core.Request request,
                                                      String clusterName)

Gets a list of upgrade summaries.

Parameters:

request - the request

clusterName - the cluster name

Returns:

the upgrade summary service

getPreUpgradeCheckService

public PreUpgradeCheckService getPreUpgradeCheckService(@Context
                                                        javax.ws.rs.core.Request request,
                                                        String clusterName)

Gets the pre-upgrade checks service.

Parameters:

request - the request

clusterName - the cluster name

Returns:

the pre-upgrade checks service.

getWidgetLayoutService

public WidgetLayoutService getWidgetLayoutService(@Context
                                                  javax.ws.rs.core.Request request,
                                                  String clusterName)

Gets the widget layout service

getWidgetService

public WidgetService getWidgetService(@Context
                                      javax.ws.rs.core.Request request,
                                      String clusterName)

Gets the widget service

getCredentials

public CredentialService getCredentials(@Context
                                        javax.ws.rs.core.Request request,
                                        String clusterName)

Gets the credentials service.

Parameters:

request - the request.

clusterName - the cluster name.

Returns:

the credentials service.

getCompositeKerberosDescriptor

public ClusterKerberosDescriptorService getCompositeKerberosDescriptor(@Context
                                                                       javax.ws.rs.core.Request request,
                                                                       String clusterName)

Handles: GET /clusters/{clusterID}/kerberos_descriptor Gets the composite Kerberos descriptor associated with the cluster.

Parameters:

request - the request.

clusterName - the cluster name.

Returns:

composite Kerberos descriptor resource representation

getLogging

public LoggingService getLogging(@Context
                                 javax.ws.rs.core.Request request,
                                 String clusterName)

Gets the Logging Service

Parameters:

request - the request

clusterName - the cluster name

Returns:

a new instance of the LoggingService