Skip navigation links
A B C D E F G I L M N O P R S T 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.
activate(BundleContext) - Method in class org.apache.felix.webconsole.internal.core.BundlesConfigurationPrinter
 
activate(BundleContext) - Method in class org.apache.felix.webconsole.internal.core.BundlesServlet
 
activate(BundleContext) - Method in class org.apache.felix.webconsole.internal.core.ServicesServlet
 
AttachmentProvider - Interface in org.apache.felix.webconsole
Deprecated.
This has been deprecated. Use the org.apache.felix.status API instead.
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_FILEUPLOAD_REPO - Static variable in class org.apache.felix.webconsole.AbstractWebConsolePlugin
The name of the request attribute containing a File - upload repository path used by DiskFileItemFactory.
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_LABEL_MAP_CATEGORIZED - Static variable in class org.apache.felix.webconsole.internal.servlet.OsgiManager
The name of the (internal) request attribute providing the categorized label map structure.
ATTR_LANG_MAP - Static variable in interface org.apache.felix.webconsole.WebConsoleConstants
The name of the request attribute holding the language Map for the request (value is "felix.webconsole.langMap").
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").
authenticate(String, String) - Method in interface org.apache.felix.webconsole.WebConsoleSecurityProvider
Authenticates the user with the given user name and password.
authenticate(HttpServletRequest, HttpServletResponse) - Method in interface org.apache.felix.webconsole.WebConsoleSecurityProvider2
Authenticates the given request or asks the client for credentials.
authorize(Object, String) - Method in interface org.apache.felix.webconsole.WebConsoleSecurityProvider
Checks whether bthe authenticated user has the given role permission.

B

Base64 - Class in org.apache.felix.webconsole.internal.servlet
Provides Base64 encoding and decoding as defined by RFC 2045.
Base64() - Constructor for class org.apache.felix.webconsole.internal.servlet.Base64
Creates a Base64 codec used for decoding (all modes) and encoding in URL-unsafe mode.
Base64(boolean) - Constructor for class org.apache.felix.webconsole.internal.servlet.Base64
Creates a Base64 codec used for decoding (all modes) and encoding in the given URL-safe mode.
Base64(int) - Constructor for class org.apache.felix.webconsole.internal.servlet.Base64
Creates a Base64 codec used for decoding (all modes) and encoding in URL-unsafe mode.
Base64(int, byte[]) - Constructor for class org.apache.felix.webconsole.internal.servlet.Base64
Creates a Base64 codec used for decoding (all modes) and encoding in URL-unsafe mode.
Base64(int, byte[], boolean) - Constructor for class org.apache.felix.webconsole.internal.servlet.Base64
Creates a Base64 codec used for decoding (all modes) and encoding in URL-unsafe mode.
bindHttpService(HttpService) - Method in class org.apache.felix.webconsole.internal.servlet.OsgiManager
 
BrandingPlugin - Interface in org.apache.felix.webconsole
The BrandingPlugin is the service interface for the most elaborate way of branding the web console.
bundleChanged(BundleEvent) - Method in class org.apache.felix.webconsole.internal.i18n.ResourceBundleManager
 
BundleContextUtil - Class in org.apache.felix.webconsole.internal.core
The BundleContextUtil class.
BundleContextUtil() - Constructor for class org.apache.felix.webconsole.internal.core.BundleContextUtil
 
BundleInfo - Class in org.apache.felix.webconsole.bundleinfo
This entity defines additional bundle information entry, that is provided by the BundleInfoProvider.
BundleInfo(String, Object, BundleInfoType, String) - Constructor for class org.apache.felix.webconsole.bundleinfo.BundleInfo
Creates a new bundle information entry.
BundleInfoProvider - Interface in org.apache.felix.webconsole.bundleinfo
The bundle info provider allows the user to supply additional information that will be used by the Web Console bundle plugin.
BundleInfoType - Class in org.apache.felix.webconsole.bundleinfo
This pre-java 5 enum defines all valid bundle information value types.
BundlesConfigurationPrinter - Class in org.apache.felix.webconsole.internal.core
The BundlesConfigurationPrinter prints out the bundle list.
BundlesConfigurationPrinter() - Constructor for class org.apache.felix.webconsole.internal.core.BundlesConfigurationPrinter
 
