org.apache.ambari.server.orm.entities

Class ViewInstanceEntity

java.lang.Object

org.apache.ambari.server.orm.entities.ViewInstanceEntity

All Implemented Interfaces:

org.apache.ambari.view.ViewInstanceDefinition

@Entity
public class ViewInstanceEntity
extends Object
implements org.apache.ambari.view.ViewInstanceDefinition

Represents an instance of a View.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ViewInstanceEntity.ViewInstanceVersionDTO Keeps information about view name, version and instance name.

Constructor Summary

Constructors

Constructor and Description
ViewInstanceEntity()
ViewInstanceEntity(ViewEntity view, InstanceConfig instanceConfig) Construct a view instance definition.
ViewInstanceEntity(ViewEntity view, String name) Construct a view instance definition.
ViewInstanceEntity(ViewEntity view, String name, String label) Construct a view instance definition.

Method Summary

Modifier and Type	Method and Description
void	addResourceProvider(Resource.Type type, org.apache.ambari.view.ResourceProvider provider) Add a resource provider for the given resource type.
void	addService(String pluralName, Object service) Add a service for the given plural resource name.
boolean	alterNames() Determine whether or not to alter the names of the data store entities to avoid db reserved word conflicts.
void	clearUrl() Remove the URL associated with this entity
boolean	equals(Object o)
Long	getClusterHandle()
org.apache.ambari.view.ClusterType	getClusterType() Get the type of cluster the view instance is attached to
InstanceConfig	getConfiguration() Get the associated configuration.
String	getContextPath() Get the context path for the UI for this view.
static String	getContextPath(String viewName, String version, String viewInstanceName) Get the context path for a view instance with the given names.
String	getCurrentUserName()
Collection<ViewInstanceDataEntity>	getData() Get the instance data.
org.apache.ambari.view.migration.ViewDataMigrator	getDataMigrator(org.apache.ambari.view.migration.ViewDataMigrationContext dataMigrationContext) Get the data migrator instance for view instance.
String	getDescription()
Collection<ViewEntityEntity>	getEntities() Get the view entities.
String	getIcon() Get the icon path.
String	getIcon64() Get the big icon path.
ViewInstanceDataEntity	getInstanceData(String key) Get the instance data entity for the given key.
Map<String,String>	getInstanceDataMap()
String	getInstanceName()
String	getLabel()
String	getName() Get the name of this instance.
Collection<ViewInstancePropertyEntity>	getProperties() Get the instance properties.
ViewInstancePropertyEntity	getProperty(String key) Get the instance property entity for the given key.
Map<String,String>	getPropertyMap()
ResourceEntity	getResource() Get the admin resource entity.
org.apache.ambari.view.ResourceProvider	getResourceProvider(Resource.Type type) Get the resource provider for the given resource type.
org.apache.ambari.view.ResourceProvider	getResourceProvider(String type) Get the resource provider for the given resource type name (scoped to this view).
Object	getService(String pluralName) Get the service associated with the given plural resource name.
String	getUsername() Get the current user name.
InstanceValidationResultImpl	getValidationResult(ViewEntity viewEntity, org.apache.ambari.view.validation.Validator.ValidationContext context) Get the validation the state of the instance.
org.apache.ambari.view.ViewDefinition	getViewDefinition()
ViewEntity	getViewEntity() Get the parent view entity.
Long	getViewInstanceId() Get the view instance id.
String	getViewName()
ViewURLEntity	getViewUrl() Get the view URL associated with the instance
int	hashCode()
boolean	isVisible()
boolean	isXmlDriven() Get the xml driven flag.
void	putInstanceData(String key, String value) Associate the given instance data value with the given key.
void	putProperty(String key, String value) Add a property value to this instance.
void	removeInstanceData(String key) Remove the instance data entity associated with the given key.
void	removeProperty(String key) Remove the property identified by the given key from this instance.
void	setAlterNames(boolean alterNames) Set the flag which indicates whether or not to alter the names of the data store entities to avoid db reserved word conflicts.
void	setClusterHandle(Long clusterHandle) Set a cluster association for this view instance with the Ambari cluster identified by the given cluster handle.
void	setClusterType(org.apache.ambari.view.ClusterType clusterType) Set the type of cluster for cluster handle
void	setData(Collection<ViewInstanceDataEntity> data) Set the collection of instance data entities.
void	setDescription(String description) Set the description.
void	setEntities(Collection<ViewEntityEntity> entities) Set the view entities.
void	setIcon(String icon) Set the icon path.
void	setIcon64(String icon64) Set the big icon path.
void	setLabel(String label) Set the label.
void	setName(String name) Set the name of this instance.
void	setProperties(Collection<ViewInstancePropertyEntity> properties) Set the collection of instance property entities.
void	setResource(ResourceEntity resource) Set the admin resource entity.
protected void	setSecurityHelper(SecurityHelper securityHelper) Set the security helper.
void	setViewEntity(ViewEntity view) Set the parent view entity.
void	setViewInstanceId(Long viewInstanceId) Set the given view instance id.
void	setViewName(String viewName) Set the view name.
void	setViewUrl(ViewURLEntity viewUrl) Set the view URL associated with the instance
void	setVisible(boolean visible) Set the visible flag.
void	setXmlDriven(boolean xmlDriven) Set the xml driven flag.
String	toString()
void	validate(ViewEntity viewEntity, org.apache.ambari.view.validation.Validator.ValidationContext context) Validate the state of the instance.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ViewInstanceEntity

