org.apache.slider.providers

Class AbstractClientProvider

java.lang.Object

org.apache.hadoop.conf.Configured

org.apache.slider.providers.AbstractClientProvider

All Implemented Interfaces:

org.apache.hadoop.conf.Configurable

Direct Known Subclasses:

AgentClientProvider, SliderAMClientProvider

public abstract class AbstractClientProvider
extends org.apache.hadoop.conf.Configured

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROVIDER_RESOURCE_BASE
static String	PROVIDER_RESOURCE_BASE_ROOT
protected static ProviderUtils	providerUtils

Constructor Summary

Constructors

Constructor and Description
AbstractClientProvider(org.apache.hadoop.conf.Configuration conf)

Method Summary

Methods

Modifier and Type	Method and Description
Set<String>	getApplicationTags(SliderFileSystem fileSystem, String appDef) Return a set of application specific string tags.
abstract String	getName()
abstract List<ProviderRole>	getRoles()
protected void	mergeTemplates(AggregateConf instanceConf, String internalTemplate, String resourceTemplate, String appConfTemplate) Load in and merge in templates.
void	preflightValidateClusterConfiguration(SliderFileSystem sliderFileSystem, String clustername, org.apache.hadoop.conf.Configuration configuration, AggregateConf instanceDefinition, org.apache.hadoop.fs.Path clusterDirPath, org.apache.hadoop.fs.Path generatedConfDirPath, boolean secure) This is called pre-launch to validate that the cluster specification is valid.
void	prepareAMAndConfigForLaunch(SliderFileSystem fileSystem, org.apache.hadoop.conf.Configuration serviceConf, AbstractLauncher launcher, AggregateConf instanceDescription, org.apache.hadoop.fs.Path snapshotConfDirPath, org.apache.hadoop.fs.Path generatedConfDirPath, org.apache.hadoop.conf.Configuration clientConfExtras, String libdir, org.apache.hadoop.fs.Path tempPath, boolean miniClusterTestRun) Prepare the AM settings for launch
void	prepareInstanceConfiguration(AggregateConf aggregateConf) Any provider-side alteration of a configuration can take place here.
void	processClientOperation(SliderFileSystem fileSystem, String operation, File clientInstallPath, File clientPackage, org.codehaus.jettison.json.JSONObject config, String name) Process client operations for applications such as install, configure
void	validateInstanceDefinition(AggregateConf instanceDefinition, SliderFileSystem fs) Verify that an instance definition is considered valid by the provider

Methods inherited from class org.apache.hadoop.conf.Configured

getConf, setConf

Methods inherited from class java.lang.Object

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

Field Detail

providerUtils

protected static final ProviderUtils providerUtils

PROVIDER_RESOURCE_BASE

public static final String PROVIDER_RESOURCE_BASE

See Also:

Constant Field Values

PROVIDER_RESOURCE_BASE_ROOT

public static final String PROVIDER_RESOURCE_BASE_ROOT

See Also:

Constant Field Values

Constructor Detail

AbstractClientProvider

public AbstractClientProvider(org.apache.hadoop.conf.Configuration conf)

Method Detail

getName

public abstract String getName()

getRoles

public abstract List<ProviderRole> getRoles()

validateInstanceDefinition

public void validateInstanceDefinition(AggregateConf instanceDefinition,
                              SliderFileSystem fs)
                                throws SliderException

Verify that an instance definition is considered valid by the provider

Parameters:

instanceDefinition - instance definition

Throws:

SliderException - if the configuration is not valid

prepareInstanceConfiguration

public void prepareInstanceConfiguration(AggregateConf aggregateConf)
                                  throws SliderException,
                                         IOException

Any provider-side alteration of a configuration can take place here.

Parameters:

aggregateConf - config to patch

Throws:

IOException - IO problems

SliderException - Slider-specific issues

prepareAMAndConfigForLaunch

public void prepareAMAndConfigForLaunch(SliderFileSystem fileSystem,
                               org.apache.hadoop.conf.Configuration serviceConf,
                               AbstractLauncher launcher,
                               AggregateConf instanceDescription,
                               org.apache.hadoop.fs.Path snapshotConfDirPath,
                               org.apache.hadoop.fs.Path generatedConfDirPath,
                               org.apache.hadoop.conf.Configuration clientConfExtras,
                               String libdir,
                               org.apache.hadoop.fs.Path tempPath,
                               boolean miniClusterTestRun)
                                 throws IOException,
                                        SliderException

Prepare the AM settings for launch

Parameters:

fileSystem - filesystem

serviceConf - configuration of the client

launcher - launcher to set up

instanceDescription - instance description being launched

snapshotConfDirPath -

generatedConfDirPath -

clientConfExtras -

libdir -

tempPath -

miniClusterTestRun - flag set to true on a mini cluster run

Throws:

IOException

SliderException

mergeTemplates

protected void mergeTemplates(AggregateConf instanceConf,
                  String internalTemplate,
                  String resourceTemplate,
                  String appConfTemplate)
                       throws IOException

Load in and merge in templates. Null arguments means "no such template"

Parameters:

instanceConf - instance to patch

internalTemplate - patch to internal.json

resourceTemplate - path to resources.json

appConfTemplate - path to app_conf.json

Throws:

IOException - any IO problems

preflightValidateClusterConfiguration

public void preflightValidateClusterConfiguration(SliderFileSystem sliderFileSystem,
                                         String clustername,
                                         org.apache.hadoop.conf.Configuration configuration,
                                         AggregateConf instanceDefinition,
                                         org.apache.hadoop.fs.Path clusterDirPath,
                                         org.apache.hadoop.fs.Path generatedConfDirPath,
                                         boolean secure)
                                           throws SliderException,
                                                  IOException

This is called pre-launch to validate that the cluster specification is valid. This can include checking that the security options are in the site files prior to launch, that there are no conflicting operations etc. This check is made prior to every launch of the cluster -so can pick up problems which manually edited cluster files have added, or from specification files from previous versions. The provider MUST NOT change the remote specification. This is purely a pre-launch validation of options.

Parameters:

sliderFileSystem - filesystem

clustername - name of the cluster

configuration - cluster configuration

instanceDefinition - cluster specification

clusterDirPath - directory of the cluster

generatedConfDirPath - path to place generated artifacts

secure - flag to indicate that the cluster is secure

Throws:

SliderException - on any validation issue

IOException - on any IO problem

getApplicationTags

public Set<String> getApplicationTags(SliderFileSystem fileSystem,
                             String appDef)
                               throws SliderException

Return a set of application specific string tags.

Returns:

the set of tags.

Throws:

SliderException

processClientOperation

public void processClientOperation(SliderFileSystem fileSystem,
                          String operation,
                          File clientInstallPath,
                          File clientPackage,
                          org.codehaus.jettison.json.JSONObject config,
                          String name)
                            throws SliderException

Process client operations for applications such as install, configure

Parameters:

fileSystem -

operation -

clientInstallPath -

clientPackage -

config -

name -

Throws:

SliderException