Package org.apache.felix.webconsole

Class DefaultBrandingPlugin

  • All Implemented Interfaces:
    BrandingPlugin
    @Deprecated(since="2021-04-30")
public class DefaultBrandingPlugin
extends java.lang.Object
implements BrandingPlugin
    Deprecated.
    The Apache Felix Webconsole is not supported in Cloud environments.
    The DefaultBrandingPlugin class is the default implementation of the BrandingPlugin interface. The singleton instance of this class is used as branding plugin if no BrandingPlugin service is registered in the system.

    This default implementation provides Apache Felix based default branding as follows:

    NameProperty NameDefault Value
    Brand Name webconsole.brand.name Apache Felix Web Console
    Product Name webconsole.product.name Apache Felix
    Product URL webconsole.product.url http://felix.apache.org
    Product Image webconsole.product.image /res/imgs/logo.png
    Vendor Name webconsole.vendor.name The Apache Software Foundation
    Vendor URL webconsole.vendor.url http://www.apache.org
    Vendor Image webconsole.vendor.image /res/imgs/logo.png
    Favourite Icon webconsole.favicon /res/imgs/favicon.ico
    Main Stylesheet webconsole.stylesheet /res/ui/admin.css

    If a properties file META-INF/webconsole.properties is available through the class loader of this class, the properties overwrite the default settings according to the property names listed above. The easiest way to add such a properties file is to provide a fragment bundle with the file.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      java.lang.String getBrandName()
      Deprecated.
      Returns an indicative name of the branding plugin.
      java.lang.String getFavIcon()
      Deprecated.
      Returns the absolute path to an icon to be used as the web console "favicon".
      static DefaultBrandingPlugin getInstance()
      Deprecated.
      Retrieves the shared instance
      java.lang.String getMainStyleSheet()
      Deprecated.
      Returns the absolute path to a CSS file to be used as the main CSS for the basic admin site.
      java.lang.String getProductImage()
      Deprecated.
      Returns an absolute path to an image to be rendered as the logo of the branding product.
      java.lang.String getProductName()
      Deprecated.
      Returns the name of the product in which the web console is contained and to which the web console is branded.
      java.lang.String getProductURL()
      Deprecated.
      Returns an (absolute) URL to a web site representing the product to which the web console is branded.
      java.lang.String getVendorImage()
      Deprecated.
      Returns an absolute path to an image to be rendered as the logo of the branding product vendor.
      java.lang.String getVendorName()
      Deprecated.
      Returns the name of the branding product vendor.
      java.lang.String getVendorURL()
      Deprecated.
      Returns an (absolute) URL to the web site of the branding product vendor.

      • Methods inherited from class java.lang.Object

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