Writing XWiki components (XWiki.org)

This tutorial guides you through the creation of an XWiki component, which is a way to extend or customize the XWiki platform. Indeed the XWiki platform is composed of components and it's possible to replace the default implementations with your own implementations. It's also possible to add new component implementations to extend the platform such as by implementing new [[Rendering Macros>>DevGuide.RenderingMacroTutorial]].

4

5

{{info}}Components replace the older Plugin architecture which has been deprecated a while ago.{{/info}}

6

7

You should start by reading the [[Reference document on XWiki Components>>extensions:Extension.Component Module]].

8

9

= Let's get started! =

10

11

Enough talking, let's see some code!

12

13

In the followings we will guide you through writing a simple component, helping you to quickly get oriented in XWiki components world and explaining how it works.

14

15

== Creating a XWiki component using Maven ==

16

17

As you've read in the [[XWiki Component Reference>>extensions:Extension.Component Module]] writing a component is a three-streps process (component interface, component implementation, registration of component). To make it easier for you to get started, we have created a maven archetype to help create a simple component module with a single command.

18

19

After you've [[installed Maven and added XWiki repositories in your profile>>dev:Community.Building#HInstallingMaven]], open a shell prompt and type:

20

21

22

mvn archetype:generate -DarchetypeCatalog=https://raw.github.com/xwiki/xwiki-platform/master/xwiki-platform-tools/xwiki-platform-tool-archetypes/xwiki-platform-tool-archetype-component/archetype-catalog.xml

23

24

25

Then follow the instructions. For example:

26

27

28

vmassol@target $ mvn archetype:generate -DarchetypeCatalog=https://raw.github.com/xwiki/xwiki-platform/master/xwiki-platform-tools/xwiki-platform-tool-archetypes/xwiki-platform-tool-archetype-component/archetype-catalog.xml

29

[INFO] Scanning for projects...

30

[INFO]

31

[INFO] ------------------------------------------------------------------------

32

[INFO] Building Maven Stub Project (No POM) 1

33

[INFO] ------------------------------------------------------------------------

34

[INFO]

35

[INFO] >>> maven-archetype-plugin:2.1:generate (default-cli) @ standalone-pom >>>

36

[INFO]

37

[INFO] <<< maven-archetype-plugin:2.1:generate (default-cli) @ standalone-pom <<<

38

[INFO]

39

[INFO] --- maven-archetype-plugin:2.1:generate (default-cli) @ standalone-pom ---

40

[INFO] Generating project in Interactive mode

41

[INFO] No archetype defined. Using maven-archetype-quickstart (org.apache.maven.archetypes:maven-archetype-quickstart:1.0)

42

Choose archetype:

43

1: https://raw.github.com/xwiki/xwiki-platform/master/xwiki-platform-tools/xwiki-platform-tool-archetypes/xwiki-platform-tool-archetype-component/archetype-catalog.xml -> org.xwiki.platform:xwiki-platform-tool-archetype-component (Make it easy to create a maven project for creating a XWiki Component.)

44

Choose a number or apply filter (format: [groupId:]artifactId, case sensitive contains): : 1

45

Downloading: http://maven.xwiki.org/snapshots/org/xwiki/platform/tools/xwiki-archetype-component/1.0-SNAPSHOT/maven-metadata.xml

46

Downloaded: http://maven.xwiki.org/snapshots/org/xwiki/platform/tools/xwiki-archetype-component/1.0-SNAPSHOT/maven-metadata.xml (383 B at 3.4 KB/sec)

47

Downloading: http://maven.xwiki.org/snapshots/org/xwiki/platform/tools/xwiki-archetype-component/1.0-SNAPSHOT/maven-metadata.xml

48

Downloaded: http://maven.xwiki.org/snapshots/org/xwiki/platform/tools/xwiki-archetype-component/1.0-SNAPSHOT/maven-metadata.xml (383 B at 4.9 KB/sec)

49

Define value for property 'groupId': : com.acme

50

Define value for property 'artifactId': : example

51

Define value for property 'version': 1.0-SNAPSHOT: :

52

Define value for property 'package': com.acme: :

53

Confirm properties configuration:

54

groupId: com.acme

55

artifactId: example

56

version: 1.0-SNAPSHOT

57

package: com.acme

58

Y: : Y

59

[INFO] ----------------------------------------------------------------------------

60

[INFO] Using following parameters for creating project from Old (1.x) Archetype: xwiki-archetype-component:1.0-SNAPSHOT

61

[INFO] ----------------------------------------------------------------------------

62

[INFO] Parameter: groupId, Value: com.acme

63

[INFO] Parameter: packageName, Value: com.acme

64

