This page last changed on Feb 15, 2007 by sleberrigaud.
Description/Features
A full development kit for Confluence plugins bundled with Confluence API and dependencies.
For more information, documentation and plugin tutorials, see our Confluence Development Hub.
Included in this of the development kit are:
- Skeleton project templates for creating your own plugins
- Full API documentation of Confluence 2.2.9
- All Confuence 2.2.9 dependencies
For more details on plugins, see the plugin guide.
Requirements
- Sun Java JDK 1.4+
Confluence doesn't currently support Java 6.
- Apache Maven 1.0 : http://maven.apache.org/maven-1.x/start/download.html
- Atlassian-IDEA Maven Plugin
- A running instance of Confluence: either built from source or a standalone installation.
Maven is not strictly required to build your Confluence plugins, however, all of the example plugins have been developed with Maven as well as the template project. We highly recommend that you use Maven to build your plugins.
Idea is the Java Ide developped by JetBrains. This is totally optional for Confluence plugin development. You can use your own Ide or no Ide at all.
Instructions
- Copy the templates directory and rename it for your plugin
- Edit the project.xml for your plugin name
- in your new directory, run 'maven atlassian-idea' to generate IDEA project files.
- Launch your new project in IDEA by opening the $MY_PLUGIN_NAME.ipr file.
- Edit 'src/etc/atlassian-plugin.xml' for your project, as described in the documentation.
- Develop something cool!
- When you're ready to deploy, run 'maven jar' to build your plugin jar in the target directory
- Deploy it to your Confluence instance.
Version History
Version |
Comments |
1.4 |
initial version |
2.0 |
upgraded for new version of Confluence |
2.1.1 |
upgraded for new version of Confluence |
2.1.4 |
upgraded for new version of Confluence |
2.2.9 |
upgraded for new version of Confluence |
There appears to be a bug with the dev kit which prevents it from including the src/etc resources from the plugin when building a jar for deployment. This includes the atlassian-plugin.xml (making the plugin undeployable), however other files (such as velocity templates) are not deployed either.
The fix is to change line 802 of confluence-dev-kit-2.1.1/common/project.xml to read <directory>src/etc</directory>.

Posted by dhardiker@adaptavist.com at Feb 02, 2006 10:13
|
I have placed my unit tests in $projectRoot$/test/java however maven was not finding them - I found the problem and it was down to pathing. The dev kit creates test/java however the common project.xml looks at src/test/java. Given the choice I put tests in a separate directory branch to the source, so I have opted to resolve the conflict by pointing at tests/java.
The fix is to change line 807 of confluence-dev-kit-2.1.1/common/project.xml to read <unitTestSourceDirectory>test/java</unitTestSourceDirectory>.

Posted by dhardiker@adaptavist.com at Feb 06, 2006 10:02
|
Dan,
Thanks for pointing it out. We will fix this as soon as possible.
Cheers,
Jens

Posted by jens@atlassian.com at Feb 07, 2006 23:56
|
Is this kit compatible with 2.2.X?

Posted by solitaryrpr at Jul 07, 2006 16:34
|
I believe the readme.txt file has to be updated, as it states the kit contains:
- Full API documentation of Confluence 1.4.4
- All Confluence 1.4.4 dependencies
Thanks,
Ben
P.S: @Galen, I'm hardly a Confluence expert, but I don't think any major API changes were made in Confluence between 2.1.4 and 2.2.x. You should be fine.

Posted by bhyman at Jul 25, 2006 12:51
|
When will the 2.2.x plugin api be available? I'm using some of 2.2 features.
Thanks,
Jay

Posted by jgarala@nearinfinity.com at Sep 20, 2006 08:54
|
Is there a 2.3 development kit?

Posted by bob.swift@charter.net at Sep 22, 2006 08:41
|
No, not yet, but Jonathan has kindly provided 2.3 javadoc and maven project xml to use. See http://svn.atlassian.com/svn/public/contrib/confluence/project-files/

Posted by bob.swift@charter.net at Sep 24, 2006 01:29
|
There's currently a bug in the template plugin zip; the confluence-2.2.9.xml file does not validate as it's missing a closing </dependancies> tag at the end

Posted by mo-seph at Nov 04, 2006 06:23
|
Fixed and re-uploaded. Should be fine now. Thanks!

Posted by jnolen at Nov 06, 2006 12:55
|
It appears that some of the required jars have moved ...
Attempting to download log4j-1.2.8.jar.
Error retrieving artifact from [http://www.ibiblio.org/maven/log4j/jars/log4j-1.2.8.jar]: java.io.IOException: Unknown error downloading; status code was: 301
WARNING: Failed to download log4j-1.2.8.jar.
All in all, I dont seem to be able to get the following:
log4j-1.2.8.jar
commons-lang-1.0.1.jar
commons-collections-2.1.jar
commons-beanutils-1.6.1.jar
odmg-3.0.jar
ant-1.5.2.jar
velocity-1.3.1.jar
servletapi-2.3.jar
commons-digester-1.5.jar
avalon-framework-4.1.4.jar
batik-1.5-fop-0.20-5.jar
hsqldb-1.8.0.1.jar
junit-3.8.1.jar
jwebunit-1.2.jar
rhino-1.5R4.1.jar
rome-0.8.jar
commons-httpclient-2.0.2.jar
httpunit-1.5.4.jar
nekohtml-0.9.5.jar
xerces-2.2.1.jar
xmlParserAPIs-2.2.1.jar
axis-1.2.1.jar
axis-jaxrpc-1.2.1.jar
axis-saaj-1.2.1.jar
axis-wsdl4j-1.2.1.jar
commons-discovery-0.2.jar
commons-codec-1.3.jar
oro-2.0.7.jar
concurrent-1.3.4.jar
bsf-2.3.0.jar
xalan-2.7.0.jar
Ideas?

Posted by jwright at Dec 04, 2006 15:30
|
The ibiblio maven repository has moved, and maven doesn't understand 301 redirects. The fix is here:
http://blogs.atlassian.com/developer/2006/12/maven_1_repository_changes.html

Posted by cmiller at Dec 04, 2006 17:35
|
Success! Thanks Charles.

Posted by jwright at Dec 05, 2006 08:21
|
Just starting out with Confluence, so sorry if I've got this wrong, but it seems to me this page should clarify some things:
- The requirements includes the IDEA-Maven plugin, but not IDEA. In fact, there's no mention of what IDEA is. I now know it is an IDE, but that could easily be made clear.
- It says that Maven is optional, but doesn't say that IDEA is optional. That is particularly strange since Maven is free and IDEA costs $US 500, and I'm pretty sure that IDEA is, in fact, optional.
- The section about Java versions should be more clear--the link is to the download page for Java SDK 6, but I think you can only use up to 1.5. (The whole Java naming scheme is kind of confusing, and the info about what works with Confluence hard to find, so I'm not at all sure about this, but I think that actually version 1.4 is the safest for Confluence development.)

Posted by simonoff at Feb 15, 2007 18:37
|
I just updated the page,
Thanks for the comments,
SaM

Posted by sleberrigaud at Feb 15, 2007 19:35
|
I've downloaded confluence-dev-kit-2.2.9, to start evaluating the kit for some customizations we might be doing.
I've encountered two problems:
The examples don't build.
The reason seems to be that the maven project.xml in the examples make references to a project.xml in the common directory that isn't there. There is another file there called confluence-2.2.9.xml that appears to be the intended project.xml. It should be renamed or the dependent examples should be fixed.
Maven ignores the local repository
When I fix the problem above, and attempt to build, the path to the local dependency repository seems to be ignored, and the entire set of dependencies is downloaded again. This isn't the worst that can happen, but hey I just downloaded 44 megs of stuff that it should know about!

Posted by gmack at Mar 19, 2007 13:32
|
|