org.apache.ambari.server.controller

Interface AmbariManagementController

All Known Implementing Classes:

AmbariManagementControllerImpl

public interface AmbariManagementController

Management controller interface.

Method Summary

Modifier and Type	Method and Description
RequestStageContainer	addStages(RequestStageContainer requestStages, Cluster cluster, Map<String,String> requestProperties, Map<String,String> requestParameters, Map<State,List<Service>> changedServices, Map<State,List<ServiceComponent>> changedComponents, Map<String,Map<State,List<ServiceComponentHost>>> changedHosts, Collection<ServiceComponentHost> ignoredHosts, boolean runSmokeTest, boolean reconfigureClients, boolean useGeneratedConfigs) Add stages to the request.
RequestStageContainer	addStages(RequestStageContainer requestStages, Cluster cluster, Map<String,String> requestProperties, Map<String,String> requestParameters, Map<State,List<Service>> changedServices, Map<State,List<ServiceComponent>> changedComponents, Map<String,Map<State,List<ServiceComponentHost>>> changedHosts, Collection<ServiceComponentHost> ignoredHosts, boolean runSmokeTest, boolean reconfigureClients, boolean useGeneratedConfigs, boolean useClusterHostInfo) Add stages to the request.
boolean	checkLdapConfigured() Performs a test if LDAP server is reachable.
RequestStatusResponse	createAction(ExecuteActionRequest actionRequest, Map<String,String> requestProperties) Create the action defined by the attributes in the given request object.
RequestStatusResponse	createAndPersistStages(Cluster cluster, Map<String,String> requestProperties, Map<String,String> requestParameters, Map<State,List<Service>> changedServices, Map<State,List<ServiceComponent>> changedComponents, Map<String,Map<State,List<ServiceComponentHost>>> changedHosts, Collection<ServiceComponentHost> ignoredHosts, boolean runSmokeTest, boolean reconfigureClients) Create and persist the request stages and return a response containing the associated request and resulting tasks.
void	createCluster(ClusterRequest request) Create the cluster defined by the attributes in the given request object.
Config	createConfig(Cluster cluster, StackId stackId, String type, Map<String,String> properties, String versionTag, Map<String,Map<String,String>> propertiesAttributes) Create cluster config TODO move this method to Cluster? doesn't seem to be on its place
ConfigurationResponse	createConfiguration(ConfigurationRequest request) Creates a configuration.
void	createExtensionLink(ExtensionLinkRequest request) Create a link between an extension and a stack
void	createGroups(Set<GroupRequest> requests) Creates groups.
void	createHostComponents(Set<ServiceComponentHostRequest> requests) Create the host component defined by the attributes in the given request object.
void	createHostComponents(Set<ServiceComponentHostRequest> requests, boolean isBlueprintProvisioned) Create the host component defined by the attributes in the given request object.
void	createMembers(Set<MemberRequest> requests) Creates members of the group.
Set<ServiceConfigVersionResponse>	createServiceConfigVersion(Set<ServiceConfigVersionRequest> requests) Creates serviceconfigversions and corresponding new configurations if it is an initial request OR Rollbacks to an existing serviceconfigversion if request specifies.
void	deleteCluster(ClusterRequest request) Delete the cluster identified by the given request object.
void	deleteExtensionLink(ExtensionLinkRequest request) Delete a link between an extension and a stack
void	deleteGroups(Set<GroupRequest> requests) Deletes the user groups specified.
DeleteStatusMetaData	deleteHostComponents(Set<ServiceComponentHostRequest> requests) Delete the host component identified by the given request object.
void	deleteMembers(Set<MemberRequest> requests) Deletes the group members specified.
Map<String,Map<String,String>>	findConfigurationTagsWithOverrides(Cluster cluster, String hostName) Find configuration tags with applied overrides
String	findServiceName(Cluster cluster, String componentName) Get service name by cluster instance and component name
ActionManager	getActionManager() Get the action manager for this management controller.
TopologyUpdateEvent	getAddedComponentsTopologyEvent(Set<ServiceComponentHostRequest> requests)
AmbariEventPublisher	getAmbariEventPublisher() Gets an AmbariEventPublisher which can be used to send and receive AmbariEvents.
AmbariMetaInfo	getAmbariMetaInfo() Get the meta info for this management controller.
String	getAmbariServerURI(String path) Get an Ambari endpoint URI for the given path.
int	getAuthId() Get the authenticated user's id.
String	getAuthName() Get the authenticated user's name.
Map<String,BlueprintProvisioningState>	getBlueprintProvisioningStates(Long clusterId, Long hostId)
MetadataUpdateEvent	getClusterMetadataOnConfigsUpdate(Cluster cluster)
Clusters	getClusters() Get the clusters for this management controller.
Set<ClusterResponse>	getClusters(Set<ClusterRequest> requests) Get the clusters identified by the given request objects.
ClusterResponse	getClusterUpdateResults(ClusterRequest clusterRequest) Get cached clusterUpdateResults, used only for service config versions currently
ConfigGroupFactory	getConfigGroupFactory() Get the config group factory for this management controller.
ConfigGroupResponse	getConfigGroupUpdateResults(ConfigGroupRequest configGroupRequest)
ConfigHelper	getConfigHelper() Get config helper
Set<ConfigurationResponse>	getConfigurations(Set<ConfigurationRequest> requests) Gets the configurations identified by the given request objects.
CredentialStoreService	getCredentialStoreService() Returns the CredentialStoreService implementation associated with this controller
MaintenanceState	getEffectiveMaintenanceState(ServiceComponentHost sch) Gets the effective maintenance state for a host component
ExecutionCommand	getExecutionCommand(Cluster cluster, ServiceComponentHost scHost, RoleCommand roleCommand) Gets an execution command for host component life cycle command
ExecutionScheduleManager	getExecutionScheduleManager() Get Execution Schedule Manager
Set<ExtensionResponse>	getExtensions(Set<ExtensionRequest> requests) Get supported extensions.
Set<ExtensionVersionResponse>	getExtensionVersions(Set<ExtensionVersionRequest> requests) Get supported extension versions.
Set<GroupResponse>	getGroups(Set<GroupRequest> requests) Gets the user groups identified by the given request objects.
String	getHealthyHost(Set<String> hostList) Chooses a healthy host from the list of candidate hosts randomly.
Set<ServiceComponentHostResponse>	getHostComponents(Set<ServiceComponentHostRequest> requests) Get the host components identified by the given request objects.
Set<ServiceComponentHostResponse>	getHostComponents(Set<ServiceComponentHostRequest> requests, boolean statusOnly)
String	getJavaHome() Getter for the java home, stored in ambari.properties
String	getJCEName() Getter for the jce name, stored in ambari.properties
String	getJDKName() Getter for the jdk name, stored in ambari.properties
String	getJdkResourceUrl() Getter for the url of JDK, stored at server resources folder
String	getJobTrackerHost(Cluster cluster) Deprecated.
KerberosHelper	getKerberosHelper() Returns KerberosHelper instance
LdapSyncDto	getLdapSyncInfo() Retrieves groups and users from external LDAP.
LoggingSearchPropertyProvider	getLoggingSearchPropertyProvider() Gets the LoggingSearchPropertyProvider instance.
LoggingService	getLoggingService(String clusterName) Gets the LoggingService instance from the dependency injection framework.
Set<MemberResponse>	getMembers(Set<MemberRequest> requests) Gets the group members identified by the given request objects.
MetricPropertyProviderFactory	getMetricPropertyProviderFactory() Gets the MetricPropertyProviderFactory that was injected into this class.
MetricsCollectorHAManager	getMetricsCollectorHAManager() Gets an MetricsCollectorHAManager which can be used to get/add collector host for a cluster
List<Module>	getModules(Long mpackId) Fetch the module info for a given mpack.
MpackResponse	getMpack(Long mpackId) Fetch an mpack based on id
Set<MpackResponse>	getMpacks() Fetch all mpacks
String	getMysqljdbcUrl() Getter for the url of MySQL JDBC driver, stored at server resources folder
String	getOjdbcUrl() Getter for the url of Oracle JDBC driver, stored at server resources folder
Set<OperatingSystemResponse>	getOperatingSystems(Set<OperatingSystemRequest> requests) Get operating systems by stack name, version.
List<ServiceOsSpecific.Package>	getPackagesForServiceHost(ServiceInfo serviceInfo, Map<String,String> hostParams, String osFamily)
QuickLinkVisibilityController	getQuicklinkVisibilityController()
Map<String,String>	getRcaParameters() Returns parameters for RCA database
Set<RepositoryResponse>	getRepositories(Set<RepositoryRequest> requests) Get repositories by stack name, version and operating system.
RequestExecutionFactory	getRequestExecutionFactory() Get the Factory to create Request schedules
RoleCommandOrder	getRoleCommandOrder(Cluster cluster) Get Role Command Order
RoleGraphFactory	getRoleGraphFactory() Get the role graph factory for this management controller.
Set<RootServiceComponentResponse>	getRootServiceComponents(Set<RootServiceComponentRequest> requests) Get all components of top-level services of Ambari, not related to certain cluster.
AbstractRootServiceResponseFactory	getRootServiceResponseFactory() Get the root service response factory for this management controller.
Set<RootServiceResponse>	getRootServices(Set<RootServiceRequest> requests) Get all top-level services of Ambari, not related to certain cluster.
String	getServerDB() Getter for the name of server database
ServiceComponentFactory	getServiceComponentFactory() Get the service component factory for this management controller.
Set<ServiceConfigVersionResponse>	getServiceConfigVersions(Set<ServiceConfigVersionRequest> requests) Get service config version history
Set<StackServiceComponentResponse>	getStackComponents(Set<StackServiceComponentRequest> requests) Get components by stack name, version and service.
Set<StackConfigurationDependencyResponse>	getStackConfigurationDependencies(Set<StackConfigurationDependencyRequest> requests) Get configuration dependencies which are specific for a specific service configuration property
Set<StackConfigurationResponse>	getStackConfigurations(Set<StackConfigurationRequest> requests) Get configurations by stack name, version and service.
Set<StackConfigurationResponse>	getStackLevelConfigurations(Set<StackLevelConfigurationRequest> requests) Get configurations which are specific for a cluster (!not a service).
Set<StackResponse>	getStacks(Set<StackRequest> requests) Get supported stacks.
Set<StackServiceResponse>	getStackServices(Set<StackServiceRequest> requests) Get repositories by stack name, version.
Set<StackVersionResponse>	getStackVersions(Set<StackVersionRequest> requests) Get supported stacks versions.
TimelineMetricCacheProvider	getTimelineMetricCacheProvider()
void	initializeWidgetsAndLayouts(Cluster cluster, Service service) Initialize cluster scoped widgets and widgetLayouts for different stack components.
boolean	isLdapSyncInProgress() Checks if LDAP sync process is running.
MpackResponse	registerMpack(MpackRequest request) Register the mpack defined by the attributes in the given request object.
void	registerRackChange(String clusterName) Register a change in rack information for the hosts of the given cluster.
void	removeMpack(MpackEntity mpackEntity, StackEntity stackEntity) Remove Mpack from the mpackMap and stackMap which is used to power the Mpack and Stack APIs.
void	saveConfigGroupUpdate(ConfigGroupRequest configGroupRequest, ConfigGroupResponse configGroupResponse)
List<String>	selectHealthyHosts(Set<String> hostList) Filters hosts to only select healthy ones that are heartbeating.
LdapBatchDto	synchronizeLdapUsersAndGroups(LdapSyncRequest userRequest, LdapSyncRequest groupRequest) Synchronizes local users and groups with given data.
RequestStatusResponse	updateClusters(Set<ClusterRequest> requests, Map<String,String> requestProperties) Update the cluster identified by the given request object with the values carried by the given request object.
RequestStatusResponse	updateClusters(Set<ClusterRequest> requests, Map<String,String> requestProperties, boolean fireAgentUpdates) Update the cluster identified by the given request object with the values carried by the given request object.
void	updateExtensionLink(ExtensionLinkEntity oldLinkEntity, ExtensionLinkRequest newLinkRequest) Update a link - switch the link's extension version while keeping the same stack version and extension name
void	updateExtensionLink(ExtensionLinkRequest request) Update a link - switch the link's extension version while keeping the same stack version and extension name
void	updateGroups(Set<GroupRequest> requests) Updates the groups specified.
void	updateMembers(Set<MemberRequest> requests) Updates the members of the group specified.
RequestStatusResponse	updateStacks() Update stacks from the files at stackRoot.
void	verifyRepositories(Set<RepositoryRequest> requests) Verifies repositories' base urls.

