org.apache.felix.webconsole

Class DefaultBrandingPlugin

java.lang.Object

org.apache.felix.webconsole.DefaultBrandingPlugin

All Implemented Interfaces:

BrandingPlugin

public class DefaultBrandingPlugin
extends java.lang.Object
implements BrandingPlugin

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:

Name	Property Name	Default 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

Modifier and Type	Method and Description
java.lang.String	getBrandName() Returns an indicative name of the branding plugin.
java.lang.String	getFavIcon() Returns the absolute path to an icon to be used as the web console "favicon".
static DefaultBrandingPlugin	getInstance() Retrieves the shared instance
java.lang.String	getMainStyleSheet() Returns the absolute path to a CSS file to be used as the main CSS for the basic admin site.
java.lang.String	getProductImage() Returns an absolute path to an image to be rendered as the logo of the branding product.
java.lang.String	getProductName() 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() Returns an (absolute) URL to a web site representing the product to which the web console is branded.
java.lang.String	getVendorImage() Returns an absolute path to an image to be rendered as the logo of the branding product vendor.
java.lang.String	getVendorName() Returns the name of the branding product vendor.
java.lang.String	getVendorURL() 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

Method Detail

getInstance

public static DefaultBrandingPlugin getInstance()

Retrieves the shared instance

Returns:

the singleton instance of the object

getBrandName

public java.lang.String getBrandName()

Description copied from interface: BrandingPlugin

Returns an indicative name of the branding plugin. This value is used as the Window/Page title together with the title of the respective plugin.

Specified by:

getBrandName in interface BrandingPlugin

Returns:

the name of the branding plugin

See Also:

BrandingPlugin.getBrandName()

getProductName

public java.lang.String getProductName()

Description copied from interface: BrandingPlugin

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

Specified by:

getProductName in interface BrandingPlugin

Returns:

the product name

See Also:

BrandingPlugin.getProductName()

getProductURL

public java.lang.String getProductURL()

Description copied from interface: BrandingPlugin

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

Specified by:

getProductURL in interface BrandingPlugin

Returns:

the product URL

See Also:

BrandingPlugin.getProductURL()

getProductImage

public java.lang.String getProductImage()

Description copied from interface: BrandingPlugin

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

Specified by:

getProductImage in interface BrandingPlugin

Returns:

a path to an image - usually the product logo

See Also:

BrandingPlugin.getProductImage()

getVendorName

public java.lang.String getVendorName()

Description copied from interface: BrandingPlugin

Returns the name of the branding product vendor.

Specified by:

getVendorName in interface BrandingPlugin

Returns:

the product vendor

See Also:

BrandingPlugin.getVendorName()

getVendorURL

public java.lang.String getVendorURL()

Description copied from interface: BrandingPlugin

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

Specified by:

getVendorURL in interface BrandingPlugin

Returns:

the URL of the product vendor

See Also:

BrandingPlugin.getVendorURL()

getVendorImage

public java.lang.String getVendorImage()

Description copied from interface: BrandingPlugin

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

Specified by:

getVendorImage in interface BrandingPlugin

Returns:

the company logo

See Also:

BrandingPlugin.getVendorImage()

getFavIcon

public java.lang.String getFavIcon()

Description copied from interface: BrandingPlugin

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

Specified by:

getFavIcon in interface BrandingPlugin

Returns:

path to an image, that is shown as favorite icon in the web browser

See Also:

BrandingPlugin.getFavIcon()

getMainStyleSheet

public java.lang.String getMainStyleSheet()

Description copied from interface: BrandingPlugin

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

Specified by:

getMainStyleSheet in interface BrandingPlugin

Returns:

a path to a custom CSS. Used to override the default web console styling

See Also:

BrandingPlugin.getMainStyleSheet()