blob: 6b874f245c5c98717cffd0b9ce748d80557691e1 [file] [log] [blame]
type=page
status=published
title=Eclipse GlassFish Server Add-On Component Development Guide, Release 7
next=title.html
~~~~~~
= Eclipse GlassFish Server Add-On Component Development Guide, Release 7
[[contents]]
== Contents
* link:title.html#eclipse-glassfish-server[Eclipse GlassFish Server]
=== link:preface.html#preface[Preface]
** link:preface.html#GSACG00079[GlassFish Server Documentation Set]
** link:preface.html#GSACG00080[Related Documentation]
** link:preface.html#GSACG00081[Typographic Conventions]
** link:preface.html#GSACG00082[Symbol Conventions]
** link:preface.html#GSACG00083[Default Paths and File Names]
* link:introduction.html#GSACG00001[Introduction to the Development Environment for Eclipse GlassFish Add-On Components]
** link:introduction.html#GSACG00087[GlassFish Server Modular Architecture and Add-On Components]
** link:introduction.html#GSACG00088[OSGi Alliance Module Management Subsystem]
** link:introduction.html#GSACG00089[Hundred-Kilobyte Kernel]
** link:introduction.html#GSACG00090[Overview of the Development Process for an Add-On Component]
*** link:introduction.html#GSACG00173[Writing HK2 Components]
*** link:introduction.html#GSACG00174[Extending the Administration Console]
*** link:introduction.html#GSACG00175[Extending the `asadmin` Utility]
*** link:introduction.html#GSACG00176[Adding Monitoring Capabilities]
*** link:introduction.html#GSACG00177[Adding Configuration Data for a Component]
*** link:introduction.html#GSACG00178[Adding Container Capabilities]
*** link:introduction.html#GSACG00179[Creating a Session Persistence Module]
*** link:introduction.html#GSACG00180[Packaging and Delivering an Add-On Component]
* link:writing-hk2-components.html#GSACG00002[Writing HK2 Components]
** link:writing-hk2-components.html#GSACG00091[HK2 Component Model]
** link:writing-hk2-components.html#GSACG00092[Services in the HK2 Component Model]
** link:writing-hk2-components.html#GSACG00093[HK2 Runtime]
*** link:writing-hk2-components.html#GSACG00181[Scopes of Services]
*** link:writing-hk2-components.html#GSACG00182[Instantiation of Components in HK2]
*** link:writing-hk2-components.html#GSACG00183[HK2 Lifecycle Interfaces]
** link:writing-hk2-components.html#GSACG00094[Inversion of Control]
*** link:writing-hk2-components.html#GSACG00184[Injecting HK2 Components]
*** link:writing-hk2-components.html#GSACG00186[Instantiation Cascading in HK2]
** link:writing-hk2-components.html#GSACG00095[Identifying a Class as an Add-On Component]
** link:writing-hk2-components.html#GSACG00096[Using the Apache Maven Build System to Develop HK2 Components]
* link:extending-the-admin-console.html#GSACG00003[Extending the Administration Console]
** link:extending-the-admin-console.html#GSACG00097[Administration Console Architecture]
*** link:extending-the-admin-console.html#GSACG00187[Implementing a Console Provider]
** link:extending-the-admin-console.html#GSACG00098[About Administration Console Templates]
** link:extending-the-admin-console.html#GSACG00099[About Integration Points]
** link:extending-the-admin-console.html#GSACG00100[Specifying the ID of an Add-On Component]
** link:extending-the-admin-console.html#GSACG00101[Adding Functionality to the Administration Console]
*** link:extending-the-admin-console.html#GSACG00188[Adding a Node to the Navigation Tree]
*** link:extending-the-admin-console.html#GSACG00189[Adding Tabs to a Page]
*** link:extending-the-admin-console.html#GSACG00190[Adding a Task to the Common Tasks Page]
*** link:extending-the-admin-console.html#GSACG00191[Adding a Task Group to the Common Tasks Page]
*** link:extending-the-admin-console.html#GSACG00192[Adding Content to a Page]
*** link:extending-the-admin-console.html#GSACG00193[Adding a Page to the Administration Console]
** link:extending-the-admin-console.html#GSACG00102[Adding Internationalization Support]
** link:extending-the-admin-console.html#GSACG00103[Changing the Theme or Brand of the Administration Console]
** link:extending-the-admin-console.html#GSACG00104[Creating an Integration Point Type]
*** link:extending-the-admin-console.html#sthref4[To Create an Integration Point Type]
* link:extending-asadmin.html#GSACG00004[Extending the `asadmin` Utility]
** link:extending-asadmin.html#GSACG00105[About the Administrative Command Infrastructure of GlassFish Server]
** link:extending-asadmin.html#GSACG00107[Adding an `asadmin` Subcommand]
*** link:extending-asadmin.html#GSACG00194[Representing an `asadmin` Subcommand as a Java Class]
*** link:extending-asadmin.html#GSACG00195[Specifying the Name of an `asadmin` Subcommand]
*** link:extending-asadmin.html#GSACG00196[Ensuring That an `AdminCommand` Implementation Is Stateless]
*** link:extending-asadmin.html#GSACG00197[Example of Adding an `asadmin` Subcommand]
** link:extending-asadmin.html#GSACG00108[Adding Parameters to an `asadmin` Subcommand]
*** link:extending-asadmin.html#GSACG00198[Representing a Parameter of an `asadmin` Subcommand]
*** link:extending-asadmin.html#GSACG00199[Identifying a Parameter of an `asadmin` Subcommand]
*** link:extending-asadmin.html#GSACG00200[Specifying Whether a Parameter Is an Option or an Operand]
*** link:extending-asadmin.html#GSACG00201[Specifying the Name of an Option]
*** link:extending-asadmin.html#GSACG00202[Specifying the Acceptable Values of a Parameter]
*** link:extending-asadmin.html#GSACG00203[Specifying the Default Value of a Parameter]
*** link:extending-asadmin.html#GSACG00204[Specifying Whether a Parameter Is Required or Optional]
*** link:extending-asadmin.html#GSACG00205[Example of Adding Parameters to an `asadmin` Subcommand]
** link:extending-asadmin.html#GSACG00109[Making `asadmin` Subcommands Cluster-Aware]
*** link:extending-asadmin.html#GSACG00206[Specifying Allowed Targets]
*** link:extending-asadmin.html#GSACG00207[The `Target` Utility]
*** link:extending-asadmin.html#GSACG00208[Specifying `asadmin` Subcommand Execution]
*** link:extending-asadmin.html#GSACG00209[Subcommand Preprocessing and Postprocessing]
*** link:extending-asadmin.html#GSACG00210[Running a Command from Another Command]
** link:extending-asadmin.html#GSACG00110[Adding Message Text Strings to an `asadmin` Subcommand]
** link:extending-asadmin.html#GSACG00111[Enabling an `asadmin` Subcommand to Run]
** link:extending-asadmin.html#GSACG00112[Setting the Context of an `asadmin` Subcommand]
** link:extending-asadmin.html#GSACG00113[Changing the Brand in the GlassFish Server CLI]
** link:extending-asadmin.html#GSACG00114[Examples of Extending the `asadmin` Utility]
** link:extending-asadmin.html#GSACG00115[Implementing Create, Delete, and List Commands Using Annotations]
*** link:extending-asadmin.html#GSACG00211[Command Patterns]
*** link:extending-asadmin.html#GSACG00212[Resolvers]
*** link:extending-asadmin.html#GSACG00213[The `@Create` Annotation]
*** link:extending-asadmin.html#GSACG00214[The `@Delete` Annotation]
*** link:extending-asadmin.html#GSACG00215[The `@Listing` Annotation]
*** link:extending-asadmin.html#GSACG00216[Create Command Decorators]
*** link:extending-asadmin.html#GSACG00217[Delete Command Decorators]
*** link:extending-asadmin.html#GSACG00218[Specifying Command Execution]
*** link:extending-asadmin.html#GSACG00219[Using Multiple Command Annotations]
* link:adding-monitoring-capabilities.html#GSACG00005[Adding Monitoring Capabilities]
** link:adding-monitoring-capabilities.html#GSACG00116[Defining Statistics That Are to Be Monitored]
*** link:adding-monitoring-capabilities.html#GSACG00220[Defining an Event Provider]
*** link:adding-monitoring-capabilities.html#GSACG00221[Sending an Event]
** link:adding-monitoring-capabilities.html#GSACG00117[Updating the Monitorable Object Tree]
*** link:adding-monitoring-capabilities.html#GSACG00222[Creating Event Listeners]
*** link:adding-monitoring-capabilities.html#GSACG00223[Representing a Component's Statistics in an Event Listener Class]
*** link:adding-monitoring-capabilities.html#GSACG00224[Subscribing to Events From Event Provider Classes]
*** link:adding-monitoring-capabilities.html#GSACG00225[Listening for Events From Classes That Are Not Event Providers]
*** link:adding-monitoring-capabilities.html#GSACG00226[Registering an Event Listener]
** link:adding-monitoring-capabilities.html#GSACG00118[Dotted Names and REST URLs for an Add-On Component's Statistics]
** link:adding-monitoring-capabilities.html#GSACG00119[Adding a Type to the `monitor` Command]
** link:adding-monitoring-capabilities.html#GSACG00120[Example of Adding Monitoring Capabilities]
* link:adding-configuration-data.html#GSACG00006[Adding Configuration Data for a Component]
** link:adding-configuration-data.html#GSACG00121[How GlassFish Server Stores Configuration Data]
** link:adding-configuration-data.html#GSACG00122[Defining an Element]
*** link:adding-configuration-data.html#GSACG00074[To Define an Element]
** link:adding-configuration-data.html#GSACG00123[Defining an Attribute of an Element]
*** link:adding-configuration-data.html#GSACG00227[Representing an Attribute of an Element]
*** link:adding-configuration-data.html#GSACG00228[Specifying the Data Type of an Attribute]
*** link:adding-configuration-data.html#GSACG00229[Identifying an Attribute of an Element]
*** link:adding-configuration-data.html#GSACG00230[Specifying the Name of an Attribute]
*** link:adding-configuration-data.html#GSACG00231[Specifying the Default Value of an Attribute]
*** link:adding-configuration-data.html#GSACG00232[Specifying Whether an Attribute Is Required or Optional]
*** link:adding-configuration-data.html#GSACG00233[Example of Defining an Attribute of an Element]
** link:adding-configuration-data.html#GSACG00124[Defining a Subelement]
*** link:adding-configuration-data.html#GSACG00075[To Define a Subelement]
** link:adding-configuration-data.html#GSACG00125[Validating Configuration Data]
** link:adding-configuration-data.html#GSACG00126[Initializing a Component's Configuration Data]
*** link:adding-configuration-data.html#GSACG00076[To Define a Component's Initial Configuration Data]
*** link:adding-configuration-data.html#GSACG00077[To Write a Component's Initial Configuration Data to the `domain.xml` File]
** link:adding-configuration-data.html#GSACG00127[Creating a Transaction to Update Configuration Data]
*** link:adding-configuration-data.html#GSACG00078[To Create a Transaction to Update Configuration Data]
** link:adding-configuration-data.html#GSACG00128[Dotted Names and REST URLs of Configuration Attributes]
** link:adding-configuration-data.html#GSACG00131[Examples of Adding Configuration Data for a Component]
* link:adding-container-capabilities.html#GSACG00007[Adding Container Capabilities]
** link:adding-container-capabilities.html#GSACG00132[Creating a `Container` Implementation]
*** link:adding-container-capabilities.html#GSACG00234[Marking the Class With the `@Service` Annotation]
*** link:adding-container-capabilities.html#GSACG00235[Implementing the `Container` Interface]
** link:adding-container-capabilities.html#GSACG00133[Adding an Archive Type]
*** link:adding-container-capabilities.html#GSACG00236[Implementing the `ArchiveHandler` Interface]
** link:adding-container-capabilities.html#GSACG00134[Creating Connector Modules]
*** link:adding-container-capabilities.html#GSACG00237[Associating File Types With Containers by Using the `Sniffer` Interface]
** link:adding-container-capabilities.html#GSACG00135[Example of Adding Container Capabilities]
*** link:adding-container-capabilities.html#GSACG00238[Container Component Code]
*** link:adding-container-capabilities.html#GSACG00239[Web Client Code]
* link:session-persistence-modules.html#GSACG00008[Creating a Session Persistence Module]
** link:session-persistence-modules.html#GSACG00141[Implementing the `PersistenceStrategyBuilder` Interface]
* link:packaging-integrating-delivering.html#GSACG00009[Packaging, Integrating, and Delivering an Add-On Component]
** link:packaging-integrating-delivering.html#GSACG00142[Packaging an Add-On Component]
** link:packaging-integrating-delivering.html#GSACG00143[Integrating an Add-On Component With GlassFish Server]
** link:packaging-integrating-delivering.html#GSACG00144[Delivering an Add-On Component Through Update Tool]
* link:integration-point-reference.html#GSACG00010[Integration Point Reference]
** link:integration-point-reference.html#GSACG00145[Integration Point Attributes]
** link:integration-point-reference.html#GSACG00146[`org.glassfish.admingui:navNode` Integration Point]
** link:integration-point-reference.html#GSACG00147[`org.glassfish.admingui:rightPanel` Integration Point]
** link:integration-point-reference.html#GSACG00148[`org.glassfish.admingui:rightPanelTitle` Integration Point]
** link:integration-point-reference.html#GSACG00149[`org.glassfish.admingui:serverInstTab` Integration Point]
** link:integration-point-reference.html#GSACG00150[`org.glassfish.admingui:commonTask` Integration Point]
** link:integration-point-reference.html#GSACG00151[`org.glassfish.admingui:configuration` Integration Point]
** link:integration-point-reference.html#GSACG00152[`org.glassfish.admingui:resources` Integration Point]
** link:integration-point-reference.html#GSACG00153[`org.glassfish.admingui:customtheme` Integration Point]
** link:integration-point-reference.html#GSACG00154[`org.glassfish.admingui:masthead` Integration Point]
** link:integration-point-reference.html#GSACG00155[`org.glassfish.admingui:loginimage` Integration Point]
** link:integration-point-reference.html#GSACG00156[`org.glassfish.admingui:loginform` Integration Point]
** link:integration-point-reference.html#GSACG00157[`org.glassfish.admingui:versioninfo` Integration Point]