Method Detail

getAmbariServerURI

String getAmbariServerURI(String path)

Get an Ambari endpoint URI for the given path.

Parameters:

path - the path (e.g. /api/v1/users)

Returns:

the Ambari endpoint URI

createCluster

void createCluster(ClusterRequest request)
            throws org.apache.ambari.server.AmbariException,
                   AuthorizationException

Create the cluster defined by the attributes in the given request object.

Parameters:

request - the request object which defines the cluster to be created

Throws:

org.apache.ambari.server.AmbariException - thrown if the cluster cannot be created

AuthorizationException - thrown if the authenticated user is not authorized to perform this operation

createHostComponents

void createHostComponents(Set<ServiceComponentHostRequest> requests)
                   throws org.apache.ambari.server.AmbariException,
                          AuthorizationException

Create the host component defined by the attributes in the given request object.

Parameters:

requests - the request object which defines the host component to be created

Throws:

org.apache.ambari.server.AmbariException - thrown if the host component cannot be created

AuthorizationException

createHostComponents

void createHostComponents(Set<ServiceComponentHostRequest> requests,
                          boolean isBlueprintProvisioned)
                   throws org.apache.ambari.server.AmbariException,
                          AuthorizationException

Create the host component defined by the attributes in the given request object.

Parameters:

