co.cask.coopr.store.entity

Interface EntityStoreView

All Known Implementing Classes:

BaseEntityStoreView, BaseSQLEntityStoreView, SQLAdminEntityStoreView, SQLUserEntityStoreView

public interface EntityStoreView

A view of the entity store for adding, modifying, retrieving, and deleting entities that are accessible by a tenant admin user. TODO: introduce concept of owner or group acls for these entities

Method Summary

Methods

Modifier and Type	Method and Description
void	deleteAutomatorType(String automatorTypeName) Delete the AutomatorType associated with the given unique name.
void	deleteAutomatorType(String automatorTypeName, int version) Delete the AutomatorType associated with the given unique name.
void	deleteClusterTemplate(String clusterTemplateName) Delete the ClusterTemplate associated with the given unique name.
void	deleteClusterTemplate(String clusterTemplateName, int version) Delete the ClusterTemplate associated with the given unique name and version.
void	deleteHardwareType(String hardwareTypeName) Delete the HardwareType associated with the given unique name.
void	deleteHardwareType(String hardwareTypeName, int version) Delete the HardwareType associated with the given unique name and version.
void	deleteImageType(String imageTypeName) Delete the ImageType associated with the given unique name.
void	deleteImageType(String imageTypeName, int version) Delete the ImageType associated with the given unique name and version.
void	deletePartialTemplate(String partialTemplateName) Delete the PartialTemplate associated with the given unique name.
void	deletePartialTemplate(String partialTemplateName, int version) Delete the PartialTemplate associated with the given unique name.
void	deleteProvider(String providerName) Delete the Provider associated with the given unique name.
void	deleteProvider(String providerName, int version) Delete the Provider associated with the given unique name and version.
void	deleteProviderType(String providerTypeName) Delete the ProviderType associated with the given unique name.
void	deleteProviderType(String providerTypeName, int version) Delete the ProviderType associated with the given unique name.
void	deleteService(String serviceName) Delete the Service associated with the given unique name.
void	deleteService(String serviceName, int version) Delete the Service associated with the given unique name and version.
Collection<AutomatorType>	getAllAutomatorTypes() Get all AutomatorTypes.
Collection<ClusterTemplate>	getAllClusterTemplates() Get all ClusterTemplates.
Collection<HardwareType>	getAllHardwareTypes() Get all HardwareTypes.
Collection<ImageType>	getAllImageTypes() Get all ImageTypes.
Collection<PartialTemplate>	getAllPartialTemplates() Get all PartialTemplates.
Collection<Provider>	getAllProviders() Get all Providers.
Collection<ProviderType>	getAllProviderTypes() Get all ProviderTypes.
Collection<Service>	getAllServices() Get all Services.
AutomatorType	getAutomatorType(String automatorTypeName) Get the AutomatorType associated with the given unique name or null if no such automator type exists.
AutomatorType	getAutomatorType(String automatorTypeName, int version) Get the AutomatorType associated with the given unique name or null if no such automator type exists.
ClusterTemplate	getClusterTemplate(String clusterTemplateName) Get the ClusterTemplate associated with the given unique name or null if no such cluster template exists.
ClusterTemplate	getClusterTemplate(String clusterTemplateName, int version) Get the ClusterTemplate associated with the given unique name and version or null if no such cluster template exists.
HardwareType	getHardwareType(String hardwareTypeName) Get the HardwareType associated with the given unique name or null if no such hardware type exists.
HardwareType	getHardwareType(String hardwareTypeName, int version) Get the HardwareType associated with the given unique name and version or null if no such hardware type exists.
ImageType	getImageType(String imageTypeName) Get the ImageType associated with the given unique name or null if no such image type exists.
ImageType	getImageType(String imageTypeName, int version) Get the ImageType associated with the given unique name or null if no such image type exists.
PartialTemplate	getPartialTemplate(String partialTemplateName) Get the PartialTemplate associated with the given unique name or null if no such provider exists.
PartialTemplate	getPartialTemplate(String partialTemplateName, int version) Get the PartialTemplate associated with the given unique name or null if no such provider exists.
Provider	getProvider(String providerName) Get the Provider associated with the given unique name or null if no such provider exists.
Provider	getProvider(String providerName, int version) Get the Provider associated with the given unique name and version or null if no such provider exists.
ProviderType	getProviderType(String providerTypeName) Get the ProviderType associated with the given unique name or null if no such provider type exists.
ProviderType	getProviderType(String providerTypeName, int version) Get the ProviderType associated with the given unique name or null if no such provider type exists.
Service	getService(String serviceName) Get the Service associated with the given unique name or null if no such service exists.
Service	getService(String serviceName, int version) Get the Service associated with the given unique name and version or null if no such service exists.
void	writeAutomatorType(AutomatorType automatorType) Write the given AutomatorType to the store.
void	writeClusterTemplate(ClusterTemplate clusterTemplate) Write the given ClusterTemplate to the store.
void	writeHardwareType(HardwareType hardwareType) Write the given HardwareType to the store.
void	writeImageType(ImageType imageType) Write the given ImageType to the store.
void	writePartialTemplate(PartialTemplate partialTemplate) Write the given PartialTemplate to the store.
void	writeProvider(Provider provider) Write the given Provider to the store.
void	writeProviderType(ProviderType providerType) Write the given ProviderType to the store.
void	writeService(Service service) Write the given Service to the store.

