Creating an Integration Point Type

If your add-on component provides new content that you would like other people to extend, you may define your own integration point types. For example, if you add a new page that provides tabs of monitoring information, you might want to allow others to add their own tabs to complement your default tabs. This feature enables your page to behave like the existing Administration Console pages that you or others can extend.

To Create an Integration Point Type

1. Decide on the name of your integration point type.

   The integration point type must be a unique identifier. You might use the package name of your integration point, with a meaningful name appended to the end, as in the following example:

   org.company.project:myMonitoringTabs

2. After you have an integration point ID, use handlers to insert the integration point implementation(s).

   Include code like the following below the place in your JavaServer Faces page where you would like to enable others to add their integration point implementations:

   <event>
       <!afterCreate 
           getUIComponent(clientId="clientId:of:root" 
                          component=>$attribute{rootComp});
           includeIntegrations(type="org.company.project:myMonitoringTabs" 
                               root="#{rootComp}");
       />
   </event>

   Change clientId:of:root to match the clientId of the outermost component in which you want others to be able to add their content (in this example, the tab set is the most likely choice). Also include your integration point ID in place of org.company.project:myMonitoringTabs. If you omit the root argument to includeIntegrations, all components on the entire page can be used for the parentId of the integration points.

3. To enable others to use this integration point, document it at the GlassFish Integration Point wiki page.

   Document the integration point only if your content is publicly available.

   You or others can now provide an integration point that will be integrated into this page.

See Also

For more information, see the JSFTemplating API documentation.