requests - the request object which defines the host component to be created

isBlueprintProvisioned - means host components will be created during blueprint deploy

Throws:

org.apache.ambari.server.AmbariException - thrown if the host component cannot be created

AuthorizationException

createConfiguration

ConfigurationResponse createConfiguration(ConfigurationRequest request)
                                   throws org.apache.ambari.server.AmbariException,
                                          AuthorizationException

Creates a configuration.

Parameters:

request - the request object which defines the configuration.

Throws:

org.apache.ambari.server.AmbariException - when the configuration cannot be created.

AuthorizationException

createConfig

Config createConfig(Cluster cluster,
                    StackId stackId,
                    String type,
                    Map<String,String> properties,
                    String versionTag,
                    Map<String,Map<String,String>> propertiesAttributes)

Create cluster config TODO move this method to Cluster? doesn't seem to be on its place

Returns:

config created

createGroups

void createGroups(Set<GroupRequest> requests)
           throws org.apache.ambari.server.AmbariException

Creates groups.

Parameters:

requests - the request objects which define the groups.

Throws:

org.apache.ambari.server.AmbariException - when the groups cannot be created.

createMembers

void createMembers(Set<MemberRequest> requests)
            throws org.apache.ambari.server.AmbariException

Creates members of the group.

Parameters:

requests - the request objects which define the members.

Throws:

org.apache.ambari.server.AmbariException - when the members cannot be created.

registerMpack

MpackResponse registerMpack(MpackRequest request)
                     throws IOException,
                            AuthorizationException,
                            ResourceAlreadyExistsException

Register the mpack defined by the attributes in the given request object.

Parameters:

request - the request object which defines the mpack to be created

Throws:

org.apache.ambari.server.AmbariException - thrown if the mpack cannot be created

AuthorizationException - thrown if the authenticated user is not authorized to perform this operation

IOException

ResourceAlreadyExistsException

getClusters

Set<ClusterResponse> getClusters(Set<ClusterRequest> requests)
                          throws org.apache.ambari.server.AmbariException,
                                 AuthorizationException

Get the clusters identified by the given request objects.

Parameters:

