GlassFish - World's first Java EE 7 Application Server


<h1>GlassFish v3 User Task Analysis for Pluggability</h1>

Back to GlassFish v3 User Task Analyses

Scope

To determine:

  • The tasks that developers must perform by using GlassFish v3 interfaces for pluggability to develop plugins for GlassFish. This scope is limited only to those tasks that ensure that the plugin is a suitable GlassFish plugin.
  • The tasks that an administrator must perform to add or remove plugins for GlassFish.

Related Information

Document Plan

List of Tasks

Developer Tasks

All developer tasks will be explained in a new document: Sun GlassFish Enterprise Server v3 Prelude Add-On Component Development Guide.

  • Identify a class as a plugin
  • Extend the Administration Console GUI
    • Specify the ID of a plugin
    • Add functionality to existing pages:
      • Add a tab to a page
      • Add a page to the console
      • Add a node to the tree
      • Add a task to the Common Tasks page
      • Add elements to a page ADDED Aug 28
    • Add online help
    • Add internationalization support
    • Replace the content of an existing application with new content
    • Remove or change existing content
    • Add an integration point ADDED Aug 28
  • Add an asadmin command
  • Change the theme or brand of the user interface:
    • Change the theme or brand of the Administration Console GUI
    • Change the theme or brand of the of asadmin CLI
  • Add container capabilities
    • Implement a container
    • Implement connector interfaces
    • (Optional)Implement pluggable configuration
    • (Optional)Add AMX configuration
    • (Optional)Define new commands for configuration
  • Add deployment capabilities ADDED Aug 28
    • Add an archive type ADDED Aug 28
    • Add an annotation processor ADDED Aug 28
    • Add a class loader implementation ADDED Aug 28
  • Plug an OSGi bundle in GlassFish v3 runtime
  • Specify the package name of plugin
  • Package and deliver a plugin

Administrator Tasks

Administrator tasks will be explained in the Administration Guide and the Administration Console GUI Online Help.

  • Manage plugins
    • Manage plugins by using Update Tool
    • Manage plugins by other means

Associated Concepts

Concept Task
OSGi All
Integration points Extend the Administration Console GUI and subtasks Add an integration point
Administration Console architecture (a web application that is composed of OSGi bundles) Extend the Administration Console GUI and subtasks
Templates Extend the Administration Console GUI and subtasks
asadmin client-server protocol}} Add asadmin command

Monitoring Interfaces Summary

Key to documents in Citation column:

%%sortable

Interface Citation Type Package Description
Monitor P:4.1.3 Interface Not found Contract to enable a component to expose monitoring data therough an HK2 service.
MonitorData P:4.1.3 Annotation Not found Annotation to mark parameters as monitoring data.
ProbeProviderFactory M:4.1.1.1 M:4.5.1.2 Interface org.glassfish.flashlight.provider Factory class to generate implementation classes of event providers.
ProbeProvider M:4.1.1.2 Annotation Not found 1 Annotation to designate an interface as an event provider.
ProbeName M:4.1.1.3 Annotation org.glassfish.flashlight.provider.annotations Annotation to identify the event type associated with an event provider method.
ProbeParam M:4.1.1.4 Annotation org.glassfish.flashlight.provider.annotations Annotation to identify a method parameter as a value that a listener can monitor.
ProbeProviderInfo M:4.1.1.7 Interface Not found 2 Interface to define methods for getting information about an event type in an event provider class.
ProbeListener M:4.1.1.8 M:4.5.1.2 Annotation org.glassfish.flashlight.client Annotation to enable a listener to receive callbacks.
MethodEntry M:4.1.1.10.1 Annotation Not found Annotation to enable a listener to receive callbacks when the target method is entered.
MethodExit M:4.1.1.10.1 Annotation Not found Annotation to enable a listener to receive callbacks when the target method is exited
OnException M:4.1.1.10.3 Annotation Not found Annotation to enable a listener to receive callbacks when the target method throws an exception.
ProbeClientMediator M:4.1.1.12 M:4.5.1.2 Interface org.glassfish.flashlight.client Class to enable listeners to receive callbacks.
Monitorable 3 M:4.1.2.6 M:4.5.1.2 Interface org.glassfish.flashlight.annotations Annotation to mark a class for addition to the Monitor Regsitry.
Counter 3 M:4.1.2.6 Interface org.glassfish.flashlight.statistics Interface to define a counter that a class can use.
TimeStats 3 M:4.1.2.6 Interface org.glassfish.flashlight.statistics Interface to define a timer.
Average 3 M:4.1.2.6 Interface org.glassfish.flashlight.statistics Interface to define averages.
ProbeMethodExit M:4.5.1.2 Interface Not found  
ProbeMethodException M:4.5.1.2 Interface Not found  
MonitoringRunTimeDataRegistry M:4.5.2 Interface org.glassfish.flashlight  
TreeNode     org.glassfish.flashlight.datatree  
  1. A class is available in org.glassfish.flashlight.impl.core.
  2. The ProbeProvider class seems to implement at least part of this interface.
  3. This interface is not exposed in v3 Prelude.

Availability

Back to GlassFish v3 User Task Analyses