Come for the products,
stay for the community

The Atlassian Community can help you and your team get more value out of Atlassian products and practices.

Atlassian Community about banner
4,296,925
Community Members
 
Community Events
165
Community Groups

SOAP Web Service Client in Jira 8 plugin

Hello, everyone!

I hope these samples of a SOAP web service client usage in a Jira custom plugin help you in your implementations .

You can find complete code here:

https://github.com/AntonFermat/jira-soap-plugin

There are two part of the project:

  • jira-ws-plugin – the custom Jira plugin (8.13.6) with Axis2 SOAP web service client and its scheduled background job runner.

  • producing-ws-server – the Spring-boot sample web service server for the jira-ws-plugin demo. To start it just execute mvn spring-boot:run in comman line. You can check it with url http://localhost:8888/ws/currency.wsdl

Prerequisites

Install the Atlassian SDK and configure your environment.

Create a new Jira plugin project.

Add the maven plugin to generate classes.

It takes as input a WSDL and generates client stubs for calling a web service matching the WSDL.

<plugin>
<groupId>org.apache.axis2</groupId>
<artifactId>axis2-wsdl2code-maven-plugin</artifactId>
<version>1.7.9</version>
<executions>
<execution>
<id>ws</id>
<goals>
<goal>wsdl2code</goal>
</goals>
<configuration>
<packageName>ru.testgu.jira_ws_plugin.ws</packageName>
<wsdlFile>src/main/resources/currency.wsdl.xml</wsdlFile>
<options>
<encoding>UTF-8</encoding>
</options>
<databindingName>adb</databindingName>
</configuration>
</execution>
</executions>
</plugin>

Add Axis2 dependencies 

<!-- Web Service -->
<dependency>
<groupId>org.apache.axis2</groupId>
<artifactId>axis2-kernel</artifactId>
<version>${axis2.version}</version>
</dependency>
<dependency>
<groupId>org.apache.axis2</groupId>
<artifactId>axis2-jaxws</artifactId>
<version>${axis2.version}</version>
</dependency>
<dependency>
<groupId>org.apache.axis2</groupId>
<artifactId>axis2-adb</artifactId>
<version>${axis2.version}</version>
</dependency>
<dependency>
<groupId>org.apache.axis2</groupId>
<artifactId>axis2-transport-local</artifactId>
<version>${axis2.version}</version>
</dependency>
<dependency>
<groupId>org.apache.axis2</groupId>
<artifactId>axis2-transport-http</artifactId>
<version>${axis2.version}</version>
</dependency>
<dependency>
<groupId>org.apache.httpcomponents</groupId>
<artifactId>httpcore</artifactId>
<version>4.4.14</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>org.apache.httpcomponents</groupId>
<artifactId>httpclient</artifactId>
<version>4.5.13</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>commons-io</groupId>
<artifactId>commons-io</artifactId>
<version>2.11.0</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>commons-fileupload</groupId>
<artifactId>commons-fileupload</artifactId>
<version>1.4</version>
<scope>provided</scope>
</dependency>

Some of it (with scope provided) to exclude the enforcer plugin "banned" dependencies

Also add to the Import-Package tag the following dependency:

org.w3c.dom,
*;resolution:="optional"

Add the SOAP Web Service client component

We can run this service from the other part of the plugin

@Named("exchangeRate")
public class ExchangeRateServiceImpl implements ExchangeRateService {

private static final Logger log = LoggerFactory.getLogger(ExchangeRateServiceImpl.class);

@Override
public double exchangeRateUSD() {
double currencyValue = -1;
try {
CurrencyPortServiceStub stub = new CurrencyPortServiceStub();
// Authentication
// setAuth(stub, username, password);
CurrencyPortServiceStub.GetExchangeRateRequest request = new CurrencyPortServiceStub.GetExchangeRateRequest();
request.setCurrency(CurrencyPortServiceStub.Currency.USD);
CurrencyPortServiceStub.GetExchangeRateResponse exchangeRateResponse = stub.getExchangeRate(request);
currencyValue = exchangeRateResponse.getExchangeRate().getCurrencyValue();
} catch (RemoteException rex) {
}
log.info("=============================");
log.info("USD exchange rate: {}", currencyValue);
log.info("=============================");
return currencyValue;
}
}

Optional code for the component execution

Manually with the REST resource (ExchangeRateService.java) - http://<JIRA_BASE_URL>rest/exchangerate/1.0/message

with the http GET response:

<message>
<value>USD exchange rate: 3.0</value>
</message>

or it can be scheduled as the background job runner (ScheduledWebService.java).

0 comments

Comment

Log in or Sign up to comment
TAGS
Community showcase
Published in Jira Software

Upcoming changes to epic fields in company-managed projects

👋 Hi there Jira Community! A few months ago we shared with you plans around renaming epics in your company-managed projects. As part of these changes, we highlighted upcoming changes to epics on...

14,627 views 37 46
Read article

Community Events

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

Find an event

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

Unfortunately there are no Community Events near you at the moment.

Host an event

You're one step closer to meeting fellow Atlassian users at your local event. Learn more about Community Events

Events near you