A B C D E G I K L M O P R S U V W

A

AbstractWebConsolePlugin - Class in org.apache.felix.webconsole

The Web Console can be extended by registering an OSGi service for the interface Servlet with the service property felix.webconsole.label set to the label (last segment in the URL) of the page.

AbstractWebConsolePlugin() - Constructor for class org.apache.felix.webconsole.AbstractWebConsolePlugin

activate(BundleContext) - Method in class org.apache.felix.webconsole.AbstractWebConsolePlugin

This method is called from the Felix Web Console to ensure the AbstractWebConsolePlugin is correctly setup.

AttachmentProvider - Interface in org.apache.felix.webconsole

This is an optional extension of the ConfigurationPrinter.

ATTR_APP_ROOT - Static variable in interface org.apache.felix.webconsole.WebConsoleConstants

The name of the request attribute providing the absolute path of the Web Console root (value is "felix.webconsole.appRoot").

ATTR_CONSOLE_VARIABLE_RESOLVER - Static variable in interface org.apache.felix.webconsole.WebConsoleConstants

The name of the request attribute holding the VariableResolver for the request (value is "felix.webconsole.variable.resolver").

ATTR_FILEUPLOAD - Static variable in class org.apache.felix.webconsole.AbstractWebConsolePlugin

The name of the request attribute containing the map of FileItems from the POST request

ATTR_LABEL_MAP - Static variable in interface org.apache.felix.webconsole.WebConsoleConstants

The name of the request attribute providing a mapping of labels to page titles of registered console plugins (value is "felix.webconsole.labelMap").

ATTR_PLUGIN_ROOT - Static variable in interface org.apache.felix.webconsole.WebConsoleConstants

The name of the request attribute providing the absolute path of the current plugin (value is "felix.webconsole.pluginRoot").

B

BrandingPlugin - Interface in org.apache.felix.webconsole

The BrandingPlugin is the service interface for the most elaborate way of branding the web console.

C

ConfigurationPrinter - Interface in org.apache.felix.webconsole

The ConfigurationPrinter is a service interface to be used by providers which want to hook into the display of the current configuration of the OSGi framework.

D

deactivate() - Method in class org.apache.felix.webconsole.AbstractWebConsolePlugin

This method is called, by the Web Console to de-activate the plugin and release all used resources.

deactivate() - Method in class org.apache.felix.webconsole.SimpleWebConsolePlugin

This method will close all service trackers, created by SimpleWebConsolePlugin.getService(String) method.

DefaultBrandingPlugin - Class in org.apache.felix.webconsole

The DefaultBrandingPlugin class is the default implementation of the BrandingPlugin interface.

DefaultVariableResolver - Class in org.apache.felix.webconsole

The DefaultVariableResolver is a HashMap based default implementation of the VariableResolver interface.

DefaultVariableResolver() - Constructor for class org.apache.felix.webconsole.DefaultVariableResolver

Creates a new variable resolver with default capacity.

DefaultVariableResolver(int, float) - Constructor for class org.apache.felix.webconsole.DefaultVariableResolver

Creates a new variable resolver and initializes both - capacity & load factor

DefaultVariableResolver(int) - Constructor for class org.apache.felix.webconsole.DefaultVariableResolver

Creates a new variable resolver with specified initial capacity

DefaultVariableResolver(Map) - Constructor for class org.apache.felix.webconsole.DefaultVariableResolver

Creates a new variable resolver copying the variables from the given map.

doGet(HttpServletRequest, HttpServletResponse) - Method in class org.apache.felix.webconsole.AbstractWebConsolePlugin

Renders the web console page for the request.

E

endResponse(PrintWriter) - Method in class org.apache.felix.webconsole.AbstractWebConsolePlugin

This method is responsible for generating the footer of the page.

escapeHtml(String) - Static method in class org.apache.felix.webconsole.WebConsoleUtil

Escapes HTML special chars like: <>&\r\n and space

G

GET_RESOURCE_METHOD_NAME - Static variable in class org.apache.felix.webconsole.AbstractWebConsolePlugin

