co.cask.coopr.store.provisioner

Interface ProvisionerStore

All Superinterfaces:

com.google.common.util.concurrent.Service

All Known Implementing Classes:

SQLProvisionerStore

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

Persistent store for provisioner related information, such as capacity used.

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	deleteProvisioner(String id) Delete the provisioner with the given id.
Collection<Provisioner>	getAllProvisioners() Get all provisioners in the system.
int	getFreeCapacity() Get the total amount of free capacity available across all provisioners.
int	getNumAssignedWorkers(String tenantID) Get the number of workers assigned to the given tenant across all provisioners.
Provisioner	getProvisioner(String id) Get the provisioner for the given id.
Collection<Provisioner>	getProvisionersWithFreeCapacity() Get all provisioners that have free capacity above zero.
Collection<Provisioner>	getTenantProvisioners(String tenantId) Get all provisioners that are assigned workers for the given tenant.
Collection<Provisioner>	getTimedOutProvisioners(long idleTimestamp) Get all provisioners that have not sent a heartbeat since the given timestamp in milliseconds.
void	setHeartbeat(String provisionerId, long ts) Set the last heartbeat time of the given provisioner to the given timestamp in milliseconds.
void	writeProvisioner(Provisioner provisioner) Write the given provisioner.

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

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

Method Detail

getAllProvisioners

Collection<Provisioner> getAllProvisioners()
                                           throws IOException

Get all provisioners in the system.

Returns:

Unmodifiable collection of all provisioners in the system

Throws:

IOException

getProvisionersWithFreeCapacity

Collection<Provisioner> getProvisionersWithFreeCapacity()
                                                        throws IOException

Get all provisioners that have free capacity above zero.

Returns:

Unmodifiable collection of all provisioners with free capacity above zero

Throws:

IOException

getTimedOutProvisioners

Collection<Provisioner> getTimedOutProvisioners(long idleTimestamp)
                                                throws IOException

Get all provisioners that have not sent a heartbeat since the given timestamp in milliseconds.

Parameters:

idleTimestamp - Timestamp to use as a cutoff. Provisioners that have not sent a heartbeat since this timestamp are returned

Returns:

Unmodifiable collection of all provisioners that have not sent a heartbeat since the given timestamp in milliseconds.

Throws:

IOException

getTenantProvisioners

Collection<Provisioner> getTenantProvisioners(String tenantId)
                                              throws IOException

Get all provisioners that are assigned workers for the given tenant.

Parameters:

tenantId - Id of the tenant to get provisioners for

Returns:

Unmodifiable collection of all provisioners that are assigned workers for the given tenant

Throws:

IOException

getProvisioner

Provisioner getProvisioner(String id)
                           throws IOException

Get the provisioner for the given id.

Parameters:

id - Id of the provisioner to get

Returns:

Provisioner for the given id

Throws:

IOException

writeProvisioner

void writeProvisioner(Provisioner provisioner)
                      throws IOException

Write the given provisioner.

Parameters:

provisioner - Provisioner to write

Throws:

IOException

deleteProvisioner

void deleteProvisioner(String id)
                       throws IOException

Delete the provisioner with the given id.

Parameters:

id - Id of the provisioner to delete

Throws:

IOException

setHeartbeat

void setHeartbeat(String provisionerId,
                long ts)
                  throws IOException

Set the last heartbeat time of the given provisioner to the given timestamp in milliseconds.

Parameters:

provisionerId - Id of the provisioner whose heartbeat time should be set

ts - Timestamp in milliseconds to set the heartbeat time to

Throws:

IOException

getFreeCapacity

int getFreeCapacity()
                    throws IOException

Get the total amount of free capacity available across all provisioners.

Returns:

Total amount of free capacity available across all provisioners

Throws:

IOException

getNumAssignedWorkers

int getNumAssignedWorkers(String tenantID)
                          throws IOException

Get the number of workers assigned to the given tenant across all provisioners.

Parameters:

tenantID - Id of the tenant to get the number of assigned workers for

Returns:

Number of workers assigned to the given tenant across all provisioners

Throws:

IOException