Skip to content

Commit 69abd5b

Browse files
committed
Note about XML namespace (#11)
1 parent 47c3832 commit 69abd5b

File tree

1 file changed

+17
-10
lines changed

1 file changed

+17
-10
lines changed

README.md

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,13 @@ This plugin uses [FusionDirectory REST API](https://rest-api.fusiondirectory.org
1010

1111
## Configuration
1212

13+
### XML namespace
14+
15+
You need to add the plugin namespace to the main lsc.xml file, for example:
16+
```xml
17+
<lsc xmlns="http://lsc-project.org/XSD/lsc-core-2.2.xsd" xmlns:fusiondirectory="http://lsc-project.org/XSD/lsc-fusiondirectory-plugin-1.0.xsd" revision="0">
18+
```
19+
1320
### PluginConnection
1421

1522
+ `name`: the name of the connection
@@ -19,7 +26,7 @@ This plugin uses [FusionDirectory REST API](https://rest-api.fusiondirectory.org
1926

2027
Example:
2128

22-
```
29+
```xml
2330
<pluginConnection>
2431
<name>fusiondirectory</name>
2532
<url>http://fusiondirectory.local/fusiondirectory/rest.php/v1</url>
@@ -40,7 +47,7 @@ Example:
4047

4148
Example of source service :
4249

43-
```
50+
```xml
4451
<pluginSourceService implementationClass="org.lsc.plugins.connectors.fusiondirectory.FusionDirectorySrcService">
4552
<name>fusiondirectory-source-service</name>
4653
<connection reference="fusiondirectory" />
@@ -69,7 +76,7 @@ Example of source service :
6976

7077
Example of a destination service :
7178

72-
```
79+
```xml
7380
<pluginDestinationService implementationClass="org.lsc.plugins.connectors.fusiondirectory.FusionDirectoryDstService">
7481
<name>fusiondirectory-dest-service</name>
7582
<connection reference="fusiondirectory" />
@@ -98,13 +105,13 @@ Example of a destination service :
98105

99106
Multiple attributes in Fusiondirectory must be declared as so:
100107

101-
```
108+
```xml
102109
<fusiondirectory:attribute multiple="true">title</fusiondirectory:attribute>
103110
```
104111

105112
Attribute user/userPassword may define a passwordHash with a value chosen from Fusiondirectory > Configuration > Password settings > allowed password hashes:
106113

107-
```
114+
```xml
108115
<fusiondirectory:attribute passwordHash="clear">userPassword</fusiondirectory:attribute>
109116
```
110117

@@ -130,13 +137,13 @@ If no filters are defined, the connector will retrieve all entries of type _enti
130137

131138
When using the destination service, the `mainIdentifier` holds the value of your pivot attribute:
132139

133-
```
140+
```xml
134141
<mainIdentifier><![CDATA[ srcBean.getDatasetFirstValueById("uid") ]]></mainIdentifier>
135142
```
136143

137144
The `base` attribute holds the location where the entity will be created or moved to:
138145

139-
```
146+
```xml
140147
<dataset>
141148
<name>base</name>
142149
<policy>FORCE</policy>
@@ -152,7 +159,7 @@ The `base` attribute holds the location where the entity will be created or move
152159

153160
First, declare it as a customLibrary:
154161

155-
```
162+
```xml
156163
<task>
157164
...
158165
<customLibrary>
@@ -163,7 +170,7 @@ First, declare it as a customLibrary:
163170

164171
Then, an instance of the class can be accessed in scripts using `custom[0]`:
165172

166-
```
173+
```xml
167174
<dataset>
168175
<name>member</name>
169176
<forceValues>
@@ -185,7 +192,7 @@ This library has available methods:
185192

186193
Here is a script example of resolving group members DN from AD to FusionDirectory:
187194

188-
```
195+
```xml
189196
<dataset>
190197
<name>member</name>
191198
<forceValues>

0 commit comments

Comments
 (0)