requests - the request objects which identify the clusters to be returned

Returns:

a set of cluster responses

Throws:

org.apache.ambari.server.AmbariException - thrown if the resource cannot be read

AuthorizationException - thrown if the authenticated user is not authorized to perform this operation

getHostComponents

Set<ServiceComponentHostResponse> getHostComponents(Set<ServiceComponentHostRequest> requests)
                                             throws org.apache.ambari.server.AmbariException

Get the host components identified by the given request objects.

Parameters:

requests - the request objects which identify the host components to be returned

Returns:

a set of host component responses

Throws:

org.apache.ambari.server.AmbariException - thrown if the resource cannot be read

getHostComponents

Set<ServiceComponentHostResponse> getHostComponents(Set<ServiceComponentHostRequest> requests,
                                                    boolean statusOnly)
                                             throws org.apache.ambari.server.AmbariException

Throws:

org.apache.ambari.server.AmbariException

getConfigurations

Set<ConfigurationResponse> getConfigurations(Set<ConfigurationRequest> requests)
                                      throws org.apache.ambari.server.AmbariException

Gets the configurations identified by the given request objects.

Parameters:

requests - the request objects

Returns:

a set of configuration responses

Throws:

org.apache.ambari.server.AmbariException - if the configurations could not be read

getServiceConfigVersions

Set<ServiceConfigVersionResponse> getServiceConfigVersions(Set<ServiceConfigVersionRequest> requests)
                                                    throws org.apache.ambari.server.AmbariException

Get service config version history

Parameters:

requests - service config version requests

Returns:

service config versions

Throws:

org.apache.ambari.server.AmbariException

getGroups

Set<GroupResponse> getGroups(Set<GroupRequest> requests)
                      throws org.apache.ambari.server.AmbariException

Gets the user groups identified by the given request objects.

Parameters:

requests - the request objects

Returns:

a set of group responses

Throws:

org.apache.ambari.server.AmbariException - if the groups could not be read

getMembers

Set<MemberResponse> getMembers(Set<MemberRequest> requests)
                        throws org.apache.ambari.server.AmbariException

Gets the group members identified by the given request objects.

Parameters:

requests - the request objects

Returns:

a set of member responses

Throws:

org.apache.ambari.server.AmbariException - if the members could not be read

updateClusters

RequestStatusResponse updateClusters(Set<ClusterRequest> requests,
                                     Map<String,String> requestProperties)
                              throws org.apache.ambari.server.AmbariException,
                                     AuthorizationException

Update the cluster identified by the given request object with the values carried by the given request object.

Parameters:

requests - request objects which define which cluster to update and the values to set

requestProperties - request specific properties independent of resource

Returns:

a track action response

Throws:

org.apache.ambari.server.AmbariException - thrown if the resource cannot be updated

AuthorizationException - thrown if the authenticated user is not authorized to perform this operation

updateClusters

RequestStatusResponse updateClusters(Set<ClusterRequest> requests,
                                     Map<String,String> requestProperties,
                                     boolean fireAgentUpdates)
                              throws org.apache.ambari.server.AmbariException,
                                     AuthorizationException

Update the cluster identified by the given request object with the values carried by the given request object.

Parameters:

requests - request objects which define which cluster to update and the values to set

requestProperties - request specific properties independent of resource

fireAgentUpdates - should agent updates (configurations, metadata etc.) be fired inside

Returns:

a track action response

Throws:

org.apache.ambari.server.AmbariException - thrown if the resource cannot be updated

AuthorizationException - thrown if the authenticated user is not authorized to perform this operation

updateGroups

void updateGroups(Set<GroupRequest> requests)
           throws org.apache.ambari.server.AmbariException

Updates the groups specified.

Parameters:

requests - the groups to modify

Throws:

org.apache.ambari.server.AmbariException - if the resources cannot be updated

updateMembers

void updateMembers(Set<MemberRequest> requests)
            throws org.apache.ambari.server.AmbariException

Updates the members of the group specified.

Parameters:

requests - the members to be set for this group

Throws:

org.apache.ambari.server.AmbariException - if the resources cannot be updated

deleteCluster

void deleteCluster(ClusterRequest request)
            throws org.apache.ambari.server.AmbariException

Delete the cluster identified by the given request object.

Parameters:

request - the request object which identifies which cluster to delete

Throws:

org.apache.ambari.server.AmbariException - thrown if the resource cannot be deleted

deleteHostComponents

DeleteStatusMetaData deleteHostComponents(Set<ServiceComponentHostRequest> requests)
                                   throws org.apache.ambari.server.AmbariException,
                                          AuthorizationException

Delete the host component identified by the given request object.

Parameters:

requests - the request object which identifies which host component to delete

Returns:

a track action response

Throws:

org.apache.ambari.server.AmbariException - thrown if the resource cannot be deleted

AuthorizationException

deleteGroups

void deleteGroups(Set<GroupRequest> requests)
           throws org.apache.ambari.server.AmbariException

Deletes the user groups specified.

Parameters:

requests - the groups to delete

Throws:

org.apache.ambari.server.AmbariException - if the resources cannot be deleted

deleteMembers

void deleteMembers(Set<MemberRequest> requests)
            throws org.apache.ambari.server.AmbariException

Deletes the group members specified.

Parameters:

requests - the members to delete

Throws:

org.apache.ambari.server.AmbariException - if the resources cannot be deleted

createAction

