org.apache.ambari.server.view.configuration

Class ViewConfig

java.lang.Object

org.apache.ambari.server.view.configuration.ViewConfig

public class ViewConfig
extends Object

View configuration.

Constructor Summary

Constructors

Constructor and Description
ViewConfig()

Method Summary

Modifier and Type	Method and Description
AutoInstanceConfig	getAutoInstance() Get the configuration for the view instance auto create.
String	getBuild() Get the view build number.
String	getClusterConfigOptions() Enables views to display cluster options in case of no cluster config properties
String	getDataMigrator() Get the view class name.
Class<? extends org.apache.ambari.view.migration.ViewDataMigrator>	getDataMigratorClass(ClassLoader cl) Get the view class.
int	getDataVersion() Get the view data version.
String	getDescription() Get the view description.
String	getExtraClasspath() Get the extra classpath as a comma separated path of filenames or URLs pointing to directories or jar files.
String	getIcon() Get the icon path in the view archive.
String	getIcon64() Get the big icon path in the view archive.
List<InstanceConfig>	getInstances() Get the list of view instances.
String	getLabel() Get the public view name.
String	getMasker() Get the masker class name.
Class<? extends org.apache.ambari.view.Masker>	getMaskerClass(ClassLoader cl) Get the masker class.
String	getMaxAmbariVersion() Get the maximum version of Ambari that can run this view.
String	getMinAmbariVersion() Get the minimum version of Ambari required to run this view.
String	getName() Get the unique name.
List<ParameterConfig>	getParameters() Get the list of view parameters.
List<PermissionConfig>	getPermissions() Get the list of custom permissions defined for the view.
PersistenceConfig	getPersistence() Get the view persistence configuration.
List<ResourceConfig>	getResources() Get the list of view resources.
String	getValidator() Get the view validator class name.
Class<? extends org.apache.ambari.view.validation.Validator>	getValidatorClass(ClassLoader cl) Get the view validator class.
String	getVersion() Get the view version.
String	getView() Get the view class name.
Class<? extends org.apache.ambari.view.View>	getViewClass(ClassLoader cl) Get the view class.
boolean	isSystem() Determine whether or not this is a system view.

Methods inherited from class java.lang.Object

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

Constructor Detail

ViewConfig

public ViewConfig()

Method Detail

getName

public String getName()

Get the unique name.

Returns:

the view name

getLabel

public String getLabel()

Get the public view name.

Returns:

the view label

getDescription

public String getDescription()

Get the view description.

Returns:

the view description

getVersion

public String getVersion()

Get the view version.

Returns:

the version

getBuild

public String getBuild()

Get the view build number.

Returns:

the build number

getMinAmbariVersion

public String getMinAmbariVersion()

Get the minimum version of Ambari required to run this view.

Returns:

the minimum Ambari version

getMaxAmbariVersion

public String getMaxAmbariVersion()

Get the maximum version of Ambari that can run this view.

Returns:

the maximum Ambari version

getIcon

public String getIcon()

Get the icon path in the view archive.

Returns:

the icon path

getIcon64

public String getIcon64()

Get the big icon path in the view archive.

Returns:

the big icon path

isSystem

public boolean isSystem()

Determine whether or not this is a system view.

Returns:

true if this is a system view

getExtraClasspath

public String getExtraClasspath()

Get the extra classpath as a comma separated path of filenames or URLs pointing to directories or jar files.

Returns:

the extra classpath

getView

public String getView()

Get the view class name.

Returns:

the view class name

getViewClass

public Class<? extends org.apache.ambari.view.View> getViewClass(ClassLoader cl)
                                                          throws ClassNotFoundException

Get the view class.

Parameters:

cl - the class loader

Returns:

the view class

Throws:

ClassNotFoundException - if the class can not be loaded

getDataMigrator

public String getDataMigrator()

Get the view class name.

Returns:

the view class name

getDataMigratorClass

public Class<? extends org.apache.ambari.view.migration.ViewDataMigrator> getDataMigratorClass(ClassLoader cl)
                                                                                        throws ClassNotFoundException

Get the view class.

Parameters:

cl - the class loader

Returns:

the view class

Throws:

ClassNotFoundException - if the class can not be loaded

getDataVersion

public int getDataVersion()

Get the view data version. If not specified, data version is 0.

Returns:

the data version

getValidator

public String getValidator()

Get the view validator class name.

Returns:

the view validator class name

getValidatorClass

public Class<? extends org.apache.ambari.view.validation.Validator> getValidatorClass(ClassLoader cl)
                                                                               throws ClassNotFoundException

Get the view validator class.

Parameters:

cl - the class loader

Returns:

the view validator class

Throws:

ClassNotFoundException - if the class can not be loaded

getMasker

public String getMasker()

Get the masker class name.

Returns:

the masker class name

getMaskerClass

public Class<? extends org.apache.ambari.view.Masker> getMaskerClass(ClassLoader cl)
                                                              throws ClassNotFoundException

Get the masker class.

Parameters:

cl - the class loader

Returns:

the masker class

Throws:

ClassNotFoundException - if the class can not be loaded

getParameters

public List<ParameterConfig> getParameters()

Get the list of view parameters.

Returns:

the list of parameters

getResources

public List<ResourceConfig> getResources()

Get the list of view resources.

Returns:

return the list of resources

getAutoInstance

public AutoInstanceConfig getAutoInstance()

Get the configuration for the view instance auto create.

Returns:

the view instance auto create; null if no auto instance is specified

getInstances

public List<InstanceConfig> getInstances()

Get the list of view instances.

Returns:

the list of view instances

getPersistence

public PersistenceConfig getPersistence()

Get the view persistence configuration.

Returns:

the view persistence configuration

getPermissions

public List<PermissionConfig> getPermissions()

Get the list of custom permissions defined for the view.

Returns:

the list of custom permissions

getClusterConfigOptions

public String getClusterConfigOptions()

Enables views to display cluster options in case of no cluster config properties

Returns:

clusterConfigOptions