co.cask.coopr.store.provisioner

Class SQLPluginResourceTypeView

java.lang.Object

co.cask.coopr.store.provisioner.SQLPluginResourceTypeView

All Implemented Interfaces:

PluginResourceTypeView

public class SQLPluginResourceTypeView
extends Object
implements PluginResourceTypeView

SQL database backed implementation of PluginResourceTypeView. Stores all metadata in a single database table.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(ResourceMeta meta) Add the resource metadata to the store.
void	delete(String name, int version) Delete the given version of the given resource from the store.
boolean	exists(String name) Checks whether or not any version of the given resource exists.
boolean	exists(String name, int version) Checks whether or not a specific version of the given resource exists.
ResourceMeta	get(String name, int version) Get the metadata for the given resource name and version.
Map<String,Set<ResourceMeta>>	getAll() Get an immutable map of resource name to all metadata with that name.
Map<String,Set<ResourceMeta>>	getAll(ResourceStatus status) Get an immutable map of resource name to all metadata with that name with the given status.
Set<ResourceMeta>	getAll(String name) Get an immutable set of all resource metadata for the given resource name.
Set<ResourceMeta>	getAll(String name, ResourceStatus status) Get an immutable set of all resource metadata for the given resource name with the given status.
int	getHighestVersion(String name) Get the highest version of given resource, or 0 if the resource does not exist.
Set<ResourceMeta>	getLiveResources() Get an immutable set of all resources that are currently live.
Set<ResourceMeta>	getResourcesToSync() Get an immutable set of all resources that are slated to be active after the next sync.
void	recall(String name, int version) Recall the given resource, moving a resource in the staged state into the inactive state, or moving a resource in the active state into the recalled state.
void	stage(String name, int version) Atomically stage an inactive resource version and deactivate the current staged version if there is one.

Methods inherited from class java.lang.Object

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

Method Detail

exists

public boolean exists(String name)
               throws IOException

Description copied from interface: PluginResourceTypeView

Checks whether or not any version of the given resource exists.

Specified by:

exists in interface PluginResourceTypeView

Parameters:

name - Name of the resource to check for

Returns:

True if the module version exists, false if not

Throws:

IOException

exists

public boolean exists(String name,
             int version)
               throws IOException

Description copied from interface: PluginResourceTypeView

Checks whether or not a specific version of the given resource exists.

Specified by:

exists in interface PluginResourceTypeView

Parameters:

name - Name of the resource to check for

version - Version of the resource to check for

Returns:

True if the module version exists, false if not

Throws:

IOException

add

public void add(ResourceMeta meta)
         throws IOException

Description copied from interface: PluginResourceTypeView

Add the resource metadata to the store. The version given must be unique for the given resource name.

Specified by:

add in interface PluginResourceTypeView

Parameters:

meta - Metadata to add

Throws:

IOException

getHighestVersion

public int getHighestVersion(String name)
                      throws IOException

Description copied from interface: PluginResourceTypeView

Get the highest version of given resource, or 0 if the resource does not exist.

Specified by:

getHighestVersion in interface PluginResourceTypeView

Parameters:

name - Name of the resource to get the highest version of

Returns:

Highest version of given resource, or 0 if the resource does not exist.

Throws:

IOException

get

public ResourceMeta get(String name,
               int version)
                 throws IOException

Description copied from interface: PluginResourceTypeView

Get the metadata for the given resource name and version.

Specified by:

get in interface PluginResourceTypeView

Parameters:

name - Name of the resource to get

version - Version of the resource to get

Returns:

Metadata of the given resource

Throws:

IOException

delete

public void delete(String name,
          int version)
            throws IOException

Description copied from interface: PluginResourceTypeView

Delete the given version of the given resource from the store.

Specified by:

delete in interface PluginResourceTypeView

Parameters:

name - Name of the resource to delete

version - Version of the resource to delete

Throws:

IOException

getAll

public Map<String,Set<ResourceMeta>> getAll()
                                     throws IOException

Description copied from interface: PluginResourceTypeView

Get an immutable map of resource name to all metadata with that name.

Specified by:

getAll in interface PluginResourceTypeView

Returns:

Immutable map of resource name to resource metadata

Throws:

IOException

getAll

public Map<String,Set<ResourceMeta>> getAll(ResourceStatus status)
                                     throws IOException

Description copied from interface: PluginResourceTypeView

Get an immutable map of resource name to all metadata with that name with the given status.

Specified by:

getAll in interface PluginResourceTypeView

Parameters:

status - Status of the resources to get

Returns:

Immutable map of resource name to resource metadata

Throws:

IOException

getAll

public Set<ResourceMeta> getAll(String name)
                         throws IOException

Description copied from interface: PluginResourceTypeView

Get an immutable set of all resource metadata for the given resource name.

Specified by:

getAll in interface PluginResourceTypeView

Parameters:

name - Name of resource to get metadata for

Returns:

Immutable set of all resource metadata for the given resource name

Throws:

IOException

getAll

public Set<ResourceMeta> getAll(String name,
                       ResourceStatus status)
                         throws IOException

Description copied from interface: PluginResourceTypeView

Get an immutable set of all resource metadata for the given resource name with the given status.

Specified by:

getAll in interface PluginResourceTypeView

Parameters:

name - Name of resources to get

status - Status of the resources to get

Returns:

Immutable set of all resource metadata for the given resource name with the given status

Throws:

IOException

getResourcesToSync

public Set<ResourceMeta> getResourcesToSync()
                                     throws IOException

Description copied from interface: PluginResourceTypeView

Get an immutable set of all resources that are slated to be active after the next sync.

Specified by:

getResourcesToSync in interface PluginResourceTypeView

Returns:

Immutable set of all resources that are slated to be active after the next sync.

Throws:

IOException

getLiveResources

public Set<ResourceMeta> getLiveResources()
                                   throws IOException

Description copied from interface: PluginResourceTypeView

Get an immutable set of all resources that are currently live.

Specified by:

getLiveResources in interface PluginResourceTypeView

Returns:

Immutable set of all resources that are currently live.

Throws:

IOException

stage

public void stage(String name,
         int version)
           throws IOException

Description copied from interface: PluginResourceTypeView

Atomically stage an inactive resource version and deactivate the current staged version if there is one. Staging a recalled resource puts it back in an active state. This is a no-op if the given resource is already staged or active, or if the given resource does not exist.

Specified by:

stage in interface PluginResourceTypeView

Parameters:

name - Name of resource to stage

version - Version of resource to stage

Throws:

IOException

recall

public void recall(String name,
          int version)
            throws IOException

Description copied from interface: PluginResourceTypeView

Recall the given resource, moving a resource in the staged state into the inactive state, or moving a resource in the active state into the recalled state. This a no-op if the given resource is already recalled or inactive, or if the given resource does not exist.

Specified by:

recall in interface PluginResourceTypeView

Parameters:

name - Name of resource to recall

version - Version of resource to recall

Throws:

IOException