co.cask.cdap.data2.datafabric.dataset.type

Class DatasetTypeManager

java.lang.Object

com.google.common.util.concurrent.AbstractIdleService

co.cask.cdap.data2.datafabric.dataset.type.DatasetTypeManager

All Implemented Interfaces:

com.google.common.util.concurrent.Service

public class DatasetTypeManager
extends com.google.common.util.concurrent.AbstractIdleService

Manages dataset types and modules metadata

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.common.util.concurrent.Service

com.google.common.util.concurrent.Service.Listener, com.google.common.util.concurrent.Service.State

Constructor Summary

Constructors

Constructor and Description
DatasetTypeManager(CConfiguration cConf, MDSDatasetsRegistry mdsDatasets, LocationFactory locationFactory, Map<String,co.cask.cdap.api.dataset.module.DatasetModule> defaultModules)

Method Summary

Methods

Modifier and Type	Method and Description
void	addModule(Id.DatasetModule datasetModuleId, String className, Location jarLocation) Add datasets module in a namespace
boolean	deleteModule(Id.DatasetModule datasetModuleId) Deletes specified dataset module
void	deleteModules(Id.Namespace namespaceId) Deletes all modules in a namespace, other than system.
DatasetModuleMeta	getModule(Id.DatasetModule datasetModuleId)
Collection<DatasetModuleMeta>	getModules(Id.Namespace namespaceId)
DatasetTypeMeta	getTypeInfo(Id.DatasetType datasetTypeId) Get dataset type information
Collection<DatasetTypeMeta>	getTypes(Id.Namespace namespaceId)
protected void	shutDown()
protected void	startUp()

Methods inherited from class com.google.common.util.concurrent.AbstractIdleService

addListener, executor, isRunning, start, startAndWait, state, stop, stopAndWait, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

DatasetTypeManager

@Inject
public DatasetTypeManager(CConfiguration cConf,
                         MDSDatasetsRegistry mdsDatasets,
                         LocationFactory locationFactory,
                         Map<String,co.cask.cdap.api.dataset.module.DatasetModule> defaultModules)

Method Detail

startUp

protected void startUp()
                throws Exception

Specified by:

startUp in class com.google.common.util.concurrent.AbstractIdleService

Throws:

Exception

shutDown

protected void shutDown()
                 throws Exception

Specified by:

shutDown in class com.google.common.util.concurrent.AbstractIdleService

Throws:

Exception

addModule

public void addModule(Id.DatasetModule datasetModuleId,
             String className,
             Location jarLocation)
               throws DatasetModuleConflictException

Add datasets module in a namespace

Parameters:

datasetModuleId - the Id.DatasetModule to add

className - module class

jarLocation - location of the module jar

Throws:

DatasetModuleConflictException

getTypes

public Collection<DatasetTypeMeta> getTypes(Id.Namespace namespaceId)

Parameters:

namespaceId - the Id.Namespace to retrieve types from

Returns:

collection of types available in the specified namespace

getTypeInfo

@Nullable
public DatasetTypeMeta getTypeInfo(Id.DatasetType datasetTypeId)

Get dataset type information

Parameters:

datasetTypeId - name of the type to get info for

Returns:

instance of DatasetTypeMeta or null if type does NOT exist

getModules

public Collection<DatasetModuleMeta> getModules(Id.Namespace namespaceId)

Parameters:

namespaceId - Id.Namespace to retrieve the module list from

Returns:

list of dataset modules information from the specified namespace

getModule

@Nullable
public DatasetModuleMeta getModule(Id.DatasetModule datasetModuleId)

Parameters:

datasetModuleId - Id.DatasetModule of the module to return info for

Returns:

dataset module info or null if module with given name does NOT exist

deleteModule

public boolean deleteModule(Id.DatasetModule datasetModuleId)
                     throws DatasetModuleConflictException

Deletes specified dataset module

Parameters:

datasetModuleId - Id.DatasetModule of the dataset module to delete

Returns:

true if deleted successfully, false if module didn't exist: nothing to delete

Throws:

DatasetModuleConflictException - when there are other modules depend on the specified one, in which case deletion does NOT happen

deleteModules

public void deleteModules(Id.Namespace namespaceId)
                   throws DatasetModuleConflictException

Deletes all modules in a namespace, other than system. Presumes that the namespace has already been checked to be non-system.

Parameters:

namespaceId - the Id.Namespace to delete modules from.

Throws:

DatasetModuleConflictException