org.apache.ambari.server.controller.internal

Class AbstractProviderModule

java.lang.Object

org.apache.ambari.server.controller.internal.AbstractProviderModule

All Implemented Interfaces:

ResourceProviderObserver, JMXHostProvider, MetricHostProvider, MetricsServiceProvider, ProviderModule

Direct Known Subclasses:

DefaultProviderModule

public abstract class AbstractProviderModule
extends Object
implements ProviderModule, ResourceProviderObserver, JMXHostProvider, MetricHostProvider, MetricsServiceProvider

An abstract provider module implementation.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.ambari.server.controller.metrics.MetricsServiceProvider

MetricsServiceProvider.MetricsService

Field Summary

Fields

Modifier and Type	Field and Description
protected AmbariEventPublisher	eventPublisher Used to respond to the following events: ClusterConfigChangedEvent
protected AmbariManagementController	managementController

Constructor Summary

Constructors

Constructor and Description
AbstractProviderModule() Create a default provider module.

Method Summary

Modifier and Type	Method and Description
protected void	createPropertyProviders(Resource.Type type)
protected abstract ResourceProvider	createResourceProvider(Resource.Type type)
String	getCollectorHostName(String clusterName, MetricsServiceProvider.MetricsService service) Get the metrics server host name for the given cluster name.
String	getCollectorPort(String clusterName, MetricsServiceProvider.MetricsService service) Get the metrics server port for the given cluster name.
String	getHostName(String clusterName, String componentName) Get the host name for the given cluster name and component name.
Set<String>	getHostNames(String clusterName, String componentName) Get the JMX host names for the given cluster name and component name.
String	getJMXProtocol(String clusterName, String componentName) Get the protocol for the specified cluster name and component.
String	getJMXRpcMetricTag(String clusterName, String componentName, String port) Get the rpc tag for the specified cluster name, component and port number
MetricsServiceProvider.MetricsService	getMetricsServiceType() Get type of Metrics system installed.
String	getPort(String clusterName, String componentName, String hostName, boolean httpsEnabled) Get the port for the specified cluster name and component.
List<PropertyProvider>	getPropertyProviders(Resource.Type type) Get the list of property providers for the given resource type.
String	getPublicHostName(String clusterName, String hostName)
ResourceProvider	getResourceProvider(Resource.Type type) Get a resource adapter for the given resource type.
boolean	isCollectorComponentLive(String clusterName, MetricsServiceProvider.MetricsService service) Get the status of metrics server component for the given cluster name.
boolean	isCollectorHostExternal(String clusterName) Is the collector host external to the cluster?
boolean	isCollectorHostLive(String clusterName, MetricsServiceProvider.MetricsService service) Get the status of metrics server host for the given cluster name.
void	onConfigurationChangedEvent(ClusterConfigChangedEvent event) Handles ClusterConfigChangedEvent which means that some caches should invalidate.
protected void	putPropertyProviders(Resource.Type type, List<PropertyProvider> providers)
protected void	putResourceProvider(Resource.Type type, ResourceProvider resourceProvider)
protected void	registerResourceProvider(Resource.Type type)
void	update(ResourceProviderEvent event) Update this observer with an event from a resource provider.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.ambari.server.controller.metrics.MetricHostProvider

getExternalHostName

Field Detail

managementController

@Inject
protected AmbariManagementController managementController

eventPublisher

@Inject
protected AmbariEventPublisher eventPublisher

Used to respond to the following events:

• ClusterConfigChangedEvent

Constructor Detail

AbstractProviderModule

public AbstractProviderModule()

Create a default provider module.

Method Detail

getResourceProvider

public ResourceProvider getResourceProvider(Resource.Type type)

Description copied from interface: ProviderModule

Get a resource adapter for the given resource type.

Specified by:

getResourceProvider in interface ProviderModule

Parameters:

type - the resource type

Returns:

the resource adapter

getPropertyProviders

public List<PropertyProvider> getPropertyProviders(Resource.Type type)

Description copied from interface: ProviderModule

Get the list of property providers for the given resource type.

Specified by:

getPropertyProviders in interface ProviderModule

Parameters:

type - the resource type

Returns:

the list of property providers

update

public void update(ResourceProviderEvent event)

Description copied from interface: ResourceProviderObserver

Update this observer with an event from a resource provider.

Specified by:

update in interface ResourceProviderObserver

Parameters:

event - the event

getMetricsServiceType

public MetricsServiceProvider.MetricsService getMetricsServiceType()

Get type of Metrics system installed.

Specified by:

getMetricsServiceType in interface MetricsServiceProvider

Returns:

@MetricsService, null if none found.

getCollectorHostName

public String getCollectorHostName(String clusterName,
                                   MetricsServiceProvider.MetricsService service)
                            throws SystemException

