GlassFish - World's first Java EE 7 Application Server


Integration Points

Prelude Integration Points | Back to AdminConsole V3

The following table describes the currently supported IntegrationPoints for the admin console application. If you have questions, please join and email the email alias.  This table was started for v3, however, some data may apply to earlier releases -- even if the since column says 3.0.

type parentId priority content Since
org.glassfish.admingui:navNode
Currently, the left-hand navigation tree for the application. 		The parentId is the ID of the navigation node which should be the parent for the content of this IntegrationPoint. Some of the interesting IDs that you may want to target using the parentId:
  • tree - The root node of the entire navigation tree.
  • applicationServer - "Application Server" tree node.
  • applications - The "Applications" tree node.
  • webApplications - Web Applications" tree node.
  • Resources - Resources tree node.
  • #{configNameId} - Configuration tree node.
  • webContainer - Web Container tree node.
  • httpService - HTTP Service tree node.
 Relative ordering of IntegrationPoints with the same parentId. The content can be one of two things: a relative path to a page containing content to integrate, or a URL to an external resource which returns the appropriate data structure (see "Navigation Node Data Structure" below) for inclusion GF3.0
org.glassfish.admingui:rightPanel
See also: org.glassfish.admingui:rightPanelTitle 		Not Applicable If multiple plugins specify content for the right frame, the one with greater priority will take precedence. This should specify a path relative to the root of the plugin .jar file to a file containing the content for the right panel. Alternately, it may contain a full URL which will deliver the content for the right panel. GF3.0
org.glassfish.admingui:rightPanelTitle
See also: org.glassfish.admingui:rightPanel 		Not Applicable If multiple plugins specify content for the right frame, the one with greater priority will take precedence. This specifies the title to display at the top of the right panel. GF3.0
org.glassfish.admingui:serverInstTab
Add a tab to the tabSet of the Application Server General page. 		The "parentId" is a simple "id" of the tabSet which should be the parent for the "content" of this IntegrationPoint. One id that you may want to target is the "parentId":
  • serverInstTabs - the first tabset that displays the General info of the appserver.
 Relative ordering of IntegrationPoints with the same parentId. A relative path to a JSF page containing content to integrate.
  • Note: When using this IP, you need to set the session variable of serverInstTabs to your tabId
  • setSessionAttribute(key="serverInstTabs" value="myTabId");
  • do a #include "/appServer/serverInstTabs.inc" in your page
 GF3.0
org.glassfish.admingui:commonTask
Add a common task group to the common task page. 		Add a common task Group or common task under an existing group. The parentId can be:
  • commonTasksSection : use this to add a group
  • deployment: add individual task to Deployment Group
  • monitoring:add task to monitoring group
 Relative ordering of the intergration point to common task page A relative path to a JSF page containing content to integrate. GF3.0
org.glassfish.admingui:configuration
Add any component to the configuration page property sheet. 		Add a component to the Configuration Page. We normally add a link to the sub tree node that is under configuration.
  • propSheetSection - use this to add any component to the page.
 Relative ordering of the IntegrationPoints to the same parentId A relative path to a JSF page containing content to integrate. GF3.0
org.glassfish.admingui:resources
Add any component to the resource page property sheet. 		Add a component to the Resources Page. We normally add a link to the sub tree node that is under Resources.
  • propSheetSection - use this to add any component to the page.
 Relative ordering of the IntegrationPoints to the same parentId A relative path to a JSF page containing content to integrate. GF3.0
org.glassfish.admingui:customtheme Not Applicable Valid priority values are from 1 to 100. Smallest number will have highest priority and will be used first. The name of the properties files which contains the correct key/value pairs which will be used to access your theme jar file. The following are required keys:
  • ThemeContext.DEFAULT_THEME - define the theme name for the theme that this application may depend on.(required)
  • ThemeContext.DEFAULT_THEME_VERSION - define the theme version this application may depend on.(required)
 GF3.0
org.glassfish.admingui:masthead Not Applicable Valid priority values are from 1 to 100. Smallest number will have highest priority and will be used first. Name and location of the include masthead file which can be customized with a branding image. This include file will be integreted on the masthead of the Administration Console. GF3.0
org.glassfish.admingui:loginimage Not Applicable Valid priority values are from 1 to 100. Smallest number will have highest priority and will be used first. Name and location of the include file containing the branding login image code which will be integrated with the login page of the Administration Console. GF3.0
org.glassfish.admingui:loginform Not Applicable Valid priority values are from 1 to 100. Smallest number will have highest priority and will be used first. Name and location of the include file containing the customized login form code. This code also contains the login background image used for the login of the Administration Console. GF3.0
org.glassfish.admingui:versioninfo Not Applicable Valid priority values are from 1 to 100. Smallest number will have highest priority and will be used first. Name and location of the include file containing the branding image which will be integreted with the content of version popup window. GF3.0
org.glassfish.admingui:upsellframepe Not Applicable Valid priority values are from 1 to 100. Smallest number will have highest priority and will be used first. Name and location of the include file containing the frame source code which will be used to display/hide content in the bottom frame of the Administration console for the community distribution. GF3.0
org.glassfish.admingui:upsellframeee Not Applicable Valid priority values are from 1 to 100. Smallest number will have highest priority and will be used first. Name and location of the include file containing the frame source code which will be used to display/hide content in the bottom frame of the Administration console for the enterprise distribution. GF3.0
org.glassfish.admingui.availabilityTabs Srini, complete this...     GF3.1

META-INF/admingui/console-config.xml Example:

<?xml version="1.0" encoding="UTF-8"?>

<console-config id="javaone">
    <integration-point
        id="JavaOneNode"
        type="org.glassfish.admingui:navNode"
        priority="210"
        parentId="tree"
        content="treenode-ex1.jsf"
    />
</console-config>

Navigation Node Data Structure

A basic navigation node might look something like this:

<gf:navNode id="myNode"
                  label="My Custom Nav Node"
                  url="/someNewPage.jsf"
                  icon="/resources/images/myIcon.gif"
                  expanded="true">
    </gf:navNode>

For more complex navigation requirements, {{gf:navNode}}s can be nested. The full set of supported attributes is as follows:

  • id - The ID of the component. While IDs are optional, it is a good idea to provide a specific ID, especially if one expects to want to add nodes under this node in the future.
  • label - The text label for the navigation node
  • url - An optional URL
  • icon - The URL to an image for the tree's root icon
  • target - An optional target to specify on the link created for this node (e.g., '_blank')
  • expanded - A boolean indicating whether or not this node should be expanded by default.
  • template - An optional parameter indicate what template should be used to decorate the page to which this node links. The value will be a relative path to a template file provided by the Admin Console or one of its plugins (e.g., '/pluginId/templates/customLayout.xhmtl'). The default value is /layout.xhtml. If the 
    url
    parameter points to an external resource, the URL rendered will point a page in the admin console. This page will then read the contents of the users-specified URL and display those contents in the appropriate spot in the specified template.
  • processPage - This option is intended to be used in conjunction with the template parameter. By default, the page read and displayed will be rendered as is. If, however, the plugin author wishes the page to processed by the Admin Console runtime, the parameter should be set to "true." The URL referenced must then return valid markup.