ViewEntity (Ambari Server 3.0.0.0-SNAPSHOT API)

java.lang.Object
- org.apache.ambari.server.orm.entities.ViewEntity

All Implemented Interfaces:: org.apache.ambari.view.ViewDefinition

@Entity
public class ViewEntity
extends Object
implements org.apache.ambari.view.ViewDefinition

Entity representing a View.

Nested Class Summary
- Nested classes/interfaces inherited from interface org.apache.ambari.view.ViewDefinition
  org.apache.ambari.view.ViewDefinition.ViewStatus

Field Summary

Fields
Modifier and Type Field and Description

static String AMBARI_ONLY

Fields
Modifier and Type	Field and Description
`static String`	`AMBARI_ONLY`

Constructor Summary

Constructors
Constructor and Description
`ViewEntity()` Construct a view entity.
`ViewEntity(ViewConfig configuration, Configuration ambariConfiguration, String archivePath)` Construct a view entity from the given configuration.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addInstanceDefinition(ViewInstanceEntity viewInstanceDefinition)` Add an instance definition.
`void`	`addResourceConfiguration(Resource.Type type, ResourceConfig config)` Add a resource configuration for the given type.
`void`	`addResourceDefinition(ViewSubResourceDefinition definition)` Add a resource definition.
`void`	`addResourceProvider(Resource.Type type, ResourceProvider provider)` Add a resource provider for the given type.
`Configuration`	`getAmbariConfiguration()` Get the Ambari configuration.
`String`	`getAmbariProperty(String key)` Get a property for the given key from the ambari configuration.
`String`	`getArchive()` Get the path of the view archive.
`String`	`getBuild()`
`ClassLoader`	`getClassLoader()` Get the class loader used to load the view classes.
`String`	`getCommonName()` Get the common name of the view.
`ViewConfig`	`getConfiguration()` Get the associated view configuration.
`String`	`getDescription()`
`Resource.Type`	`getExternalResourceType()` Get the external resource type for the view.
`String`	`getIcon()` Get the icon path.
`String`	`getIcon64()` Get the big icon path.
`ViewInstanceEntity`	`getInstanceDefinition(String instanceName)` Get an instance definition for the given name.
`Collection<ViewInstanceEntity>`	`getInstances()` Get the view instances.
`String`	`getLabel()`
`String`	`getMask()`
`String`	`getName()` Get the view name.
`Collection<ViewParameterEntity>`	`getParameters()` Get the view parameters.
`PermissionEntity`	`getPermission(String permissionName)` Get the permission entity for the given permission name.
`Collection<PermissionEntity>`	`getPermissions()` Get the view custom permissions.
`String`	`getQualifiedResourceTypeName(String resourceTypeName)` Get a resource name qualified by the associated view name.
`Map<Resource.Type,ResourceConfig>`	`getResourceConfigurations()` Get the mapping of resource type to resource configurations.
`ViewSubResourceDefinition`	`getResourceDefinition(Resource.Type type)` Get the resource definition for the given type.
`Map<Resource.Type,ViewSubResourceDefinition>`	`getResourceDefinitions()` Get the mapping of resource type to resource definitions.
`ResourceProvider`	`getResourceProvider(Resource.Type type)` Get the resource provider for the given type.
`Collection<ViewResourceEntity>`	`getResources()` Get the view resources.
`ResourceTypeEntity`	`getResourceType()` Get the admin resource type entity.
`org.apache.ambari.view.ViewDefinition.ViewStatus`	`getStatus()`
`String`	`getStatusDetail()`
`org.apache.ambari.view.validation.Validator`	`getValidator()` Get the associated view validator.
`String`	`getVersion()`
`org.apache.ambari.view.View`	`getView()` Get the associated view.
`String`	`getViewName()`
`static String`	`getViewName(String name, String version)` Get the internal view name from the given common name and version.
`Set<Resource.Type>`	`getViewResourceTypes()` Get the set of resource types for this view.
`boolean`	`hasValidator()` Determine whether or not a validator has been specified for this view.
`boolean`	`isClusterConfigurable()` Determine whether or not this view is configurable through a cluster association.
`boolean`	`isDeployed()` Determine whether or not the entity is deployed.
`boolean`	`isSystem()` Determine whether or not the view is a system view.
`void`	`removeInstanceDefinition(String instanceName)` Remove an instance definition.
`void`	`setArchive(String archive)` Set the view archive path.
`void`	`setBuild(String build)` Set the view build number.
`void`	`setClassLoader(ClassLoader classLoader)` Set the class loader.
`void`	`setConfiguration(ViewConfig configuration)` Set the view configuration.
`void`	`setDescription(String description)` Set the view description.
`void`	`setIcon(String icon)` Set the icon path.
`void`	`setIcon64(String icon64)` Set the big icon path.
`void`	`setInstances(Collection<ViewInstanceEntity> instances)` Set the view instances.
`void`	`setLabel(String label)` Set the view label (display name).
`void`	`setMask(String mask)` Set the mask class name.
`void`	`setName(String name)` Set the view name.
`void`	`setParameters(Collection<ViewParameterEntity> parameters)` Set the view parameters.
`void`	`setPermissions(Collection<PermissionEntity> permissions)` Set the custom view permissions.
`void`	`setResources(Collection<ViewResourceEntity> resources)` Set the view resources.
`void`	`setResourceType(ResourceTypeEntity resourceType)` Set the admin resource type entity.
`void`	`setStatus(org.apache.ambari.view.ViewDefinition.ViewStatus status)` Set the status of the view.
`void`	`setStatusDetail(String statusDetail)` Set the status detail for the view.
`void`	`setSystem(boolean required)` Set the flag which indicates whether or not the view is a system view.
`void`	`setValidator(org.apache.ambari.view.validation.Validator validator)` Set the view validator.
`void`	`setVersion(String version)` Set the view version.
`void`	`setView(org.apache.ambari.view.View view)` Set the view.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - AMBARI_ONLY
```
public static final String AMBARI_ONLY
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ViewEntity
```
public ViewEntity()
```
    Construct a view entity.
  - ViewEntity
