Package org.gcube.application.cms.plugins.implementations

Class AbstractLifeCycleManager

java.lang.Object

org.gcube.application.cms.plugins.implementations.AbstractPlugin

org.gcube.application.cms.plugins.implementations.AbstractLifeCycleManager

All Implemented Interfaces:

org.gcube.application.cms.plugins.InitializablePlugin, org.gcube.application.cms.plugins.LifecycleManager, org.gcube.application.cms.plugins.Plugin

Direct Known Subclasses:

SimpleLifeCycleManager

public abstract class AbstractLifeCycleManager
extends AbstractPlugin
implements org.gcube.application.cms.plugins.LifecycleManager

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	AbstractLifeCycleManager.Events

Field Summary

Fields

Modifier and Type	Field	Description
protected org.gcube.application.geoportal.common.model.plugins.LifecycleManagerDescriptor	DESCRIPTOR
protected org.gcube.application.cms.plugins.PluginManagerInterface	pluginManager
protected org.gcube.application.cms.implementations.ProjectAccess	projectAccess

Constructor Summary

Constructors

Constructor	Description
AbstractLifeCycleManager()

Method Summary

Modifier and Type	Method	Description
protected boolean	canInvokeStep(String stepID, org.gcube.application.geoportal.common.model.document.accounting.User u, org.gcube.application.geoportal.common.model.useCaseDescriptor.HandlerDeclaration config)
org.gcube.application.geoportal.common.model.configuration.Configuration	getCurrentConfiguration(org.gcube.application.cms.plugins.requests.BaseRequest request)
org.gcube.application.geoportal.common.model.plugins.PluginDescriptor	getDescriptor()
org.gcube.application.cms.plugins.reports.InitializationReport	init()
org.gcube.application.cms.plugins.reports.InitializationReport	initInContext()
protected org.gcube.application.cms.plugins.reports.EventExecutionReport	onDeleteDocument(org.gcube.application.cms.plugins.reports.EventExecutionReport report)
protected org.gcube.application.cms.plugins.reports.EventExecutionReport	onDeleteFileSet(org.gcube.application.cms.plugins.reports.EventExecutionReport report)
org.gcube.application.cms.plugins.reports.EventExecutionReport	onEvent(org.gcube.application.cms.plugins.requests.EventExecutionRequest request)
protected org.gcube.application.cms.plugins.reports.EventExecutionReport	onInitDocument(org.gcube.application.cms.plugins.reports.EventExecutionReport report)
protected org.gcube.application.cms.plugins.reports.EventExecutionReport	onUpdateDocument(org.gcube.application.cms.plugins.reports.EventExecutionReport report)
org.gcube.application.cms.plugins.reports.StepExecutionReport	performStep(org.gcube.application.cms.plugins.requests.StepExecutionRequest request)
protected void	registerEvents()
protected void	registerSteps()
org.gcube.application.cms.plugins.reports.EventExecutionReport	setDefault(org.gcube.application.cms.plugins.reports.EventExecutionReport currentReport)	Override this method for programmatic default values management
protected void	setEvent(GuardedEventManager m)
protected void	setStep(GuardedStepExecution e)
void	shutdown()
org.gcube.application.cms.plugins.reports.EventExecutionReport	validate(org.gcube.application.cms.plugins.reports.EventExecutionReport currentReport)

Methods inherited from class org.gcube.application.cms.plugins.implementations.AbstractPlugin

getConfigurationFromProfile, getMultipleDeclarationsFromProfile

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.gcube.application.cms.plugins.LifecycleManager

setPluginManager

Field Detail

pluginManager

protected org.gcube.application.cms.plugins.PluginManagerInterface pluginManager

projectAccess

protected org.gcube.application.cms.implementations.ProjectAccess projectAccess

DESCRIPTOR

protected org.gcube.application.geoportal.common.model.plugins.LifecycleManagerDescriptor DESCRIPTOR

Constructor Detail

AbstractLifeCycleManager

public AbstractLifeCycleManager()

Method Detail

setEvent

protected void setEvent(GuardedEventManager m)

setStep

protected void setStep(GuardedStepExecution e)

onDeleteDocument

protected org.gcube.application.cms.plugins.reports.EventExecutionReport onDeleteDocument(org.gcube.application.cms.plugins.reports.EventExecutionReport report)
                                                                                   throws org.gcube.application.geoportal.common.model.rest.ConfigurationException,
                                                                                          org.gcube.application.cms.plugins.faults.InvalidPluginRequestException,
                                                                                          org.gcube.application.cms.plugins.faults.MaterializationException,
                                                                                          org.gcube.application.cms.plugins.faults.EventException

Throws:

org.gcube.application.geoportal.common.model.rest.ConfigurationException

org.gcube.application.cms.plugins.faults.InvalidPluginRequestException

org.gcube.application.cms.plugins.faults.MaterializationException

org.gcube.application.cms.plugins.faults.EventException

onDeleteFileSet