BundlesServlet - Class in org.apache.felix.webconsole.internal.core
The BundlesServlet provides the bundles plugins, used to display the list of bundles, installed on the framework.
BundlesServlet() - Constructor for class org.apache.felix.webconsole.internal.core.BundlesServlet
Default constructor

C

CONFIG_PRINTER_MODES - Static variable in interface org.apache.felix.webconsole.WebConsoleConstants
The property marking a service as a configuration printer.
CONFIG_PRINTER_WEB_UNESCAPED - Static variable in interface org.apache.felix.webconsole.WebConsoleConstants
Name of the optional service registration property indicating that a ConfigurationPrinter service will provide HTML output when used in web mode.
ConfigManager - Class in org.apache.felix.webconsole.internal.configuration
The ConfigManager class is the Web Console plugin to manage configurations.
ConfigManager() - Constructor for class org.apache.felix.webconsole.internal.configuration.ConfigManager
Default constructor
ConfigurationAdminConfigurationPrinter - Class in org.apache.felix.webconsole.internal.configuration
ConfigurationAdminConfigurationPrinter uses the ConfigurationAdmin service to print the available configurations.
ConfigurationAdminConfigurationPrinter() - Constructor for class org.apache.felix.webconsole.internal.configuration.ConfigurationAdminConfigurationPrinter
 
ConfigurationPrinter - Interface in org.apache.felix.webconsole
Deprecated.
This has been deprecated. Use the org.apache.felix.status API instead.
ConfigurationRender - Class in org.apache.felix.webconsole.internal.misc
 
ConfigurationRender() - Constructor for class org.apache.felix.webconsole.internal.misc.ConfigurationRender
 
ConfigurationUtil - Class in org.apache.felix.webconsole.internal.servlet
A helper class to get configuration properties.

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.internal.core.BundlesConfigurationPrinter
 
deactivate() - Method in class org.apache.felix.webconsole.internal.core.BundlesServlet
 
deactivate() - Method in class org.apache.felix.webconsole.internal.core.ServicesServlet
 
deactivate() - Method in class org.apache.felix.webconsole.SimpleWebConsolePlugin
This method will close all service trackers, created by SimpleWebConsolePlugin.getService(String) method.
decode(Object) - Method in class org.apache.felix.webconsole.internal.servlet.Base64
Decodes an Object using the base64 algorithm.
decode(String) - Method in class org.apache.felix.webconsole.internal.servlet.Base64
Decodes a String containing characters in the Base64 alphabet.
decode(byte[]) - Method in class org.apache.felix.webconsole.internal.servlet.Base64
Decodes a byte[] containing characters in the Base64 alphabet.
decodeBase64(String) - Static method in class org.apache.felix.webconsole.internal.servlet.Base64
Decodes a Base64 String into octets
decodeBase64(byte[]) - Static method in class org.apache.felix.webconsole.internal.servlet.Base64
Decodes Base64 data into octets
decodeInteger(byte[]) - Static method in class org.apache.felix.webconsole.internal.servlet.Base64
Decodes a byte64-encoded integer according to crypto standards such as W3C's XML-Signature
DEFAULT_LOG_LEVEL - Static variable in class org.apache.felix.webconsole.internal.servlet.OsgiManager
 
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.
destroy() - Method in class org.apache.felix.webconsole.internal.servlet.OsgiManager
 
dispose() - Method in class org.apache.felix.webconsole.internal.i18n.ResourceBundleManager
Removes the bundle lister.
dispose() - Method in class org.apache.felix.webconsole.internal.servlet.OsgiManager
 
doGet(HttpServletRequest, HttpServletResponse) - Method in class org.apache.felix.webconsole.AbstractWebConsolePlugin
Renders the web console page for the request.
doGet(HttpServletRequest, HttpServletResponse) - Method in class org.apache.felix.webconsole.internal.compendium.LogServlet
 
doGet(HttpServletRequest, HttpServletResponse) - Method in class org.apache.felix.webconsole.internal.configuration.ConfigManager
 
doGet(HttpServletRequest, HttpServletResponse) - Method in class org.apache.felix.webconsole.internal.core.BundlesServlet
 
