Contents

List of Examples

List of Tables

Title and Copyright Information

Preface

• GlassFish Server Documentation Set
• Related Documentation
• Typographic Conventions
• Symbol Conventions
• Default Paths and File Names
• Documentation, Support, and Training
• Searching Oracle Product Documentation
• Documentation Accessibility

1 Introduction to the Development Environment for GlassFish Server Add-On Components

• GlassFish Server Modular Architecture and Add-On Components
• OSGi Alliance Module Management Subsystem
• Hundred-Kilobyte Kernel
• Overview of the Development Process for an Add-On Component
  • Writing HK2 Components
  • Extending the Administration Console
  • Extending the asadmin Utility
  • Adding Monitoring Capabilities
  • Adding Configuration Data for a Component
  • Adding Container Capabilities
  • Creating a Session Persistence Module
  • Packaging and Delivering an Add-On Component

2 Writing HK2 Components

• HK2 Component Model
• Services in the HK2 Component Model
• HK2 Runtime
  • Scopes of Services
  • Instantiation of Components in HK2
  • HK2 Lifecycle Interfaces
• Inversion of Control
  • Injecting HK2 Components
  • Instantiation Cascading in HK2
• Identifying a Class as an Add-On Component
• Using the Apache Maven Build System to Develop HK2 Components

3 Extending the Administration Console

• Administration Console Architecture
  • Implementing a Console Provider
• About Administration Console Templates
• About Integration Points
• Specifying the ID of an Add-On Component
• Adding Functionality to the Administration Console
  • Adding a Node to the Navigation Tree
    • Creating a JavaServer Faces Page for Your Node
  • Adding Tabs to a Page
    • Creating JavaServer Faces Pages for Your Tabs
  • Adding a Task to the Common Tasks Page
    • Creating a JavaServer Faces Page for Your Task
  • Adding a Task Group to the Common Tasks Page
    • Creating a JavaServer Faces Page for Your Task Group
  • Adding Content to a Page
    • Creating a JavaServer Faces Page for Your Page Content
  • Adding a Page to the Administration Console
• Adding Internationalization Support
• Changing the Theme or Brand of the Administration Console
• Creating an Integration Point Type
  • To Create an Integration Point Type

4 Extending the asadmin Utility

• About the Administrative Command Infrastructure of GlassFish Server
• Adding an asadmin Subcommand
  • 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 Allowed Targets
  • The Target Utility
  • 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
• Changing the Brand in the GlassFish Server CLI
• Examples of Extending the asadmin Utility
• Implementing Create, Delete, and List Commands Using Annotations
  • Command Patterns
  • Resolvers
  • The @Create Annotation
  • The @Delete Annotation
  • The @Listing Annotation
  • Create Command Decorators
  • Delete Command Decorators
  • Specifying Command Execution
  • Using Multiple Command Annotations

5 Adding Monitoring Capabilities

• Defining Statistics That Are to Be Monitored
  • Defining an Event Provider
    • Defining an Event Provider by Writing a Java Class
    • Defining an Event Provider by Writing an XML Fragment
    • Packaging a Component's Event Providers
  • Sending an Event
• Updating the Monitorable Object Tree
  • Creating Event Listeners
  • Representing a Component's Statistics in an Event Listener Class
  • Subscribing to Events From Event Provider Classes
  • Registering an Event Listener
• Dotted Names and REST URLs for an Add-On Component's Statistics
• Example of Adding Monitoring Capabilities

6 Adding Configuration Data for a Component

• How GlassFish Server Stores Configuration Data
• Defining an Element
  • To Define an Element
• Defining an Attribute of an Element
  • Representing an Attribute of an Element
  • Specifying the Data Type of an Attribute
  • Identifying an Attribute of an Element
  • Specifying the Name of an Attribute
  • Specifying the Default Value of an Attribute
  • Specifying Whether an Attribute Is Required or Optional
  • Example of Defining an Attribute of an Element
• Defining a Subelement
  • To Define a Subelement
• Validating Configuration Data
• Initializing a Component's Configuration Data
  • To Define a Component's Initial Configuration Data
  • To Write a Component's Initial Configuration Data to the domain.xml File
• Creating a Transaction to Update Configuration Data
  • To Create a Transaction to Update Configuration Data
• Dotted Names and REST URLs of Configuration Attributes
• Examples of Adding Configuration Data for a Component

7 Adding Container Capabilities

• Creating a Container Implementation
  • Marking the Class With the @Service Annotation
  • Implementing the Container Interface
• Adding an Archive Type
  • Implementing the ArchiveHandler Interface
• Creating Connector Modules
  • Associating File Types With Containers by Using the Sniffer Interface
    • Making Sniffer Implementations Available to the GlassFish Server
• Example of Adding Container Capabilities
  • Container Component Code
  • Web Client Code

8 Creating a Session Persistence Module

• Implementing the PersistenceStrategyBuilder Interface

9 Packaging, Integrating, and Delivering an Add-On Component

• Packaging an Add-On Component
• Integrating an Add-On Component With GlassFish Server
• Delivering an Add-On Component Through Update Tool

A Integration Point Reference

• Integration Point Attributes
• org.glassfish.admingui:navNode Integration Point
• org.glassfish.admingui:rightPanel Integration Point
• org.glassfish.admingui:rightPanelTitle Integration Point
• org.glassfish.admingui:serverInstTab Integration Point
• org.glassfish.admingui:commonTask Integration Point
• org.glassfish.admingui:configuration Integration Point
• org.glassfish.admingui:resources Integration Point
• org.glassfish.admingui:customtheme Integration Point
• org.glassfish.admingui:masthead Integration Point
• org.glassfish.admingui:loginimage Integration Point
• org.glassfish.admingui:loginform Integration Point
• org.glassfish.admingui:versioninfo Integration Point