Web Console Plugin typically consists of servlet and resources such as images, scripts or style sheets.

getAttachments(String) - Method in interface org.apache.felix.webconsole.AttachmentProvider

Return an array of attachments for the given render mode.

getBrandingPlugin() - Static method in class org.apache.felix.webconsole.AbstractWebConsolePlugin

Returns the BrandingPlugin currently used for web console branding.

getBrandName() - Method in interface org.apache.felix.webconsole.BrandingPlugin

Returns an indicative name of the branding plugin.

getBrandName() - Method in class org.apache.felix.webconsole.DefaultBrandingPlugin

getBundle() - Method in class org.apache.felix.webconsole.AbstractWebConsolePlugin

Returns the Bundle pertaining to the bundle context with which this plugin has been activated.

getBundleContext() - Method in class org.apache.felix.webconsole.AbstractWebConsolePlugin

Returns the BundleContext with which this plugin has been activated.

getCssReferences() - Method in class org.apache.felix.webconsole.AbstractWebConsolePlugin

Returns a list of CSS reference paths or null if no additional CSS files are provided by the plugin.

getCssReferences() - Method in class org.apache.felix.webconsole.SimpleWebConsolePlugin

getFavIcon() - Method in interface org.apache.felix.webconsole.BrandingPlugin

Returns the absolute path to an icon to be used as the web console "favicon".

getFavIcon() - Method in class org.apache.felix.webconsole.DefaultBrandingPlugin

getInstance() - Static method in class org.apache.felix.webconsole.DefaultBrandingPlugin

Retrieves the shared instance

getLabel() - Method in class org.apache.felix.webconsole.AbstractWebConsolePlugin

Retrieves the label.

getLabel() - Method in class org.apache.felix.webconsole.SimpleWebConsolePlugin

getMainStyleSheet() - Method in interface org.apache.felix.webconsole.BrandingPlugin

Returns the absolute path to a CSS file to be used as the main CSS for the basic admin site.

getMainStyleSheet() - Method in class org.apache.felix.webconsole.DefaultBrandingPlugin

getParameter(HttpServletRequest, String) - Static method in class org.apache.felix.webconsole.AbstractWebConsolePlugin

Deprecated.

use WebConsoleUtil.getParameter(HttpServletRequest, String)

getParameter(HttpServletRequest, String) - Static method in class org.apache.felix.webconsole.WebConsoleUtil

An utility method, that is used to filter out simple parameter from file parameter when multipart transfer encoding is used.

getParameterInt(HttpServletRequest, String, int) - Static method in class org.apache.felix.webconsole.WebConsoleUtil

Retrieves a request parameter and converts it to int.

getProductImage() - Method in interface org.apache.felix.webconsole.BrandingPlugin

Returns an absolute path to an image to be rendered as the logo of the branding product.

getProductImage() - Method in class org.apache.felix.webconsole.DefaultBrandingPlugin

getProductName() - Method in interface org.apache.felix.webconsole.BrandingPlugin

Returns the name of the product in which the web console is contained and to which the web console is branded.

getProductName() - Method in class org.apache.felix.webconsole.DefaultBrandingPlugin

getProductURL() - Method in interface org.apache.felix.webconsole.BrandingPlugin

Returns an (absolute) URL to a web site representing the product to which the web console is branded.

getProductURL() - Method in class org.apache.felix.webconsole.DefaultBrandingPlugin

getResource(String) - Method in class org.apache.felix.webconsole.SimpleWebConsolePlugin

Called internally by AbstractWebConsolePlugin to load resources.

getResourceProvider() - Method in class org.apache.felix.webconsole.AbstractWebConsolePlugin

Returns the object which might provide resources.

getService(String) - Method in class org.apache.felix.webconsole.SimpleWebConsolePlugin

Gets the service with the specified class name.

getServletName() - Method in class org.apache.felix.webconsole.AbstractWebConsolePlugin

Returns the title for this plugin as returned by getTitle()

getTitle() - Method in class org.apache.felix.webconsole.AbstractWebConsolePlugin