[INFO] Parameter: package, Value: com.acme

65

[INFO] Parameter: artifactId, Value: example

66

[INFO] Parameter: basedir, Value: /Users/vmassol/dev/xwiki/trunks-clean4/platform/tools/xwiki-archetypes/target

67

[INFO] Parameter: version, Value: 1.0-SNAPSHOT

68

[INFO] ********************* End of debug info from resources from generated POM ***********************

69

[INFO] project created from Old (1.x) Archetype in dir: /Users/vmassol/dev/xwiki/trunks-clean4/platform/tools/xwiki-archetypes/target/example

70

[INFO] ------------------------------------------------------------------------

71

[INFO] BUILD SUCCESS

72

[INFO] ------------------------------------------------------------------------

73

[INFO] Total time: 12.868s

74

[INFO] Finished at: Sun Nov 14 18:27:52 CET 2010

75

[INFO] Final Memory: 9M/81M

76

[INFO] ------------------------------------------------------------------------

vmassol@target $

Then go in the created directory (##example## in our example above) and run ##mvn install## to build your component.

81

82

== The Component explained ==

83

84

Assume, for the following explanations, that the package you used is ##com.acme##

85

86

Navigating in the component project folder, you will see the following standard Maven project structure:

pom.xml

src/main/java/com/acme/HelloWorld.java

91

src/main/java/com/acme/internal/DefaultHelloWorld.java

92

src/main/java/com/acme/internal/HelloWorldScriptService.java

93

src/main/resources/META-INF/components.txt

94

src/test/java/com/acme/HelloWorldTest.java

95

96

97

which correspond to the default files created: the ##HelloWorld## interface (a.k.a component role), its implementation ##DefaultHelloWorld## (component implementation), a test class for this component ##HelloWorldTest##, the component declaration file ##components.txt## and the Maven project ##pom.xml## file. The ##HelloWorldScriptService## file is described below when we explain how to make the component's API available to wiki pages.

98

99

If you have a look in the ##pom.xml##, you'll notice the following dependencies:

<groupId>org.xwiki.commons</groupId>

105

<artifactId>xwiki-commons-component-api</artifactId>

106

<version>${commons.version}</version>

107

</dependency>

108

109

110

<groupId>org.xwiki.commons</groupId>

111

<artifactId>xwiki-commons-test</artifactId>

112

<version>${commons.version}</version>

</dependency>

</dependencies>

The code above defines the dependency on the ##xwiki-core-component-default## in the core which is where XWiki Component notions are defined. There's also a dependency on ##xwiki-core-shared-tests## which provides helper classes to easily test components.

119

120

The interface file (##HelloWorld.java##) contains the definition of a regular Java interface, and looks like this:

121

122

123

@ComponentRole /* annotation used for declaring the service our component provides */

124

public interface HelloWorld

{

String sayHello();

}

Keep in mind that this interface specifies the API that other components can use on your component. In our case, we'll build a polite component that can ##sayHello()##.

131

132

Then we have the implementation of the interface, the ##DefaultHelloWorld## class.

133

134

135

@Component /* annotation used for declaring a component implementation */

136

@Singleton /* annotation used for defining the component as a singleton */

137

public class DefaultHelloWorld implements HelloWorld

138

139

140

Note that optionally, there is a ##@Named## annotation to specify a component //hint//. This is useful especially when we want to distinguish between several implementations for the same type of component. Image we had a special HelloWorld implementation taking the greeting message from a database; it could look like:

@Component

@Named("database")

public class DatabaseHelloWorld implements HelloWorld

146

147

148

Then the ##sayHello## in ##DefaultHelloWorld## is basic in this example:

/**

* Says hello by returning a greeting to the caller.

153

*

154

* @return A greeting.

155

*/

156

public String sayHello()

157

{

158

return "Hello world!";

}

And now, the ##components.txt## file, in which component implementations present in this jar are specified for the ##ComponentManager## to register them.

163

164

{{code language="none"}}com.acme.internal.DefaultHelloWorld{{/code}}

165

166

= How to find my component and use it? =

167

168

== From other components ==

169

170

To access your component from another component we use the components engine, and specify the dependencies, leaving instantiation and component injection to the be handled by the component manager.

171

172

In order to use the ##HelloWorld## component, you need a reference to it in the the component that uses it. For this, you should use a member variable in the implementation of the using component, for example, a ##Socializer## component will need to be able to say hello to the world:

@Component

@Singleton

public class DefaultSocializer implements Socializer

{

[...]

/** Will be injected by the component manager */

182

@Inject

183

private HelloWorld helloWorld;

[...]

}

Note the ##@Inject## annotation, which instructs the component manager to inject the required component where needed.

190

191

And that's it, you can now use the ##helloWorld## member anywhere in the ##DefaultSocializer## class freely, without further concerns, it will be assigned by the component manager provided that the ##HelloWorld## component is on the classpath at runtime when the ##Socializer## is used. Such as:

192

193

194

public class DefaultSocializer implements Socializer

{

[...]

public void startConversation()

199

{

200

this.helloWorld.sayHello();

[...]

}

[...]

}

More, note that all through the process of defining a communication path between two components, we never referred components implementations, all specifications being done through //roles// and //interfaces//: the implementation of a service is completely hidden from any code external to the component.

210

211

== From non-components java code (e.g. older plugins) ==

212

213

For this kind of usages, since we cannot use the component-based architecture advantages and the "magic" of the component manager, the XWiki team has created a helper method that acts like a bridge between component code and non-component code, the ##com.xpn.xwiki.web.Utils.getComponent(String role, String hint)## that gets the specified component instance from the component manager and returns it. As seen in the previous sections, the hint is an optional identifier, additional to ##role##, used to differentiate between implementations of the same interface: the //roles// identify services while the hints help differentiate between implementations. The ##getComponent## function also has a signature without the ##hint## parameter, that uses the default hint.

214

215

To use our greetings provider component, we would simply invoke:

216

217

218

HelloWorld greeter = Utils.getComponent(HelloWorld.class);

greeter.sayHello();

Note that, even if, in fact, the object returned by this function is an instance of the DefaultHelloWorld, you should **never declare your object of the implementation type nor cast to implementation instead of interface**. A component is represented by its interface, the implementation for such a service can be provided by any code, any class so relying on the implementation type is neither good practice (since the interface contract should be enough for a component), nor safe. In the future, a maven enforcer plugin will be setup in the build lifecycle, so that any reference to component implementations (located in an "internal" subpackage) will cause build errors.

223

224

{{info}}The usage of ##Utils.getComponent()## functions is highly discouraged, reserved for this type of situations, when you need to access a component from non-componentized code. For the componentized code, you should use either dependency declaration at 'compile-time' (as shown before with annotations) or, if you need to resolve components dependencies at runtime, use the ##ComponentManager##, which you can access by implementing the Composable interface as described in the [[Component Module Reference>>extensions:Extension.Component Module]].{{/info}}

225

226

== From wiki pages ==

227

228

Components can be made accessible to wiki pages by writing a ##ScriptService## implementation. They can then be access using any provided scripting language (velocity, groovy, python, ruby, php, etc).

229

230

Let's make our ##sayHello## method accessible:

@Component

@Named("hello")

@Singleton

public class HelloWorldScriptService implements ScriptService

237

{

238

@Inject

239

private HelloWorld helloWorld;

240

241

public String greet()

242

{

243

return this.helloWorld.sayHello();

}

}

Notice the component hint used (the ##hello## part in the ##@Component##). This is the name under which the script service will be accessible from scripting languages.

249

250

For example to access it in velocity you'd write:

251

252

$services.hello.greet()

From Groovy:

services.hello.greet()

258

259

260

Now for our script service to work we need to register it as a component and thus add it to the ##META-INF/components.txt## file:

261

262

...

263

com.acme.internal.HelloWorldScriptService

264

265

266

We also need to make the Script Service infrastructure available in our classpath. This is done by adding the following in your ##pom.xml## file:

267

268

269

<groupId>org.xwiki.commons</groupId>

270

<artifactId>xwiki-commons-script</artifactId>

271

<version>${commons.version}</version>

</dependency>

= Accessing Legacy code =

276

277

By legacy we mean old XWiki code that hasn't been moved to components yet.

278

279

== The XWiki data model ==

280

281

Since the XWiki data model (documents, objects, attachments, etc.) reside in the big, old ##xwiki-core## module, and since we don't want to add the whole core and all its dependencies as a dependency of a simple lightweight component (this would eventually lead to a circular dependency, which is not allowed by maven), the current strategy, until the data model is completely turned into a component, is to use a //bridge// between the new component architecture and the old ##xwiki-core##.

282

283

In short, the way this works is based on the fact that implementations for a component don't have to be in the same ##.jar## as the interface, and there is no dependency //from// the component interface //to// the actual implementation, only the other way around. So, we made a few simple components that offer basic access to XWiki documents, and declared the classes in ##xwiki-core## as the default implementation for those components.

284

285

If your component needs to access the XWiki data model, it will use the components from the ##xwiki-core-bridge## module for that. Note that these interfaces are rather small, so you can't do everything that you could with the old model. If you need to add some methods to the bridge, feel free to propose it on the [[mailing list>>dev:Community.MailingLists]].

For example:

@Component

@Singleton

public class DefaultHelloWorld implements HelloWorld

293

{

294

/** Provides access to documents. Injected by the Component Manager. */

295

@Inject

296

private DocumentAccessBridge documentAccessBridge;

[...]

private String getConfiguredGreeting()

301

{

302

return documentAccessBridge.getProperty("XWiki.XWikiPreferences", "greeting_text");

}

== The XWiki context ==

307

308

Note that the XWiki context is deprecated. It was an older way of keeping track of the current request, which had to be passed around from method to method, looking like a [[ball and chain>>http://en.wikipedia.org/wiki/Ball_and_chain]] present everywhere in the code.

309

310

In the component world, the current request information is held in an **[[execution context>>http://maven.xwiki.org/site/xwiki-core-parent/xwiki-core-context/apidocs/org/xwiki/context/ExecutionContext.html]]**. This is actually more powerful than the old XWiki context, as it is a generic execution context, and you can create one anytime you want and use it anyway you want. And you don't have to manually pass it around with all method calls, as execution contexts are managed by the **[[Execution component>>http://maven.xwiki.org/site/xwiki-core-parent/xwiki-core-context/apidocs/org/xwiki/context/Execution.html]]**, which you can use just like any other XWiki component.

311

312

In short, if you want to get access to the execution context (which holds context information inserted by the new components), you must declare an injection point on the ##Execution## component (located in the ##xwiki-core-context## module), and then you can write:

313

314

315

/** Provides access to the request context. Injected by the Component Manager. */

316

@Inject

317

private Execution execution;

[...]

private void workWithTheContext()

322

{

323

ExecutionContext context = execution.getContext();

324

// Do something with the execution context

}

If you still need to access the old XWiki context, then you can get a reference to it from the execution context, but you should not cast it to an ##XWikiContext##, which would pull the whole xwiki-core as a dependency, but to a ##Map##. You won't be able to access all the properties, like the current user name or the URL factory, but you can access anything placed in the internal map of the XWikiContext.

329

330

331

private void workWithTheContext()

332

{

333

ExecutionContext context = execution.getContext();

334

Map<Object, Object> xwikiContext = (Map<Object, Object>) context.getProperty("xwikicontext");

335

// Do something with the XWiki context

}

If you want not just to use the execution context, but to make something available in every execution context, you can create an implementation of the [[ExecutionContextInitializer>>http://maven.xwiki.org/site/xwiki-core-parent/xwiki-core-context/apidocs/org/xwiki/context/ExecutionContextInitializer.html]] component, and populate newly created execution contexts, just like with [[velocity contexts>>#HAccessingacomponentfromvelocity]].

340

341

== Code outside components ==

342

343

You can use external libraries as in any other maven module, just declare the right dependencies in your module's ##pom.xml##.

344

345

As a general rule, you should **not** work with any non-componentized XWiki code, as the way the old code was designed leads to an eventual dependency on the whole ##xwiki-core## module, which we are trying to avoid. If the component you are writing is needed by other modules (which is the case with most components, since a component which isn't providing any usable/used services is kind of useless), then this will likely lead to an eventual cyclic dependency, which will break the whole build.

346

347

If you need some functionality from the old core, consider rewriting that part as a new component first, and then use that new component from your code. You should ask first on the [[devs mailing list>>dev:Community.MailingLists]], so that we can design and implement it collaboratively.

348

349

If the effort needed for this is too large, you can try creating a bridge component, by writing just the interfaces in a new module, and make the classes from the core the default implementation of those interfaces. Then, since in the end the xwiki-core, the bridge component and your component will reside in the same classpath, plexus will take care of coupling the right classes. Be careful when writing such bridges, as they are short lived (since in the end all the old code will be replaced by proper components), and if the future real component will have a different interface, then you will have to rewrite your code to adapt to the new method names, or worse, the new component logic.

350

351

= Deploying the Component =

352

353

Now that we have a functioning Component let's build it and deploy it to a XWiki Enterprise instance:

354

* To build the component, issue ##mvn install##. This generates a JAR in the ##target## directory of your project.

355

* To install it into a XWiki Enterprise instance, just copy that JAR file in ##XE_WAR_HOME/WEB-INF/lib## where ##XE_WAR_HOME## is where the XWiki Enterprise WAR is deployed.

356

357

Your component is now ready for service.

358

359

Enjoy!

Wiki source code of Writing XWiki components

Quick Links

Navigation

About

About

Support

Platform

User Guide

Admin Guide

Developer Guide

Projects

XWiki

Extensions

Other

Contribute

Status

Practices

Under the Hood

Get Involved

Get Connected