ESB Console Plugin Type

A Plugin Type provides the ability to customize the ESB Console. This ability to customize areas of the Web UI is based on one or more of the following customization criteria:

• Entity Type - An EntityType defines the type of component that you want to customize
• UI element or UI Integration Type - A UIIntegrationType defines the type of UI Component that you want to provide customization for.
• Identifier - An Identifier defines the specific type of entity that you want to customize.
• ParentId - A Parent Identifier defines the parent of the specific type of entity that you want to customize.

In addition there are attributes that are required to be specified in the PluginType. They are:

• imageUrl - specifies the URL of the image resource file to use when displaying an element.
• urlEntryPoint - The URL entry point of the page to display. The isRelativeToContextRoot attribute is set to true if the web application plugin is deployed on the same server as the ESB Console. It is set to false if the plugin web application is deployed on a remote server.
• tabsetReference - The tabset reference that is linked to that node.

Note that both tabsetReference and urlEntryPoint elements are mutually exclusive - you wont find one when you find the other.

Sample 1 - Customize all occurences of a BPEL Service Engine tree node

The following specifies a custom plugin type that customizes all occurences of a BPEL Service Engine tree node.

    <!-- Custom Plugin Type that customizes BPEL Service Engine tree nodes -->
    <pluginType customPluginType='Management' entityType='service-engine' uiIntegrationType='tree-node'>
        <parentId entityType='ServiceEngines'>Service Engines</parentId>
        <displayName>sun-bpel-engine</displayName>
        <urlEntryPoint isRelativeToContextRoot='false'>http://fully.Qualified.Domain.Host.Name:8080/bpel/welcomeGWT.html</urlEntryPoint>
        <imageUrl>http://fully.Qualified.Domain.Host.Name:8080/bpel/org.glassfish.openesb.console.ui.Main/tree/ServiceEngine.png</imageUrl>
    </pluginType>

Sample 2 - Customize the Manage Domains tab

The following specifies a custom plugin type that customizes the Manage Domains tab

    <!-- Custom plugin for Manage Domains Tabs-->
    <pluginType customPluginType='Manage Domains' entityType='domains'  uiIntegrationType='tab'>
        <imageUrl>/tree/sa.png</imageUrl>
        <urlEntryPoint isRelativeToContextRoot='false'>uri://org.glassfish.openesb.client.ui.ManageDomains.class</urlEntryPoint>
    </pluginType>

Sample 3 - Customize all occurrences of a BPEL Service Unit tree node

The following specifies a custom plugin type that customizes all occurrences of a BPEL Service Unit tree node.

    
    <!-- Custom plugin type that customize all concurrences BPEL Service Unit tree nodes -->
    <pluginType customPluginType='Management' entityType='service-unit' uiIntegrationType='tree-node'>
        <deployedOn>sun-bpel-engine</deployedOn>
        <parentId entityType='service-assembly'/>
        <imageUrl>tree/ServiceUnit.png</imageUrl>
        <urlEntryPoint isRelativeToContextRoot='false'>uri://org.glassfish.openesb.console.ui.client.modules.statistics.StatisticsPanel.class</urlEntryPoint>
    </pluginType>  

Sample 4 - Plug-in a tabset reference to any service assemblies tree node

The following specifies a custom plugin type that plugs in a tabset reference to any service assemblies tree node.

    <!-- Custom plugin for Service Assemblies Tree Node -->
    <pluginType customPluginType='Management' entityType='ServiceAssemblies'  uiIntegrationType='tree-node'>
        <parentId entityType='JBI_META_CONTAINER'>JBI</parentId>
        <displayName>Service Assemblies</displayName>
        <imageUrl>tree/ServiceAssemblyBadge.png</imageUrl>
        <tabsetReference name='Service Assemblies Tabset' />
    </pluginType>

    <!-- Service Assemblies Tabset -->
    <tabsetType name='Service Assemblies Tabset' tabs='Manage Service Assemblies, Help' />

    <!-- Tab Plugins for SERVICE_ASSEMBLIES -->
    <pluginType customPluginType='Manage Service Assemblies' entityType='ServiceAssemblies'  uiIntegrationType='tab'>
        <imageUrl>/tree/sa.png</imageUrl>
        <urlEntryPoint isRelativeToContextRoot='false'>uri://org.glassfish.openesb.client.ui.ManageServiceAssemblies.class
        </urlEntryPoint>
    </pluginType>

    <!-- Tab Plugins for Help -->
    <pluginType customPluginType='Help' 
                entityType='Domains, Domain, JBI_META_CONTAINER, ServiceEngines, service-engine, BindingComponents, binding-component, SharedLibraries, shared-library, ServiceAssemblies,service-assembly, service-unit'
                uiIntegrationType='tab'>

        <imageUrl>/tree/sa.png</imageUrl>
        <urlEntryPoint isRelativeToContextRoot='false'>uri://org.glassfish.openesb.client.ui.Help.class
        </urlEntryPoint>
    </pluginType>

Sample 5 - A complete plugin sample that customizes the tree nodes of both the sun-bpel-engine, and the service-units that are deployed on the sun-bpel-engine

The following specifies a complete plugin sample that customizes the tree nodes of both the sun-bpel-engine, and the service-units that are deployed on the sun-bpel-engine.

<?xml version='1.0' encoding='UTF-8'?>
<esb-console-plugin name='BPEL Plugin'
    targetComponentName='sun-bpel-engine' version='1.0'
    xmlns='http://java.sun.com/xml/ns/esb/console/PluginData'>

    <!-- Manage BPEL Service Engine -->
    <pluginType customPluginType='Management' entityType='service-engine' uiIntegrationType='tree-node'>
        <parentId entityType='ServiceEngines'>Service Engines</parentId>
        <displayName>sun-bpel-engine</displayName>
        <urlEntryPoint isRelativeToContextRoot='false'>http://fully.Qualified.Domain.Host.Name:8080/bpel/welcomeGWT.html</urlEntryPoint>
        <imageUrl>http://fully.Qualified.Domain.Host.Name:8080/bpel/org.glassfish.openesb.console.ui.Main/tree/ServiceEngine.png</imageUrl>
    </pluginType>
    
    <!-- Manage BPEL Service Units -->
    <pluginType customPluginType='Management' entityType='service-unit' uiIntegrationType='tree-node'>
        <deployedOn>sun-bpel-engine</deployedOn>
        <parentId entityType='service-assembly'/>
        <imageUrl>tree/ServiceUnit.png</imageUrl>
        <urlEntryPoint isRelativeToContextRoot='false'>uri://org.glassfish.openesb.console.ui.client.modules.statistics.StatisticsPanel.class</urlEntryPoint>
    </pluginType>    

</esb-console-plugin>

Plugins can either be:

• External Plugins
• Internal Plugins

---

• Back to Technical Details
• Back to How-Tos

---

• Navigate to About
• Navigate to Getting Started
• Navigate to Community
• Navigate to Screencasts and Demos
• Navigate to Technical Information
• Navigate to How Tos
• Navigate to Project Details
• Navigate to Source Code
• Navigate to Frequently Asked Questions(FAQ)

---

Number of visits: 4

This page (revision-31) was last changed on 30-Mar-09 09:45 AM, -0700 by Gopalan Suresh Raj.
This page was created on 06-Oct-08 14:12 PM, -0700 by Gopalan Suresh Raj.

More info...