protected org.gcube.application.cms.plugins.reports.EventExecutionReport onDeleteFileSet(org.gcube.application.cms.plugins.reports.EventExecutionReport report)
                                                                                  throws org.gcube.application.geoportal.common.model.rest.ConfigurationException,
                                                                                         org.gcube.application.cms.plugins.faults.InvalidPluginRequestException,
                                                                                         org.gcube.application.cms.plugins.faults.MaterializationException,
                                                                                         org.gcube.application.cms.plugins.faults.EventException

Throws:

org.gcube.application.geoportal.common.model.rest.ConfigurationException

org.gcube.application.cms.plugins.faults.InvalidPluginRequestException

org.gcube.application.cms.plugins.faults.MaterializationException

org.gcube.application.cms.plugins.faults.EventException

onUpdateDocument

protected org.gcube.application.cms.plugins.reports.EventExecutionReport onUpdateDocument(org.gcube.application.cms.plugins.reports.EventExecutionReport report)

onInitDocument

protected org.gcube.application.cms.plugins.reports.EventExecutionReport onInitDocument(org.gcube.application.cms.plugins.reports.EventExecutionReport report)
                                                                                 throws org.gcube.application.cms.plugins.faults.InvalidPluginRequestException

Throws:

org.gcube.application.cms.plugins.faults.InvalidPluginRequestException

registerEvents

protected void registerEvents()

registerSteps

protected void registerSteps()

performStep

public org.gcube.application.cms.plugins.reports.StepExecutionReport performStep(org.gcube.application.cms.plugins.requests.StepExecutionRequest request)
                                                                          throws org.gcube.application.cms.plugins.faults.StepException,
                                                                                 org.gcube.application.cms.plugins.faults.InvalidPluginRequestException,
                                                                                 org.gcube.application.cms.plugins.faults.InvalidProfileException,
                                                                                 org.gcube.application.geoportal.common.model.rest.ConfigurationException,
                                                                                 org.gcube.application.cms.plugins.faults.InsufficientPrivileges

Specified by:

performStep in interface org.gcube.application.cms.plugins.LifecycleManager

Throws:

org.gcube.application.cms.plugins.faults.StepException

org.gcube.application.cms.plugins.faults.InvalidPluginRequestException

org.gcube.application.cms.plugins.faults.InvalidProfileException

org.gcube.application.geoportal.common.model.rest.ConfigurationException

org.gcube.application.cms.plugins.faults.InsufficientPrivileges

canInvokeStep

protected boolean canInvokeStep(String stepID,
                                org.gcube.application.geoportal.common.model.document.accounting.User u,
                                org.gcube.application.geoportal.common.model.useCaseDescriptor.HandlerDeclaration config)
                         throws org.gcube.application.geoportal.common.model.rest.ConfigurationException

Throws:

org.gcube.application.geoportal.common.model.rest.ConfigurationException

initInContext

public org.gcube.application.cms.plugins.reports.InitializationReport initInContext()
                                                                             throws org.gcube.application.cms.plugins.faults.InitializationException

Specified by:

initInContext in interface org.gcube.application.cms.plugins.InitializablePlugin

Throws:

org.gcube.application.cms.plugins.faults.InitializationException

init

public org.gcube.application.cms.plugins.reports.InitializationReport init()
                                                                    throws org.gcube.application.cms.plugins.faults.InitializationException

Specified by:

init in interface org.gcube.application.cms.plugins.InitializablePlugin

Throws:

org.gcube.application.cms.plugins.faults.InitializationException

getDescriptor

public org.gcube.application.geoportal.common.model.plugins.PluginDescriptor getDescriptor()

Specified by:

getDescriptor in interface org.gcube.application.cms.plugins.Plugin

onEvent

public org.gcube.application.cms.plugins.reports.EventExecutionReport onEvent(org.gcube.application.cms.plugins.requests.EventExecutionRequest request)
                                                                       throws org.gcube.application.cms.plugins.faults.EventException,
                                                                              org.gcube.application.cms.plugins.faults.InvalidPluginRequestException

Specified by:

onEvent in interface org.gcube.application.cms.plugins.LifecycleManager

Throws:

org.gcube.application.cms.plugins.faults.EventException

org.gcube.application.cms.plugins.faults.InvalidPluginRequestException

setDefault

public org.gcube.application.cms.plugins.reports.EventExecutionReport setDefault(org.gcube.application.cms.plugins.reports.EventExecutionReport currentReport)

Override this method for programmatic default values management

Parameters:

currentReport -

Returns:

validate

public org.gcube.application.cms.plugins.reports.EventExecutionReport validate(org.gcube.application.cms.plugins.reports.EventExecutionReport currentReport)

shutdown

public void shutdown()
              throws org.gcube.application.cms.plugins.faults.ShutDownException

Specified by:

shutdown in interface org.gcube.application.cms.plugins.InitializablePlugin

Throws:

org.gcube.application.cms.plugins.faults.ShutDownException

getCurrentConfiguration

public org.gcube.application.geoportal.common.model.configuration.Configuration getCurrentConfiguration(org.gcube.application.cms.plugins.requests.BaseRequest request)
                                                                                                 throws org.gcube.application.geoportal.common.model.rest.ConfigurationException

Specified by:

getCurrentConfiguration in interface org.gcube.application.cms.plugins.LifecycleManager

Throws:

org.gcube.application.geoportal.common.model.rest.ConfigurationException