co.cask.coopr.store.tenant

Interface TenantStore

All Superinterfaces:

com.google.common.util.concurrent.Service

All Known Implementing Classes:

SQLTenantStore

public interface TenantStore
extends com.google.common.util.concurrent.Service

Store for adding, modifying, retrieving, and deleting tenants.

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

Method Summary

Methods

Modifier and Type	Method and Description
void	deleteTenantByName(String name) Delete the Tenant associated with the given name.
List<Tenant>	getAllTenants() Get an immutable list of all tenants.
List<TenantSpecification>	getAllTenantSpecifications() Get an immutable list of all TenantSpecification.
String	getNameForId(String id) Get the name of the tenant that has the given id, or null if the tenant does not exist.
Tenant	getTenantByID(String id) Get the Tenant associated with the given id or null if none exists.
Tenant	getTenantByName(String name) Get the Tenant associated with the given name or null if none exists.
void	writeTenant(Tenant tenant) Write the given Tenant to the store.

Methods inherited from interface com.google.common.util.concurrent.Service

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

Method Detail

getTenantByID

Tenant getTenantByID(String id)
                     throws IOException

Get the Tenant associated with the given id or null if none exists.

Parameters:

id - Id of the tenant.

Returns:

Tenant for the given id or null if no such tenant exists.

Throws:

IOException

getTenantByName

Tenant getTenantByName(String name)
                       throws IOException

Get the Tenant associated with the given name or null if none exists.

Parameters:

name - Name of the tenant.

Returns:

Tenant for the given name or null if no such tenant exists.

Throws:

IOException

getAllTenants

List<Tenant> getAllTenants()
                           throws IOException

Get an immutable list of all tenants.

Returns:

Collection of all tenants.

Throws:

IOException

getAllTenantSpecifications

List<TenantSpecification> getAllTenantSpecifications()
                                                     throws IOException

Get an immutable list of all TenantSpecification.

Returns:

Collection of all tenant specifications.

Throws:

IOException

writeTenant

void writeTenant(Tenant tenant)
                 throws IOException

Write the given Tenant to the store. Will overwrite the existing Tenant if one exists.

Parameters:

tenant - Tenant to write.

Throws:

IOException

deleteTenantByName

void deleteTenantByName(String name)
                        throws IOException

Delete the Tenant associated with the given name.

Parameters:

name - Name of the tenant to delete.

Throws:

IOException

getNameForId

String getNameForId(String id)
                    throws IOException

Get the name of the tenant that has the given id, or null if the tenant does not exist.

Parameters:

id - Id of the tenant to get the name for

Returns:

Name of the tenant with the given id, or null if the tenant does not exist

Throws:

IOException