org.ops4j.pax.web.service.spi.model.views

Interface ReportViewPlugin

All Known Implementing Classes:

ServerModel

public interface ReportViewPlugin

An interfaces that should be implemented by bundles that want to create/alter/enhance the information returned by ReportWebContainerView.

This interface was created to let pax-web-extender-war provide more information about failed WAB installation.

Method Summary

Modifier and Type	Method and Description
default void	collectServlets(Set<ServletInfo> servlets) Fill information about available servlets
void	collectWebApplications(Set<WebApplicationInfo> webapps) This method is called to fill a list of web application models for reporting purpose.
WebApplicationInfo	getWebApplication(long bundleId) Returns information about single WAB (by its bundle id).
WebApplicationInfo	getWebApplication(String contextPath) Returns information about single WAB (by its context path) - only successully deployed WABs should be returned, because there may be more failed contexts too.

Method Detail

collectWebApplications

void collectWebApplications(Set<WebApplicationInfo> webapps)

This method is called to fill a list of web application models for reporting purpose. It is the responsibility of the implementation to check (by some kind of key) if the WebApplicationInfo is already in the passed set - in this case, the existing model can be updated instead.

Parameters:

webapps -

getWebApplication

WebApplicationInfo getWebApplication(String contextPath)

Returns information about single WAB (by its context path) - only successully deployed WABs should be returned, because there may be more failed contexts too. For information about failed WABs, use the method with bundle ID.

Parameters:

contextPath -

Returns:

getWebApplication

WebApplicationInfo getWebApplication(long bundleId)

Returns information about single WAB (by its bundle id).

Parameters:

bundleId -

Returns:

collectServlets

default void collectServlets(Set<ServletInfo> servlets)

Fill information about available servlets

Parameters:

servlets -