public ViewInstanceEntity()

ViewInstanceEntity

public ViewInstanceEntity(ViewEntity view,
                          InstanceConfig instanceConfig)

Construct a view instance definition.

Parameters:

view - the parent view definition

instanceConfig - the associated configuration

ViewInstanceEntity

public ViewInstanceEntity(ViewEntity view,
                          String name)

Construct a view instance definition.

Parameters:

view - the parent view definition

name - the instance name

ViewInstanceEntity

public ViewInstanceEntity(ViewEntity view,
                          String name,
                          String label)

Construct a view instance definition.

Parameters:

view - the parent view definition

name - the instance name

label - the instance label

Method Detail

getInstanceName

public String getInstanceName()

Specified by:

getInstanceName in interface org.apache.ambari.view.ViewInstanceDefinition

getViewName

public String getViewName()

Specified by:

getViewName in interface org.apache.ambari.view.ViewInstanceDefinition

getPropertyMap

public Map<String,String> getPropertyMap()

Specified by:

getPropertyMap in interface org.apache.ambari.view.ViewInstanceDefinition

getInstanceDataMap

public Map<String,String> getInstanceDataMap()

Specified by:

getInstanceDataMap in interface org.apache.ambari.view.ViewInstanceDefinition

getViewDefinition

public org.apache.ambari.view.ViewDefinition getViewDefinition()

Specified by:

getViewDefinition in interface org.apache.ambari.view.ViewInstanceDefinition

getLabel

public String getLabel()

Specified by:

getLabel in interface org.apache.ambari.view.ViewInstanceDefinition

getDescription

public String getDescription()

Specified by:

getDescription in interface org.apache.ambari.view.ViewInstanceDefinition

getClusterHandle

public Long getClusterHandle()

Specified by:

getClusterHandle in interface org.apache.ambari.view.ViewInstanceDefinition

isVisible

public boolean isVisible()

Specified by:

isVisible in interface org.apache.ambari.view.ViewInstanceDefinition

getViewInstanceId

public Long getViewInstanceId()

Get the view instance id.

Returns:

the instance id

setViewInstanceId

public void setViewInstanceId(Long viewInstanceId)

Set the given view instance id.

Parameters:

viewInstanceId - the instance id

setViewName

public void setViewName(String viewName)

Set the view name.

Parameters:

viewName - the view name

getName

public String getName()

Get the name of this instance.

Returns:

the instance name

setName

public void setName(String name)

Set the name of this instance.

Parameters:

name - the instance name

setLabel

public void setLabel(String label)

Set the label.

Parameters:

label - the label

setDescription

public void setDescription(String description)

Set the description.

Parameters:

description - the description

setClusterHandle

public void setClusterHandle(Long clusterHandle)

Set a cluster association for this view instance with the Ambari cluster identified by the given cluster handle. For a local cluster reference, the cluster handle is simply the unique cluster id.

Parameters:

clusterHandle - the cluster identifier

getClusterType

public org.apache.ambari.view.ClusterType getClusterType()

Get the type of cluster the view instance is attached to

Specified by:

getClusterType in interface org.apache.ambari.view.ViewInstanceDefinition

Returns:

clusterType the type of cluster for cluster handle

setClusterType

public void setClusterType(org.apache.ambari.view.ClusterType clusterType)

Set the type of cluster for cluster handle

Parameters:

clusterType -

setVisible

public void setVisible(boolean visible)

Set the visible flag.

Parameters:

visible - visible flag

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

isXmlDriven

public boolean isXmlDriven()

Get the xml driven flag.

Returns:

the xml driven flag

setXmlDriven

public void setXmlDriven(boolean xmlDriven)

Set the xml driven flag.

Parameters:

xmlDriven - the xml driven flag

alterNames

public boolean alterNames()

Determine whether or not to alter the names of the data store entities to avoid db reserved word conflicts.

Returns:

true if the view is a system view

setAlterNames

public void setAlterNames(boolean alterNames)

Set the flag which indicates whether or not to alter the names of the data store entities to avoid db reserved word conflicts.

Parameters:

alterNames - the alterNames flag; true if the data store names should be altered

getProperties

public Collection<ViewInstancePropertyEntity> getProperties()

Get the instance properties.

Returns:

the instance properties

putProperty

public void putProperty(String key,
                        String value)

Add a property value to this instance.

Parameters:

key - the property key

value - the property value

removeProperty

public void removeProperty(String key)

Remove the property identified by the given key from this instance.

Parameters:

