org.gcube.vremanagement.executor.persistence.couchdb

Class CouchDBPersistenceConnector

java.lang.Object

org.gcube.vremanagement.executor.persistence.SmartExecutorPersistenceConnector

org.gcube.vremanagement.executor.persistence.couchdb.CouchDBPersistenceConnector

All Implemented Interfaces:

ScheduledTaskConfiguration, org.gcube.vremanagement.executor.plugin.PluginStateNotification

public class CouchDBPersistenceConnector
extends SmartExecutorPersistenceConnector
implements ScheduledTaskConfiguration

Author:

Luca Frosini (ISTI - CNR) http://www.lucafrosini.com/

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	_ID_JSON_FIELD
protected static String	_REV_JSON_FIELD
protected static String	ACTIVE_VIEW
protected org.ektorp.CouchDbConnector	couchDbConnector
protected org.ektorp.CouchDbInstance	couchDbInstance
protected static String	DB_NAME
protected static int	LAST
protected static String	MAP_REDUCE__DESIGN
protected static String	ORPHAN_VIEW
protected static String	PLUGIN_STATE
protected static String	PLUGIN_STATE_DOCUMENT
protected static String	PLUGIN_STATE_VIEW_ABANDONED
protected static String	PREVIOUSLY_USED_BY
protected static String	RESERVATION_TIMESTAMP
protected static String	RESERVED_BY
protected static String	SCHEDULED_TASK_TYPE
protected static String	SCHEDULED_TASKS_DOCUMENT
protected static String	TYPE_JSON_FIELD
protected static String	USED_BY_FIELD

Constructor Summary

Constructors

Constructor and Description
CouchDBPersistenceConnector(SmartExecutorPersistenceConfiguration configuration)

Method Summary

Methods

Modifier and Type	Method and Description
void	addScheduledTask(UUID uuid, String consumerID, org.gcube.vremanagement.executor.api.types.LaunchParameter parameter) Create a Scheduled Task on persistence
void	close() Close the connection to DB
protected void	createItem(org.codehaus.jackson.JsonNode node, String id)
protected void	createItem(org.json.JSONObject obj, String id)
protected void	deleteItem(String id, String revision)
protected List<org.gcube.vremanagement.executor.api.types.LaunchParameter>	findOrphanedScheduledTasks()
protected void	freeOrphanedScheduledTasks()
List<org.gcube.vremanagement.executor.api.types.LaunchParameter>	getAvailableScheduledTasks() Retrieve from the #SmartExecutorPersistenceConnector the orphaned Scheduled tasks
org.gcube.vremanagement.executor.plugin.PluginState	getLastPluginInstanceState(UUID uuid) Deprecated.
protected org.json.JSONObject	getObjectByID(String id)
org.gcube.vremanagement.executor.plugin.PluginState	getPluginInstanceState(UUID uuid, int iterationNumber) Deprecated.
org.gcube.vremanagement.executor.api.types.LaunchParameter	getScheduledTask(UUID uuid) Return the Scheduled Task if any, null otherwise
protected org.ektorp.http.HttpClient	initHttpClient(URL url, String username, String password)
void	pluginStateEvolution(org.gcube.vremanagement.executor.plugin.PluginStateEvolution pluginStateEvolution)
protected void	prepareConnection(SmartExecutorPersistenceConfiguration configuration)
protected org.ektorp.ViewResult	query(org.ektorp.ViewQuery query)
protected org.gcube.vremanagement.executor.plugin.PluginState	reallyQuery(org.gcube.vremanagement.executor.plugin.PluginDeclaration pluginDeclaration, UUID uuid, int iterationNumber)
void	releaseScheduledTask(UUID uuid) Release the Scheduled Task leaving it as orphan on persistence
void	removeScheduledTask(UUID uuid) Remove from persistence the Scheduled Task.
void	reserveScheduledTask(UUID uuid, String consumerID) Reserve an orphan Scheduled tasks
protected void	updateItem(org.json.JSONObject obj)

Methods inherited from class java.lang.Object

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

Field Detail

couchDbInstance

protected org.ektorp.CouchDbInstance couchDbInstance

couchDbConnector

protected org.ektorp.CouchDbConnector couchDbConnector

DB_NAME

protected static final String DB_NAME

See Also:

Constant Field Values

_ID_JSON_FIELD

protected static final String _ID_JSON_FIELD

See Also:

Constant Field Values

_REV_JSON_FIELD

protected static final String _REV_JSON_FIELD

See Also:

Constant Field Values

TYPE_JSON_FIELD

protected static final String TYPE_JSON_FIELD

See Also:

Constant Field Values

LAST

protected static final int LAST

See Also:

Constant Field Values

MAP_REDUCE__DESIGN

protected static final String MAP_REDUCE__DESIGN

See Also:

Constant Field Values

PLUGIN_STATE_DOCUMENT

protected static final String PLUGIN_STATE_DOCUMENT

See Also:

Constant Field Values

PLUGIN_STATE

protected static final String PLUGIN_STATE

See Also:

Constant Field Values

PLUGIN_STATE_VIEW_ABANDONED

protected static final String PLUGIN_STATE_VIEW_ABANDONED

See Also:

Constant Field Values

SCHEDULED_TASKS_DOCUMENT

protected static final String SCHEDULED_TASKS_DOCUMENT

See Also:

Constant Field Values

ACTIVE_VIEW

protected static final String ACTIVE_VIEW

See Also:

Constant Field Values

ORPHAN_VIEW

protected static final String ORPHAN_VIEW

See Also:

