Keycloak

1
<?xml version="1.0"?>
2
<!--
3
  ~ Copyright 2016 Red Hat, Inc. and/or its affiliates
4
  ~ and other contributors as indicated by the @author tags.
5
  ~
6
  ~ Licensed under the Apache License, Version 2.0 (the "License");
7
  ~ you may not use this file except in compliance with the License.
8
  ~ You may obtain a copy of the License at
9
  ~
10
  ~ http://www.apache.org/licenses/LICENSE-2.0
11
  ~
12
  ~ Unless required by applicable law or agreed to in writing, software
13
  ~ distributed under the License is distributed on an "AS IS" BASIS,
14
  ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15
  ~ See the License for the specific language governing permissions and
16
  ~ limitations under the License.
17
  -->
18

19
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
20
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
21
    <parent>
22
        <artifactId>keycloak-parent</artifactId>
23
        <groupId>org.keycloak</groupId>
24
        <version>999.0.0-SNAPSHOT</version>
25
        <relativePath>../pom.xml</relativePath>
26
    </parent>
27
    <modelVersion>4.0.0</modelVersion>
28

29
    <artifactId>keycloak-services</artifactId>
30
    <name>Keycloak REST Services</name>
31
    <description/>
32

33
    <properties>
34
        <version.swagger.doclet>1.1.2</version.swagger.doclet>
35
        <maven.compiler.plugin.version>3.8.1</maven.compiler.plugin.version>
36
        <maven.compiler.release>17</maven.compiler.release>
37
        <maven.compiler.source>17</maven.compiler.source>
38
        <maven.compiler.target>17</maven.compiler.target>
39
    </properties>
40

41
    <dependencies>
42
        <dependency>
43
            <groupId>org.keycloak</groupId>
44
            <artifactId>keycloak-core</artifactId>
45
        </dependency>
46
        <dependency>
47
            <groupId>org.keycloak</groupId>
48
            <artifactId>keycloak-core</artifactId>
49
            <scope>test</scope>
50
            <type>test-jar</type>
51
        </dependency>
52
        <dependency>
53
            <groupId>org.keycloak</groupId>
54
            <artifactId>${keycloak.crypto.artifactId}</artifactId>
55
            <scope>test</scope>
56
        </dependency>
57
        <dependency>
58
            <groupId>org.freemarker</groupId>
59
            <artifactId>freemarker</artifactId>
60
            <scope>provided</scope>
61
        </dependency>
62
        <dependency>
63
            <groupId>jakarta.mail</groupId>
64
            <artifactId>jakarta.mail-api</artifactId>
65
        </dependency>
66
        <dependency>
67
            <groupId>org.eclipse.angus</groupId>
68
            <artifactId>angus-mail</artifactId>
69
        </dependency>
70
        <dependency>
71
            <groupId>org.keycloak</groupId>
72
            <artifactId>keycloak-common</artifactId>
73
        </dependency>
74
        <dependency>
75
            <groupId>org.keycloak</groupId>
76
            <artifactId>keycloak-server-spi</artifactId>
77
            <scope>provided</scope>
78
        </dependency>
79
        <dependency>
80
            <groupId>org.keycloak</groupId>
81
            <artifactId>keycloak-server-spi-private</artifactId>
82
            <scope>provided</scope>
83
        </dependency>
84
        <dependency>
85
            <groupId>org.twitter4j</groupId>
86
            <artifactId>twitter4j-core</artifactId>
87
        </dependency>
88

89
        <dependency>
90
            <groupId>org.jboss.logging</groupId>
91
            <artifactId>jboss-logging</artifactId>
92
        </dependency>
93
        <dependency>
94
            <groupId>org.jboss.logging</groupId>
95
            <artifactId>jboss-logging-annotations</artifactId>
96
            <scope>provided</scope>
97
        </dependency>
98
        <dependency>
99
            <groupId>org.jboss.logging</groupId>
100
            <artifactId>jboss-logging-processor</artifactId>
101
            <scope>provided</scope>
102
            <optional>true</optional>
103
        </dependency>
104
        <dependency>
105
            <!-- for MockHttpRequest -->
106
            <groupId>org.jboss.resteasy</groupId>
