How to make Component Plugin Module dependency-injected.

1. Write the below in the atlassian-plugin.xml.


<component key="helloWorldService" public="true" class="com.akira.MyHelloWorldServiceImpl">
<interface>com.akira.MyHelloWorldService</interface>
</component>

2. MyHelloWorldService

package com.akira;

public interface MyHelloWorldService {
String getMessage();
}

3. MyHelloWorldServiceImpl

package com.akira;

public class MyHelloWorldServiceImpl implements MyHelloWorldService {

public String getMessage() {
return "Hello World";
}
}

4. Use the Component Plugin Module in an ActionSupport class.

public class AkiraActionSupport extends JiraWebActionSupport {

private MyHelloWorldService _myHelloWorldService;

public String doExecute() {
System.out.println(_myHelloWorldService.getMessage());
return SUCCESS;
}
}

5. A NullPointerException occurs because the dependency-injection fails.

6. What other steps are required to make Componet Module available.

1 answer

1 accepted

0 votes

Inject it in constructor.

public class AkiraActionSupport extends JiraWebActionSupport {

    private MyHelloWorldService _myHelloWorldService;

    public AkiraActionSupport(MyHelloWorldService _myHelloWorldService){
        this.myHelloWorldService = myHelloWorldService;
    }
   
    public String doExecute() {
        System.out.println(_myHelloWorldService.getMessage());
        return SUCCESS;
    }
}

You will need component-import if you are using it in a different plugin.

Thank you very much.

I forgot how to use Springframework's dependency injection.

But I am wondering if I can inject it using Annotation Qualifier in JIRA like below.

@Autowired

@Qualifier("MyHelloWorldService")

private MyHelloWorldService _myHelloWorldService;

it seems you can. Just create custom spring-only xml definition in resource/META-INF/spring/*.xml. You can read more about it in: https://developer.atlassian.com/display/PLUGINFRAMEWORK/Advanced+Configuration+with+Spring+XML+Files Don't forget <context:annotation-config /> (as in: https://answers.atlassian.com/questions/29872/why-is-spring-autowire-not-working-for-my-jira-plugin-classes)

Suggest an answer

Log in or Join to answer
Community showcase
Sarah Schuster
Posted Jan 29, 2018 in Jira

What are common themes you've seen across successful & failed Jira Software implementations?

Hey everyone! My name is Sarah Schuster, and I'm a Customer Success Manager in Atlassian specializing in Jira Software Cloud. Over the next few weeks I will be posting discussion topics (8 total) to ...

2,916 views 12 18
Join discussion

Atlassian User Groups

Connect with like-minded Atlassian users at free events near you!

Find a group

Connect with like-minded Atlassian users at free events near you!

Find my local user group

Unfortunately there are no AUG chapters near you at the moment.

Start an AUG

You're one step closer to meeting fellow Atlassian users at your local meet up. Learn more about AUGs

Groups near you
Atlassian Team Tour

Join us on the Team Tour

We're bringing product updates and pro tips on teamwork to ten cities around the world.

Save your spot