org.apache.ambari.server.view

Class ViewRegistry

java.lang.Object

org.apache.ambari.server.view.ViewRegistry

@Singleton
public class ViewRegistry
extends Object

Registry for view and view instance definitions.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	ViewRegistry.ViewModule Module for stand alone view registry.

Field Summary

Fields

Modifier and Type	Field and Description
static String	API_PREFIX
static String	DEFAULT_AUTO_INSTANCE_URL
protected static int	DEFAULT_REQUEST_CONNECT_TIMEOUT
protected static int	DEFAULT_REQUEST_READ_TIMEOUT
protected ViewDataMigrationUtility	viewDataMigrationUtility View Data Migration Utility

Constructor Summary

Constructors

Constructor and Description
ViewRegistry(AmbariEventPublisher publisher) Create the view registry.

Method Summary

Modifier and Type	Method and Description
void	addDefinition(ViewEntity definition) Add a view definition to the registry.
void	addInstanceDefinition(ViewEntity definition, ViewInstanceEntity instanceDefinition) Add an instance definition for the given view definition.
protected void	bindViewInstance(ViewEntity viewDefinition, ViewInstanceEntity viewInstanceDefinition)
boolean	checkAdmin() Determine whether or not the current view user has admin rights.
boolean	checkPermission(String viewName, String version, String instanceName, boolean readOnly) Determine whether or not access to the view instance resource identified by the given instance name should be allowed based on the permissions granted to the current user.
boolean	checkPermission(ViewInstanceEntity instanceEntity, boolean readOnly) Determine whether or not access to the given view instance should be allowed based on the permissions granted to the current user.
protected boolean	checkViewVersions(ViewEntity view, String serverVersion) Check the configured view max and min Ambari versions for the given view entity against the given Ambari server version.
protected void	clear() Clear the registry.
void	copyPrivileges(ViewInstanceEntity sourceInstanceEntity, ViewInstanceEntity targetInstanceEntity) Copy all privileges from one view instance to another
protected ViewAmbariStreamProvider	createAmbariStreamProvider() Factory method to create a view Ambari stream provider.
protected org.apache.ambari.view.AmbariStreamProvider	createRemoteAmbariStreamProvider(Long clusterId) Get Remote Ambari Cluster Stream provider
protected ViewURLStreamProvider	createURLStreamProvider(org.apache.ambari.view.ViewContext viewContext) Factory method to create a view URL stream provider.
protected ViewInstanceEntity	createViewInstanceDefinition(ViewConfig viewConfig, ViewEntity viewDefinition, InstanceConfig instanceConfig)
protected static boolean	extractViewArchive(String archivePath, ViewRegistry.ViewModule viewModule, boolean systemOnly)
void	fireEvent(org.apache.ambari.view.events.Event event) Notify any registered listeners of the given event.
org.apache.ambari.view.cluster.Cluster	getCluster(org.apache.ambari.view.ViewInstanceDefinition viewInstance) Get the cluster associated with the given view instance.
ViewEntity	getDefinition(ResourceTypeEntity resourceTypeEntity) Get the view definition for the given resource type.
ViewEntity	getDefinition(String viewName, String version) Get a view definition for the given name.
Collection<ViewEntity>	getDefinitions() Get the collection of all the view definitions.
static ViewRegistry	getInstance() Get the view registry singleton.
ViewInstanceEntity	getInstanceDefinition(String viewName, String version, String instanceName) Get the instance definition for the given view name and instance name.
Collection<ViewInstanceEntity>	getInstanceDefinitions(ViewEntity definition) Get the collection of view instances for the given view definition.
protected Map<Resource.Type,ResourceProvider>	getResourceProviders() Get the view resource provider mapping.
Set<SubResourceDefinition>	getSubResourceDefinitions(String viewName, String version) Get the sub-resource definitions for the given view name.
protected ViewDataMigrationUtility	getViewDataMigrationUtility()
ViewInstanceEntity	getViewInstanceEntity(String viewName, String instanceName) Get a view instance entity for the given view name and instance name.
boolean	hasPermission(PermissionEntity permissionEntity, ResourceEntity resourceEntity, String userName) Determine whether or not the access specified by the given permission is permitted for the given user on the view instance identified by the given resource.
boolean	includeDefinition(ViewEntity definitionEntity) Determine whether or not the given view definition resource should be included based on the permissions granted to the current user.
static void	initInstance(ViewRegistry singleton) Init the singleton instance.
void	installViewInstance(ViewInstanceEntity instanceEntity) TODO : This should move to ViewInstanceOperationHandler Install the given view instance with its associated view.
boolean	instanceExists(ViewInstanceEntity instanceEntity) Determine whether or not the given view instance exists.
static void	main(String[] args) Registry main method.
void	onAmbariEvent(ServiceInstalledEvent event) Receive notification that a new service has been added to a cluster.
void	onClusterConfigFinishedEvent(ClusterConfigFinishedEvent event)
protected void	onDeploy(ViewEntity definition)
void	readViewArchive(Path path) Extract a view archive at the specified path
void	readViewArchives() Read all view archives.
void	readViewArchives(String viewNameRegExp) Read only view archives with names corresponding to given regular expression.
void	registerListener(org.apache.ambari.view.events.Listener listener, String viewName, String viewVersion) Register the given listener to listen for events from the view identified by the given name and version.
void	removeInstanceData(ViewInstanceEntity instanceEntity, String key) Remove the data entry keyed by the given key from the given instance entity.
void	removeInstanceDefinition(ViewEntity definition, String instanceName) Remove an instance definition for the given view definition.
protected ViewEntity	setupViewDefinition(ViewEntity viewDefinition, ClassLoader cl)
protected void	setViewDataMigrationUtility(ViewDataMigrationUtility viewDataMigrationUtility)
void	setViewInstanceProperties(ViewInstanceEntity instanceEntity, Map<String,String> properties, ViewConfig viewConfig, ClassLoader classLoader) Set the properties of the given view instance from the given property set.
protected void	setViewInstanceRoleAccess(ViewInstanceEntity viewInstanceEntity, Collection<String> roles) Set access to the a particular view instance based on a set of roles.
void	uninstallViewInstance(ViewInstanceEntity instanceEntity) Uninstall a view instance for the view with the given view name.
void	unregisterListener(org.apache.ambari.view.events.Listener listener, String viewName, String viewVersion) Un-register the given listener from the view identified by the given name and version.
void	updateView(ViewInstanceEntity instanceEntity) Calls onUpdate hook on View class
void	updateViewInstance(ViewInstanceEntity instanceEntity) Update a view instance for the view with the given view name.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_REQUEST_CONNECT_TIMEOUT

