Sun GlassFish Enterprise Server v3 Add-On Component Development Guide

Changing the Brand in the Enterprise Server CLI

The brand in the Enterprise Server command-line interface (CLI) consists of the product name and release information that are displayed in the following locations:

If you are incorporating Enterprise Server into a new product with an external vendor's own brand name, change the brand in the Enterprise Server CLI.

To change the brand in the Enterprise Server CLI, create an OSGi fragment bundle that contains a plain text file that is named src/main/resources/BrandingVersion.properties.

In the BrandingVersion.properties file, define the following keyword-value pairs:

product_name=product-name
abbrev_product_name=abbrev-product-name
major_version=major-version
minor_version=minor-version
build_id=build-id
version_prefix=version-prefix
version_suffix=version-suffix

Define each keyword-value pair on a separate line of the file. Each value is a text string without quotes.

The meaning of each keyword-value pair is as follows:

product_name=product-name

Specifies the full product name without any release information, for example, Sun GlassFish Enterprise Server.



abbrev_product_name=abbrev-product-name

Specifies an abbreviated form of the product name without any release information, for example, Sun GlassFish.

major_version=major-version

Returns the product major version, for example, 3

minor_version=minor-version

Specifies the product minor version, for example, 0.

build_id=build-id

Specifies the build version, for example, build 17.

version_prefix=version-prefix

Specifies a prefix for the product version, for example, v.

version_suffix=version-suffix

Specifies a suffix for the product version, for example, Prelude.


Example 4–4 BrandingVersion.properties File for Changing the Brand in the Enterprise Server CLI

This example shows the content of the BrandingVersion.properties for defining the product name and release information of Sun GlassFish Enterprise Server v3.0 Prelude, build 17. The abbreviated product name is sun-glassfish.

product_name=Sun GlassFish Enterprise Server
abbrev_product_name=sun-glassfish
major_version=3
minor_version=0
build_id=build 17
version_prefix=v
version_suffix=Prelude