107
            <artifactId>resteasy-core</artifactId>
108
            <scope>test</scope>
109
        </dependency>
110
        <dependency>
111
            <groupId>io.quarkus.resteasy.reactive</groupId>
112
            <artifactId>resteasy-reactive</artifactId>
113
            <scope>provided</scope>
114
        </dependency>
115
        <dependency>
116
            <groupId>io.quarkus.resteasy.reactive</groupId>
117
            <artifactId>resteasy-reactive-common</artifactId>
118
            <scope>provided</scope>
119
        </dependency>
120
        <dependency>
121
            <groupId>org.apache.httpcomponents</groupId>
122
            <artifactId>httpclient</artifactId>
123
            <scope>provided</scope>
124
        </dependency>
125
        <dependency>
126
            <groupId>jakarta.ws.rs</groupId>
127
            <artifactId>jakarta.ws.rs-api</artifactId>
128
        </dependency>
129
        <dependency>
130
            <groupId>jakarta.transaction</groupId>
131
            <artifactId>jakarta.transaction-api</artifactId>
132
        </dependency>
133
        <dependency>
134
            <groupId>jakarta.xml.soap</groupId>
135
            <artifactId>jakarta.xml.soap-api</artifactId>
136
        </dependency>
137
        <dependency>
138
            <groupId>org.jboss.resteasy</groupId>
139
            <artifactId>resteasy-core-spi</artifactId>
140
        </dependency>
141
        <dependency>
142
            <groupId>com.googlecode.owasp-java-html-sanitizer</groupId>
143
            <artifactId>owasp-java-html-sanitizer</artifactId>
144
        </dependency>
145
        <dependency>
146
            <groupId>com.fasterxml.jackson.core</groupId>
147
            <artifactId>jackson-core</artifactId>
148
        </dependency>
149
        <dependency>
150
            <groupId>com.fasterxml.jackson.core</groupId>
151
            <artifactId>jackson-databind</artifactId>
152
        </dependency>
153
        <dependency>
154
            <groupId>com.fasterxml.jackson.core</groupId>
155
            <artifactId>jackson-annotations</artifactId>
156
        </dependency>
157
        <dependency>
158
            <groupId>javax.annotation</groupId>
159
            <artifactId>javax.annotation-api</artifactId>
160
        </dependency>
161
        <dependency>
162
            <groupId>com.fasterxml.jackson.datatype</groupId>
163
            <artifactId>jackson-datatype-jdk8</artifactId>
164
        </dependency>
165
        <dependency>
166
            <groupId>com.fasterxml.woodstox</groupId>
167
            <artifactId>woodstox-core</artifactId>
168
            <version>${woodstox.version}</version>    <!-- this version has to match that of used in Wildfly -->
169
            <scope>test</scope>
170
        </dependency>
171
        <dependency>
172
            <groupId>com.google.zxing</groupId>
173
            <artifactId>javase</artifactId>
174
        </dependency>
175
        <dependency>
176
            <groupId>org.keycloak</groupId>
177
            <artifactId>keycloak-saml-core-public</artifactId>
178
            <scope>provided</scope>
179
        </dependency>
180
        <dependency>
181
            <groupId>org.keycloak</groupId>
182
            <artifactId>keycloak-saml-core</artifactId>
183
            <scope>provided</scope>
184
        </dependency>
185
        <dependency>
186
            <groupId>commons-io</groupId>
187
            <artifactId>commons-io</artifactId>
188
            <scope>provided</scope>
189
        </dependency>
190
        <dependency>
191
            <groupId>junit</groupId>
192
            <artifactId>junit</artifactId>
193
            <scope>test</scope>
194
        </dependency>
195
        <dependency>
196
            <groupId>org.hamcrest</groupId>
197
            <artifactId>hamcrest</artifactId>
198
            <scope>test</scope>
199
        </dependency>
200
        <dependency>
201
            <groupId>com.icegreen</groupId>
202
            <artifactId>greenmail</artifactId>
203
            <scope>test</scope>
204
            <exclusions>
205
                <exclusion>
206
                    <groupId>org.slf4j</groupId>