protected static final int DEFAULT_REQUEST_CONNECT_TIMEOUT

See Also:

Constant Field Values

DEFAULT_REQUEST_READ_TIMEOUT

protected static final int DEFAULT_REQUEST_READ_TIMEOUT

See Also:

Constant Field Values

API_PREFIX

public static final String API_PREFIX

See Also:

Constant Field Values

DEFAULT_AUTO_INSTANCE_URL

public static final String DEFAULT_AUTO_INSTANCE_URL

See Also:

Constant Field Values

viewDataMigrationUtility

protected ViewDataMigrationUtility viewDataMigrationUtility

View Data Migration Utility

Constructor Detail

ViewRegistry

@Inject
public ViewRegistry(AmbariEventPublisher publisher)

Create the view registry.

Method Detail

main

public static void main(String[] args)

Registry main method.

Parameters:

args - the command line arguments

getDefinitions

public Collection<ViewEntity> getDefinitions()

Get the collection of all the view definitions.

Returns:

the collection of view definitions

getDefinition

public ViewEntity getDefinition(String viewName,
                                String version)

Get a view definition for the given name.

Parameters:

viewName - the view name

version - the version

Returns:

the view definition for the given name

getDefinition

public ViewEntity getDefinition(ResourceTypeEntity resourceTypeEntity)

Get the view definition for the given resource type.

Parameters:

resourceTypeEntity - the resource type

Returns:

the view definition for the given resource type or null

addDefinition

public void addDefinition(ViewEntity definition)

Add a view definition to the registry.

Parameters:

definition - the definition

getInstanceDefinitions

public Collection<ViewInstanceEntity> getInstanceDefinitions(ViewEntity definition)

Get the collection of view instances for the given view definition.

Parameters:

definition - the view definition

Returns:

the collection of view instances for the view definition

getInstanceDefinition

public ViewInstanceEntity getInstanceDefinition(String viewName,
                                                String version,
                                                String instanceName)

Get the instance definition for the given view name and instance name.

Parameters:

viewName - the view name

version - the version

instanceName - the instance name

Returns:

the view instance definition for the given view and instance name

addInstanceDefinition

public void addInstanceDefinition(ViewEntity definition,
                                  ViewInstanceEntity instanceDefinition)

Add an instance definition for the given view definition.

Parameters:

definition - the owning view definition

instanceDefinition - the instance definition

removeInstanceDefinition

public void removeInstanceDefinition(ViewEntity definition,
                                     String instanceName)

Remove an instance definition for the given view definition.

Parameters:

definition - the owning view definition

instanceName - the instance name

initInstance

public static void initInstance(ViewRegistry singleton)

Init the singleton instance.

Parameters:

singleton - the view registry

getInstance

public static ViewRegistry getInstance()