RequestStatusResponse createAction(ExecuteActionRequest actionRequest,
                                   Map<String,String> requestProperties)
                            throws org.apache.ambari.server.AmbariException

Create the action defined by the attributes in the given request object. Used only for custom commands/actions.

Parameters:

actionRequest - the request object which defines the action to be created

requestProperties - the request properties

Throws:

org.apache.ambari.server.AmbariException - thrown if the action cannot be created

getStacks

Set<StackResponse> getStacks(Set<StackRequest> requests)
                      throws org.apache.ambari.server.AmbariException

Get supported stacks.

Parameters:

requests - the stacks

Returns:

a set of stacks responses

Throws:

org.apache.ambari.server.AmbariException - if the resources cannot be read

updateStacks

RequestStatusResponse updateStacks()
                            throws org.apache.ambari.server.AmbariException

Update stacks from the files at stackRoot.

Returns:

a track action response

Throws:

org.apache.ambari.server.AmbariException - if

createExtensionLink

void createExtensionLink(ExtensionLinkRequest request)
                  throws org.apache.ambari.server.AmbariException

Create a link between an extension and a stack

Throws:

org.apache.ambari.server.AmbariException - if we fail to link the extension to the stack

updateExtensionLink

void updateExtensionLink(ExtensionLinkRequest request)
                  throws org.apache.ambari.server.AmbariException

Update a link - switch the link's extension version while keeping the same stack version and extension name

Throws:

org.apache.ambari.server.AmbariException - if we fail to link the extension to the stack

updateExtensionLink

void updateExtensionLink(ExtensionLinkEntity oldLinkEntity,
                         ExtensionLinkRequest newLinkRequest)
                  throws org.apache.ambari.server.AmbariException

Update a link - switch the link's extension version while keeping the same stack version and extension name

Throws:

org.apache.ambari.server.AmbariException - if we fail to link the extension to the stack

deleteExtensionLink

void deleteExtensionLink(ExtensionLinkRequest request)
                  throws org.apache.ambari.server.AmbariException

Delete a link between an extension and a stack

Throws:

org.apache.ambari.server.AmbariException - if we fail to unlink the extension from the stack

getExtensions

Set<ExtensionResponse> getExtensions(Set<ExtensionRequest> requests)
                              throws org.apache.ambari.server.AmbariException

Get supported extensions.

Parameters:

requests - the extensions

Returns:

a set of extensions responses

Throws:

org.apache.ambari.server.AmbariException - if the resources cannot be read

getExtensionVersions

Set<ExtensionVersionResponse> getExtensionVersions(Set<ExtensionVersionRequest> requests)
                                            throws org.apache.ambari.server.AmbariException

Get supported extension versions.

Parameters:

requests - the extension versions

Returns:

a set of extension versions responses

Throws:

org.apache.ambari.server.AmbariException - if the resources cannot be read

getStackVersions

Set<StackVersionResponse> getStackVersions(Set<StackVersionRequest> requests)
                                    throws org.apache.ambari.server.AmbariException

Get supported stacks versions.

Parameters:

requests - the stacks versions

Returns:

a set of stacks versions responses

Throws:

org.apache.ambari.server.AmbariException - if the resources cannot be read

getRepositories

Set<RepositoryResponse> getRepositories(Set<RepositoryRequest> requests)
                                 throws org.apache.ambari.server.AmbariException

Get repositories by stack name, version and operating system.

Parameters:

requests - the repositories

Returns:

a set of repositories

Throws:

org.apache.ambari.server.AmbariException - if the resources cannot be read

verifyRepositories

void verifyRepositories(Set<RepositoryRequest> requests)
                 throws org.apache.ambari.server.AmbariException

Verifies repositories' base urls.

Parameters:

requests - the repositories

Throws:

org.apache.ambari.server.AmbariException - if verification of any of urls fails

getStackServices

Set<StackServiceResponse> getStackServices(Set<StackServiceRequest> requests)
                                    throws org.apache.ambari.server.AmbariException

Get repositories by stack name, version.

Parameters:

requests - the services

Returns:

a set of services

Throws:

org.apache.ambari.server.AmbariException - if the resources cannot be read

getStackConfigurations

Set<StackConfigurationResponse> getStackConfigurations(Set<StackConfigurationRequest> requests)
                                                throws org.apache.ambari.server.AmbariException

Get configurations by stack name, version and service.

Parameters:

requests - the configurations

Returns:

a set of configurations

Throws:

org.apache.ambari.server.AmbariException - if the resources cannot be read

getStackComponents

Set<StackServiceComponentResponse> getStackComponents(Set<StackServiceComponentRequest> requests)
                                               throws org.apache.ambari.server.AmbariException

Get components by stack name, version and service.

Parameters:

requests - the components

Returns:

a set of components

Throws:

org.apache.ambari.server.AmbariException - if the resources cannot be read

getOperatingSystems

Set<OperatingSystemResponse> getOperatingSystems(Set<OperatingSystemRequest> requests)
                                          throws org.apache.ambari.server.AmbariException

Get operating systems by stack name, version.

Parameters:

requests - the operating systems

Returns:

a set of operating systems

Throws:

org.apache.ambari.server.AmbariException - if the resources cannot be read

getRootServices

Set<RootServiceResponse> getRootServices(Set<RootServiceRequest> requests)
                                  throws org.apache.ambari.server.AmbariException

Get all top-level services of Ambari, not related to certain cluster.