207
                    <artifactId>slf4j-api</artifactId>
208
                </exclusion>
209
            </exclusions>
210
        </dependency>
211
        <dependency>
212
            <groupId>com.webauthn4j</groupId>
213
            <artifactId>webauthn4j-core</artifactId>
214
        </dependency>
215
        <dependency>
216
            <groupId>com.github.ua-parser</groupId>
217
            <artifactId>uap-java</artifactId>
218
        </dependency>
219
        <dependency>
220
            <groupId>org.eclipse.microprofile.openapi</groupId>
221
            <artifactId>microprofile-openapi-api</artifactId>
222
        </dependency>
223
        <dependency>
224
            <groupId>io.smallrye.common</groupId>
225
            <artifactId>smallrye-common-annotation</artifactId>
226
        </dependency>
227
        <dependency>
228
            <groupId>org.keycloak</groupId>
229
            <artifactId>keycloak-model-storage-private</artifactId>
230
        </dependency>
231

232
    </dependencies>
233
    <build>
234
        <plugins>
235
            <plugin>
236
                <groupId>org.apache.maven.plugins</groupId>
237
                <artifactId>maven-compiler-plugin</artifactId>
238
                <configuration>
239
                    <compilerArgument>
240
                        -AgeneratedTranslationFilesPath=${project.build.directory}/generated-translation-files
241
                    </compilerArgument>
242
                </configuration>
243
            </plugin>
244
        </plugins>
245
    </build>
246

247
    <profiles>
248
        <profile>
249
            <id>jboss-release</id>
250

251
            <build>
252
                <plugins>
253
                    <plugin>
254
                        <artifactId>maven-resources-plugin</artifactId>
255
                        <executions>
256
                            <execution>
257
                                <id>copy-resources</id>
258
                                <phase>validate</phase>
259
                                <goals>
260
                                    <goal>copy-resources</goal>
261
                                </goals>
262
                                <configuration>
263
                                    <outputDirectory>target/docs</outputDirectory>
264
                                    <resources>
265
                                        <resource>
266
                                            <directory>src/docs</directory>
267
                                            <filtering>true</filtering>
268
                                        </resource>
269
                                    </resources>
270
                                </configuration>
271
                            </execution>
272
                            <execution>
273
                                <id>copy-raw-openapi-definition</id>
274
                                <phase>package</phase>
275
                                <goals>
276
                                    <goal>copy-resources</goal>
277
                                </goals>
278
                                <configuration>
279
                                    <outputDirectory>${project.basedir}/target/apidocs-rest/output</outputDirectory>
280
                                    <resources>
281
                                        <resource>
282
                                            <directory>${project.build.directory}/apidocs-rest/swagger/apidocs</directory>
283
                                            <includes>
284
                                                <include>**/openapi.yaml</include>
285
                                                <include>**/openapi.json</include>
286
                                            </includes>
287
                                        </resource>
288
                                    </resources>
289
                                    <overwrite>true</overwrite>
290
                                </configuration>
291
                            </execution>
292
                        </executions>
293
                    </plugin>
294
                    <plugin>
295
                        <groupId>io.smallrye</groupId>
296
                        <artifactId>smallrye-open-api-maven-plugin</artifactId>
297
                        <configuration>
298
                            <scanProfiles>admin</scanProfiles>
299
                            <outputDirectory>${project.build.directory}/apidocs-rest/swagger/apidocs</outputDirectory>
300
                            <infoTitle>Keycloak Admin REST API</infoTitle>
301
                            <infoDescription>This is a REST API reference for the Keycloak Admin REST API.</infoDescription>
302
                        </configuration>
303
                        <executions>
304
                            <execution>
305
                                <goals>
306
                                    <goal>generate-schema</goal>
307
                                </goals>
308
                            </execution>
309
                        </executions>
310
                    </plugin>
311
                    <plugin>
312
                        <groupId>org.openapitools</groupId>
313
                        <artifactId>openapi-generator-maven-plugin</artifactId>
314
                        <executions>
315
                            <execution>
316
                                <id>generate-ascii-docs</id>
317
                                <phase>prepare-package</phase>
318
                                <goals>
319
                                    <goal>generate</goal>
