org.apache.felix.webconsole

Interface BrandingPlugin

All Known Implementing Classes:

DefaultBrandingPlugin

public interface BrandingPlugin

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

See Also:

DefaultBrandingPlugin

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".
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.

Method Detail

getBrandName

java.lang.String getBrandName()

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.

Returns:

the name of the branding plugin

getProductName

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.

Returns:

the product name

getProductURL

java.lang.String getProductURL()

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

Returns:

the product URL

getProductImage

java.lang.String getProductImage()

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

Returns:

a path to an image - usually the product logo

getVendorName

java.lang.String getVendorName()

Returns the name of the branding product vendor.

Returns:

the product vendor

getVendorURL

java.lang.String getVendorURL()

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

Returns:

the URL of the product vendor

getVendorImage

java.lang.String getVendorImage()

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

Returns:

the company logo

getFavIcon

java.lang.String getFavIcon()

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

Returns:

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

getMainStyleSheet

java.lang.String getMainStyleSheet()

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

Returns:

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