org.nuxeo.ecm.webengine

Class WebEngineComponent

java.lang.Object

org.nuxeo.runtime.model.DefaultComponent

org.nuxeo.ecm.webengine.WebEngineComponent

All Implemented Interfaces:

Adaptable, Component, Extensible, TimestampedService

public class WebEngineComponent
extends DefaultComponent

TODO remove old WebEngine references and rename WebEngine2 to WebEngine

Author:

Bogdan Stefanescu

Field Summary

Fields

Modifier and Type	Field and Description
static String	FORM_XP
static String	GUARD_XP
static ComponentName	NAME
static String	RENDERING_EXTENSION_XP
static String	REQUEST_CONFIGURATION_XP
static String	RESOURCE_BINDING_XP

Constructor Summary

Constructors

Constructor and Description
WebEngineComponent()

Method Summary

Methods

Modifier and Type	Method and Description
void	activate(ComponentContext context) Activates the component.
void	deactivate(ComponentContext context) Deactivates the component.
<T> T	getAdapter(Class<T> adapter) Returns an object which is an instance of the given class associated with this object.
WebEngine	getEngine()
void	registerContribution(Object contribution, String extensionPoint, ComponentInstance contributor)
void	unregisterContribution(Object contribution, String extensionPoint, ComponentInstance contributor)

Methods inherited from class org.nuxeo.runtime.model.DefaultComponent

applicationStarted, getApplicationStartedOrder, getLastModified, registerExtension, setLastModified, unregisterExtension

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final ComponentName NAME

RENDERING_EXTENSION_XP

public static final String RENDERING_EXTENSION_XP

See Also:

Constant Field Values

RESOURCE_BINDING_XP

public static final String RESOURCE_BINDING_XP

See Also:

Constant Field Values

REQUEST_CONFIGURATION_XP

public static final String REQUEST_CONFIGURATION_XP

See Also:

Constant Field Values

GUARD_XP

public static final String GUARD_XP

See Also:

Constant Field Values

FORM_XP

public static final String FORM_XP

See Also:

Constant Field Values

Constructor Detail

WebEngineComponent

public WebEngineComponent()

Method Detail

activate

public void activate(ComponentContext context)
              throws Exception

Description copied from interface: Component

Activates the component.

This method is called by the runtime when a component is activated.

Specified by:

activate in interface Component

Overrides:

activate in class DefaultComponent

Parameters:

context - the runtime context

Throws:

Exception - if an error occurs during activation

deactivate

public void deactivate(ComponentContext context)
                throws Exception

Description copied from interface: Component

Deactivates the component.

This method is called by the runtime when a component is deactivated.

Specified by:

deactivate in interface Component

Overrides:

deactivate in class DefaultComponent

Parameters:

context - the runtime context

Throws:

Exception - if an error occurs during activation

getEngine

public WebEngine getEngine()

registerContribution

public void registerContribution(Object contribution,
                        String extensionPoint,
                        ComponentInstance contributor)
                          throws Exception

Overrides:

registerContribution in class DefaultComponent

Throws:

Exception

unregisterContribution

public void unregisterContribution(Object contribution,
                          String extensionPoint,
                          ComponentInstance contributor)
                            throws Exception

Overrides:

unregisterContribution in class DefaultComponent

Throws:

Exception

getAdapter

public <T> T getAdapter(Class<T> adapter)

Description copied from interface: Adaptable

Returns an object which is an instance of the given class associated with this object. Returns null if no such object can be found.

Specified by:

getAdapter in interface Adaptable

Overrides:

getAdapter in class DefaultComponent

Parameters:

adapter - the adapter class to look up

Returns:

a object castable to the given class, or null if this object does not have an adapter for the given class