Constant Field Values

USED_BY_FIELD

protected static final String USED_BY_FIELD

See Also:

Constant Field Values

RESERVED_BY

protected static final String RESERVED_BY

See Also:

Constant Field Values

PREVIOUSLY_USED_BY

protected static final String PREVIOUSLY_USED_BY

See Also:

Constant Field Values

RESERVATION_TIMESTAMP

protected static final String RESERVATION_TIMESTAMP

See Also:

Constant Field Values

SCHEDULED_TASK_TYPE

protected static final String SCHEDULED_TASK_TYPE

See Also:

Constant Field Values

Constructor Detail

CouchDBPersistenceConnector

public CouchDBPersistenceConnector(SmartExecutorPersistenceConfiguration configuration)
                            throws Exception

Throws:

Exception

Method Detail

initHttpClient

protected org.ektorp.http.HttpClient initHttpClient(URL url,
                                        String username,
                                        String password)

prepareConnection

protected void prepareConnection(SmartExecutorPersistenceConfiguration configuration)
                          throws Exception

Throws:

Exception

query

protected org.ektorp.ViewResult query(org.ektorp.ViewQuery query)

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

updateItem

protected void updateItem(org.json.JSONObject obj)
                   throws Exception

Throws:

Exception

getObjectByID

protected org.json.JSONObject getObjectByID(String id)
                                     throws Exception

Throws:

Exception

createItem

protected void createItem(org.json.JSONObject obj,
              String id)
                   throws Exception

Throws:

Exception

createItem

protected void createItem(org.codehaus.jackson.JsonNode node,
              String id)
                   throws Exception

Throws:

Exception

deleteItem

protected void deleteItem(String id,
              String revision)
                   throws org.ektorp.UpdateConflictException,
                          Exception

Throws:

org.ektorp.UpdateConflictException

Exception

pluginStateEvolution

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

Specified by:

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

Throws:

Exception

getPluginInstanceState

@Deprecated
public org.gcube.vremanagement.executor.plugin.PluginState getPluginInstanceState(UUID uuid,
                                                                                    int iterationNumber)
                                                                           throws Exception

Deprecated.

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

Returns:

the actual/last PluginState of the Plugin

Throws:

Exception - if fails

getLastPluginInstanceState

@Deprecated
public org.gcube.vremanagement.executor.plugin.PluginState getLastPluginInstanceState(UUID uuid)
                                                                               throws Exception

Deprecated.

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

Specified by:

getLastPluginInstanceState in class SmartExecutorPersistenceConnector

Parameters:

uuid - the execution identifier of the running/run Plugin

Returns:

the actual/last PluginState of the Plugin

Throws:

Exception - if fails

reallyQuery

protected org.gcube.vremanagement.executor.plugin.PluginState reallyQuery(org.gcube.vremanagement.executor.plugin.PluginDeclaration pluginDeclaration,
                                                              UUID uuid,
                                                              int iterationNumber)
                                                                   throws Exception

Parameters:

uuid -

iterationNumber - -1 means LAST

Returns:

Throws:

Exception

findOrphanedScheduledTasks

protected List<org.gcube.vremanagement.executor.api.types.LaunchParameter> findOrphanedScheduledTasks()

freeOrphanedScheduledTasks

protected void freeOrphanedScheduledTasks()

getAvailableScheduledTasks

public List<org.gcube.vremanagement.executor.api.types.LaunchParameter> getAvailableScheduledTasks()
                                                                                            throws SchedulePersistenceException

Retrieve from the #SmartExecutorPersistenceConnector the orphaned Scheduled tasks

Specified by:

getAvailableScheduledTasks in interface ScheduledTaskConfiguration

Returns:

the list of orphaned Scheduled

Throws:

SchedulePersistenceException - if fails

addScheduledTask

public void addScheduledTask(UUID uuid,
                    String consumerID,
                    org.gcube.vremanagement.executor.api.types.LaunchParameter parameter)
                      throws SchedulePersistenceException

Create a Scheduled Task on persistence

Specified by:

addScheduledTask in interface ScheduledTaskConfiguration

Parameters:

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

Throws:

SchedulePersistenceException - if fails

reserveScheduledTask

public void reserveScheduledTask(UUID uuid,
                        String consumerID)
                          throws SchedulePersistenceException

Reserve an orphan Scheduled tasks

Specified by:

reserveScheduledTask in interface ScheduledTaskConfiguration

Parameters:

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

Throws:

SchedulePersistenceException - if fails

removeScheduledTask

public void removeScheduledTask(UUID uuid)
                         throws SchedulePersistenceException

Remove from persistence the Scheduled Task.

Specified by:

removeScheduledTask in interface ScheduledTaskConfiguration

Parameters:

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

Throws:

SchedulePersistenceException

releaseScheduledTask

public void releaseScheduledTask(UUID uuid)
                          throws SchedulePersistenceException

Release the Scheduled Task leaving it as orphan on persistence

Specified by:

releaseScheduledTask in interface ScheduledTaskConfiguration

Parameters:

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

Throws:

SchedulePersistenceException

getScheduledTask

public org.gcube.vremanagement.executor.api.types.LaunchParameter getScheduledTask(UUID uuid)
                                                                            throws SchedulePersistenceException

Return the Scheduled Task if any, null otherwise

Specified by:

getScheduledTask in interface ScheduledTaskConfiguration

Parameters:

uuid - which identify the Scheduled Task

Returns:

LaunchParameter of the Scheduled task if any, null otherwise

Throws:

SchedulePersistenceException - if fails