org.nuxeo.ecm.webengine

Class WebEngine

java.lang.Object

org.nuxeo.ecm.webengine.WebEngine

All Implemented Interfaces:

ResourceLocator

public class WebEngine
extends Object
implements ResourceLocator

Author:

Bogdan Stefanescu

Field Summary

Fields

Modifier and Type	Field and Description
static String	SKIN_PATH_PREFIX_KEY

Constructor Summary

Constructors

Constructor and Description
WebEngine(File root)
WebEngine(ResourceRegistry registry, File root)

Method Summary

Methods

Modifier and Type	Method and Description
void	addApplication(WebEngineModule app)
void	addResourceBinding(ResourceBinding binding) Deprecated. resources are deprecated - you should use a jax-rs application to declare more resources.
void	flushCache()
static WebContext	getActiveContext()
AnnotationManager	getAnnotationManager()
WebEngineModule[]	getApplications()
ResourceBinding[]	getBindings() Deprecated. resources are deprecated - you should use a jax-rs application to declare more resources.
File	getDeploymentDirectory()
Map<String,Object>	getEnvironment()
GlobalTypes	getGlobalTypes()
String	getMimeType(String ext)
Module	getModule(String name)
ModuleManager	getModuleManager()
File	getModulesDirectory()
ResourceRegistry	getRegistry() Deprecated.
RenderingEngine	getRendering()
RequestConfiguration	getRequestConfiguration()
File	getResourceFile(String key) Get a file resource given a key
URL	getResourceURL(String key) Gets an URL resource given a key
File	getRootDirectory()
Scripting	getScripting()
String	getSkinPathPrefix()
WebLoader	getWebLoader()
void	initJspRequestSupport(GenericServlet servlet, HttpServletRequest request, HttpServletResponse response)
boolean	isDirty()
Class<?>	loadClass(String className)
void	loadJspTaglib(GenericServlet servlet) JSP taglib support
void	registerRenderingExtension(String id, Object obj)
void	reload() Reloads configuration.
void	reloadModules()
void	removeResourceBinding(ResourceBinding binding) Deprecated. resources are deprecated - you should use a jax-rs application to declare more resources.
void	setDirty(boolean dirty)
void	setSkinPathPrefix(String skinPathPrefix)
void	start()
void	stop()
boolean	tryReload()
void	unregisterRenderingExtension(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 String SKIN_PATH_PREFIX_KEY

See Also:

Constant Field Values

Constructor Detail

WebEngine

public WebEngine(File root)

WebEngine

public WebEngine(ResourceRegistry registry,
         File root)

Method Detail

getActiveContext

public static WebContext getActiveContext()

getRequestConfiguration

public RequestConfiguration getRequestConfiguration()

loadJspTaglib

public void loadJspTaglib(GenericServlet servlet)

JSP taglib support

initJspRequestSupport

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

getWebLoader

public WebLoader getWebLoader()

setSkinPathPrefix

public void setSkinPathPrefix(String skinPathPrefix)

getSkinPathPrefix

public String getSkinPathPrefix()

getRegistry

@Deprecated
public ResourceRegistry getRegistry()

Deprecated.

loadClass

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

Throws:

ClassNotFoundException

getGlobalTypes

public GlobalTypes getGlobalTypes()

getMimeType

public String getMimeType(String ext)

getAnnotationManager

public AnnotationManager getAnnotationManager()

registerRenderingExtension

public void registerRenderingExtension(String id,
                              Object obj)

unregisterRenderingExtension

public void unregisterRenderingExtension(String id)

getEnvironment

public Map<String,Object> getEnvironment()

getScripting

public Scripting getScripting()

getApplications

public WebEngineModule[] getApplications()

addApplication

public void addApplication(WebEngineModule app)

getModuleManager

public ModuleManager getModuleManager()

getModule

public Module getModule(String name)

getRootDirectory

public File getRootDirectory()

getDeploymentDirectory

public File getDeploymentDirectory()

getModulesDirectory

public File getModulesDirectory()

getRendering

public RenderingEngine getRendering()

addResourceBinding

@Deprecated
public void addResourceBinding(ResourceBinding binding)

Deprecated. resources are deprecated - you should use a jax-rs application to declare more resources.

Manage jax-rs root resource bindings

removeResourceBinding

@Deprecated
public void removeResourceBinding(ResourceBinding binding)

Deprecated. resources are deprecated - you should use a jax-rs application to declare more resources.

getBindings

@Deprecated
public ResourceBinding[] getBindings()

Deprecated. resources are deprecated - you should use a jax-rs application to declare more resources.

setDirty

public void setDirty(boolean dirty)

tryReload

public boolean tryReload()

isDirty

public boolean isDirty()

flushCache

public void flushCache()

reload

public void reload()

Reloads configuration.

reloadModules

public void reloadModules()

start

public void start()

stop

public void stop()

getResourceURL

public URL getResourceURL(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 File getResourceFile(String key)

Description copied from interface: ResourceLocator

Get a file resource given a key

Specified by:

getResourceFile in interface ResourceLocator

Returns: