Extending the GlassFish
v3 Admin Console
Ken Paulsen
Senior Staff Engineer
Sun Microsystems, Inc.

Agenda
• What is an Admin Console Plugin?
• Plugin Details
• References

What is an Admin Console Plugin?
Answer: An OSGi bundle which contains 1 or more
Integration Points:
• Tree Nodes
• Pages
• Tabs
• Help
• Page-specific
• Theme
3

Admin Console v3 Plugins
What is an Admin Console Plugin?
Integration Point
Integration Point
4

What is an Admin Console Plugin?
• In addition to Integration Points, a Console
Plugin may also:
> Expose new Java code that is used by any
other plugin via “JSFTemplating Handlers.”
> Import packages from other OSGi bundles
> Provide additional pages, page fragments, or
resources (images, css, properties files,
JavaScript, etc.).
> Provide faces-config.xml file entries which are
scanned at application startup.
5

Agenda
• What is an Admin Console Plugin?
• Plugin Details
• References

Plugin Details
7

Console Provider
• Marker Service
• Provides console-config.xml URL
• Default: META-INF/admingui/console-config.xml
@Service
public class JavaOnePlugin implements
ConsoleProvider {
public URL getConfiguration() {
return null;
}
}

Integration Points
• Defined inside console-config.xml:
<?xml version=\"1.0\" encoding=\"UTF-8\"?>
<console-config id=\"javaone\">
<integration-point
id=\"JavaOneNode\"
type=\"org.glassfish.admingui:treeNode\"
priority=\"210\"
parentId=\"tree\"
content=\"treenode-ex1.jsf\" />
</console-config>

Integration Points
• The “id” for the plugin bundle
• Visible in urls to plugin bundle resources
<?xml version=\"1.0\" encoding=\"UTF-8\"?>
<console-config id=\"javaone\">
<integration-point
id=\"JavaOneNode\"
type=\"org.glassfish.admingui:treeNode\"
priority=\"210\"
parentId=\"tree\"
content=\"treenode-ex1.jsf\" />
</console-config>

Integration Points
• The integration-point “type” targets where
an integration should occur
<?xml version=\"1.0\" encoding=\"UTF-8\"?>
<console-config id=\"javaone\">
<integration-point
id=\"JavaOneNode\"
type=\"org.glassfish.admingui:treeNode\"
priority=\"210\"
parentId=\"tree\"
content=\"treenode-ex1.jsf\" />
</console-config>

Integration Points
• “priority” can be used for ordering
• “parentId” is used for fine-grained targeting
<?xml version=\"1.0\" encoding=\"UTF-8\"?>
<console-config id=\"javaone\">
<integration-point
id=\"JavaOneNode\"
type=\"org.glassfish.admingui:treeNode\"
priority=\"210\"
parentId=\"tree\"
content=\"treenode-ex1.jsf\" />
</console-config>

Integration Points
• “content” specifies the contents of the
integration, typically a JSF page fragment.
<?xml version=\"1.0\" encoding=\"UTF-8\"?>
<console-config id=\"javaone\">
<integration-point
id=\"JavaOneNode\"
type=\"org.glassfish.admingui:treeNode\"
priority=\"210\"
parentId=\"tree\"
content=\"treenode-ex1.jsf\" />
</console-config>

Agenda
• What is an Admin Console Plugin?
• Plugin Details
• References

References
• Plugin Developer Guide Documentation
> http://wiki.glassfish.java.net/Wiki.jsp?page=AddOnComponentDevelopmentGuide
• JSFTemplating Templates
> Makes creating new pages easy
> Follows Facelets templating pattern
> http://wiki.glassfish.java.net/Wiki.jsp?page=V3AdminGuiTemplates
• JSFTemplating Handlers
> Used to invoke Java code from plugin JSF pages
> Many already available, ready for use
> https://jsftemplating.dev.java.net/doc
• Woodstock Documentation
> https://woodstock.dev.java.net/Documentation.htm
• Documentation of all public Integration Points:
> http://wiki.glassfish.java.net/Wiki.jsp?page=V3IntegrationPoint

Questions?
Extending the GlassFish
v3 Admin Console
https://glassfish.dev.java.net
Ken Paulsen
ken.paulsen@sun.com