org.exoplatform.web

Class WebAppController

java.lang.Object

org.exoplatform.web.WebAppController

All Implemented Interfaces:

org.picocontainer.Startable

public class WebAppController
extends Object
implements org.picocontainer.Startable

The WebAppController is the entry point of the GateIn service.

Field Summary

Fields

Modifier and Type	Field and Description
static QualifiedName	HANDLER_PARAM .
protected static org.gatein.common.logging.Logger	log .

Constructor Summary

Constructors

Constructor and Description
WebAppController(org.exoplatform.container.xml.InitParams params) Must have 'controller.config' as init parameter configuration (in xml) that point to the controller.xml used to initialize navigation controller This service component is a container for applications: PortalApplication, PortletApplication, StandaloneApplication....

Method Summary

Modifier and Type	Method and Description
<T extends Application> T	addApplication(T app) Add application (portlet, gadget) to the global application map if and only if it has not been registered yet.
String	findRoutes(String uri)
<T extends Application> T	getApplication(String appId)
List<Application>	getApplicationByType(String type)
Object	getAttribute(String name, Object value)
String	getConfigurationPath()
Router	getRouter()
void	loadConfiguration(String path)
void	onHandlersInit(javax.servlet.ServletConfig config) Delegate init action to handler, for example: PortalRequestHandler have a change to create and register PortalApplication with WebAppController
void	register(WebRequestHandler handler) Register an handler as a component plugin, this method is invoked by the kernel with reflection.
void	reloadConfiguration()
void	removeApplication(String appId)
void	service(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) This is the first method - in the GateIn portal - reached by incoming HTTP request, it acts like a servlet service() method.
void	start()
void	stop()
void	unregister(String[] paths)

Methods inherited from class java.lang.Object

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

Field Detail

HANDLER_PARAM

public static final QualifiedName HANDLER_PARAM

.

log

protected static org.gatein.common.logging.Logger log

.

Constructor Detail

WebAppController

public WebAppController(org.exoplatform.container.xml.InitParams params)
                 throws Exception

Must have 'controller.config' as init parameter configuration (in xml) that point to the controller.xml used to initialize navigation controller This service component is a container for applications: PortalApplication, PortletApplication, StandaloneApplication.... It use the navigation controller to route the request to corresponding handlers (config as service plugin)

Parameters:

params - the init params

Throws:

Exception - any exception

Method Detail

getAttribute

public Object getAttribute(String name,
                           Object value)

getApplication

public <T extends Application> T getApplication(String appId)

getApplicationByType

public List<Application> getApplicationByType(String type)

removeApplication

public void removeApplication(String appId)

getConfigurationPath

public String getConfigurationPath()

loadConfiguration

public void loadConfiguration(String path)
                       throws IOException,
                              RouterConfigException

Throws:

IOException

RouterConfigException

reloadConfiguration

public void reloadConfiguration()
                         throws RouterConfigException,
                                IOException

Throws:

RouterConfigException

IOException

findRoutes

public String findRoutes(String uri)

addApplication

public <T extends Application> T addApplication(T app)

Add application (portlet, gadget) to the global application map if and only if it has not been registered yet.

Type Parameters:

T -

Parameters:

app -

Returns:

register

public void register(WebRequestHandler handler)

Register an handler as a component plugin, this method is invoked by the kernel with reflection.

Parameters:

handler - the handler

unregister

public void unregister(String[] paths)

onHandlersInit

public void onHandlersInit(javax.servlet.ServletConfig config)
                    throws Exception

Delegate init action to handler, for example: PortalRequestHandler have a change to create and register PortalApplication with WebAppController

Parameters:

config -

Throws:

Exception

getRouter

public Router getRouter()

service

public void service(javax.servlet.http.HttpServletRequest req,
                    javax.servlet.http.HttpServletResponse res)
             throws Exception

This is the first method - in the GateIn portal - reached by incoming HTTP request, it acts like a servlet service() method. According to the servlet path used the correct handler is selected and then executed.

During a request the request life cycle is demarcated by calls to RequestLifeCycle.begin(ExoContainer) and RequestLifeCycle.end().

Parameters:

req - the http request

res - the http response

Throws:

Exception - any exception

start

public void start()

Specified by:

start in interface org.picocontainer.Startable

stop

public void stop()

Specified by:

stop in interface org.picocontainer.Startable