Parameters:

requests - the top-level services

Returns:

a set of top-level services

Throws:

org.apache.ambari.server.AmbariException - if the resources cannot be read

getRootServiceComponents

Set<RootServiceComponentResponse> getRootServiceComponents(Set<RootServiceComponentRequest> requests)
                                                    throws org.apache.ambari.server.AmbariException

Get all components of top-level services of Ambari, not related to certain cluster.

Parameters:

requests - the components of top-level services

Returns:

a set of components

Throws:

org.apache.ambari.server.AmbariException - if the resources cannot be read

findServiceName

String findServiceName(Cluster cluster,
                       String componentName)
                throws org.apache.ambari.server.AmbariException

Get service name by cluster instance and component name

Parameters:

cluster - the cluster instance

componentName - the component name in String type

Returns:

a service name

Throws:

org.apache.ambari.server.AmbariException - if service name is null or empty

getClusters

Clusters getClusters()

Get the clusters for this management controller.

Returns:

the clusters

getConfigHelper

ConfigHelper getConfigHelper()

Get config helper

Returns:

config helper

getAmbariMetaInfo

AmbariMetaInfo getAmbariMetaInfo()

Get the meta info for this management controller.

Returns:

the meta info

getServiceComponentFactory

ServiceComponentFactory getServiceComponentFactory()

Get the service component factory for this management controller.

Returns:

the service component factory

getRootServiceResponseFactory

AbstractRootServiceResponseFactory getRootServiceResponseFactory()

Get the root service response factory for this management controller.

Returns:

the root service response factory

getConfigGroupFactory

ConfigGroupFactory getConfigGroupFactory()

Get the config group factory for this management controller.

Returns:

the config group factory

getRoleGraphFactory

RoleGraphFactory getRoleGraphFactory()

Get the role graph factory for this management controller.

Returns:

the role graph factory

getActionManager

ActionManager getActionManager()

Get the action manager for this management controller.

Returns:

the action manager

getAuthName

String getAuthName()

Get the authenticated user's name.

Returns:

the authenticated user's name

getAuthId

int getAuthId()

Get the authenticated user's id.

Returns:

the authenticated user's name

createAndPersistStages

RequestStatusResponse createAndPersistStages(Cluster cluster,
                                             Map<String,String> requestProperties,
                                             Map<String,String> requestParameters,
                                             Map<State,List<Service>> changedServices,
                                             Map<State,List<ServiceComponent>> changedComponents,
                                             Map<String,Map<State,List<ServiceComponentHost>>> changedHosts,
                                             Collection<ServiceComponentHost> ignoredHosts,
                                             boolean runSmokeTest,
                                             boolean reconfigureClients)
                                      throws org.apache.ambari.server.AmbariException

Create and persist the request stages and return a response containing the associated request and resulting tasks.

Parameters:

cluster - the cluster

requestProperties - the request properties

requestParameters - the request parameters; may be null

changedServices - the services being changed; may be null

changedComponents - the components being changed

changedHosts - the hosts being changed

ignoredHosts - the hosts to be ignored

runSmokeTest - indicates whether or not the smoke tests should be run

reconfigureClients - indicates whether or not the clients should be reconfigured

Returns:

the request response

Throws:

org.apache.ambari.server.AmbariException - is thrown if the stages can not be created

addStages

RequestStageContainer addStages(RequestStageContainer requestStages,
                                Cluster cluster,
                                Map<String,String> requestProperties,
                                Map<String,String> requestParameters,
                                Map<State,List<Service>> changedServices,
                                Map<State,List<ServiceComponent>> changedComponents,
                                Map<String,Map<State,List<ServiceComponentHost>>> changedHosts,
                                Collection<ServiceComponentHost> ignoredHosts,
                                boolean runSmokeTest,
                                boolean reconfigureClients,
                                boolean useGeneratedConfigs)
                         throws org.apache.ambari.server.AmbariException

Add stages to the request.

Parameters:

requestStages - Stages currently associated with request

cluster - cluster being acted on

requestProperties - the request properties

requestParameters - the request parameters; may be null

changedServices - the services being changed; may be null

changedComponents - the components being changed

changedHosts - the hosts being changed

ignoredHosts - the hosts to be ignored

runSmokeTest - indicates whether or not the smoke tests should be run

reconfigureClients - indicates whether or not the clients should be reconfigured

Returns:

request stages

Throws:

org.apache.ambari.server.AmbariException - if stages can't be created

addStages

RequestStageContainer addStages(RequestStageContainer requestStages,
                                Cluster cluster,
                                Map<String,String> requestProperties,
                                Map<String,String> requestParameters,
                                Map<State,List<Service>> changedServices,
                                Map<State,List<ServiceComponent>> changedComponents,
                                Map<String,Map<State,List<ServiceComponentHost>>> changedHosts,
                                Collection<ServiceComponentHost> ignoredHosts,
                                boolean runSmokeTest,
                                boolean reconfigureClients,
                                boolean useGeneratedConfigs,
                                boolean useClusterHostInfo)
                         throws org.apache.ambari.server.AmbariException

Add stages to the request.

Parameters:

requestStages - Stages currently associated with request

cluster - cluster being acted on

requestProperties - the request properties

requestParameters - the request parameters; may be null

changedServices - the services being changed; may be null

changedComponents - the components being changed

changedHosts - the hosts being changed

ignoredHosts - the hosts to be ignored

