org.nuxeo.ecm.webengine
Class WebEngine

java.lang.Object
  org.nuxeo.ecm.webengine.WebEngine

All Implemented Interfaces:

ResourceLocator

public class WebEngine
extends java.lang.Object
implements ResourceLocator

Author:

Bogdan Stefanescu

Field Summary

static java.lang.String

SKIN_PATH_PREFIX_KEY

Constructor Summary

WebEngine(java.io.File root)

WebEngine(ResourceRegistry registry, java.io.File root)

Method Summary

void	addResourceBinding(ResourceBinding binding) Manage jax-rs root resource bindings
static WebContext	getActiveContext()
AnnotationManager	getAnnotationManager()
ApplicationManager	getApplicationManager() TODO: This is deprecating ModuleManager
ResourceBinding[]	getBindings()
java.io.File	getDeploymentDirectory()
java.lang.String	getDevMode()
java.util.Map<java.lang.String,java.lang.Object>	getEnvironment()
GlobalTypes	getGlobalTypes()
java.lang.String	getMimeType(java.lang.String ext)
Module	getModule(java.lang.String name)
ModuleManager	getModuleManager()
java.io.File	getModulesDirectory()
java.io.File[]	getRegisteredModules() Makes a copy to avoid concurrent modification exceptions.
ResourceRegistry	getRegistry() Deprecated.
ReloadManager	getReloadManager()
RenderingEngine	getRendering()
RequestConfiguration	getRequestConfiguration()
java.io.File	getResourceFile(java.lang.String key) Get a file resource given a key
java.net.URL	getResourceURL(java.lang.String key) Gets an URL resource given a key
java.io.File	getRootDirectory()
Scripting	getScripting()
java.lang.String	getSkinPathPrefix()
WebLoader	getWebLoader()
void	initJspRequestSupport(javax.servlet.GenericServlet servlet, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
boolean	isDevMode()
java.lang.Class<?>	loadClass(java.lang.String className)
void	loadJspTaglib(javax.servlet.GenericServlet servlet) JSP taglib support
void	registerModule(java.io.File config) Registers a module reference given its configuration file.
void	registerModule(java.io.File config, boolean addToClassPath)
void	registerRenderingExtension(java.lang.String id, java.lang.Object obj)
void	reload() Reloads configuration.
void	reload2() reload for we 2.
void	reloadModules()
void	removeResourceBinding(ResourceBinding binding)
static void	setActiveContext(WebContext ctx)
void	setDevMode(java.lang.String devModeId)
void	setSkinPathPrefix(java.lang.String skinPathPrefix)
void	start()
void	stop()
void	unregisterRenderingExtension(java.lang.String id)

Methods inherited from class java.lang.Object

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

Field Detail

SKIN_PATH_PREFIX_KEY

public static final java.lang.String SKIN_PATH_PREFIX_KEY

See Also:

Constant Field Values

Constructor Detail

WebEngine

public WebEngine(java.io.File root)

WebEngine

public WebEngine(ResourceRegistry registry,
                 java.io.File root)

Method Detail

getActiveContext

public static WebContext getActiveContext()

setActiveContext

public static void setActiveContext(WebContext ctx)

getRequestConfiguration

public RequestConfiguration getRequestConfiguration()

getApplicationManager

public ApplicationManager getApplicationManager()

TODO: This is deprecating ModuleManager

loadJspTaglib

public void loadJspTaglib(javax.servlet.GenericServlet servlet)

JSP taglib support

initJspRequestSupport

public void initJspRequestSupport(javax.servlet.GenericServlet servlet,
                                  javax.servlet.http.HttpServletRequest request,
                                  javax.servlet.http.HttpServletResponse response)

getWebLoader

public WebLoader getWebLoader()

setSkinPathPrefix

public void setSkinPathPrefix(java.lang.String skinPathPrefix)

getSkinPathPrefix

public java.lang.String getSkinPathPrefix()

getRegistry

@Deprecated
public ResourceRegistry getRegistry()

Deprecated.

loadClass

public java.lang.Class<?> loadClass(java.lang.String className)
                             throws java.lang.ClassNotFoundException

Throws:

java.lang.ClassNotFoundException

getGlobalTypes

public GlobalTypes getGlobalTypes()

getMimeType

public java.lang.String getMimeType(java.lang.String ext)

getAnnotationManager

public AnnotationManager getAnnotationManager()

isDevMode

public boolean isDevMode()

getDevMode

public java.lang.String getDevMode()

setDevMode

public void setDevMode(java.lang.String devModeId)

registerRenderingExtension

public void registerRenderingExtension(java.lang.String id,
                                       java.lang.Object obj)

unregisterRenderingExtension

public void unregisterRenderingExtension(java.lang.String id)

getEnvironment

public java.util.Map<java.lang.String,java.lang.Object> getEnvironment()

getScripting

public Scripting getScripting()

registerModule

public void registerModule(java.io.File config)

Registers a module reference given its configuration file. The module configuration is not yet loaded. It will be loaded the first time an HTTP request will be made.

registerModule

public void registerModule(java.io.File config,
                           boolean addToClassPath)

getRegisteredModules

public java.io.File[] getRegisteredModules()

Makes a copy to avoid concurrent modification exceptions.

getModuleManager

public ModuleManager getModuleManager()

getModule

public Module getModule(java.lang.String name)

getRootDirectory

public java.io.File getRootDirectory()

getDeploymentDirectory

public java.io.File getDeploymentDirectory()

getModulesDirectory

public java.io.File getModulesDirectory()

getReloadManager

public ReloadManager getReloadManager()

getRendering

public RenderingEngine getRendering()

addResourceBinding

public void addResourceBinding(ResourceBinding binding)

Manage jax-rs root resource bindings

removeResourceBinding

public void removeResourceBinding(ResourceBinding binding)

getBindings

public ResourceBinding[] getBindings()

reload2

public void reload2()

reload for we 2.

reload

public void reload()

Reloads configuration.

reloadModules

public void reloadModules()

start

public void start()

stop

public void stop()

getResourceURL

public java.net.URL getResourceURL(java.lang.String key)

Description copied from interface: ResourceLocator

Gets an URL resource given a key

Specified by:

getResourceURL in interface ResourceLocator

Parameters:

key - the resource key

Returns:

the resource URL or null if no such result was found

getResourceFile

public java.io.File getResourceFile(java.lang.String key)

Description copied from interface: ResourceLocator

Get a file resource given a key

Specified by:

getResourceFile in interface ResourceLocator

Returns: