...
| Expand |
|---|
| Code Block |
|---|
| <?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.mycompany</groupId>
<artifactId>silexample</artifactId>
<version>4.0.0</version>
<name>silexample</name>
<description>Example: integrating SIL routines and descriptors</description>
<packaging>atlassian-plugin</packaging>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<katlcommons.version>4.0.0-SNAPSHOT</katlcommons.version>
<spring.osgi.version>1.2.1</spring.osgi.version>
<spring.version>4.1.6.RELEASE</spring.version>
<jira.version>7.0.0</jira.version>
<jira.data.version>7.0.0</jira.data.version>
<jira.sal.version>3.0.0</jira.sal.version>
<jira.event.version>2.3.5</jira.event.version>
<atlassian.spring.scanner.version>1.2.13</atlassian.spring.scanner.version>
<plugin.testrunner.version>2.0.0</plugin.testrunner.version>
<amps.version>6.1.2</amps.version>
</properties>
<dependencies>
<dependency>
<groupId>com.atlassian.jira</groupId>
<artifactId>jira-api</artifactId>
<version>${jira.version}</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>com.atlassian.sal</groupId>
<artifactId>sal-api</artifactId>
<version>${jira.sal.version}</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>com.atlassian.event</groupId>
<artifactId>atlassian-event</artifactId>
<version>${jira.event.version}</version>
<scope>provided</scope>
</dependency>
<!--
This is for the annotations you need to indicate components and OSGI services.
-->
<dependency>
<groupId>com.atlassian.plugin</groupId>
<artifactId>atlassian-spring-scanner-annotation</artifactId>
<version>${atlassian.spring.scanner.version}</version>
<scope>compile</scope>
</dependency>
<!--
This is the runtime code for interpreting the build time index files
-->
<dependency>
<groupId>com.atlassian.plugin</groupId>
<artifactId>atlassian-spring-scanner-runtime</artifactId>
<version>${atlassian.spring.scanner.version}</version>
<scope>runtime</scope>
</dependency>
<!-- ===================================== -->
<!-- KeplercPrime dependencies -->
<!-- ===================================== -->
<dependency>
<groupId>com.keplerrominfo.jira.plugins</groupId>
<artifactId>katl-commons</artifactId>
<scope>provided</scope>
<version>${katlcommonssilengine.version}</version>
</dependency>
<!-- ===================================== -->
<!-- Spring & common dependencies -->
<!-- ===================================== -->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-context</artifactId>
<scope>provided</scope>
<version>${spring.version}</version>
</dependency>
<dependency>
<groupId>commons-logging</groupId>
<artifactId>commons-logging</artifactId>
<version>1.1.3</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
<version>1.2.17</version>
<scope>provided</scope>
</dependency>
<!-- ===================================== -->
<!-- TEST dependencies -->
<!-- ===================================== -->
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<scope>test</scope>
<version>4.12</version>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
<version>1.6.6</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>com.atlassian.jira</groupId>
<artifactId>jira-tests</artifactId>
<version>${jira.version}</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>com.atlassian.plugins</groupId>
<artifactId>atlassian-plugins-osgi-testrunner</artifactId>
<version>${plugin.testrunner.version}</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>com.atlassian.jira</groupId>
<artifactId>jira-func-tests</artifactId>
<version>${jira.version}</version>
<scope>test</scope>
<exclusions>
<exclusion>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-simple</artifactId>
</exclusion>
</exclusions>
</dependency>
</dependencies>
<build>
<resources>
<resource>
<directory>src/main/resources</directory>
<excludes>
<exclude>atlassian-plugin.xml</exclude>
<exclude>META-INF/KINFO</exclude>
<exclude>META-INF/KVERSION</exclude>
</excludes>
</resource>
<resource>
<directory>src/main/resources</directory>
<filtering>true</filtering>
<includes>
<include>atlassian-plugin.xml</include>
<include>META-INF/KINFO</include>
<include>META-INF/KVERSION</include>
</includes>
</resource>
</resources>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<version>3.1</version>
<configuration>
<source>1.8</source>
<target>1.8</target>
</configuration>
</plugin>
<plugin>
<groupId>com.atlassian.maven.plugins</groupId>
<artifactId>maven-jira-plugin</artifactId>
<version>${amps.version}</version>
<extensions>true</extensions>
<configuration>
<compressResources>false</compressResources>
<useFastdevCli>false</useFastdevCli>
<enableFastdev>false</enableFastdev>
<enableDevToolbox>false</enableDevToolbox>
<enablePde>false</enablePde>
<enableQuickReload>true</enableQuickReload>
<quickReloadVersion>1.29</quickReloadVersion>
<productVersion>${jira.version}</productVersion>
<productDataVersion>${jira.version}</productDataVersion>
<!-- Enable here the products if you want container tests (you should) -->
<products>
<product>
<id>jira</id>
<instanceId>jira-${jira.version}</instanceId>
<version>${jira.version}</version>
<dataVersion>${jira.data.version}</dataVersion>
<!-- dataPath>${basedir}/src/test/resources/generated-test-resources.zip</dataPath -->
</product>
</products>
<pluginArtifacts>
<!-- installed in the product when using atlas-run or atlas-debug -->
<pluginArtifact>
<groupId>com.keplerrominfo.jira.plugins</groupId>
<artifactId>katl-commons</artifactId>
<version>${katlcommonssilengine.version}</version>
</pluginArtifact>
</pluginArtifacts>
<pluginDependencies>
<!-- OBR dependencies -->
<pluginDependency>
<groupId>com.keplerrominfo.jira.plugins</groupId>
<artifactId>katl-commons</artifactId>
</pluginDependency>
</pluginDependencies>
<testGroups>
<testGroup>
<id>wired-jira-integration</id>
<productIds>
<productId>jira-test</productId>
</productIds>
<includes>
<include>it/**/*WiredTest.java</include>
</includes>
</testGroup>
</testGroups>
<testBundleExcludes>
<testBundleExclude>
<groupId>com.keplerrominfo.jira.plugins</groupId>
<artifactId>katl-commons</artifactId>
</testBundleExclude>
<testBundleExclude>
<groupId>com.keplerrominfo</groupId>
<artifactId>sil</artifactId>
</testBundleExclude>
<testBundleExclude>
<groupId>com.keplerrominfo</groupId>
<artifactId>stl</artifactId>
</testBundleExclude>
<testBundleExclude>
<groupId>com.keplerrominfo</groupId>
<artifactId>sil-remote-client</artifactId>
</testBundleExclude>
<testBundleExclude>
<groupId>com.keplerrominfo</groupId>
<artifactId>sil-sms-client</artifactId>
</testBundleExclude>
<testBundleExclude>
<groupId>com.keplerrominfo</groupId>
<artifactId>kepler-util</artifactId>
</testBundleExclude>
<testBundleExclude>
<groupId>com.keplerrominfo</groupId>
<artifactId>kepler-refapp</artifactId>
</testBundleExclude>
<testBundleExclude>
<groupId>xalan</groupId>
<artifactId>xalan</artifactId>
</testBundleExclude>
<testBundleExclude>
<groupId>xml-apis</groupId>
<artifactId>xml-apis</artifactId>
</testBundleExclude>
</testBundleExcludes>
<instructions>
<Bundle-Name>SIL Example</Bundle-Name>
<Bundle-SymbolicName>com.mycompany.silexample</Bundle-SymbolicName>
<Atlassian-Plugin-Key>com.mycompany.silexample</Atlassian-Plugin-Key>
<Spring-Context>*</Spring-Context>
<Export-Package>
!net.java.ao,
!com.atlassian,
com.mycompany.silexample.*
</Export-Package>
<Import-Package>
com.keplerrominfo.refapp.launcher;resolution:="optional",
com.keplerrominfo.refapp.launcher.*;resolution:="optional",
org.springframework.osgi.*;resolution:="optional",
org.eclipse.gemini.blueprint.*;resolution:="optional",
com.atlassian.plugin.osgi.bridge.external,
*;resolution:="optional"
</Import-Package>
</instructions>
<skipManifestValidation>true</skipManifestValidation>
<systemPropertyVariables>
<webdriver.browser>htmlunit</webdriver.browser>
<!--
You can also use chrome if you have it installed.
You'll also need a webDriver for Chrome, which you can get from
https://sites.google.com/a/chromium.org/chromedriver/downloads and place it somewhere on the disk.
Then just comment the htmlunit driver above and uncomment below.
-->
<!--<webdriver.browser>chrome</webdriver.browser>-->
<!--<webdriver.chrome.driver>D:/tools/chromedriver.exe</webdriver.chrome.driver>-->
</systemPropertyVariables>
</configuration>
</plugin>
<plugin>
<groupId>com.atlassian.plugin</groupId>
<artifactId>atlassian-spring-scanner-maven-plugin</artifactId>
<version>${atlassian.spring.scanner.version}</version>
<executions>
<execution>
<goals>
<goal>atlassian-spring-scanner</goal>
</goals>
<!-- process-classes seems to be skipped if you are using scala
so perhaps use prepare-package -->
<phase>process-classes</phase>
</execution>
</executions>
<configuration>
<includeExclude>+com.mycompany.*</includeExclude>
<verbose>true</verbose>
<scannedDependencies>
<!--
- Add here the scanned dependencies, if any
<dependency>
<groupId>com.somegroup</groupId>
<artifactId>artifact.id</artifactId>
</dependency>
-->
</scannedDependencies>
</configuration>
</plugin>
</plugins>
</build>
<reporting>
<plugins>
<plugin>
<artifactId>maven-javadoc-plugin</artifactId>
<version>LATEST</version>
</plugin>
<plugin>
<artifactId>maven-surefire-plugin</artifactId>
<version>2.4.3</version>
<configuration>
<argLine>-Xms128m -Xmx256m</argLine>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-project-info-reports-plugin</artifactId>
<version>LATEST</version>
</plugin>
</plugins>
</reporting>
</project> |
|
...
We will create two more files in the META-INF directory: KINFO and KVERSION . These files are required by the Kepler cPrime framework support and while KINFO is free text (you can put there anything you want), KVERSION has a fixed structure, it must contain the released date of the plugin:
...
| Code Block |
|---|
|
JIRA SIL Module: silexample, version ${version}
Simple SIL extension example.
Copyright (c) Kepler-RominfocPrime, Inc.
Visit us at httphttps://www.kepler-rominfocprime.com/ |
Another thing to work on is the atlassian-plugin.xml file or the add-on descriptor. Create an empty add-on descriptor, like this:
| Code Block |
|---|
| title | atlassian-plugin.xml |
|---|
|
<atlassian-plugin key="com.mycompany.silexample"
name="SIL Example"
plugins-version="2">
<plugin-info>
<description>SIL Basic Example</description>
<version>${version}</version>
<vendor name="KeplercPrime, RominfoInc." url="httphttps://www.kepler-rominfocprime.com/" />
<param name="plugin-icon">images/generic.png</param>
<param name="plugin-logo">images/generic.png</param>
<param name="vendor-icon">images/keplerLogo.png</param>
<param name="vendor-logo">images/keplerLogo.png</param>
<param name="atlassian-data-center-compatible">true</param>
</plugin-info>
</atlassian-plugin> |
...
| Expand |
|---|
| Code Block |
|---|
| language | java |
|---|
| title | ExampleLauncher.java |
|---|
| linenumbers | true |
|---|
| /*
* File: ExampleLauncher.java
* Created by rdumitriu on 12.12.2016.
*/
package com.mycompany.silexample;
import com.atlassian.event.api.EventPublisher;
import com.atlassian.jira.issue.Issue;
import com.atlassian.jira.issue.fields.CustomField;
import com.atlassian.jira.project.ProjectManager;
import com.atlassian.plugin.spring.scanner.annotation.component.ClasspathComponent;
import com.atlassian.plugin.spring.scanner.annotation.export.ExportAsService;
import com.atlassian.plugin.spring.scanner.annotation.imports.ComponentImport;
import com.atlassian.sal.api.lifecycle.LifecycleAware;
import com.keplerrominfo.jira.commons.ivm.*;
import com.keplerrominfo.refapp.config.*;
import com.keplerrominfo.refapp.config.impl.PluginConfigurationServiceImpl;
import com.keplerrominfo.refapp.launcher.AbstractPluginLauncher;
import com.keplerrominfo.sil.lang.RoutineRegistry;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
/**
* This is a standard launcher for a KeplercPrime add-on. We respect here the life-cycle of the add-on within the whole JIRA,
* so make sure you follow it.
*
* @author Radu Dumitriu (rdumitriu@gmail.com)
* @version 1.0
* @since 1.0
*/
@Component
@ExportAsService(LifecycleAware.class)
public class ExampleLauncher extends AbstractPluginLauncher {
private static final Log LOG = LogFactory.getLog(ExampleLauncher.class);
private final CustomFieldDescriptorRegistry customFieldDescriptorRegistry;
private final ProjectManager projectManager;
@Autowired
public ExampleLauncher(@ComponentImport EventPublisher eventPublisher,
//this is the local component providing info about the add-on (ExamplePluginInfoService)
PluginInfoService pluginInfoService,
//do not remove this, it will generate the correct component-import
@ComponentImport CommonPluginConfigurationService commonPluginConfigurationService,
@ComponentImport HostConfigurationProvider hostConfigurationProvider,
@ClasspathComponent PluginConfigurationServiceImpl pluginConfigurationService,
@ComponentImport CustomFieldDescriptorRegistry customFieldDescriptorRegistry,
@ComponentImport ProjectManager projectManager) {
super(eventPublisher, pluginInfoService, hostConfigurationProvider, pluginConfigurationService);
this.customFieldDescriptorRegistry = customFieldDescriptorRegistry;
this.projectManager = projectManager;
}
@Override
public void doAtLaunch() {
super.doAtLaunch();
//HERE:: will do more at launch
}
@Override
public void doAtStop() {
//HERE:: will do cleanup
super.doAtStop();
}
} |
|
...