Method Detail

getProvider

Provider getProvider(String providerName)
                     throws IOException

Get the Provider associated with the given unique name or null if no such provider exists.

Parameters:

providerName - Unique name of the provider to get.

Returns:

Provider matching the given name or null if no such provider exists.

Throws:

Exception

IOException

getProvider

Provider getProvider(String providerName,
                   int version)
                     throws IOException

Get the Provider associated with the given unique name and version or null if no such provider exists.

Parameters:

providerName - Unique name of the provider to get.

version - Version of the provider to get.

Returns:

Provider matching the given name and version or null if no such provider exists.

Throws:

Exception

IOException

getAllProviders

Collection<Provider> getAllProviders()
                                     throws IOException

Get all Providers.

Returns:

Collection of all providers.

Throws:

Exception

IOException

writeProvider

void writeProvider(Provider provider)
                   throws IOException,
                          IllegalAccessException

Write the given Provider to the store. Will overwrite the existing Provider if it exists.

Parameters:

provider - Provider to write.

Throws:

Exception

IOException

IllegalAccessException

deleteProvider

void deleteProvider(String providerName)
                    throws IOException,
                           IllegalAccessException

Delete the Provider associated with the given unique name.

Parameters:

providerName - Name of the provider to delete.

Throws:

Exception

IOException

IllegalAccessException

deleteProvider

void deleteProvider(String providerName,
                  int version)
                    throws IOException,
                           IllegalAccessException

Delete the Provider associated with the given unique name and version.

Parameters:

providerName - Name of the provider to delete.

version - Version of the provider to delete.

Throws:

Exception

IOException

IllegalAccessException

getHardwareType

HardwareType getHardwareType(String hardwareTypeName)
                             throws IOException

Get the HardwareType associated with the given unique name or null if no such hardware type exists.

Parameters:

hardwareTypeName - Unique name of the hardware type to get.

Returns:

Hardware type matching the given name or null if no such hardware type exists.

Throws:

Exception

IOException

getHardwareType

HardwareType getHardwareType(String hardwareTypeName,
                           int version)
                             throws IOException

Get the HardwareType associated with the given unique name and version or null if no such hardware type exists.

Parameters:

hardwareTypeName - Unique name of the hardware type to get.

version - Version of the hardware type to get.

Returns:

Hardware type matching the given name and version or null if no such hardware type exists.

Throws:

Exception

IOException

getAllHardwareTypes

Collection<HardwareType> getAllHardwareTypes()
                                             throws IOException

Get all HardwareTypes.

Returns:

Collection of all hardware types.

Throws:

Exception