```
public ViewEntity(ViewConfig configuration,
                  Configuration ambariConfiguration,
                  String archivePath)
```
    Construct a view entity from the given configuration.
    
    Parameters:
    
    configuration - the view configuration
    
    ambariConfiguration - the Ambari configuration
    
    archivePath - the path of the view archive
- Method Detail
  - getViewName
```
public String getViewName()
```
    Specified by:
    
    getViewName in interface org.apache.ambari.view.ViewDefinition
  - getLabel
```
public String getLabel()
```
    Specified by:
    
    getLabel in interface org.apache.ambari.view.ViewDefinition
  - getDescription
```
public String getDescription()
```
    Specified by:
    
    getDescription in interface org.apache.ambari.view.ViewDefinition
  - getVersion
```
public String getVersion()
```
    Specified by:
    
    getVersion in interface org.apache.ambari.view.ViewDefinition
  - getBuild
```
public String getBuild()
```
    Specified by:
    
    getBuild in interface org.apache.ambari.view.ViewDefinition
  - getStatus
```
public org.apache.ambari.view.ViewDefinition.ViewStatus getStatus()
```
    Specified by:
    
    getStatus in interface org.apache.ambari.view.ViewDefinition
  - getStatusDetail
```
public String getStatusDetail()
```
    Specified by:
    
    getStatusDetail in interface org.apache.ambari.view.ViewDefinition
  - getMask
```
public String getMask()
```
    Specified by:
    
    getMask in interface org.apache.ambari.view.ViewDefinition
  - getName
```
public String getName()
```
    Get the view name.
    
    Returns:
    
    the view name
  - setName
```
public void setName(String name)
```
    Set the view name.
    
    Parameters:
    
    name - the view name
  - getCommonName
```
public String getCommonName()
```
    Get the common name of the view. This name is shared across versions of the view.
    
    Returns:
    
    the common name
  - setLabel
```
public void setLabel(String label)
```
    Set the view label (display name).
    
    Parameters:
    
    label - the view label
  - setDescription
```
public void setDescription(String description)
```
    Set the view description.
    
    Parameters:
    
    description - the view description
  - setVersion
```
public void setVersion(String version)
```
    Set the view version.
    
    Parameters:
    
    version - the version
  - setBuild
```
public void setBuild(String build)
```
    Set the view build number.
    
    Parameters:
    
    build - the build
  - getIcon
```
public String getIcon()
```
    Get the icon path.
    
    Returns:
    
    the icon path
  - setIcon
```
public void setIcon(String icon)
```
    Set the icon path.
    
    Parameters:
    
    icon - the icon path
  - getIcon64
```
public String getIcon64()
```
    Get the big icon path.
    
    Returns:
    
    the big icon path
  - setIcon64
```
public void setIcon64(String icon64)
```
    Set the big icon path.
    
    Parameters:
    
    icon64 - the big icon path
  - getParameters
```
public Collection<ViewParameterEntity> getParameters()
```
    Get the view parameters.
    
    Returns:
    
    the view parameters
  - setParameters