doGet(HttpServletRequest, HttpServletResponse) - Method in class org.apache.felix.webconsole.internal.core.ServicesServlet
 
doGet(HttpServletRequest, HttpServletResponse) - Method in class org.apache.felix.webconsole.internal.misc.LicenseServlet
 
doPost(HttpServletRequest, HttpServletResponse) - Method in class org.apache.felix.webconsole.internal.compendium.LogServlet
 
doPost(HttpServletRequest, HttpServletResponse) - Method in class org.apache.felix.webconsole.internal.configuration.ConfigManager
 
doPost(HttpServletRequest, HttpServletResponse) - Method in class org.apache.felix.webconsole.internal.core.BundlesServlet
 
doPost(HttpServletRequest, HttpServletResponse) - Method in class org.apache.felix.webconsole.internal.system.VMStatPlugin
 

E

encode(Object) - Method in class org.apache.felix.webconsole.internal.servlet.Base64
Encodes an Object using the base64 algorithm.
encode(byte[]) - Method in class org.apache.felix.webconsole.internal.servlet.Base64
Encodes a byte[] containing binary data, into a byte[] containing characters in the Base64 alphabet.
encodeBase64(byte[]) - Static method in class org.apache.felix.webconsole.internal.servlet.Base64
Encodes binary data using the base64 algorithm but does not chunk the output.
encodeBase64(byte[], boolean) - Static method in class org.apache.felix.webconsole.internal.servlet.Base64
Encodes binary data using the base64 algorithm, optionally chunking the output into 76 character blocks.
encodeBase64(byte[], boolean, boolean) - Static method in class org.apache.felix.webconsole.internal.servlet.Base64
Encodes binary data using the base64 algorithm, optionally chunking the output into 76 character blocks.
encodeBase64(byte[], boolean, boolean, int) - Static method in class org.apache.felix.webconsole.internal.servlet.Base64
Encodes binary data using the base64 algorithm, optionally chunking the output into 76 character blocks.
encodeBase64Chunked(byte[]) - Static method in class org.apache.felix.webconsole.internal.servlet.Base64
Encodes binary data using the base64 algorithm and chunks the encoded output into 76 character blocks
encodeBase64String(byte[]) - Static method in class org.apache.felix.webconsole.internal.servlet.Base64
Encodes binary data using the base64 algorithm into 76 character blocks separated by CRLF.
encodeBase64URLSafe(byte[]) - Static method in class org.apache.felix.webconsole.internal.servlet.Base64
Encodes binary data using a URL-safe variation of the base64 algorithm but does not chunk the output.
encodeBase64URLSafeString(byte[]) - Static method in class org.apache.felix.webconsole.internal.servlet.Base64
Encodes binary data using a URL-safe variation of the base64 algorithm but does not chunk the output.
encodeInteger(BigInteger) - Static method in class org.apache.felix.webconsole.internal.servlet.Base64
Encodes to a byte64-encoded integer according to crypto standards such as W3C's XML-Signature
encodeToString(byte[]) - Method in class org.apache.felix.webconsole.internal.servlet.Base64
Encodes a byte[] containing binary data, into a String containing characters in the Base64 alphabet.
endResponse(PrintWriter) - Method in class org.apache.felix.webconsole.AbstractWebConsolePlugin
This method is responsible for generating the footer of the page.
Entry() - Constructor for class org.apache.felix.webconsole.internal.misc.LicenseServlet.Entry
 
escapeHtml(String) - Static method in class org.apache.felix.webconsole.WebConsoleUtil
Escapes HTML special chars like: <>&\r\n and space

F

