Skip Navigation Links | |
Exit Print View | |
Oracle GlassFish Server 3.1 Add-On Component Development Guide |
1. Introduction to the Development Environment for GlassFish Server Add-On Components
3. Extending the Administration Console
4. Extending the asadmin Utility
About the Administrative Command Infrastructure of GlassFish Server
Representing an asadmin Subcommand as a Java Class
Specifying the Name of an asadmin Subcommand
Ensuring That an AdminCommand Implementation Is Stateless
Example of Adding an asadmin Subcommand
Adding Parameters to an asadmin Subcommand
Representing a Parameter of an asadmin Subcommand
Identifying a Parameter of an asadmin Subcommand
Specifying Whether a Parameter Is an Option or an Operand
Specifying the Name of an Option
Specifying the Long Form of an Option Name
Specifying the Short Form of an Option Name
Specifying the Acceptable Values of a Parameter
Specifying the Default Value of a Parameter
Specifying Whether a Parameter Is Required or Optional
Example of Adding Parameters to an asadmin Subcommand
Making asadmin Subcommands Cluster-Aware
Specifying asadmin Subcommand Execution
Subcommand Preprocessing and Postprocessing
Running a Command from Another Command
Adding Message Text Strings to an asadmin Subcommand
Enabling an asadmin Subcommand to Run
Setting the Context of an asadmin Subcommand
Examples of Extending the asadmin Utility
Implementing Create, Delete, and List Commands Using Annotations
Using Multiple Command Annotations
5. Adding Monitoring Capabilities
6. Adding Configuration Data for a Component
7. Adding Container Capabilities
8. Creating a Session Persistence Module
9. Packaging, Integrating, and Delivering an Add-On Component
The brand in the GlassFish Server command-line interface (CLI) consists of the product name and release information that are displayed in the following locations:
In the string that the version(1) subcommand displays
In each entry in the server.log file
If you are incorporating GlassFish Server into a new product with an external vendor's own brand name, change the brand in the GlassFish Server CLI.
To change the brand in the GlassFish 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:
Specifies the full product name without any release information, for example, Oracle GlassFish Server.
Specifies an abbreviated form of the product name without any release information, for example, GlassFish Server.
Returns the product major version, for example, 3
Specifies the product minor version, for example, 0.
Specifies the build version, for example, build 17.
Specifies a prefix for the product version, for example, v.
Specifies a suffix for the product version, for example, Beta.
Example 4-4 BrandingVersion.properties File for Changing the Brand in the GlassFish Server CLI
This example shows the content of the BrandingVersion.properties for defining the product name and release information of Oracle GlassFish Server 3.0.1, build 17. The abbreviated product name is glassfish-server.
product_name=Oracle GlassFish Server abbrev_product_name=glassfish-server major_version=3 minor_version=0.1 build_id=build 17