Component Plugin Module

Added by Mike Cannon-Brookes, last edited by Don Brown on Jun 12, 2008  (view change) show comment
JIRA Documentation

Index

A component plugin module defines a Java component which will be injected into JIRA's internal component system.

JIRA's internal components are managed by PicoContainer.

A new component is simple to define as follows:

<component key="userService" name="User Service" 
    class="com.atlassian.jira.rpc.soap.UserServiceImpl">
    <interface>com.atlassian.jira.rpc.soap.UserService</interface>
</component>

This example here defines a component implementing UserService that is put into the PicoContainer to inject into any other plugin modules. If you include this component module in your plugin, then your other plugin modules can define a constructor with a UserService parameter and this implementation will be provided to your plugin module automatically.

These components allow you to simplify the creation and management of your plugin modules quite a lot.

Labels:

Enter labels to add to this page:
Wait Image 
Looking for a label? Just start typing.

Comments (1)

 

  1. Mar 14, 2008

    Matt Doar says:

    The Subversion plugin is a good example of a plugin that uses a component module...

    The Subversion plugin is a good example of a plugin that uses a component module.

    p.s. there's a typo in the word constructor