320
                                </goals>
321
                                <configuration>
322
                                    <globalProperties>
323
                                        <apiDocs>true</apiDocs>
324
                                        <apiModels>true</apiModels>
325
                                        <apiTests>false</apiTests>
326
                                        <modelTests>false</modelTests>
327
                                        <verbose>false</verbose>
328
                                    </globalProperties>
329
                                    <inputSpec>${project.build.directory}/apidocs-rest/swagger/apidocs/openapi.yaml</inputSpec>
330
                                    <output>${project.basedir}/target/docs/asciidoc/</output>
331
                                    <generatorName>asciidoc</generatorName>
332
                                    <generateApiDocumentation>true</generateApiDocumentation>
333
                                    <generateModelDocumentation>true</generateModelDocumentation>
334
                                    <generateSupportingFiles>true</generateSupportingFiles>
335
                                    <groupId>${project.groupId}</groupId>
336
                                    <artifactId>${project.artifactId}</artifactId>
337
                                    <templateDirectory>src/docs/openapi-generator-templates/keycloak-admin-api</templateDirectory>
338
                                    <configOptions>
339
                                        <useIntroduction>true</useIntroduction>
340
                                        <delegatePattern>false</delegatePattern>
341
                                        <useMethodAndPath>true</useMethodAndPath>
342
                                        <prependFormOrBodyParameters>false</prependFormOrBodyParameters>
343
                                        <skipExamples>true</skipExamples>
344
                                    </configOptions>
345
                                    <skipValidateSpec>true</skipValidateSpec>
346
                                </configuration>
347
                            </execution>
348
                        </executions>
349
                    </plugin>
350

351
                    <plugin>
352
                        <groupId>org.asciidoctor</groupId>
353
                        <artifactId>asciidoctor-maven-plugin</artifactId>
354
                        <executions>
355
                            <execution>
356
                                <id>generate-docs</id>
357
                                <phase>package</phase>
358
                                <goals>
359
                                    <goal>process-asciidoc</goal>
360
                                </goals>
361
                                <configuration>
362
                                    <sourceDirectory>${project.basedir}/target/docs/asciidoc</sourceDirectory>
363
                                    <sourceDocumentName>index.adoc</sourceDocumentName>
364
                                    <outputDirectory>${project.basedir}/target/apidocs-rest/output</outputDirectory>
365
                                    <backend>html5</backend>
366
                                    <attributes>
367
                                        <!-- List of attributes:
368
                                        https://github.com/asciidoctor/asciidoctorj/blob/master/asciidoctorj-core/src/main/java/org/asciidoctor/Attributes.java
369
                                         -->
370
                                        <toc/>
371
                                        <toc-position>left</toc-position>
372
                                        <generated>${project.basedir}/target/apidocs-rest/asciidoc</generated>
373
                                        <!-- Boolean attributes are passed as defined/undefined to AsciiDoc, not at their literal value -->
374
                                        <project_community>true</project_community>
375
                                        <project_product>false</project_product>
376
                                    </attributes>
377
                                </configuration>
378
                            </execution>
379
                        </executions>
380
                    </plugin>
381
                </plugins>
382
            </build>
383
        </profile>
384

385

386
        <profile>
387
            <id>product</id>
388
            <activation>
389
                <property>
390
                    <name>product</name>
391
                </property>
392
            </activation>
393
            <build>
394
                <plugins>
395
                    <plugin>
396
                        <groupId>org.asciidoctor</groupId>
397
                        <artifactId>asciidoctor-maven-plugin</artifactId>
398
                        <executions>
399
                            <execution>
400
                                <id>generate-docs</id>
401
                                <phase>package</phase>
402
                                <goals>
403
                                    <goal>process-asciidoc</goal>
404
                                </goals>
405
                                <configuration combine.children="append">
406
                                    <attributes combine.children="append">
407
                                        <project_community>false</project_community>
408
                                        <project_product>true</project_product>
409
                                    </attributes>
410
                                </configuration>
411
                            </execution>
412
                        </executions>
413
                    </plugin>
414
                </plugins>
415
            </build>
416
        </profile>
417

418
    </profiles>
419
</project>
420