Retrieves the title of the plug-in.

getTitle() - Method in interface org.apache.felix.webconsole.ConfigurationPrinter

Returns a human readable title string to be placed in front of the configuration report generated by the ConfigurationPrinter.printConfiguration(PrintWriter) method.

getTitle() - Method in class org.apache.felix.webconsole.SimpleWebConsolePlugin

getVariableResolver(ServletRequest) - Static method in class org.apache.felix.webconsole.WebConsoleUtil

Returns the VariableResolver for the given request.

getVendorImage() - Method in interface org.apache.felix.webconsole.BrandingPlugin

Returns an absolute path to an image to be rendered as the logo of the branding product vendor.

getVendorImage() - Method in class org.apache.felix.webconsole.DefaultBrandingPlugin

getVendorName() - Method in interface org.apache.felix.webconsole.BrandingPlugin

Returns the name of the branding product vendor.

getVendorName() - Method in class org.apache.felix.webconsole.DefaultBrandingPlugin

getVendorURL() - Method in interface org.apache.felix.webconsole.BrandingPlugin

Returns an (absolute) URL to the web site of the branding product vendor.

getVendorURL() - Method in class org.apache.felix.webconsole.DefaultBrandingPlugin

I

isHtmlRequest(HttpServletRequest) - Method in class org.apache.felix.webconsole.AbstractWebConsolePlugin

Detects whether this request is intended to have the headers and footers of this plugin be rendered or not.

K

keyVal(JSONWriter, String, Object) - Static method in class org.apache.felix.webconsole.WebConsoleUtil

Writes a key-value pair in a JSON writer.

L

log(int, String) - Method in class org.apache.felix.webconsole.AbstractWebConsolePlugin

Calls the GenericServlet.log(String) method if the configured log level is less than or equal to the given level.

log(int, String, Throwable) - Method in class org.apache.felix.webconsole.AbstractWebConsolePlugin

Calls the GenericServlet.log(String, Throwable) method if the configured log level is less than or equal to the given level.

M

MODE_ALWAYS - Static variable in interface org.apache.felix.webconsole.ConfigurationPrinter

The default mode - this printer is used in the web console and the zip.

MODE_TXT - Static variable in interface org.apache.felix.webconsole.ConfigurationPrinter

The txt mode - this printer is used in the txt.

MODE_WEB - Static variable in interface org.apache.felix.webconsole.ConfigurationPrinter

The web mode - this printer is used in the web console.

MODE_ZIP - Static variable in interface org.apache.felix.webconsole.ConfigurationPrinter

The zip mode - this printer is used in the zip.

ModeAwareConfigurationPrinter - Interface in org.apache.felix.webconsole

This is an optional extension of the ConfigurationPrinter.

O

org.apache.felix.webconsole - package org.apache.felix.webconsole

P

PLUGIN_CSS_REFERENCES - Static variable in interface org.apache.felix.webconsole.WebConsoleConstants

The name of the service registration properties providing references to addition CSS files that should be loaded when rendering the header for a registered plugin.

PLUGIN_LABEL - Static variable in interface org.apache.felix.webconsole.WebConsoleConstants

The URI address label under which the OSGi Manager plugin is called by the OSGi Manager (value is "felix.webconsole.label").

PLUGIN_TITLE - Static variable in interface org.apache.felix.webconsole.WebConsoleConstants

The title under which the OSGi Manager plugin is called by the OSGi Manager (value is "felix.webconsole.label").

printConfiguration(PrintWriter) - Method in interface org.apache.felix.webconsole.ConfigurationPrinter

Prints the configuration report to the given printWriter.

printConfiguration(PrintWriter, String) - Method in interface org.apache.felix.webconsole.ModeAwareConfigurationPrinter

Prints the configuration report to the given printWriter.

PROPERTY_MODES - Static variable in interface org.apache.felix.webconsole.ConfigurationPrinter

The optional service property specifying the modes of the printer.

R

readTemplateFile(String) - Method in class org.apache.felix.webconsole.AbstractWebConsolePlugin