Get the view registry singleton.

Returns:

the view registry

getSubResourceDefinitions

public Set<SubResourceDefinition> getSubResourceDefinitions(String viewName,
                                                            String version)

Get the sub-resource definitions for the given view name.

Parameters:

viewName - the instance name

version - the version

Returns:

the set of sub-resource definitions

readViewArchives

public void readViewArchives()

Read all view archives.

readViewArchives

public void readViewArchives(String viewNameRegExp)

Read only view archives with names corresponding to given regular expression.

Parameters:

viewNameRegExp - view name regular expression

instanceExists

public boolean instanceExists(ViewInstanceEntity instanceEntity)

Determine whether or not the given view instance exists.

Parameters:

instanceEntity - the view instance entity

Returns:

true if the the given view instance exists; false otherwise

installViewInstance

public void installViewInstance(ViewInstanceEntity instanceEntity)
                         throws ValidationException,
                                IllegalArgumentException,
                                org.apache.ambari.view.SystemException

TODO : This should move to ViewInstanceOperationHandler Install the given view instance with its associated view.

Parameters:

instanceEntity - the view instance entity

Throws:

ValidationException - if the given instance fails the validation checks

IllegalArgumentException - if the view associated with the given instance does not exist

org.apache.ambari.view.SystemException - if the instance can not be installed

updateViewInstance

public void updateViewInstance(ViewInstanceEntity instanceEntity)
                        throws ValidationException,
                               org.apache.ambari.view.SystemException

Update a view instance for the view with the given view name.

Parameters:

instanceEntity - the view instance entity

Throws:

ValidationException - if the given instance fails the validation checks

org.apache.ambari.view.SystemException - if the instance can not be updated

updateView

public void updateView(ViewInstanceEntity instanceEntity)

Calls onUpdate hook on View class

Parameters:

instanceEntity -

getViewInstanceEntity

public ViewInstanceEntity getViewInstanceEntity(String viewName,
                                                String instanceName)

Get a view instance entity for the given view name and instance name.

Parameters:

viewName - the view name

instanceName - the instance name

Returns:

a view instance entity for the given view name and instance name.

uninstallViewInstance

public void uninstallViewInstance(ViewInstanceEntity instanceEntity)
                           throws IllegalStateException

Uninstall a view instance for the view with the given view name.

Parameters:

instanceEntity - the view instance entity

Throws:

IllegalStateException - if the given instance is not in a valid state

removeInstanceData

public void removeInstanceData(ViewInstanceEntity instanceEntity,
                               String key)

Remove the data entry keyed by the given key from the given instance entity.

Parameters:

instanceEntity - the instance entity

key - the data key

copyPrivileges

public void copyPrivileges(ViewInstanceEntity sourceInstanceEntity,
                           ViewInstanceEntity targetInstanceEntity)

Copy all privileges from one view instance to another

Parameters:

sourceInstanceEntity - the source instance entity

targetInstanceEntity - the target instance entity

fireEvent

public void fireEvent(org.apache.ambari.view.events.Event event)

Notify any registered listeners of the given event.

Parameters:

event - the event

registerListener

public void registerListener(org.apache.ambari.view.events.Listener listener,
                             String viewName,
                             String viewVersion)

Register the given listener to listen for events from the view identified by the given name and version.

Parameters:

listener - the listener

viewName - the view name

viewVersion - the view version; null indicates all versions

unregisterListener

public void unregisterListener(org.apache.ambari.view.events.Listener listener,
                               String viewName,
                               String viewVersion)

Un-register the given listener from the view identified by the given name and version.

Parameters:

listener - the listener

viewName - the view name

viewVersion - the view version; null indicates all versions

hasPermission

public boolean hasPermission(PermissionEntity permissionEntity,
                             ResourceEntity resourceEntity,
                             String userName)

Determine whether or not the access specified by the given permission is permitted for the given user on the view instance identified by the given resource.

Parameters:

permissionEntity - the permission entity

resourceEntity - the resource entity

userName - the user name

Returns:

true if the access specified by the given permission is permitted for the given user.

checkPermission

public boolean checkPermission(String viewName,
                               String version,
                               String instanceName,
                               boolean readOnly)

Determine whether or not access to the view instance resource identified by the given instance name should be allowed based on the permissions granted to the current user.

Parameters:

viewName - the view name

version - the view version

instanceName - the name of the view instance resource

readOnly - indicate whether or not this is for a read only operation

Returns:

true if the access to the view instance is allowed

checkPermission

public boolean checkPermission(ViewInstanceEntity instanceEntity,
                               boolean readOnly)

Determine whether or not access to the given view instance should be allowed based on the permissions granted to the current user.

Parameters:

instanceEntity - the view instance entity

readOnly - indicate whether or not this is for a read only operation

