Package org.gcube.vremanagement.executor.persistence.postgresql

Class PostgreSQLPersistenceConnector

java.lang.Object

org.gcube.vremanagement.executor.plugin.PluginStateNotification

org.gcube.vremanagement.executor.persistence.SmartExecutorPersistenceConnector

org.gcube.vremanagement.executor.persistence.postgresql.PostgreSQLPersistenceConnector

All Implemented Interfaces:

ScheduledTaskPersistence

public class PostgreSQLPersistenceConnector
extends SmartExecutorPersistenceConnector

Keeps the scheduled tasks and the states of their executions in a PostgreSQL database, in two tables the connector creates when they are missing. Each row holds the JSON of the object and the columns the queries select on; every value of a query is a parameter. A caller reaches only the rows of the Context of its request.

Author:

Luca Frosini (ISTI - CNR)

Field Summary

Fields

Modifier and Type	Field	Description
protected DataSource	dataSource
protected static final String	RUN_ON
protected static final String[]	SCHEMA
protected static final String	STATE_TABLE
protected static final String	TASK_TABLE

Fields inherited from class org.gcube.vremanagement.executor.plugin.PluginStateNotification

inputs

Constructor Summary

Constructors

Constructor	Description
PostgreSQLPersistenceConnector(SmartExecutorPersistenceConfiguration configuration)

Method Summary

Modifier and Type	Method	Description
void	addScheduledTask(ScheduledTask scheduledTask)	Create a Scheduled Task on persistence
void	close()	Close the connection to DB
Map<org.gcube.vremanagement.executor.plugin.PluginState,Long>	countFinalStates(Long since)	Counts the executions of the current Context that reached a final state, by that state: each execution of a Plugin records its final state once.
protected DataSource	createDataSource(SmartExecutorPersistenceConfiguration configuration)
protected void	createSchema()
protected static String	currentContext()
long	deleteStatesBefore(long before)	Deletes the states of the executions of the current Context recorded before a time, except the last state of each task, so that the state of every task can still be read.
org.gcube.vremanagement.executor.plugin.PluginStateEvolution	getPluginInstanceState(UUID uuid, Integer iterationNumber)	Retrieve the status of the iterationNumber (passed as parameter) of a running/run Plugin which is/was identified by the UUID passed as parameter
ScheduledTask	getScheduledTask(UUID uuid)	Return the Scheduled Task if any, null otherwise
protected String	getScheduledTaskJSON(Connection connection, UUID uuid)
List<ScheduledTask>	getScheduledTasks(Collection<String> plugins)	Retrieve from the #SmartExecutorPersistenceConnector the orphaned Scheduled tasks
void	pluginStateEvolution(org.gcube.vremanagement.executor.plugin.PluginStateEvolution pluginStateEvolution, Exception exception)
void	releaseScheduledTask(UUID uuid)	Release the Scheduled Task leaving it as orphan on persistence
void	releaseScheduledTask(ScheduledTask scheduledTask)	Release the Scheduled Task leaving it as orphan on persistence
void	removeScheduledTask(UUID uuid)	Remove from persistence the Scheduled Task.
void	removeScheduledTask(ScheduledTask scheduledTask)	Remove from persistence the Scheduled Task.
void	reserveScheduledTask(ScheduledTask scheduledTask)	Reserve an orphan Scheduled tasks

Methods inherited from class java.lang.Object

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

Field Details

STATE_TABLE

protected static final String STATE_TABLE

See Also:

• Constant Field Values

TASK_TABLE

protected static final String TASK_TABLE

See Also:

• Constant Field Values

RUN_ON

protected static final String RUN_ON

See Also:

• Constant Field Values

SCHEMA

protected static final String[] SCHEMA

dataSource

protected DataSource dataSource

Constructor Details

PostgreSQLPersistenceConnector

public PostgreSQLPersistenceConnector(SmartExecutorPersistenceConfiguration configuration)
                               throws Exception

Throws:

Exception

Method Details

createDataSource

protected DataSource createDataSource(SmartExecutorPersistenceConfiguration configuration)

Parameters:

configuration - the address and the credentials of the database

Returns:

the source of the connections to the database

createSchema

protected void createSchema()
                     throws SQLException

Throws:

SQLException

close

public void close()
           throws Exception

Description copied from class: SmartExecutorPersistenceConnector

Close the connection to DB

Specified by:

close in class SmartExecutorPersistenceConnector

Throws:

Exception - if fails

currentContext

protected static String currentContext()

getPluginInstanceState

public org.gcube.vremanagement.executor.plugin.PluginStateEvolution getPluginInstanceState(UUID uuid,
 Integer iterationNumber)
                                                                                    throws org.gcube.vremanagement.executor.exception.PluginInstanceNotFoundException,
org.gcube.vremanagement.executor.exception.ExecutorException

Description copied from class: SmartExecutorPersistenceConnector

Retrieve the status of the iterationNumber (passed as parameter) of a running/run Plugin which is/was identified by the UUID passed as parameter

Specified by:

getPluginInstanceState in class SmartExecutorPersistenceConnector

Parameters:

uuid - the execution identifier of the running/run Plugin

iterationNumber - the iterationNumber (null to get the last)

Returns:

the actual/last PluginState of the Plugin

Throws:

org.gcube.vremanagement.executor.exception.PluginInstanceNotFoundException - if the plugin instance is not found

org.gcube.vremanagement.executor.exception.ExecutorException - if the operation fails

pluginStateEvolution

public void pluginStateEvolution(org.gcube.vremanagement.executor.plugin.PluginStateEvolution pluginStateEvolution,
 Exception exception)
                          throws Exception

Specified by:

pluginStateEvolution in class org.gcube.vremanagement.executor.plugin.PluginStateNotification

Throws:

Exception

countFinalStates

public Map<org.gcube.vremanagement.executor.plugin.PluginState,Long> countFinalStates(Long since)
                                                                               throws org.gcube.vremanagement.executor.exception.ExecutorException

Description copied from class: SmartExecutorPersistenceConnector

Counts the executions of the current Context that reached a final state, by that state: each execution of a Plugin records its final state once.

Specified by:

countFinalStates in class SmartExecutorPersistenceConnector

Parameters:

since - only the executions that reached their final state at this time or later, in milliseconds since the epoch; null counts all the executions in the database

Returns:

the number of executions by final state, with every final state present

Throws:

org.gcube.vremanagement.executor.exception.ExecutorException - if the operation fails

deleteStatesBefore

public long deleteStatesBefore(long before)
                        throws org.gcube.vremanagement.executor.exception.ExecutorException

Description copied from class: SmartExecutorPersistenceConnector

Deletes the states of the executions of the current Context recorded before a time, except the last state of each task, so that the state of every task can still be read.

Specified by:

deleteStatesBefore in class SmartExecutorPersistenceConnector

Parameters:

before - the time, in milliseconds since the epoch

Returns:

the number of states deleted

Throws:

org.gcube.vremanagement.executor.exception.ExecutorException - if the operation fails

addScheduledTask

public void addScheduledTask(ScheduledTask scheduledTask)
                      throws SchedulePersistenceException

Description copied from interface: ScheduledTaskPersistence

Create a Scheduled Task on persistence

Parameters:

scheduledTask - to create on persistence

Throws:

SchedulePersistenceException - if fails

getScheduledTasks

public List<ScheduledTask> getScheduledTasks(Collection<String> plugins)
                                      throws SchedulePersistenceException

Description copied from interface: ScheduledTaskPersistence

Retrieve from the #SmartExecutorPersistenceConnector the orphaned Scheduled tasks

Returns:

the list of orphaned Scheduled

Throws:

SchedulePersistenceException - if fails

getScheduledTaskJSON

protected String getScheduledTaskJSON(Connection connection,
 UUID uuid)
                               throws SQLException,
SchedulePersistenceException

Returns:

the JSON of the task with the UUID, only in the Context of the caller: an UUID does not reach the tasks of other Contexts

Throws:

SQLException

SchedulePersistenceException

getScheduledTask

public ScheduledTask getScheduledTask(UUID uuid)
                               throws SchedulePersistenceException

Description copied from interface: ScheduledTaskPersistence

Return the Scheduled Task if any, null otherwise

Parameters:

uuid - which identify the Scheduled Task

Returns:

LaunchParameter of the Scheduled task if any, null otherwise

Throws:

SchedulePersistenceException - if fails

reserveScheduledTask

public void reserveScheduledTask(ScheduledTask scheduledTask)
                          throws SchedulePersistenceException

Description copied from interface: ScheduledTaskPersistence

Reserve an orphan Scheduled tasks

Throws:

SchedulePersistenceException - if fails

removeScheduledTask

public void removeScheduledTask(UUID uuid)
                         throws SchedulePersistenceException

Description copied from interface: ScheduledTaskPersistence

Remove from persistence the Scheduled Task.

Parameters:

uuid - the uuid which (will) identify the task on the SmartExecutor instance

Throws:

SchedulePersistenceException

removeScheduledTask

public void removeScheduledTask(ScheduledTask scheduledTask)
                         throws SchedulePersistenceException

Description copied from interface: ScheduledTaskPersistence

Remove from persistence the Scheduled Task.

Throws:

SchedulePersistenceException

releaseScheduledTask

public void releaseScheduledTask(UUID uuid)
                          throws SchedulePersistenceException

Description copied from interface: ScheduledTaskPersistence

Release the Scheduled Task leaving it as orphan on persistence

Parameters:

uuid - the uuid which (will) identify the task on the SmartExecutor instance

Throws:

SchedulePersistenceException

releaseScheduledTask

public void releaseScheduledTask(ScheduledTask scheduledTask)
                          throws SchedulePersistenceException

Description copied from interface: ScheduledTaskPersistence

Release the Scheduled Task leaving it as orphan on persistence

Throws:

SchedulePersistenceException