Description copied from interface: MetricHostProvider

Get the metrics server host name for the given cluster name.

Specified by:

getCollectorHostName in interface MetricHostProvider

Parameters:

clusterName - the cluster name

Returns:

the metrics server

Throws:

SystemException - if unable to get the metrics server host name

isCollectorHostExternal

public boolean isCollectorHostExternal(String clusterName)

Description copied from interface: MetricHostProvider

Is the collector host external to the cluster?

Specified by:

isCollectorHostExternal in interface MetricHostProvider

Parameters:

clusterName - the cluster name

Returns:

true if metrics server component is NOT in this cluster

getCollectorPort

public String getCollectorPort(String clusterName,
                               MetricsServiceProvider.MetricsService service)
                        throws SystemException

Description copied from interface: MetricHostProvider

Get the metrics server port for the given cluster name.

Specified by:

getCollectorPort in interface MetricHostProvider

Parameters:

clusterName - the cluster name

Returns:

the metrics server

Throws:

SystemException - if unable to get the metrics server port

isCollectorHostLive

public boolean isCollectorHostLive(String clusterName,
                                   MetricsServiceProvider.MetricsService service)
                            throws SystemException

Description copied from interface: MetricHostProvider

Get the status of metrics server host for the given cluster name.

Specified by:

isCollectorHostLive in interface MetricHostProvider

Parameters:

clusterName - the cluster name

Returns:

true if heartbeat with metrics server host wasn't lost

Throws:

SystemException - if unable to get the status of metrics server host

getHostName

public String getHostName(String clusterName,
                          String componentName)
                   throws SystemException

Description copied from interface: MetricHostProvider

Get the host name for the given cluster name and component name.

Specified by:

getHostName in interface MetricHostProvider

Parameters:

clusterName - the cluster name

componentName - the component name

Returns:

the host name

Throws:

SystemException - if unable to get the JMX host name

getPublicHostName

public String getPublicHostName(String clusterName,
                                String hostName)

Specified by:

getPublicHostName in interface JMXHostProvider

getHostNames

public Set<String> getHostNames(String clusterName,
                                String componentName)

Description copied from interface: JMXHostProvider

Get the JMX host names for the given cluster name and component name.

Specified by:

getHostNames in interface JMXHostProvider

Parameters:

clusterName - the cluster name

componentName - the component name

Returns:

set of JMX host names

isCollectorComponentLive

public boolean isCollectorComponentLive(String clusterName,
                                        MetricsServiceProvider.MetricsService service)
                                 throws SystemException

Description copied from interface: MetricHostProvider

Get the status of metrics server component for the given cluster name.

Specified by:

isCollectorComponentLive in interface MetricHostProvider

Parameters:

clusterName - the cluster name

Returns:

true if metrics server component is started

Throws:

SystemException - if unable to get the status of metrics server component

getPort

public String getPort(String clusterName,
                      String componentName,
                      String hostName,
                      boolean httpsEnabled)

Description copied from interface: JMXHostProvider

Get the port for the specified cluster name and component.

Specified by:

getPort in interface JMXHostProvider

Parameters:

clusterName - the cluster name

componentName - the component name

hostName - the component hostName

httpsEnabled - https enabled

Returns:

the port for the specified cluster name and component

createResourceProvider

protected abstract ResourceProvider createResourceProvider(Resource.Type type)

registerResourceProvider

protected void registerResourceProvider(Resource.Type type)

putResourceProvider

protected void putResourceProvider(Resource.Type type,
                                   ResourceProvider resourceProvider)

putPropertyProviders

protected void putPropertyProviders(Resource.Type type,
                                    List<PropertyProvider> providers)

createPropertyProviders

protected void createPropertyProviders(Resource.Type type)

getJMXProtocol

public String getJMXProtocol(String clusterName,
                             String componentName)

Description copied from interface: JMXHostProvider

Get the protocol for the specified cluster name and component.

Specified by:

getJMXProtocol in interface JMXHostProvider

Parameters:

clusterName - the cluster name

componentName - the component name

Returns:

the JMX protocol for the specified cluster name and component, one of http or https

getJMXRpcMetricTag

public String getJMXRpcMetricTag(String clusterName,
                                 String componentName,
                                 String port)

Description copied from interface: JMXHostProvider

Get the rpc tag for the specified cluster name, component and port number

Specified by:

getJMXRpcMetricTag in interface JMXHostProvider

Parameters:

clusterName - the cluster name

componentName - the componentName name

port - the port number

Returns:

the RPC tag for the specified cluster name, component and port number(client/healthcheck/etc.).

onConfigurationChangedEvent

public void onConfigurationChangedEvent(ClusterConfigChangedEvent event)

Handles ClusterConfigChangedEvent which means that some caches should invalidate.

Parameters:

event - the change event.