```
public void setParameters(Collection<ViewParameterEntity> parameters)
```
    Set the view parameters.
    
    Parameters:
    
    parameters - the view parameters
  - getPermissions
```
public Collection<PermissionEntity> getPermissions()
```
    Get the view custom permissions.
    
    Returns:
    
    the view permissions
  - setPermissions
```
public void setPermissions(Collection<PermissionEntity> permissions)
```
    Set the custom view permissions.
    
    Parameters:
    
    permissions - the permissions
  - getPermission
```
public PermissionEntity getPermission(String permissionName)
```
    Get the permission entity for the given permission name.
    
    Parameters:
    
    permissionName - the permission name
    
    Returns:
    
    the matching permission entity or null
  - getResources
```
public Collection<ViewResourceEntity> getResources()
```
    Get the view resources.
    
    Returns:
    
    the view resources
  - setResources
```
public void setResources(Collection<ViewResourceEntity> resources)
```
    Set the view resources.
    
    Parameters:
    
    resources - the view resources
  - getInstances
```
public Collection<ViewInstanceEntity> getInstances()
```
    Get the view instances.
    
    Returns:
    
    the view instances
  - setInstances
```
public void setInstances(Collection<ViewInstanceEntity> instances)
```
    Set the view instances.
    
    Parameters:
    
    instances - the instances
  - addInstanceDefinition
```
public void addInstanceDefinition(ViewInstanceEntity viewInstanceDefinition)
```
    Add an instance definition.
    
    Parameters:
    
    viewInstanceDefinition - the instance definition
  - removeInstanceDefinition
```
public void removeInstanceDefinition(String instanceName)
```
    Remove an instance definition.
    
    Parameters:
    
    instanceName - the instance name
  - getInstanceDefinition
```
public ViewInstanceEntity getInstanceDefinition(String instanceName)
```
    Get an instance definition for the given name.
    
    Parameters:
    
    instanceName - the instance name
    
    Returns:
    
    the instance definition
  - getArchive
```
public String getArchive()
```
    Get the path of the view archive.
    
    Returns:
    
    the path of the view archive
  - setArchive
```
public void setArchive(String archive)
```
    Set the view archive path.
    
    Parameters:
    
    archive - the view archive path
  - getAmbariProperty
```
public String getAmbariProperty(String key)
```
    Get a property for the given key from the ambari configuration.
    
    Parameters:
    
    key - the property key
    
    Returns:
    
    the property value; null indicates that the configuration contains no mapping for the key
  - getAmbariConfiguration
```
public Configuration getAmbariConfiguration()
```
    Get the Ambari configuration.
    
    Returns:
    
    the Ambari configuration
  - getQualifiedResourceTypeName
```
public String getQualifiedResourceTypeName(String resourceTypeName)
```
    Get a resource name qualified by the associated view name.
    
    Parameters:
    
    resourceTypeName - the resource type name
    
    Returns:
    
    the qualified resource name
  - getExternalResourceType
```
public Resource.Type getExternalResourceType()
```
    Get the external resource type for the view.
    
    Returns:
    
    the external resource type
  - getClassLoader
```
public ClassLoader getClassLoader()
```
    Get the class loader used to load the view classes.
    
    Returns:
    
    the class loader
  - setClassLoader
```
public void setClassLoader(ClassLoader classLoader)
```
    Set the class loader.
    
    Parameters:
    
    classLoader - the class loader
  - addResourceProvider
```
public void addResourceProvider(Resource.Type type,
                                ResourceProvider provider)
```
    Add a resource provider for the given type.
    
    Parameters:
    
    type - the resource type
    
    provider - the resource provider
  - getResourceProvider
```
public ResourceProvider getResourceProvider(Resource.Type type)
```
    Get the resource provider for the given type.
    
    Parameters:
    
    type - the resource type
    
    Returns:
    
    the resource provider associated with the given type
  - addResourceDefinition
```
public void addResourceDefinition(ViewSubResourceDefinition definition)
```
    Add a resource definition.
    
    Parameters:
    
    definition - the resource definition
  - getResourceDefinition
```
public ViewSubResourceDefinition getResourceDefinition(Resource.Type type)
```
    Get the resource definition for the given type.
    
    Parameters:
    
    type - the resource type
    
    Returns:
    
    the resource definition associated with the given type
  - getResourceDefinitions
```
public Map<Resource.Type,ViewSubResourceDefinition> getResourceDefinitions()
```
    Get the mapping of resource type to resource definitions.
    
    Returns:
    
    the mapping of resource type to resource definitions
  - addResourceConfiguration