runSmokeTest - indicates whether or not the smoke tests should be run

reconfigureClients - indicates whether or not the clients should be reconfigured

useGeneratedConfigs - indicates whether or not the actual configs should be a part of the stage

useClusterHostInfo - indicates whether or not the cluster topology info should be a part of the stage

Returns:

request stages

Throws:

org.apache.ambari.server.AmbariException - if stages can't be created

getJdkResourceUrl

String getJdkResourceUrl()

Getter for the url of JDK, stored at server resources folder

getJavaHome

String getJavaHome()

Getter for the java home, stored in ambari.properties

getJDKName

String getJDKName()

Getter for the jdk name, stored in ambari.properties

getJCEName

String getJCEName()

Getter for the jce name, stored in ambari.properties

getServerDB

String getServerDB()

Getter for the name of server database

getOjdbcUrl

String getOjdbcUrl()

Getter for the url of Oracle JDBC driver, stored at server resources folder

getMysqljdbcUrl

String getMysqljdbcUrl()

Getter for the url of MySQL JDBC driver, stored at server resources folder

selectHealthyHosts

List<String> selectHealthyHosts(Set<String> hostList)
                         throws org.apache.ambari.server.AmbariException

Filters hosts to only select healthy ones that are heartbeating.

The host's HostState is used to determine if a host is healthy.

Returns:

a List of healthy hosts, or an empty List if none exist.

Throws:

org.apache.ambari.server.AmbariException

See Also:

HostState#HEALTHY}

getHealthyHost

String getHealthyHost(Set<String> hostList)
               throws org.apache.ambari.server.AmbariException

Chooses a healthy host from the list of candidate hosts randomly. If there are no healthy hosts, then this method will return null.

The host's HostState is used to determine if a host is healthy.

Returns:

a random healthy host, or null.

Throws:

org.apache.ambari.server.AmbariException

See Also:

HostState#HEALTHY}

findConfigurationTagsWithOverrides

Map<String,Map<String,String>> findConfigurationTagsWithOverrides(Cluster cluster,
                                                                  String hostName)
                                                           throws org.apache.ambari.server.AmbariException

Find configuration tags with applied overrides

Parameters:

cluster - the cluster

hostName - the host name

Returns:

the configuration tags

Throws:

org.apache.ambari.server.AmbariException - if configuration tags can not be obtained

getRcaParameters

Map<String,String> getRcaParameters()

Returns parameters for RCA database

Returns:

the map with parameters for RCA db

getRequestExecutionFactory

RequestExecutionFactory getRequestExecutionFactory()

Get the Factory to create Request schedules

Returns:

the request execution factory

getExecutionScheduleManager

ExecutionScheduleManager getExecutionScheduleManager()

Get Execution Schedule Manager

getClusterUpdateResults

ClusterResponse getClusterUpdateResults(ClusterRequest clusterRequest)

Get cached clusterUpdateResults, used only for service config versions currently

Parameters:

clusterRequest -

Returns:

getJobTrackerHost

@Deprecated
String getJobTrackerHost(Cluster cluster)

Deprecated.

Get JobTracker hostname HDP-1.x is not supported anymore

getEffectiveMaintenanceState

MaintenanceState getEffectiveMaintenanceState(ServiceComponentHost sch)
                                       throws org.apache.ambari.server.AmbariException

Gets the effective maintenance state for a host component

Parameters:

sch - the service component host

Returns:

the maintenance state

Throws:

org.apache.ambari.server.AmbariException

getRoleCommandOrder

RoleCommandOrder getRoleCommandOrder(Cluster cluster)

Get Role Command Order

checkLdapConfigured

boolean checkLdapConfigured()

Performs a test if LDAP server is reachable.

Returns:

true if connection to LDAP was established

getLdapSyncInfo

LdapSyncDto getLdapSyncInfo()
                     throws org.apache.ambari.server.AmbariException

Retrieves groups and users from external LDAP.

Returns:

ldap sync DTO

Throws:

org.apache.ambari.server.AmbariException - if LDAP is configured incorrectly

synchronizeLdapUsersAndGroups

LdapBatchDto synchronizeLdapUsersAndGroups(LdapSyncRequest userRequest,
                                           LdapSyncRequest groupRequest)
                                    throws org.apache.ambari.server.AmbariException

Synchronizes local users and groups with given data.

Parameters:

userRequest - users to be synchronized

groupRequest - groups to be synchronized

Returns:

the results of the LDAP synchronization

Throws:

org.apache.ambari.server.AmbariException - if synchronization data was invalid

isLdapSyncInProgress

boolean isLdapSyncInProgress()

Checks if LDAP sync process is running.

Returns:

true if LDAP sync is in progress

getStackLevelConfigurations

Set<StackConfigurationResponse> getStackLevelConfigurations(Set<StackLevelConfigurationRequest> requests)
                                                     throws org.apache.ambari.server.AmbariException

Get configurations which are specific for a cluster (!not a service).

Parameters:

requests -

Returns:

Throws:

org.apache.ambari.server.AmbariException

getPackagesForServiceHost

List<ServiceOsSpecific.Package> getPackagesForServiceHost(ServiceInfo serviceInfo,
                                                          Map<String,String> hostParams,
                                                          String osFamily)

Parameters:

serviceInfo - service info for a given service

hostParams - parameter map. May be changed during method execution

osFamily - os family for host

Returns:

a full list of package dependencies for a service that should be installed on a host

