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]].

6

7

8

Components replace the older Plugin architecture which has been deprecated a while ago.

9

10

11

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

12

13

= Let's get started! =

14

15

Enough talking, let's see some code!

16

17

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.

18

19

== Creating a XWiki component using Maven ==

20

21

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).

22

23

To make it easier for you to get started, we have created a [[Maven Archetype>>http://maven.apache.org/plugins/maven-archetype-plugin/]] to help create a simple component module with a single command.

24

25

After you've [[installed Maven>>http://maven.apache.org]], open a shell prompt an type:

26

27

mvn archetype:generate

28

29

30

This will list all archetypes available on Maven Central. If instead you wish to directly use the XWiki Component Archetype, you can directly type (update the version to use the version you wish to use):

31

32

33

mvn archetype:generate \

34

-DarchetypeArtifactId=xwiki-commons-component-archetype \

35

-DarchetypeGroupId=org.xwiki.commons \

36

-DarchetypeVersion=3.3

37

38

39

Then follow the instructions. For example:

40

41

42

vmassol@tmp $ mvn archetype:generate

43

[INFO] Scanning for projects...

44

[INFO]

45

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

46

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

47

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

48

[INFO]

49

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

50

[INFO]

51

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

52

[INFO]

53

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

54

[INFO] Generating project in Interactive mode

55

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

56

Choose archetype:

57

...

58

493: remote -> org.xwiki.commons:xwiki-commons-component-archetype (Make it easy to create a maven project for creating XWiki Components.)

59

...

60

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

61

Choose org.xwiki.commons:xwiki-commons-component-archetype version:

1: 3.3-milestone-1

2: 3.3-milestone-2

3: 3.3-SNAPSHOT

Choose a number: 3:

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

67

Define value for property 'artifactId': : example

68

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

69

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

70

Confirm properties configuration:

71

groupId: com.acme

72

artifactId: example

73

version: 1.0-SNAPSHOT

74

package: com.acme

75

Y: : Y

76

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

77

[INFO] Using following parameters for creating project from Archetype: xwiki-commons-component-archetype:3.3-SNAPSHOT

78

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

79

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

80

[INFO] Parameter: artifactId, Value: example

81

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

82

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

83

[INFO] Parameter: packageInPathFormat, Value: com/acme

84

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

85

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

86

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

87

[INFO] Parameter: artifactId, Value: example

88

[INFO] project created from Archetype in dir: /private/tmp/example

89

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

90

[INFO] BUILD SUCCESS

91

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

92

[INFO] Total time: 7:58.355s

93

[INFO] Finished at: Tue Dec 06 17:18:00 CET 2011

94

[INFO] Final Memory: 7M/81M

95

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

96

97

98

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

99

100

== The Component explained ==

101

102

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

103

104

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

pom.xml

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

109

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

110

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

111

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

112

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

113

114

115

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.

116

117

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

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

123

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

124

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

125

</dependency>

126

127

128

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

129

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

130

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

</dependency>

</dependencies>

The code above defines the dependency on the ##xwiki-core-component-api## 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.

137

138

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

139

140

141

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

142

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()##.

149

150

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

151

152

153

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

154

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

155

public class DefaultHelloWorld implements HelloWorld

156

157

158

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

164

165

166

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

/**

* Says hello by returning a greeting to the caller.

171

*

172

* @return A greeting.

173

*/

174

public String sayHello()

175

{

176

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.

181

182

183

com.acme.internal.DefaultHelloWorld

184

185

186

= How to find my component and use it? =

187

188

== From other components ==

189

190

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.

191

192

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 */

202

@Inject

203

private HelloWorld helloWorld;

[...]

}

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

210

211

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:

212

213

214

public class DefaultSocializer implements Socializer

{

[...]

public void startConversation()

219

{

220

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.

230

231

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

232

233

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.

234

235

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

236

237

238

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.

243

244

245

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]].

246

247

248

== From wiki pages ==

249

250

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).

251

252

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

@Component

@Named("hello")

@Singleton

public class HelloWorldScriptService implements ScriptService

259

{

260

@Inject

261

private HelloWorld helloWorld;

262

263

public String greet()

264

{

265

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.

271

272

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

273

{{code language="none"}}$services.hello.greet(){{/code}}

274

275

From Groovy:

276

{{code language="none"}}services.hello.greet(){{/code}}

277

278

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:

279

{{code language="none"}}...

280

com.acme.internal.HelloWorldScriptService{{/code}}

281

282

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:

283

{{code language="xml"}}<dependency>

284

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

285

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

286

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

287

</dependency>{{/code}}

288

289

= Accessing Legacy code =

290

291

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

292

293

== The XWiki data model ==

294

295

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##.

296

297

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.

298

299

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

307

{

308

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

309

@Inject

310

private DocumentAccessBridge documentAccessBridge;

[...]

private String getConfiguredGreeting()

315

{

316

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

}

== The XWiki context ==

321

322

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.

323

324

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.

325

326

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:

327

328

329

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

330

@Inject

331

private Execution execution;

[...]

private void workWithTheContext()

336

{

337

ExecutionContext context = execution.getContext();

338

// 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.

343

344

345

private void workWithTheContext()

346

{

347

ExecutionContext context = execution.getContext();

348

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

349

// 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]].

354

355

== Code outside components ==

356

357

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

358

359

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.

360

361

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.

362

363

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.

364

365

= Deploying the Component =

366

367

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

368

369

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

370

* 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.

371

372

Your component is now ready for service.

373

374

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