org.ops4j.pax.web.service.spi.util

Class WebContainerManager

java.lang.Object

org.ops4j.pax.web.service.spi.util.WebContainerManager

All Implemented Interfaces:

EventListener, org.osgi.framework.BundleListener, org.osgi.util.tracker.ServiceTrackerCustomizer<org.ops4j.pax.web.service.WebContainer,org.osgi.framework.ServiceReference<org.ops4j.pax.web.service.WebContainer>>

public class WebContainerManager
extends Object
implements org.osgi.framework.BundleListener, org.osgi.util.tracker.ServiceTrackerCustomizer<org.ops4j.pax.web.service.WebContainer,org.osgi.framework.ServiceReference<org.ops4j.pax.web.service.WebContainer>>

This class combines a BundleListener and ServiceListener to manage at least two scenarios:

• pax-web-extender-whiteboard
• pax-web-extender-war

The scenarios are quite similar, because in both cases the information is collected from multiple sources:

• pax-web-extender-whiteboard - Whiteboard services being registered through different bundles. Many bundles may contribute to multiple web applications
• pax-web-extender-war - bundles with Web-ContextPath manifest headers. Here, by design, single bundle is equivalent to single web application (possibly with the support of bundle fragments or embedded JARs).

However the web applications may be actually registered only when WebContainer OSGi service is available. Thus this class coordinates the above conditions.

This listener manages a (bundle-scoped) reference to current WebContainer and binding to its lifecycle processes the information obtained from multiple client bundles that try to install Web Application related elements/components into the current web container.

Before Pax Web 8, this was managed in pax-web-extender-war by org.ops4j.pax.web.extender.war.internal.tracker.ReplaceableService. In Pax Web 8, for pax-web-extender-whiteboard, initially I used separate ServiceListener, but I think it's a good idea to unify this functionality inside pax-web-spi bundle.

Field Summary

Fields

Modifier and Type	Field and Description
static org.slf4j.Logger	LOG

Constructor Summary

Constructors

Constructor and Description
WebContainerManager(org.osgi.framework.BundleContext context, WebContainerListener listener) Creates a manager that delivers service events synchronously (for test purposes).
WebContainerManager(org.osgi.framework.BundleContext context, WebContainerListener listener, String threadName) Creates a manager to handle: the lifecycle of WebContainer service reference(s) the lifecycles of bundles that want to interact with a WebContainer.

Method Summary

Modifier and Type	Method and Description
org.osgi.framework.ServiceReference<org.ops4j.pax.web.service.WebContainer>	addingService(org.osgi.framework.ServiceReference<org.ops4j.pax.web.service.WebContainer> reference)
void	bundleChanged(org.osgi.framework.BundleEvent event)
org.ops4j.pax.web.service.WebContainer	container(org.osgi.framework.Bundle bundle, org.osgi.framework.ServiceReference<org.ops4j.pax.web.service.WebContainer> ref)
<T extends org.ops4j.pax.web.service.views.PaxWebContainerView> T	containerView(org.osgi.framework.Bundle bundle, org.osgi.framework.ServiceReference<org.ops4j.pax.web.service.WebContainer> ref, Class<T> viewClass) Helper method that makes it easier to obtain a PaxWebContainerView using passed BundleContext and ServiceReference to a WebContainer
org.osgi.framework.ServiceReference<org.ops4j.pax.web.service.WebContainer>	currentWebContainerReference()
void	initialize() Initialization sets up bundle and service listeners assuming there are dedicated observers (to get customized notification) registered.
void	modifiedService(org.osgi.framework.ServiceReference<org.ops4j.pax.web.service.WebContainer> reference, org.osgi.framework.ServiceReference<org.ops4j.pax.web.service.WebContainer> service)
void	releaseContainer(org.osgi.framework.Bundle bundle) Helper method to release cached PaxWebContainerView for the passed BundleContext and current reference to a WebContainer service.
void	releaseContainer(org.osgi.framework.Bundle bundle, org.osgi.framework.ServiceReference<org.ops4j.pax.web.service.WebContainer> ref) Helper method to release cached PaxWebContainerView
void	removedService(org.osgi.framework.ServiceReference<org.ops4j.pax.web.service.WebContainer> reference, org.osgi.framework.ServiceReference<org.ops4j.pax.web.service.WebContainer> service)
void	shutdown() Cleans up internal trackers and thread pools.
WhiteboardWebContainerView	whiteboardView(org.osgi.framework.Bundle bundle) Returns a WhiteboardWebContainerView for the passed BundleContext and current reference to WebContainer service.
WhiteboardWebContainerView	whiteboardView(org.osgi.framework.Bundle bundle, org.osgi.framework.ServiceReference<org.ops4j.pax.web.service.WebContainer> ref) Returns a WhiteboardWebContainerView for the passed BundleContext and the passed reference to WebContainer service.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