key - the key

getProperty

public ViewInstancePropertyEntity getProperty(String key)

Get the instance property entity for the given key.

Parameters:

key - the key

Returns:

the instance property entity identified by the given key

setProperties

public void setProperties(Collection<ViewInstancePropertyEntity> properties)

Set the collection of instance property entities.

Parameters:

properties - the collection of instance property entities

getData

public Collection<ViewInstanceDataEntity> getData()

Get the instance data.

Returns:

the instance data

setData

public void setData(Collection<ViewInstanceDataEntity> data)

Set the collection of instance data entities.

Parameters:

data - the collection of instance data entities

getEntities

public Collection<ViewEntityEntity> getEntities()

Get the view entities.

Returns:

the view entities

setEntities

public void setEntities(Collection<ViewEntityEntity> entities)

Set the view entities.

Parameters:

entities - the view entities

putInstanceData

public void putInstanceData(String key,
                            String value)

Associate the given instance data value with the given key.

Parameters:

key - the key

value - the value

removeInstanceData

public void removeInstanceData(String key)

Remove the instance data entity associated with the given key.

Parameters:

key - the key

getInstanceData

public ViewInstanceDataEntity getInstanceData(String key)

Get the instance data entity for the given key.

Parameters:

key - the key

Returns:

the instance data entity associated with the given key

getViewEntity

public ViewEntity getViewEntity()

Get the parent view entity.

Returns:

the parent view entity

setViewEntity

public void setViewEntity(ViewEntity view)

Set the parent view entity.

Parameters:

view - the parent view entity

getConfiguration

public InstanceConfig getConfiguration()

Get the associated configuration.

Returns:

the configuration

addResourceProvider

public void addResourceProvider(Resource.Type type,
                                org.apache.ambari.view.ResourceProvider provider)

Add a resource provider for the given resource type.

Parameters:

type - the resource type

provider - the resource provider

getResourceProvider

public org.apache.ambari.view.ResourceProvider getResourceProvider(Resource.Type type)

Get the resource provider for the given resource type.

Parameters:

type - the resource type

Returns:

the resource provider

getResourceProvider

public org.apache.ambari.view.ResourceProvider getResourceProvider(String type)

Get the resource provider for the given resource type name (scoped to this view).

Parameters:

type - the resource type name

Returns:

the resource provider

addService

public void addService(String pluralName,
                       Object service)

Add a service for the given plural resource name.

Parameters:

pluralName - the plural resource name

service - the service

getService

public Object getService(String pluralName)

Get the service associated with the given plural resource name.

Parameters:

pluralName - the plural resource name

Returns:

the service associated with the given name

getContextPath

public String getContextPath()

Get the context path for the UI for this view.

Returns:

the context path

getContextPath

public static String getContextPath(String viewName,
                                    String version,
                                    String viewInstanceName)

Get the context path for a view instance with the given names.

Parameters:

viewName - the view name

viewInstanceName - the instance name

Returns:

the context path

getUsername

public String getUsername()

Get the current user name.

Returns:

the current user name; empty String if user is not known

getResource

public ResourceEntity getResource()

Get the admin resource entity.

Returns:

the resource entity

setResource

public void setResource(ResourceEntity resource)

Set the admin resource entity.

Parameters:

resource - the resource entity

getDataMigrator

public org.apache.ambari.view.migration.ViewDataMigrator getDataMigrator(org.apache.ambari.view.migration.ViewDataMigrationContext dataMigrationContext)
                                                                  throws ClassNotFoundException

Get the data migrator instance for view instance.

Parameters:

dataMigrationContext - the data migration context to inject into migrator instance.

Returns:

the data migrator.

Throws:

ClassNotFoundException - if class defined in the archive could not be loaded

validate

public void validate(ViewEntity viewEntity,
                     org.apache.ambari.view.validation.Validator.ValidationContext context)
              throws ValidationException

Validate the state of the instance.

Parameters:

viewEntity - the view entity to which this instance will be bound

context - the validation context

Throws:

ValidationException - if the instance can not be validated

getValidationResult

public InstanceValidationResultImpl getValidationResult(ViewEntity viewEntity,
                                                        org.apache.ambari.view.validation.Validator.ValidationContext context)
                                                 throws IllegalStateException

Get the validation the state of the instance.

Parameters:

viewEntity - the view entity to which this instance will be bound

context - the validation context

Returns:

the instance validation result

Throws:

IllegalStateException

getCurrentUserName

public String getCurrentUserName()

setSecurityHelper

protected void setSecurityHelper(SecurityHelper securityHelper)

Set the security helper.

Parameters:

securityHelper - the helper

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getViewUrl

public ViewURLEntity getViewUrl()

Get the view URL associated with the instance

Returns:

setViewUrl

public void setViewUrl(ViewURLEntity viewUrl)

Set the view URL associated with the instance

Parameters:

viewUrl -

clearUrl

public void clearUrl()

Remove the URL associated with this entity

toString

public String toString()

Overrides:

toString in class Object