org.eclipse.jetty.osgi.boot.internal.webapp
Interface IWebBundleDeployerHelper

All Known Implementing Classes:

WebBundleDeployerHelper

public interface IWebBundleDeployerHelper

Internal interface for the class that deploys a webapp on a server. Used as we migrate from the single instance of the jety server to multiple jetty servers.

Field Summary

static String

INTERNAL_SERVICE_PROP_UNKNOWN_CONTEXT_HANDLER_TYPE when this property is present, the type of context handler registered is not known in advance.

Method Summary

ContextHandler	registerContext(org.osgi.framework.Bundle contributor, String contextFileRelativePath, String extraClasspath, String overrideBundleInstallLocation, String requireTldBundle, ContextHandler handler) This type of registration relies on jetty's complete context xml file.
WebAppContext	registerWebapplication(org.osgi.framework.Bundle bundle, String webappFolderPath, String contextPath, String extraClasspath, String overrideBundleInstallLocation, String requireTldBundle, String webXmlPath, String defaultWebXmlPath, WebAppContext webAppContext) Deploy a new web application on the jetty server.
void	unregister(ContextHandler contextHandler) Stop a ContextHandler and remove it from the collection.

Field Detail

INTERNAL_SERVICE_PROP_UNKNOWN_CONTEXT_HANDLER_TYPE

static final String INTERNAL_SERVICE_PROP_UNKNOWN_CONTEXT_HANDLER_TYPE

when this property is present, the type of context handler registered is not known in advance.

See Also:

Constant Field Values

Method Detail

registerWebapplication

WebAppContext registerWebapplication(org.osgi.framework.Bundle bundle,
                                     String webappFolderPath,
                                     String contextPath,
                                     String extraClasspath,
                                     String overrideBundleInstallLocation,
                                     String requireTldBundle,
                                     String webXmlPath,
                                     String defaultWebXmlPath,
                                     WebAppContext webAppContext)
                                     throws Exception

Deploy a new web application on the jetty server.

Parameters:

bundle - The bundle

webappFolderPath - The path to the root of the webapp. Must be a path relative to bundle; either an absolute path.

contextPath - The context path. Must start with "/"

extraClasspath -

overrideBundleInstallLocation -

requireTldBundle - The list of bundles's symbolic names that contain tld files that are required by this WAB.

webXmlPath -

defaultWebXmlPath - TODO: parameter description

Returns:

The contexthandler created and started

Throws:

Exception

unregister

void unregister(ContextHandler contextHandler)
                throws Exception

Stop a ContextHandler and remove it from the collection.

Parameters:

contextHandler -

Throws:

Exception

See Also:

ContextDeployer.undeploy(java.lang.String)

registerContext

ContextHandler registerContext(org.osgi.framework.Bundle contributor,
                               String contextFileRelativePath,
                               String extraClasspath,
                               String overrideBundleInstallLocation,
                               String requireTldBundle,
                               ContextHandler handler)
                               throws Exception

This type of registration relies on jetty's complete context xml file. Context encompasses jndi and all other things. This makes the definition of the webapp a lot more self-contained.

Parameters:

contributor -

contextFileRelativePath -

extraClasspath -

overrideBundleInstallLocation -

requireTldBundle - The list of bundles'symbolic name that contain tld files for this webapp.

handler - the context handler passed in the server reference that will be configured, deployed and started.

Returns:

The contexthandler created and started

Throws:

Exception