Reads the templateFile as a resource through the class loader of this class converting the binary data into a string using UTF-8 encoding.

register(BundleContext) - Method in class org.apache.felix.webconsole.SimpleWebConsolePlugin

This is an utility method.

renderContent(HttpServletRequest, HttpServletResponse) - Method in class org.apache.felix.webconsole.AbstractWebConsolePlugin

This method is used to render the content of the plug-in.

renderTopNavigation(HttpServletRequest, PrintWriter) - Method in class org.apache.felix.webconsole.AbstractWebConsolePlugin

This method is called to generate the top level links with the available plug-ins.

resolve(String) - Method in class org.apache.felix.webconsole.DefaultVariableResolver

Returns the string representation of the value stored under the variable name in this map.

resolve(String) - Method in interface org.apache.felix.webconsole.VariableResolver

Returns a replacement value for the named variable or null if no replacement is available.

S

sendRedirect(HttpServletRequest, HttpServletResponse, String) - Method in class org.apache.felix.webconsole.AbstractWebConsolePlugin

Deprecated.

use WebConsoleUtil.sendRedirect(HttpServletRequest, HttpServletResponse, String)

sendRedirect(HttpServletRequest, HttpServletResponse, String) - Static method in class org.apache.felix.webconsole.WebConsoleUtil

Utility method to handle relative redirects.

SERVICE - Static variable in interface org.apache.felix.webconsole.ConfigurationPrinter

The service name under which services of this class must be registered to be picked for inclusion in the configuration report.

SERVICE_NAME - Static variable in interface org.apache.felix.webconsole.WebConsoleConstants

The name of the service to register as to be used as a "plugin" for the OSGi Manager (value is "javax.servlet.Servlet").

setBrandingPlugin(BrandingPlugin) - Static method in class org.apache.felix.webconsole.AbstractWebConsolePlugin

Sets the BrandingPlugin to use globally by all extensions of this class for branding.

setLogLevel(int) - Static method in class org.apache.felix.webconsole.AbstractWebConsolePlugin

Sets the log level to be applied for calls to the log(int, String) and log(int, String, Throwable) methods.

setNoCache(HttpServletResponse) - Static method in class org.apache.felix.webconsole.WebConsoleUtil

Sets response headers to force the client to not cache the response sent back.

setVariableResolver(ServletRequest, VariableResolver) - Static method in class org.apache.felix.webconsole.WebConsoleUtil

Sets the VariableResolver as the WebConsoleConstants.ATTR_CONSOLE_VARIABLE_RESOLVER attribute in the given request.

SimpleWebConsolePlugin - Class in org.apache.felix.webconsole

SimpleWebConsolePlugin is an utility class that provides default implementation of the AbstractWebConsolePlugin and supports the following features: Methods for (un)registering the web console plugin service Default implementation for resource loading

SimpleWebConsolePlugin(String, String, String[]) - Constructor for class org.apache.felix.webconsole.SimpleWebConsolePlugin

Creates new Simple Web Console Plugin.

startResponse(HttpServletRequest, HttpServletResponse) - Method in class org.apache.felix.webconsole.AbstractWebConsolePlugin

This method is responsible for generating the top heading of the page.

U

unregister() - Method in class org.apache.felix.webconsole.SimpleWebConsolePlugin

An utility method that removes the service, registered by the SimpleWebConsolePlugin.register(BundleContext) method.

urlDecode(String) - Static method in class org.apache.felix.webconsole.WebConsoleUtil

Decode the given value expected to be URL encoded.

V

VariableResolver - Interface in org.apache.felix.webconsole

The VariableResolver interface defines the API for an object which may be provided by plugins to provide replacement values for variables in the generated content.

W

WebConsoleConstants - Interface in org.apache.felix.webconsole

WebConsoleConstants provides some common constants that are used by plugin developers.

WebConsoleUtil - Class in org.apache.felix.webconsole

The WebConsoleUtil provides various utility methods for use by Web Console plugins.

A B C D E G I K L M O P R S U V W