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:

InitializablePlugin, LifecycleManager, Plugin

Direct Known Subclasses:

SimpleLifeCycleManager

public abstract class AbstractLifeCycleManager
extends AbstractPlugin
implements 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 PluginManagerInterface	pluginManager
protected 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(BaseRequest request)
org.gcube.application.geoportal.common.model.plugins.PluginDescriptor	getDescriptor()
InitializationReport	init()	To be called for static initialization
InitializationReport	initInContext()	To be called once per context
protected EventExecutionReport	onDeleteDocument(EventExecutionReport report)
protected EventExecutionReport	onDeleteFileSet(EventExecutionReport report)
EventExecutionReport	onEvent(EventExecutionRequest request)
protected EventExecutionReport	onInitDocument(EventExecutionReport report)
protected EventExecutionReport	onUpdateDocument(EventExecutionReport report)
StepExecutionReport	performStep(StepExecutionRequest request)
protected void	registerEvents()
protected void	registerSteps()
EventExecutionReport	setDefault(EventExecutionReport currentReport)	Override this method for programmatic default values management
protected void	setEvent(GuardedEventManager m)
protected void	setStep(GuardedStepExecution e)
void	shutdown()	To be called at application shutdown
EventExecutionReport	validate(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 PluginManagerInterface pluginManager

projectAccess

protected 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 EventExecutionReport onDeleteDocument(EventExecutionReport report)
                                         throws org.gcube.application.geoportal.common.model.rest.ConfigurationException,
                                                InvalidPluginRequestException,
                                                MaterializationException,
                                                EventException

Throws:

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

InvalidPluginRequestException

MaterializationException

EventException

onDeleteFileSet

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

Throws:

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

InvalidPluginRequestException

MaterializationException

EventException

onUpdateDocument

protected EventExecutionReport onUpdateDocument(EventExecutionReport report)

onInitDocument

protected EventExecutionReport onInitDocument(EventExecutionReport report)
                                       throws InvalidPluginRequestException

Throws:

InvalidPluginRequestException

registerEvents

protected void registerEvents()

registerSteps

protected void registerSteps()

performStep

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

Specified by:

performStep in interface LifecycleManager

Throws:

StepException

InvalidPluginRequestException

InvalidProfileException

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

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 InitializationReport initInContext()
                                   throws InitializationException

Description copied from interface: InitializablePlugin

To be called once per context

Specified by:

initInContext in interface InitializablePlugin

Returns:

Throws:

InitializationException

init

public InitializationReport init()
                          throws InitializationException

Description copied from interface: InitializablePlugin

To be called for static initialization

Specified by:

init in interface InitializablePlugin

Returns:

Throws:

InitializationException

getDescriptor

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

Specified by:

getDescriptor in interface Plugin

onEvent

public EventExecutionReport onEvent(EventExecutionRequest request)
                             throws EventException,
                                    InvalidPluginRequestException

Specified by:

onEvent in interface LifecycleManager

Throws:

EventException

InvalidPluginRequestException

setDefault

public EventExecutionReport setDefault(EventExecutionReport currentReport)

Override this method for programmatic default values management

Parameters:

currentReport -

Returns:

validate

public EventExecutionReport validate(EventExecutionReport currentReport)

shutdown

public void shutdown()
              throws ShutDownException

Description copied from interface: InitializablePlugin

To be called at application shutdown

Specified by:

shutdown in interface InitializablePlugin

Throws:

ShutDownException

getCurrentConfiguration

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

Specified by:

getCurrentConfiguration in interface LifecycleManager

Throws:

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