IOException

writeHardwareType

void writeHardwareType(HardwareType hardwareType)
                       throws IOException,
                              IllegalAccessException

Write the given HardwareType to the store. Will overwrite the existing HardwareType if it exists.

Parameters:

hardwareType - Hardware type to write.

Throws:

Exception

IOException

IllegalAccessException

deleteHardwareType

void deleteHardwareType(String hardwareTypeName)
                        throws IOException,
                               IllegalAccessException

Delete the HardwareType associated with the given unique name.

Parameters:

hardwareTypeName - Name of the hardware type to delete.

Throws:

Exception

IOException

IllegalAccessException

deleteHardwareType

void deleteHardwareType(String hardwareTypeName,
                      int version)
                        throws IOException,
                               IllegalAccessException

Delete the HardwareType associated with the given unique name and version.

Parameters:

hardwareTypeName - Name of the hardware type to delete.

version - Version of the hardware type to delete.

Throws:

Exception

IOException

IllegalAccessException

getImageType

ImageType getImageType(String imageTypeName)
                       throws IOException

Get the ImageType associated with the given unique name or null if no such image type exists.

Parameters:

imageTypeName - Unique name of the image type to get.

Returns:

Image type matching the given name or null if no such image type exists.

Throws:

Exception

IOException

getImageType

ImageType getImageType(String imageTypeName,
                     int version)
                       throws IOException

Get the ImageType associated with the given unique name or null if no such image type exists.

Parameters:

imageTypeName - Unique name of the image type to get.

version - Version of the image type to get.

Returns:

Image type matching the given name and version or null if no such image type exists.

Throws:

Exception

IOException

getAllImageTypes

Collection<ImageType> getAllImageTypes()
                                       throws IOException

Get all ImageTypes.

Returns:

Collection of all image types.

Throws:

Exception

IOException

writeImageType

void writeImageType(ImageType imageType)
                    throws IOException,
                           IllegalAccessException

Write the given ImageType to the store. Will overwrite the existing ImageType if it exists.

Parameters:

imageType - Image type to write.

Throws:

Exception

IOException

IllegalAccessException

deleteImageType

void deleteImageType(String imageTypeName)
                     throws IOException,
                            IllegalAccessException

Delete the ImageType associated with the given unique name.

Parameters:

imageTypeName - Name of the image type to delete.

Throws:

Exception

IOException

IllegalAccessException

deleteImageType

void deleteImageType(String imageTypeName,
                   int version)
                     throws IOException,
                            IllegalAccessException

Delete the ImageType associated with the given unique name and version.

Parameters:

imageTypeName - Name of the image type to delete.

version - Version of the image type to delete.

Throws:

Exception

IOException

IllegalAccessException

getService

Service getService(String serviceName)
                   throws IOException

Get the Service associated with the given unique name or null if no such service exists.

Parameters:

serviceName - Unique name of the service to get.

Returns:

Service matching the given name or null if no such service exists.

Throws:

Exception

IOException

getService

Service getService(String serviceName,
                 int version)
                   throws IOException

Get the Service associated with the given unique name and version or null if no such service exists.

Parameters:

serviceName - Unique name of the service to get.

version - Version of the service to get.

Returns:

Service matching the given name and version or null if no such service exists.

Throws:

Exception

IOException

getAllServices

Collection<Service> getAllServices()
                                   throws IOException

Get all Services.

Returns:

Collection of all services.

Throws:

Exception

IOException

writeService

void writeService(Service service)
                  throws IOException,
                         IllegalAccessException

Write the given Service to the store. Will overwrite the existing Service if it exists.

Parameters:

service - Service to write.

Throws:

Exception

IOException

IllegalAccessException

deleteService

void deleteService(String serviceName)
                   throws IOException,
                          IllegalAccessException

Delete the Service associated with the given unique name.

Parameters:

serviceName - Name of the service to delete.

Throws:

Exception

IOException

IllegalAccessException

deleteService

void deleteService(String serviceName,
                 int version)
                   throws IOException,
                          IllegalAccessException