```
public void addResourceConfiguration(Resource.Type type,
                                     ResourceConfig config)
```
    Add a resource configuration for the given type.
    
    Parameters:
    
    type - the resource type
    
    config - the configuration
  - getResourceConfigurations
```
public Map<Resource.Type,ResourceConfig> getResourceConfigurations()
```
    Get the mapping of resource type to resource configurations.
    
    Returns:
    
    the mapping of resource types to resource configurations
  - getViewResourceTypes
```
public Set<Resource.Type> getViewResourceTypes()
```
    Get the set of resource types for this view.
    
    Returns:
    
    the set of resource type
  - setConfiguration
```
public void setConfiguration(ViewConfig configuration)
```
    Set the view configuration.
    
    Parameters:
    
    configuration - the view configuration
  - getConfiguration
```
public ViewConfig getConfiguration()
```
    Get the associated view configuration.
    
    Returns:
    
    the configuration
  - setView
```
public void setView(org.apache.ambari.view.View view)
```
    Set the view.
    
    Parameters:
    
    view - the view
  - getView
```
public org.apache.ambari.view.View getView()
```
    Get the associated view.
    
    Returns:
    
    the view
  - setValidator
```
public void setValidator(org.apache.ambari.view.validation.Validator validator)
```
    Set the view validator.
    
    Parameters:
    
    validator - the view validator
  - getValidator
```
public org.apache.ambari.view.validation.Validator getValidator()
```
    Get the associated view validator.
    
    Returns:
    
    the view validator
  - hasValidator
```
public boolean hasValidator()
```
    Determine whether or not a validator has been specified for this view.
    
    Returns:
    
    true if this view has a validator
  - setMask
```
public void setMask(String mask)
```
    Set the mask class name.
    
    Parameters:
    
    mask - the mask class name
  - isSystem
```
public boolean isSystem()
```
    Determine whether or not the view is a system view.
    
    Returns:
    
    true if the view is a system view
  - setSystem
```
public void setSystem(boolean required)
```
    Set the flag which indicates whether or not the view is a system view.
    
    Parameters:
    
    required - the system flag; true if the view is a system view
  - getResourceType
```
public ResourceTypeEntity getResourceType()
```
    Get the admin resource type entity.
    
    Returns:
    
    the resource type entity
  - setResourceType
```
public void setResourceType(ResourceTypeEntity resourceType)
```
    Set the admin resource type entity.
    
    Parameters:
    
    resourceType - the resource type entity
  - setStatus
```
public void setStatus(org.apache.ambari.view.ViewDefinition.ViewStatus status)
```
    Set the status of the view.
    
    Parameters:
    
    status - the view status
  - setStatusDetail
```
public void setStatusDetail(String statusDetail)
```
    Set the status detail for the view.
    
    Parameters:
    
    statusDetail - the status detail
  - isClusterConfigurable
```
public boolean isClusterConfigurable()
```
    Determine whether or not this view is configurable through a cluster association.
    
    Returns:
    
    true if this view is cluster configurable
  - isDeployed
```
public boolean isDeployed()
```
    Determine whether or not the entity is deployed.
    
    Returns:
    
    true if the entity is deployed
  - getViewName
```
public static String getViewName(String name,
                                 String version)
```
    Get the internal view name from the given common name and version.
    
    Parameters:
    
    name - the view common name
    
    version - the version
    
    Returns:
    
    the view name
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class ViewEntity

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.ambari.view.ViewDefinition

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

AMBARI_ONLY

Constructor Detail

ViewEntity

ViewEntity

Method Detail

getViewName

getLabel

getDescription

getVersion

getBuild

getStatus

getStatusDetail

getMask

getName

setName

getCommonName

setLabel

setDescription

setVersion

setBuild

getIcon

setIcon

getIcon64

setIcon64

getParameters

setParameters

getPermissions

setPermissions

getPermission

getResources

setResources

getInstances

setInstances

addInstanceDefinition

removeInstanceDefinition

getInstanceDefinition

getArchive

setArchive

getAmbariProperty

getAmbariConfiguration

getQualifiedResourceTypeName

getExternalResourceType

getClassLoader

setClassLoader

addResourceProvider

getResourceProvider

addResourceDefinition

getResourceDefinition

getResourceDefinitions

addResourceConfiguration

getResourceConfigurations

getViewResourceTypes

setConfiguration

getConfiguration

setView

getView

setValidator

getValidator

hasValidator

setMask

isSystem

setSystem

getResourceType

setResourceType

setStatus

setStatusDetail

isClusterConfigurable

isDeployed

getViewName

toString