oracle.jdeveloper.webapp.design
Class DTEManager

java.lang.Object
  oracle.jdeveloper.webapp.design.DTEManager

public class DTEManager
extends java.lang.Object

Public interface to JSP VE Design Time Engine

Field Summary

static java.lang.String	DTE_DISABLED_PROJECT_PROPERTY Name of the transient project properties that is set to Boolean.TRUE when the web-app auto restarted is stopped.
protected static java.lang.String	DTE_MANAGER_NAME

Constructor Summary

DTEManager()

Method Summary

void	addContextualObjectProvider(ContextualObjectProvider provider) Register the give contextual object provider
void	addIncludeProvider(oracle.bali.xml.grammar.QualifiedName qname, IncludeProvider provider) Register the include provider given the qualified name
static DTEManager	getInstance()
void	registerLoadResourcesFromClassLoaderFeatureEnabler(LoadResourcesFromClassLoaderFeatureEnabler loadResourcesFromClassLoaderFeatureEnabler)
void	registerVisualEditorPathProvider(MetaClass<VisualEditorPathProvider> visualEditorPathProvider) Register an extension point allowing JSP Design Time Visual Editor viewable paths to be specified for JspSourceNode and subclasses (JspFragmentSourceNode, JspTagSourceNode, JspTagXSourceNode, JspTagFragmentSourceNode).
void	registerVisualEditorPathProvider(MetaClass<VisualEditorPathProvider> visualEditorPathProvider, float weight) Register an extension point allowing JSP Design Time Visual Editor viewable paths to be specified for JspSourceNode and subclasses (JspFragmentSourceNode, JspTagSourceNode, JspTagXSourceNode, JspTagFragmentSourceNode).
void	removeContextualObjectProvider(ContextualObjectProvider provider) Unregister the given contextual object provider
void	removeIncludeProvider(oracle.bali.xml.grammar.QualifiedName qname) Unregister the include provider for the qualified name
void	restartWebApp(Project project) Restart the webapp in JSP VE design time(fake servlet container)
void	startWebAppAutoRestart(Project project) By default the dte restarts the webapp whenever the web.xml or other configuration files are modified.
void	stopWebAppAutoRestart(Project project) By default the dte restarts the webapp whenever the web.xml or other configuration files are modified.
void	suppressClassPathEntry(java.net.URL classPathEntry) Register a classPathEntry (jar or directory) that should be suppressed from the Web Application Environment.
void	suppressResource(java.net.URL baseUrl, java.lang.String resourceName) Register a resource that should be suppressed from the Web Application environment.

Methods inherited from class java.lang.Object

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

Field Detail

DTE_MANAGER_NAME

protected static final java.lang.String DTE_MANAGER_NAME

See Also:

Constant Field Values

DTE_DISABLED_PROJECT_PROPERTY

public static final java.lang.String DTE_DISABLED_PROJECT_PROPERTY

Name of the transient project properties that is set to Boolean.TRUE when the web-app auto restarted is stopped.

See Also:

Constant Field Values

Constructor Detail

DTEManager

public DTEManager()

Method Detail

getInstance

public static DTEManager getInstance()

addContextualObjectProvider

public void addContextualObjectProvider(ContextualObjectProvider provider)

Register the give contextual object provider

removeContextualObjectProvider

public void removeContextualObjectProvider(ContextualObjectProvider provider)

Unregister the given contextual object provider

addIncludeProvider

public void addIncludeProvider(oracle.bali.xml.grammar.QualifiedName qname,
                               IncludeProvider provider)

Register the include provider given the qualified name

removeIncludeProvider

public void removeIncludeProvider(oracle.bali.xml.grammar.QualifiedName qname)

Unregister the include provider for the qualified name

registerVisualEditorPathProvider

public void registerVisualEditorPathProvider(MetaClass<VisualEditorPathProvider> visualEditorPathProvider)

Register an extension point allowing JSP Design Time Visual Editor viewable paths to be specified for JspSourceNode and subclasses (JspFragmentSourceNode, JspTagSourceNode, JspTagXSourceNode, JspTagFragmentSourceNode).

registerVisualEditorPathProvider

public void registerVisualEditorPathProvider(MetaClass<VisualEditorPathProvider> visualEditorPathProvider,
                                             float weight)

Register an extension point allowing JSP Design Time Visual Editor viewable paths to be specified for JspSourceNode and subclasses (JspFragmentSourceNode, JspTagSourceNode, JspTagXSourceNode, JspTagFragmentSourceNode).

This variant provides a weight for the Provider, allowing it to take precedence over a standard implementation for the same type of JspSourceNode Context

registerLoadResourcesFromClassLoaderFeatureEnabler

public void registerLoadResourcesFromClassLoaderFeatureEnabler(LoadResourcesFromClassLoaderFeatureEnabler loadResourcesFromClassLoaderFeatureEnabler)

suppressClassPathEntry

public void suppressClassPathEntry(java.net.URL classPathEntry)

Register a classPathEntry (jar or directory) that should be suppressed from the Web Application Environment. Use this mechanism to suppress a service that shouldn't be configured during design-time. This can be used as an alternative to calling "suppressResource" on all of the service resources in a module, if the entire module should be suppressed.

Parameters:

classPathEntry - the URL of the jar or directory that should be suppressed. The URL should be constructed using oracle.ide.net.URLFactory.

suppressResource

public void suppressResource(java.net.URL baseUrl,
                             java.lang.String resourceName)

Register a resource that should be suppressed from the Web Application environment. Use this mechanism to suppress a service resource that registers some aspect of the Runtime that shouldn't be configured during design-time. e.g. META-INF/services/org.apache.myfaces.trinidad.context.PageFlowScopeProvider

Parameters:

baseUrl - the URL of the jar or directory that contains the resource to suppress. The URL should be constructed using oracle.ide.net.URLFactory.

resourceName - the name of the resource, as passed to ClassLoader.getResources()

stopWebAppAutoRestart

public void stopWebAppAutoRestart(Project project)

By default the dte restarts the webapp whenever the web.xml or other configuration files are modified. Other configuration files include faces-config.xml This API will stop the auto restart mode.

Parameters:

project - the project which the webapp belong to

startWebAppAutoRestart

public void startWebAppAutoRestart(Project project)

By default the dte restarts the webapp whenever the web.xml or other configuration files are modified. Other configuration files include faces-config.xml This API will start the auto restart mode. Note : Every stopWebAppAutoRestart should have a corresponding startWebAppAutoRestart for the "auto" webapp restart mode to be actually turned on eventually.

Parameters:

project - the project which the webapp belong to

restartWebApp

public void restartWebApp(Project project)

Restart the webapp in JSP VE design time(fake servlet container)

Parameters:

project - The project for the webapp