Delete the Service associated with the given unique name and version.

Parameters:

serviceName - Name of the service to delete.

version - Version of the service to delete.

Throws:

Exception

IOException

IllegalAccessException

getClusterTemplate

ClusterTemplate getClusterTemplate(String clusterTemplateName)
                                   throws IOException

Get the ClusterTemplate associated with the given unique name or null if no such cluster template exists.

Parameters:

clusterTemplateName - Unique name of the cluster template to get.

Returns:

Cluster template matching the given name or null if no such cluster template exists.

Throws:

Exception

IOException

getClusterTemplate

ClusterTemplate getClusterTemplate(String clusterTemplateName,
                                 int version)
                                   throws IOException

Get the ClusterTemplate associated with the given unique name and version or null if no such cluster template exists.

Parameters:

clusterTemplateName - Unique name of the cluster template to get.

version - Version of the cluster template to get.

Returns:

Cluster template matching the given name or null if no such cluster template exists.

Throws:

Exception

IOException

getAllClusterTemplates

Collection<ClusterTemplate> getAllClusterTemplates()
                                                   throws IOException

Get all ClusterTemplates.

Returns:

Collection of all cluster templates.

Throws:

Exception

IOException

writeClusterTemplate

void writeClusterTemplate(ClusterTemplate clusterTemplate)
                          throws IOException,
                                 IllegalAccessException

Write the given ClusterTemplate to the store. Will overwrite the existing ClusterTemplate if it exists.

Parameters:

clusterTemplate - Cluster template to write.

Throws:

Exception

IOException

IllegalAccessException

deleteClusterTemplate

void deleteClusterTemplate(String clusterTemplateName)
                           throws IOException,
                                  IllegalAccessException

Delete the ClusterTemplate associated with the given unique name.

Parameters:

clusterTemplateName - Name of the cluster template to delete.

Throws:

Exception

IOException

IllegalAccessException

deleteClusterTemplate

void deleteClusterTemplate(String clusterTemplateName,
                         int version)
                           throws IOException,
                                  IllegalAccessException

Delete the ClusterTemplate associated with the given unique name and version.

Parameters:

clusterTemplateName - Name of the cluster template to delete.

version - Version of the cluster template to delete.

Throws:

Exception

IOException

IllegalAccessException

getPartialTemplate

PartialTemplate getPartialTemplate(String partialTemplateName)
                                   throws IOException

Get the PartialTemplate associated with the given unique name or null if no such provider exists.

Parameters:

partialTemplateName - Unique name of the provider to get.

Returns:

Partial template matching the given name or null if no such provider exists.

Throws:

Exception

IOException

getPartialTemplate

PartialTemplate getPartialTemplate(String partialTemplateName,
                                 int version)
                                   throws IOException

Get the PartialTemplate associated with the given unique name or null if no such provider exists.

Parameters:

partialTemplateName - Unique name of the provider to get.

version - Version of the provider to get.

Returns:

Partial template matching the given name or null if no such provider exists.

Throws:

Exception

IOException

getAllPartialTemplates

Collection<PartialTemplate> getAllPartialTemplates()
                                                   throws IOException

Get all PartialTemplates.

Returns:

Collection of all partial templates.

Throws:

Exception

IOException

writePartialTemplate

void writePartialTemplate(PartialTemplate partialTemplate)
                          throws IOException,
                                 IllegalAccessException

Write the given PartialTemplate to the store. Will overwrite the existing PartialTemplate if it exists.

Parameters:

partialTemplate - Partial template to write.

Throws:

Exception

IOException

IllegalAccessException

deletePartialTemplate

void deletePartialTemplate(String partialTemplateName)
                           throws IOException,
                                  IllegalAccessException

Delete the PartialTemplate associated with the given unique name.

Parameters:

partialTemplateName - Name of the partial template to delete.

Throws:

Exception

IOException

IllegalAccessException

deletePartialTemplate

void deletePartialTemplate(String partialTemplateName,
                         int version)
                           throws IOException,
                                  IllegalAccessException

Delete the PartialTemplate associated with the given unique name.

Parameters:

partialTemplateName - Name of the partial template to delete.

version - Version of the partial template to delete.

Throws:

Exception

IOException

IllegalAccessException

getProviderType

ProviderType getProviderType(String providerTypeName)
                             throws IOException

Get the ProviderType associated with the given unique name or null if no such provider type exists.

Parameters:

providerTypeName - Unique name of the provider type to get.

Returns:

Provider type matching the given name or null if no such provider exists.

Throws:

Exception

IOException

getProviderType

ProviderType getProviderType(String providerTypeName,
                           int version)
                             throws IOException

Get the ProviderType associated with the given unique name or null if no such provider type exists.

Parameters:

providerTypeName - Unique name of the provider type to get.

version - Version of the provider type to get.

Returns:

Provider type matching the given name or null if no such provider exists.

Throws:

Exception

IOException

getAllProviderTypes

Collection<ProviderType> getAllProviderTypes()
                                             throws IOException

Get all ProviderTypes.

Returns:

Collection of all provider types.

Throws:

Exception

IOException

writeProviderType

void writeProviderType(ProviderType providerType)
                       throws IOException,
                              IllegalAccessException

Write the given ProviderType to the store. Will overwrite the existing ProviderType if it exists.

Parameters:

providerType - Provider type to write.

Throws:

Exception

IOException

IllegalAccessException

deleteProviderType

void deleteProviderType(String providerTypeName)
                        throws IOException,
                               IllegalAccessException

Delete the ProviderType associated with the given unique name.

Parameters:

providerTypeName - Name of the provider type to delete.

Throws:

Exception

IOException

IllegalAccessException

deleteProviderType

void deleteProviderType(String providerTypeName,
                      int version)
                        throws IOException,
                               IllegalAccessException

Delete the ProviderType associated with the given unique name.

Parameters:

providerTypeName - Name of the provider type to delete.

version - Version of the provider type to delete.

Throws:

Exception

IOException

IllegalAccessException

getAutomatorType

AutomatorType getAutomatorType(String automatorTypeName)
                               throws IOException

Get the AutomatorType associated with the given unique name or null if no such automator type exists.

Parameters:

automatorTypeName - Unique name of the automator type to get.

Returns:

Automator type matching the given name or null if no such provider exists.

Throws:

Exception

IOException

getAutomatorType

AutomatorType getAutomatorType(String automatorTypeName,
                             int version)
                               throws IOException

Get the AutomatorType associated with the given unique name or null if no such automator type exists.

Parameters:

automatorTypeName - Unique name of the automator type to get.

version - Version of the automator type to get.

Returns:

Automator type matching the given name or null if no such provider exists.

Throws:

Exception

IOException

getAllAutomatorTypes

Collection<AutomatorType> getAllAutomatorTypes()
                                               throws IOException

Get all AutomatorTypes.

Returns:

Collection of all automator types.

Throws:

Exception

IOException

writeAutomatorType

void writeAutomatorType(AutomatorType automatorType)
                        throws IOException,
                               IllegalAccessException

Write the given AutomatorType to the store. Will overwrite the existing AutomatorType if it exists.

Parameters:

automatorType - Automator type to write.

Throws:

Exception

IOException

IllegalAccessException

deleteAutomatorType

void deleteAutomatorType(String automatorTypeName)
                         throws IOException,
                                IllegalAccessException

Delete the AutomatorType associated with the given unique name.

Parameters:

automatorTypeName - Name of the automator type to delete.

Throws:

Exception

IOException

IllegalAccessException

deleteAutomatorType

void deleteAutomatorType(String automatorTypeName,
                       int version)
                         throws IOException,
                                IllegalAccessException

Delete the AutomatorType associated with the given unique name.

Parameters:

automatorTypeName - Name of the automator type to delete.

version - Version of the automator type to delete.

Throws:

Exception

IOException

IllegalAccessException