Returns:

true if the access to the view instance is allowed

checkAdmin

public boolean checkAdmin()

Determine whether or not the current view user has admin rights.

Returns:

true if the current view user is an admin

includeDefinition

public boolean includeDefinition(ViewEntity definitionEntity)

Determine whether or not the given view definition resource should be included based on the permissions granted to the current user.

Parameters:

definitionEntity - the view definition entity

Returns:

true if the view instance should be included based on the permissions of the current user

setViewInstanceProperties

public void setViewInstanceProperties(ViewInstanceEntity instanceEntity,
                                      Map<String,String> properties,
                                      ViewConfig viewConfig,
                                      ClassLoader classLoader)
                               throws org.apache.ambari.view.SystemException

Set the properties of the given view instance from the given property set.

Parameters:

instanceEntity - the view instance entity

properties - the view instance properties

viewConfig - the view configuration

classLoader - the class loader for the view

Throws:

org.apache.ambari.view.SystemException - if the view instance properties can not be set

getCluster

public org.apache.ambari.view.cluster.Cluster getCluster(org.apache.ambari.view.ViewInstanceDefinition viewInstance)

Get the cluster associated with the given view instance.

Parameters:

viewInstance - the view instance

Returns:

the cluster

onAmbariEvent

public void onAmbariEvent(ServiceInstalledEvent event)

Receive notification that a new service has been added to a cluster.

Used for view instance auto creation.

Parameters:

event - the service installed event

onClusterConfigFinishedEvent

public void onClusterConfigFinishedEvent(ClusterConfigFinishedEvent event)

clear

protected void clear()

Clear the registry.

getResourceProviders

protected Map<Resource.Type,ResourceProvider> getResourceProviders()

Get the view resource provider mapping.

Returns:

the map of view resource providers

setupViewDefinition

protected ViewEntity setupViewDefinition(ViewEntity viewDefinition,
                                         ClassLoader cl)
                                  throws ClassNotFoundException,
                                         IntrospectionException

Throws:

ClassNotFoundException

IntrospectionException

createViewInstanceDefinition

protected ViewInstanceEntity createViewInstanceDefinition(ViewConfig viewConfig,
                                                          ViewEntity viewDefinition,
                                                          InstanceConfig instanceConfig)
                                                   throws ValidationException,
                                                          ClassNotFoundException,
                                                          org.apache.ambari.view.SystemException

Throws:

ValidationException

ClassNotFoundException

org.apache.ambari.view.SystemException

bindViewInstance

protected void bindViewInstance(ViewEntity viewDefinition,
                                ViewInstanceEntity viewInstanceDefinition)
                         throws ClassNotFoundException

Throws:

ClassNotFoundException

onDeploy

protected void onDeploy(ViewEntity definition)

readViewArchive

public void readViewArchive(Path path)

Extract a view archive at the specified path

Parameters:

path -

setViewInstanceRoleAccess

protected void setViewInstanceRoleAccess(ViewInstanceEntity viewInstanceEntity,
                                         Collection<String> roles)

Set access to the a particular view instance based on a set of roles.

View access to the specified view instances will be granted to anyone directly or indirectly assigned to one of the roles in the suppled set of role names.

Parameters:

viewInstanceEntity - a view instance entity

roles - the set of roles to use to for granting access

checkViewVersions

protected boolean checkViewVersions(ViewEntity view,
                                    String serverVersion)

Check the configured view max and min Ambari versions for the given view entity against the given Ambari server version.

Parameters:

view - the view

serverVersion - the server version

Returns:

true if the given server version >= min version && <= max version for the given view

extractViewArchive

protected static boolean extractViewArchive(String archivePath,
                                            ViewRegistry.ViewModule viewModule,
                                            boolean systemOnly)
                                     throws Exception

Throws:

Exception

createURLStreamProvider

protected ViewURLStreamProvider createURLStreamProvider(org.apache.ambari.view.ViewContext viewContext)

Factory method to create a view URL stream provider.

Parameters:

viewContext - the view context

Returns:

a new view URL stream provider

createAmbariStreamProvider

protected ViewAmbariStreamProvider createAmbariStreamProvider()

Factory method to create a view Ambari stream provider.

Returns:

a new view Ambari stream provider

createRemoteAmbariStreamProvider

protected org.apache.ambari.view.AmbariStreamProvider createRemoteAmbariStreamProvider(Long clusterId)

Get Remote Ambari Cluster Stream provider

Parameters:

clusterId -

Returns:

getViewDataMigrationUtility

protected ViewDataMigrationUtility getViewDataMigrationUtility()

setViewDataMigrationUtility

protected void setViewDataMigrationUtility(ViewDataMigrationUtility viewDataMigrationUtility)