registerRackChange

void registerRackChange(String clusterName)
                 throws org.apache.ambari.server.AmbariException

Register a change in rack information for the hosts of the given cluster.

Parameters:

clusterName - the name of the cluster

Throws:

org.apache.ambari.server.AmbariException - if an error occurs during the rack change registration

initializeWidgetsAndLayouts

void initializeWidgetsAndLayouts(Cluster cluster,
                                 Service service)
                          throws org.apache.ambari.server.AmbariException

Initialize cluster scoped widgets and widgetLayouts for different stack components.

Parameters:

cluster - @Cluster object

service - @Service object

Throws:

org.apache.ambari.server.AmbariException

getExecutionCommand

ExecutionCommand getExecutionCommand(Cluster cluster,
                                     ServiceComponentHost scHost,
                                     RoleCommand roleCommand)
                              throws org.apache.ambari.server.AmbariException

Gets an execution command for host component life cycle command

Returns:

Throws:

org.apache.ambari.server.AmbariException

getStackConfigurationDependencies

Set<StackConfigurationDependencyResponse> getStackConfigurationDependencies(Set<StackConfigurationDependencyRequest> requests)
                                                                     throws org.apache.ambari.server.AmbariException

Get configuration dependencies which are specific for a specific service configuration property

Parameters:

requests -

Returns:

Throws:

org.apache.ambari.server.AmbariException

getTimelineMetricCacheProvider

TimelineMetricCacheProvider getTimelineMetricCacheProvider()

getMetricPropertyProviderFactory

MetricPropertyProviderFactory getMetricPropertyProviderFactory()

Gets the MetricPropertyProviderFactory that was injected into this class. This is a terrible pattern.

Returns:

the injected MetricPropertyProviderFactory

getLoggingSearchPropertyProvider

LoggingSearchPropertyProvider getLoggingSearchPropertyProvider()

Gets the LoggingSearchPropertyProvider instance.

Returns:

the injected LoggingSearchPropertyProvider

getLoggingService

LoggingService getLoggingService(String clusterName)

Gets the LoggingService instance from the dependency injection framework.

Parameters:

clusterName - the cluster name associated with this LoggingService instance

Returns:

an instance of LoggingService associated with the specified cluster.

getKerberosHelper

KerberosHelper getKerberosHelper()

Returns KerberosHelper instance

Returns:

getCredentialStoreService

CredentialStoreService getCredentialStoreService()

Returns the CredentialStoreService implementation associated with this controller

Returns:

CredentialStoreService

getAmbariEventPublisher

AmbariEventPublisher getAmbariEventPublisher()

Gets an AmbariEventPublisher which can be used to send and receive AmbariEvents.

Returns:

getMetricsCollectorHAManager

MetricsCollectorHAManager getMetricsCollectorHAManager()

Gets an MetricsCollectorHAManager which can be used to get/add collector host for a cluster

Returns:

MetricsCollectorHAManager

getQuicklinkVisibilityController

QuickLinkVisibilityController getQuicklinkVisibilityController()

Returns:

the visibility controller that decides which quicklinks should be visible based on the actual quick links profile. If no profile is set, all links will be shown.

getConfigGroupUpdateResults

ConfigGroupResponse getConfigGroupUpdateResults(ConfigGroupRequest configGroupRequest)

saveConfigGroupUpdate

void saveConfigGroupUpdate(ConfigGroupRequest configGroupRequest,
                           ConfigGroupResponse configGroupResponse)

getClusterMetadataOnConfigsUpdate

MetadataUpdateEvent getClusterMetadataOnConfigsUpdate(Cluster cluster)
                                               throws org.apache.ambari.server.AmbariException

Throws:

org.apache.ambari.server.AmbariException

getAddedComponentsTopologyEvent

TopologyUpdateEvent getAddedComponentsTopologyEvent(Set<ServiceComponentHostRequest> requests)
                                             throws org.apache.ambari.server.AmbariException

Throws:

org.apache.ambari.server.AmbariException

getBlueprintProvisioningStates

Map<String,BlueprintProvisioningState> getBlueprintProvisioningStates(Long clusterId,
                                                                      Long hostId)
                                                               throws org.apache.ambari.server.AmbariException

Throws:

org.apache.ambari.server.AmbariException

getModules

List<Module> getModules(Long mpackId)

Fetch the module info for a given mpack.

Parameters:

mpackId -

Returns:

List of modules

removeMpack

void removeMpack(MpackEntity mpackEntity,
                 StackEntity stackEntity)
          throws IOException

Remove Mpack from the mpackMap and stackMap which is used to power the Mpack and Stack APIs.

Parameters:

mpackEntity -

stackEntity -

Throws:

IOException

createServiceConfigVersion

Set<ServiceConfigVersionResponse> createServiceConfigVersion(Set<ServiceConfigVersionRequest> requests)
                                                      throws org.apache.ambari.server.AmbariException,
                                                             AuthorizationException

Creates serviceconfigversions and corresponding new configurations if it is an initial request OR Rollbacks to an existing serviceconfigversion if request specifies.

Parameters:

requests -

Returns:

Throws:

org.apache.ambari.server.AmbariException

AuthorizationException

getMpacks

Set<MpackResponse> getMpacks()

Fetch all mpacks

Returns:

getMpack

MpackResponse getMpack(Long mpackId)

Fetch an mpack based on id

Parameters:

mpackId -

Returns: