org.exoplatform.container

Class RootContainer.PortalContainerPreInitTask

java.lang.Object

org.exoplatform.container.RootContainer.PortalContainerPreInitTask

All Implemented Interfaces:

RootContainer.PortalContainerInitTask

Direct Known Subclasses:

PortalContainer.RegisterTask

Enclosing class:

RootContainer

public abstract static class RootContainer.PortalContainerPreInitTask
extends Object
implements RootContainer.PortalContainerInitTask

This class is used to define a task that needs to be launched before the initialization of a portal container

Field Summary

Fields

Modifier and Type	Field and Description
static String	TYPE The name of the type of task

Constructor Summary

Constructors

Constructor and Description
PortalContainerPreInitTask()

Method Summary

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
String	getType()
void	onAlreadyExists(javax.servlet.ServletContext context, PortalContainer portalContainer) This method is called if the related portal container has already been registered

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.exoplatform.container.RootContainer.PortalContainerInitTask

execute

Field Detail

TYPE

public static final String TYPE

The name of the type of task

See Also:

Constant Field Values

Constructor Detail

PortalContainerPreInitTask

public PortalContainerPreInitTask()

Method Detail

alreadyExists

public final boolean alreadyExists(PortalContainer portalContainer)

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

Specified by:

alreadyExists in interface RootContainer.PortalContainerInitTask

Parameters:

portalContainer - the value of the current portal container

Returns:

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

onAlreadyExists

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

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

Specified by:

onAlreadyExists in interface RootContainer.PortalContainerInitTask

Parameters:

context - the servlet context of the web application

portalContainer - the value of the current portal container

getType

public final String getType()

Specified by:

getType in interface RootContainer.PortalContainerInitTask

Returns:

the type of the task