mobi.designmyapp.common.instance.provider

Class InstanceProvider

java.lang.Object

mobi.designmyapp.common.instance.provider.InstanceProvider

All Implemented Interfaces:

Comparable<InstanceProvider>

public abstract class InstanceProvider
extends Object
implements Comparable<InstanceProvider>

This class represents an instance provider, a provider manage instances (@see mobi.designmyapp.common.instance.model.Instance) Created by Jean Blanchard on 28/10/14.

Field Summary

Fields

Modifier and Type	Field and Description
protected List<Instance>	instances
protected Integer	poolSize
protected Integer	priority
protected Integer	ttl

Constructor Summary

Constructors

Constructor and Description
InstanceProvider()

Method Summary

Modifier and Type	Method and Description
abstract boolean	canCreateInstance() Indicate if the InstanceProvider can create instances checking poolSize and running instances List.
int	compareTo(InstanceProvider instanceProvider) Default implementation of compareTo for the InstanceManager.
abstract int	getActiveCount() Retrieve the number of RUNNING instances.
abstract Instance	getInstance(String instanceId) Retrieve a single instance by its id, null if the id is not found.
abstract List<Instance>	getInstances() Retrieve deployed instances.
abstract String	getName() Friendly name for this provider.
Integer	getPoolSize()
Integer	getPriority()
abstract Status	getStatus() Retrieve the status of this InstanceProvider.
Integer	getTtl() Return the provider-level time-to-live for default instances.
abstract void	refreshInstancesState() Refresh the status of the instances.
abstract Instance	restart(String instanceId) Restart an instance.
void	setPoolSize(Integer poolSize)
void	setPriority(Integer priority)
abstract Instance	start(String imageName, List<String> options, List<String> args) Start a new instance.
abstract void	stop(String instanceId) Terminate an instance.

Methods inherited from class java.lang.Object

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

Field Detail

instances

protected List<Instance> instances

poolSize

protected Integer poolSize

ttl

protected Integer ttl

priority

protected Integer priority

Constructor Detail

InstanceProvider

public InstanceProvider()

Method Detail

getInstances

public abstract List<Instance> getInstances()

Retrieve deployed instances.

Returns:

deployed instances

refreshInstancesState

public abstract void refreshInstancesState()

Refresh the status of the instances.

getInstance

public abstract Instance getInstance(String instanceId)

Retrieve a single instance by its id, null if the id is not found.

Parameters:

instanceId - instance id to retrieve

Returns:

the instance or null if not found

getPoolSize

public Integer getPoolSize()

setPoolSize

public void setPoolSize(Integer poolSize)

getPriority

public Integer getPriority()

setPriority

public void setPriority(Integer priority)

getName

public abstract String getName()

Friendly name for this provider.

Returns:

the name of the provider

start

public abstract Instance start(String imageName,
                               List<String> options,
                               List<String> args)

Start a new instance.

Parameters:

imageName - String representing the kind of instance to launch

options - List representing the option to use when starting the instance

args - List representing the args to use when starting the instance

Returns:

the started instance if no errors append

stop

public abstract void stop(String instanceId)

Terminate an instance.

Parameters:

instanceId - instance id to terminate

restart

public abstract Instance restart(String instanceId)

Restart an instance.

Parameters:

instanceId - instance Id to restart

Returns:

the restarted instance

getStatus

public abstract Status getStatus()

Retrieve the status of this InstanceProvider.

Returns:

InstanceProvider status @see mobi.designmyapp.common.instance.model.Status

canCreateInstance

public abstract boolean canCreateInstance()

Indicate if the InstanceProvider can create instances checking poolSize and running instances List.

Returns:

boolean indicating whether a new instance can be started.

getActiveCount

public abstract int getActiveCount()

Retrieve the number of RUNNING instances.

Returns:

number of RUNNING instances

getTtl

public Integer getTtl()

Return the provider-level time-to-live for default instances.

Returns:

time-to-live

compareTo

public int compareTo(InstanceProvider instanceProvider)

Default implementation of compareTo for the InstanceManager.

Specified by:

compareTo in interface Comparable<InstanceProvider>