public static final org.slf4j.Logger LOG

Constructor Detail

WebContainerManager

public WebContainerManager(org.osgi.framework.BundleContext context,
                           WebContainerListener listener)

Creates a manager that delivers service events synchronously (for test purposes).

Parameters:

context -

listener -

WebContainerManager

public WebContainerManager(org.osgi.framework.BundleContext context,
                           WebContainerListener listener,
                           String threadName)

Creates a manager to handle:

• the lifecycle of WebContainer service reference(s)
• the lifecycles of bundles that want to interact with a WebContainer.

Parameters:

context - nothing can be done without it

listener - a required instance of high-level listener to get notified about lifecycle changes

threadName - a name of the thread in which the instance of WebContainer service reference will be passed. If null, then events will be delivered synchronously.

Method Detail

initialize

public void initialize()

Initialization sets up bundle and service listeners assuming there are dedicated observers (to get customized notification) registered.

shutdown

public void shutdown()

Cleans up internal trackers and thread pools.

currentWebContainerReference

public org.osgi.framework.ServiceReference<org.ops4j.pax.web.service.WebContainer> currentWebContainerReference()

containerView

public <T extends org.ops4j.pax.web.service.views.PaxWebContainerView> T containerView(org.osgi.framework.Bundle bundle,
                                                                                       org.osgi.framework.ServiceReference<org.ops4j.pax.web.service.WebContainer> ref,
                                                                                       Class<T> viewClass)

Helper method that makes it easier to obtain a PaxWebContainerView using passed BundleContext and ServiceReference to a WebContainer

Parameters:

bundle -

ref -

viewClass -

Returns:

container

public org.ops4j.pax.web.service.WebContainer container(org.osgi.framework.Bundle bundle,
                                                        org.osgi.framework.ServiceReference<org.ops4j.pax.web.service.WebContainer> ref)

whiteboardView

public WhiteboardWebContainerView whiteboardView(org.osgi.framework.Bundle bundle)

Returns a WhiteboardWebContainerView for the passed BundleContext and current reference to WebContainer service.

Parameters:

bundle -

Returns:

whiteboardView

public WhiteboardWebContainerView whiteboardView(org.osgi.framework.Bundle bundle,
                                                 org.osgi.framework.ServiceReference<org.ops4j.pax.web.service.WebContainer> ref)

Returns a WhiteboardWebContainerView for the passed BundleContext and the passed reference to WebContainer service.

Parameters:

bundle -

ref -

Returns:

releaseContainer

public void releaseContainer(org.osgi.framework.Bundle bundle)

Helper method to release cached PaxWebContainerView for the passed BundleContext and current reference to a WebContainer service.

Parameters:

bundle -

releaseContainer

public void releaseContainer(org.osgi.framework.Bundle bundle,
                             org.osgi.framework.ServiceReference<org.ops4j.pax.web.service.WebContainer> ref)

Helper method to release cached PaxWebContainerView

Parameters:

bundle -

ref -

bundleChanged

public void bundleChanged(org.osgi.framework.BundleEvent event)

Specified by:

bundleChanged in interface org.osgi.framework.BundleListener

addingService

public org.osgi.framework.ServiceReference<org.ops4j.pax.web.service.WebContainer> addingService(org.osgi.framework.ServiceReference<org.ops4j.pax.web.service.WebContainer> reference)

Specified by:

addingService in interface org.osgi.util.tracker.ServiceTrackerCustomizer<org.ops4j.pax.web.service.WebContainer,org.osgi.framework.ServiceReference<org.ops4j.pax.web.service.WebContainer>>

modifiedService

public void modifiedService(org.osgi.framework.ServiceReference<org.ops4j.pax.web.service.WebContainer> reference,
                            org.osgi.framework.ServiceReference<org.ops4j.pax.web.service.WebContainer> service)

Specified by:

modifiedService in interface org.osgi.util.tracker.ServiceTrackerCustomizer<org.ops4j.pax.web.service.WebContainer,org.osgi.framework.ServiceReference<org.ops4j.pax.web.service.WebContainer>>

removedService

public void removedService(org.osgi.framework.ServiceReference<org.ops4j.pax.web.service.WebContainer> reference,
                           org.osgi.framework.ServiceReference<org.ops4j.pax.web.service.WebContainer> service)

Specified by:

removedService in interface org.osgi.util.tracker.ServiceTrackerCustomizer<org.ops4j.pax.web.service.WebContainer,org.osgi.framework.ServiceReference<org.ops4j.pax.web.service.WebContainer>>