Package org.apache.felix.webconsole

Class DefaultBrandingPlugin

  • All Implemented Interfaces:
    BrandingPlugin, org.apache.felix.webconsole.spi.BrandingPlugin
    @Deprecated
public class DefaultBrandingPlugin
extends java.lang.Object
implements BrandingPlugin
    Deprecated.
    Plugins should never use the branding plugin directly
    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:

    Web Console Branding Properties
    NameProperty NameDefault Value
    Brand Name webconsole.brand.name Apache Felix Web Console
    Product Name webconsole.product.name Apache Felix
    Product URL webconsole.product.url https://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 https://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 Detail

      • getInstance

        public static DefaultBrandingPlugin getInstance()
        Deprecated.
        Retrieves the shared instance
        Returns:
        the singleton instance of the object

      • getBrandName

        public java.lang.String getBrandName()
        Deprecated.
        Specified by:
        getBrandName in interface org.apache.felix.webconsole.spi.BrandingPlugin

      • getFavIcon

        public java.lang.String getFavIcon()
        Deprecated.
        Specified by:
        getFavIcon in interface org.apache.felix.webconsole.spi.BrandingPlugin

      • getMainStyleSheet

        public java.lang.String getMainStyleSheet()
        Deprecated.
        Specified by:
        getMainStyleSheet in interface org.apache.felix.webconsole.spi.BrandingPlugin

      • getProductImage

        public java.lang.String getProductImage()
        Deprecated.
        Specified by:
        getProductImage in interface org.apache.felix.webconsole.spi.BrandingPlugin

      • getProductName

        public java.lang.String getProductName()
        Deprecated.
        Specified by:
        getProductName in interface org.apache.felix.webconsole.spi.BrandingPlugin

      • getProductURL

        public java.lang.String getProductURL()
        Deprecated.
        Specified by:
        getProductURL in interface org.apache.felix.webconsole.spi.BrandingPlugin

      • getVendorImage

        public java.lang.String getVendorImage()
        Deprecated.
        Specified by:
        getVendorImage in interface org.apache.felix.webconsole.spi.BrandingPlugin

      • getVendorName

        public java.lang.String getVendorName()
        Deprecated.
        Specified by:
        getVendorName in interface org.apache.felix.webconsole.spi.BrandingPlugin

      • getVendorURL

        public java.lang.String getVendorURL()
        Deprecated.
        Specified by:
        getVendorURL in interface org.apache.felix.webconsole.spi.BrandingPlugin