FilteringResponseWrapper - Class in org.apache.felix.webconsole.internal.filter
The FilteringResponseWrapper wraps the response to provide a filtering writer for HTML responses.
FilteringResponseWrapper(HttpServletResponse, ResourceBundle, ServletRequest) - Constructor for class org.apache.felix.webconsole.internal.filter.FilteringResponseWrapper
Creates a wrapper instance using the given resource bundle for translations.
FWK_PROP_WORK_CONTEXT - Static variable in class org.apache.felix.webconsole.internal.core.BundleContextUtil
This property defines which bundle context the web console plugins use to get the list of bundles and services.

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
Deprecated.
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.
getBundleInfo(Bundle, String, Locale) - Method in interface org.apache.felix.webconsole.bundleinfo.BundleInfoProvider
Gets the associated bundle information with the specified bundle (by it's ID) The Service may also be called outside through the new Inventory bundle due to mapping the BundlesServlet to an InventoryPrinter and for example calling it from a Gogo Shell.
getCategory() - Method in class org.apache.felix.webconsole.AbstractWebConsolePlugin
This method should return category string which will be used to render the plugin in the navigation menu.
getCategory() - Method in class org.apache.felix.webconsole.SimpleWebConsolePlugin
 
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
 
getDefaultValue() - Method in class org.apache.felix.webconsole.internal.configuration.MetatypePropertyDescriptor
 
getDescription() - Method in class org.apache.felix.webconsole.bundleinfo.BundleInfo
Gets user-friendly description of the key pair.
getDescription() - Method in class org.apache.felix.webconsole.internal.configuration.MetatypePropertyDescriptor
 
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
 
getName() - Method in class org.apache.felix.webconsole.bundleinfo.BundleInfo
Gets the name of the information entry.
getName(Locale) - Method in interface org.apache.felix.webconsole.bundleinfo.BundleInfoProvider
Gets the name of the bundle info provider as localized string.
getName() - Method in class org.apache.felix.webconsole.bundleinfo.BundleInfoType
Returns the name of the type.
getName() - Method in class org.apache.felix.webconsole.internal.configuration.MetatypePropertyDescriptor
 
getOptionLabels() - Method in class org.apache.felix.webconsole.internal.configuration.MetatypePropertyDescriptor
 
getOptionValues() - Method in class org.apache.felix.webconsole.internal.configuration.MetatypePropertyDescriptor
 
getParameter(HttpServletRequest, String) - Static method in class org.apache.felix.webconsole.AbstractWebConsolePlugin
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
 
getProperty(BundleContext, String, String) - Static method in class org.apache.felix.webconsole.internal.servlet.ConfigurationUtil
Returns the named property from the framework.
getProperty(BundleContext, String, int) - Static method in class org.apache.felix.webconsole.internal.servlet.ConfigurationUtil
Returns the named property from the framework.
getProperty(Map, String, String) - Static method in class org.apache.felix.webconsole.internal.servlet.ConfigurationUtil
Returns the named property from the configuration.
getProperty(Map, String, int) - Static method in class org.apache.felix.webconsole.internal.servlet.ConfigurationUtil
Returns the named property from the configuration.
getResource(String) - Method in class org.apache.felix.webconsole.SimpleWebConsolePlugin
Called internally by AbstractWebConsolePlugin to load resources.
getResourceBundle(Locale) - Method in class org.apache.felix.webconsole.i18n.LocalizationHelper
Used to retrieve the resource bundle for the specified locale.
getResourceBundle(Locale) - Method in class org.apache.felix.webconsole.internal.i18n.ResourceBundleCache
Gets the resource bundle for the specified locale.
getResourceBundle(Bundle, Locale) - Method in class org.apache.felix.webconsole.internal.i18n.ResourceBundleManager
This method is used to retrieve a /cached/ instance of the i18n resource associated with a given bundle.
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 AbstractWebConsolePlugin.getTitle()
getStringArrayProperty(Map, String) - Static method in class org.apache.felix.webconsole.internal.servlet.ConfigurationUtil
Gets a property as String[]
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
Deprecated.
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.internal.compendium.PreferencesConfigurationPrinter
 
getTitle() - Method in class org.apache.felix.webconsole.internal.compendium.WireAdminConfigurationPrinter
 
getTitle() - Method in class org.apache.felix.webconsole.internal.configuration.ConfigurationAdminConfigurationPrinter
 
getTitle() - Method in class org.apache.felix.webconsole.internal.core.BundlesConfigurationPrinter
 
getTitle() - Method in class org.apache.felix.webconsole.internal.core.PermissionsConfigurationPrinter
 
getTitle() - Method in class org.apache.felix.webconsole.internal.core.ServicesConfigurationPrinter
 
getTitle() - Method in class org.apache.felix.webconsole.internal.misc.SystemPropertiesPrinter
 
getTitle() - Method in class org.apache.felix.webconsole.internal.misc.ThreadPrinter
 
getTitle() - Method in class org.apache.felix.webconsole.SimpleWebConsolePlugin
 
getType() - Method in class org.apache.felix.webconsole.bundleinfo.BundleInfo
Gets the type of the information value.
getType() - Method in class org.apache.felix.webconsole.internal.configuration.MetatypePropertyDescriptor
 
getValue() - Method in class org.apache.felix.webconsole.bundleinfo.BundleInfo
Gets the information value.
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
 
getWorkingBundleContext(BundleContext) - Static method in class org.apache.felix.webconsole.internal.core.BundleContextUtil
Get the working bundle context: the bundle context to lookup bundles and services.
getWriter() - Method in class org.apache.felix.webconsole.internal.filter.FilteringResponseWrapper
Returns a PrintWriter for the response.

I

infoLine(PrintWriter, String, String, Object) - Static method in class org.apache.felix.webconsole.internal.misc.ConfigurationRender
Renders an info line - element in the framework configuration.
init() - Method in class org.apache.felix.webconsole.internal.servlet.OsgiManager
 
isArrayByteBase64(byte[]) - Static method in class org.apache.felix.webconsole.internal.servlet.Base64
Tests a given byte array to see if it contains only valid characters within the Base64 alphabet.
isBase64(byte) - Static method in class org.apache.felix.webconsole.internal.servlet.Base64
Returns whether or not the octet is in the base 64 alphabet.
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.
isOptional() - Method in class org.apache.felix.webconsole.internal.configuration.MetatypePropertyDescriptor
 
isUrlSafe() - Method in class org.apache.felix.webconsole.internal.servlet.Base64
Returns our current encode mode.

L

LABEL - Static variable in class org.apache.felix.webconsole.internal.core.ServicesServlet
the label for the services plugin
LicenseServlet - Class in org.apache.felix.webconsole.internal.misc
LicenseServlet provides the licenses plugin that browses through the bundles, searching for common license files.
LicenseServlet() - Constructor for class org.apache.felix.webconsole.internal.misc.LicenseServlet
Default constructor
LicenseServlet.Entry - Class in org.apache.felix.webconsole.internal.misc
 
LINK - Static variable in class org.apache.felix.webconsole.bundleinfo.BundleInfoType
Specifies that the value is String and is either a link to a local Servlet, or link to external HTTP server.
LocalizationHelper - Class in org.apache.felix.webconsole.i18n
The localization helper is supposed to be used from the bundle info providers.
LocalizationHelper(Bundle) - Constructor for class org.apache.felix.webconsole.i18n.LocalizationHelper
Creates a new helper instance.
log(int, String) - Method in class org.apache.felix.webconsole.AbstractWebConsolePlugin
Calls the ServletContext.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 ServletContext.log(String, Throwable) method if the configured log level is less than or equal to the given level.
logout(HttpServletRequest, HttpServletResponse) - Method in interface org.apache.felix.webconsole.WebConsoleSecurityProvider3
This method will be called by the web console when the user clicks the logout button.
LogServlet - Class in org.apache.felix.webconsole.internal.compendium
LogServlet provides support for reading the log messages.
LogServlet() - Constructor for class org.apache.felix.webconsole.internal.compendium.LogServlet
Default constructor

M

MetatypePropertyDescriptor - Class in org.apache.felix.webconsole.internal.configuration
The MetatypePropertyDescriptor extends the PropertyDescriptor describing a property based on a real Metatype Service Attribute Definition.
MetatypePropertyDescriptor(AttributeDefinition, boolean) - Constructor for class org.apache.felix.webconsole.internal.configuration.MetatypePropertyDescriptor
 
MIME_CHUNK_SIZE - Static variable in class org.apache.felix.webconsole.internal.servlet.Base64
MIME chunk size per RFC 2045 section 6.8.
MODE_ALWAYS - Static variable in interface org.apache.felix.webconsole.ConfigurationPrinter
Deprecated.
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
Deprecated.
The txt mode - this printer is used in the txt.
MODE_WEB - Static variable in interface org.apache.felix.webconsole.ConfigurationPrinter
Deprecated.
The web mode - this printer is used in the web console.
MODE_ZIP - Static variable in interface org.apache.felix.webconsole.ConfigurationPrinter
Deprecated.
The zip mode - this printer is used in the zip.
ModeAwareConfigurationPrinter - Interface in org.apache.felix.webconsole
Deprecated.
This has been deprecated. Use the org.apache.felix.status API instead.

N

NAME - Static variable in class org.apache.felix.webconsole.internal.core.BundlesServlet
the label of the bundles plugin - used by other plugins to reference to plugin details
NO_INFO - Static variable in interface org.apache.felix.webconsole.bundleinfo.BundleInfoProvider
This is just an utility - empty array, that could be returned when there is no additional information for a specific bundle.

O

org.apache.felix.webconsole - package org.apache.felix.webconsole
 
org.apache.felix.webconsole.bundleinfo - package org.apache.felix.webconsole.bundleinfo
 
org.apache.felix.webconsole.i18n - package org.apache.felix.webconsole.i18n
 
org.apache.felix.webconsole.internal.compendium - package org.apache.felix.webconsole.internal.compendium
 
org.apache.felix.webconsole.internal.configuration - package org.apache.felix.webconsole.internal.configuration
 
org.apache.felix.webconsole.internal.core - package org.apache.felix.webconsole.internal.core
 
org.apache.felix.webconsole.internal.filter - package org.apache.felix.webconsole.internal.filter
 
org.apache.felix.webconsole.internal.i18n - package org.apache.felix.webconsole.internal.i18n
 
org.apache.felix.webconsole.internal.misc - package org.apache.felix.webconsole.internal.misc
 
org.apache.felix.webconsole.internal.servlet - package org.apache.felix.webconsole.internal.servlet
 
org.apache.felix.webconsole.internal.system - package org.apache.felix.webconsole.internal.system
 
OsgiManager - Class in org.apache.felix.webconsole.internal.servlet
The OSGi Manager is the actual Web Console Servlet which is registered with the OSGi Http Service and which maintains registered console plugins.
OsgiManager(BundleContext) - Constructor for class org.apache.felix.webconsole.internal.servlet.OsgiManager
 

P

PARAM_NO_REDIRECT_AFTER_ACTION - Static variable in class org.apache.felix.webconsole.internal.servlet.OsgiManager
The name and value of a parameter which will prevent redirection to a render after the action has been executed (value is "_noredir_").
PEM_CHUNK_SIZE - Static variable in class org.apache.felix.webconsole.internal.servlet.Base64
PEM chunk size per RFC 1421 section 4.3.2.4.
PermissionsConfigurationPrinter - Class in org.apache.felix.webconsole.internal.core
PermissionsPrinter reads the given permissions from PermissionAdmin and ConditionalPermissionAdmin and prints them.
PermissionsConfigurationPrinter() - Constructor for class org.apache.felix.webconsole.internal.core.PermissionsConfigurationPrinter
 
PLUGIN_CATEGORY - Static variable in interface org.apache.felix.webconsole.WebConsoleConstants
The category under which the OSGi Manager plugin is listed in the top navigation by the OSGi Manager (value is "felix.webconsole.category").
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.title").
PreferencesConfigurationPrinter - Class in org.apache.felix.webconsole.internal.compendium
PreferencesConfigurationPrinter uses the Preferences service to print the store bundle preferences.
PreferencesConfigurationPrinter() - Constructor for class org.apache.felix.webconsole.internal.compendium.PreferencesConfigurationPrinter
 
printConfiguration(PrintWriter) - Method in interface org.apache.felix.webconsole.ConfigurationPrinter
Deprecated.
Prints the configuration report to the given printWriter.
printConfiguration(PrintWriter) - Method in class org.apache.felix.webconsole.internal.compendium.PreferencesConfigurationPrinter
 
printConfiguration(PrintWriter) - Method in class org.apache.felix.webconsole.internal.compendium.WireAdminConfigurationPrinter
 
printConfiguration(PrintWriter) - Method in class org.apache.felix.webconsole.internal.configuration.ConfigurationAdminConfigurationPrinter
 
printConfiguration(PrintWriter) - Method in class org.apache.felix.webconsole.internal.core.BundlesConfigurationPrinter
 
printConfiguration(PrintWriter) - Method in class org.apache.felix.webconsole.internal.core.BundlesServlet
 
printConfiguration(PrintWriter) - Method in class org.apache.felix.webconsole.internal.core.PermissionsConfigurationPrinter
 
printConfiguration(PrintWriter) - Method in class org.apache.felix.webconsole.internal.core.ServicesConfigurationPrinter
 
printConfiguration(PrintWriter) - Method in class org.apache.felix.webconsole.internal.misc.SystemPropertiesPrinter
 
printConfiguration(PrintWriter) - Method in class org.apache.felix.webconsole.internal.misc.ThreadPrinter
 
printConfiguration(PrintWriter, String) - Method in class org.apache.felix.webconsole.internal.misc.ThreadPrinter
 
printConfiguration(PrintWriter, String) - Method in interface org.apache.felix.webconsole.ModeAwareConfigurationPrinter
Deprecated.
Prints the configuration report to the given printWriter.
printThread(PrintWriter, Thread, boolean) - Method in class org.apache.felix.webconsole.internal.misc.ThreadDumper
Prints information for the given thread.
printThreads(PrintWriter, boolean) - Method in class org.apache.felix.webconsole.internal.misc.ThreadDumper
Prints all available thread groups, threads and a summary of threads availability.
PROPERTY_MODES - Static variable in interface org.apache.felix.webconsole.ConfigurationPrinter

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.
renderContent(HttpServletRequest, HttpServletResponse) - Method in class org.apache.felix.webconsole.internal.compendium.LogServlet
 
renderContent(HttpServletRequest, HttpServletResponse) - Method in class org.apache.felix.webconsole.internal.configuration.ConfigManager
 
renderContent(HttpServletRequest, HttpServletResponse) - Method in class org.apache.felix.webconsole.internal.core.BundlesServlet
 
renderContent(HttpServletRequest, HttpServletResponse) - Method in class org.apache.felix.webconsole.internal.core.ServicesServlet
 
renderContent(HttpServletRequest, HttpServletResponse) - Method in class org.apache.felix.webconsole.internal.misc.LicenseServlet
 
renderContent(HttpServletRequest, HttpServletResponse) - Method in class org.apache.felix.webconsole.internal.system.VMStatPlugin
 
renderMenu(Map, String, PrintWriter) - Method in class org.apache.felix.webconsole.AbstractWebConsolePlugin
 
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.
RESOURCE - Static variable in class org.apache.felix.webconsole.bundleinfo.BundleInfoType
This information type, specifies that the value of the information is URL object, that points to a resource.
ResourceBundleCache - Class in org.apache.felix.webconsole.internal.i18n
The ResourceBundleCache caches resource bundles per OSGi bundle.
ResourceBundleCache(Bundle) - Constructor for class org.apache.felix.webconsole.internal.i18n.ResourceBundleCache
Creates a new object
ResourceBundleManager - Class in org.apache.felix.webconsole.internal.i18n
The ResourceBundleManager manages resource bundle instance per OSGi Bundle.
ResourceBundleManager(BundleContext) - Constructor for class org.apache.felix.webconsole.internal.i18n.ResourceBundleManager
Creates a new object and adds self as a bundle listener

S

sendRedirect(HttpServletRequest, HttpServletResponse, String) - Method in class org.apache.felix.webconsole.AbstractWebConsolePlugin
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
Deprecated.
The service name under which services of this class must be registered to be picked for inclusion in the configuration report.
service(ServletRequest, ServletResponse) - Method in class org.apache.felix.webconsole.internal.servlet.OsgiManager
 
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").
ServicesConfigurationPrinter - Class in org.apache.felix.webconsole.internal.core
ServicesConfigurationPrinter provides a configuration printer for inspecting the registered services.
ServicesConfigurationPrinter() - Constructor for class org.apache.felix.webconsole.internal.core.ServicesConfigurationPrinter
 
ServicesServlet - Class in org.apache.felix.webconsole.internal.core
ServicesServlet provides a plugin for inspecting the registered services.
ServicesServlet() - Constructor for class org.apache.felix.webconsole.internal.core.ServicesServlet
Default constructor
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 AbstractWebConsolePlugin.log(int, String) and AbstractWebConsolePlugin.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 with the default category (null)
SimpleWebConsolePlugin(String, String, String, String[]) - Constructor for class org.apache.felix.webconsole.SimpleWebConsolePlugin
Creates new Simple Web Console Plugin with the given category.
startResponse(HttpServletRequest, HttpServletResponse) - Method in class org.apache.felix.webconsole.AbstractWebConsolePlugin
This method is responsible for generating the top heading of the page.
SystemPropertiesPrinter - Class in org.apache.felix.webconsole.internal.misc
 
SystemPropertiesPrinter() - Constructor for class org.apache.felix.webconsole.internal.misc.SystemPropertiesPrinter
 

T

ThreadDumper - Class in org.apache.felix.webconsole.internal.misc
This is a helper class for dumping thread stacks.
ThreadDumper() - Constructor for class org.apache.felix.webconsole.internal.misc.ThreadDumper
Base constructor.
ThreadPrinter - Class in org.apache.felix.webconsole.internal.misc
This class provides the Threads tab in the configuration status.
ThreadPrinter() - Constructor for class org.apache.felix.webconsole.internal.misc.ThreadPrinter
 
toString(Object) - Static method in class org.apache.felix.webconsole.WebConsoleUtil
This method will stringify a Java object.

U

unbindHttpService(HttpService) - Method in class org.apache.felix.webconsole.internal.servlet.OsgiManager
 
UNBOUND_LOCATION - Static variable in class org.apache.felix.webconsole.internal.configuration.ConfigManager
 
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.
USER_ATTRIBUTE - Static variable in interface org.apache.felix.webconsole.WebConsoleSecurityProvider2
The name of the request attribute providing the object representing the authenticated user.

V

validate(Object) - Method in class org.apache.felix.webconsole.bundleinfo.BundleInfoType
That method is used to validate if the object is correct for the specified type.
validate(String) - Method in class org.apache.felix.webconsole.internal.configuration.MetatypePropertyDescriptor
 
VALUE - Static variable in class org.apache.felix.webconsole.bundleinfo.BundleInfoType
That information type is for normal information keys, that provide a normal (not link) value as information.
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.
VMStatPlugin - Class in org.apache.felix.webconsole.internal.system
VMStatPlugin provides the System Information tab.
VMStatPlugin() - Constructor for class org.apache.felix.webconsole.internal.system.VMStatPlugin
Default constructor

W

WebConsoleConstants - Interface in org.apache.felix.webconsole
WebConsoleConstants provides some common constants that are used by plugin developers.
WebConsoleSecurityProvider - Interface in org.apache.felix.webconsole
The WebConsoleSecurityProvider is a service interface allowing to use an external system to authenticate users before granting access to the Web Console.
WebConsoleSecurityProvider2 - Interface in org.apache.felix.webconsole
The WebConsoleSecurityProvider2 extends the WebConsoleSecurityProvider interface allowing for full control of the authentication process to access the Web Console.
WebConsoleSecurityProvider3 - Interface in org.apache.felix.webconsole
The WebConsoleSecurityProvider3 extends the WebConsoleSecurityProvider2 interface and adds the ability to perform log-out operation.
WebConsoleUtil - Class in org.apache.felix.webconsole
The WebConsoleUtil provides various utility methods for use by Web Console plugins.
WireAdminConfigurationPrinter - Class in org.apache.felix.webconsole.internal.compendium
WireAdminConfigurationPrinter reads the configured wires in WireAdmin service, and prints them along their properties and values.
WireAdminConfigurationPrinter() - Constructor for class org.apache.felix.webconsole.internal.compendium.WireAdminConfigurationPrinter
 
WORK_CTX_OWN - Static variable in class org.apache.felix.webconsole.internal.core.BundleContextUtil
The web console uses the own bundle context.
WORK_CTX_SYSTEM - Static variable in class org.apache.felix.webconsole.internal.core.BundleContextUtil
The web console uses the system bundle context.
A B C D E F G I L M N O P R S T U V W 
Skip navigation links

Copyright © 2006–2020 The Apache Software Foundation. All rights reserved.