org.exoplatform.container

Interface RootContainer.PortalContainerInitTask

All Known Implementing Classes:

PortalContainer.RegisterTask, PortalContainer.UnregisterTask, RootContainer.PortalContainerPostCreateTask, RootContainer.PortalContainerPostInitTask, RootContainer.PortalContainerPreInitTask

Enclosing class:

RootContainer

public static interface RootContainer.PortalContainerInitTask

This interface is used to define a task that needs to be launched at a given state during the initialization of a portal container

Method Summary

Methods

Modifier and Type	Method and Description
boolean	alreadyExists(PortalContainer portalContainer) This method allows the implementation to define what the state "already exists" means for a portal container
void	execute(javax.servlet.ServletContext context, PortalContainer portalContainer) Executes the task
String	getType()
void	onAlreadyExists(javax.servlet.ServletContext context, PortalContainer portalContainer) This method is called if the related portal container has already been registered

Method Detail

alreadyExists

boolean alreadyExists(PortalContainer portalContainer)

This method allows the implementation to define what the state "already exists" means for a portal container

Parameters:

portalContainer - the value of the current portal container

Returns:

true if the portal container exists according to the task requirements, false otherwise

onAlreadyExists

void onAlreadyExists(javax.servlet.ServletContext context,
                   PortalContainer portalContainer)

This method is called if the related portal container has already been registered

Parameters:

context - the servlet context of the web application

portalContainer - the value of the current portal container

execute

void execute(javax.servlet.ServletContext context,
           PortalContainer portalContainer)

Executes the task

Parameters:

context - the servlet context of the web application

portalContainer - The portal container on which we would like to execute the task

getType

String getType()

Returns:

the type of the task