-
Notifications
You must be signed in to change notification settings - Fork 0
/
extensioninfo.xsd
239 lines (227 loc) · 11 KB
/
extensioninfo.xsd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
<?xml version="1.0" encoding="UTF-8"?>
<!--
[y] hybris Platform
Copyright (c) 2017 SAP SE or an SAP affiliate company. All rights reserved.
This software is the confidential and proprietary information of SAP
("Confidential Information"). You shall not disclose such Confidential
Information and shall use it only in accordance with the terms of the
license agreement you entered into with SAP.
-->
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">
<xs:element name="extensioninfo">
<xs:annotation>
<xs:documentation>Configures the available modules of the extension.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:annotation>
<xs:documentation>Configures the available modules of the extension.</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="extension" type="extensionType" minOccurs="1" maxOccurs="1" />
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:complexType name="extensionType">
<xs:annotation>
<xs:documentation>Configures the available modules of the extension.</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="requires-extension" type="requires-extensionType" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Configures the set of extensions required by the extension at compile time. If you set 'autoload=true' in the localextensions.xml file, you will not need to reference any core extensions here. </xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="coremodule" type="coremoduleType" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>Configures a core module for the extension. A core module consists of an items.xml file (and therefore allows to add new types to the system), a manager class, classes for the JaLo Layer and the ServiceLayer and JUnit test classes. The following directories are required: /src, /resources, /testsrc.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="webmodule" type="webmoduleType" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>Configures a web module for the extension. Required directory: /web.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="hmcmodule" type="hmcmoduleType" minOccurs="0" maxOccurs="1">
<xs:annotation>
<xs:documentation>Configures an hMC module for the extension. Required directory: /hmc.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="meta" type="metaType" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Configures metadata.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute name="name" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>Name of the extension. Do not use special characters or spaces.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="version" type="xs:string" use="optional">
<xs:annotation>
<xs:documentation>Optionally defines the version of this extension. If not defined the build process assumes it being the same version as the platform.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="classprefix" type="xs:string" use="optional">
<xs:annotation>
<xs:documentation>Prefix used for generated extension classes, such as the classes for Constants. Default is "[extensionname]".</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="abstractclassprefix" type="xs:string" use="optional">
<xs:annotation>
<xs:documentation>Prefix for generated Java classes, such as the abstract classes for getter and setter methods. Default is "Generated".</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="isoldstyleextension" type="xs:boolean" use="optional">
<xs:annotation>
<xs:documentation>Deprecated. Default is "false".</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="requiredbyall" type="xs:boolean" use="optional" default="false">
<xs:annotation>
<xs:documentation>If 'true' this extension is treated like platform/ext core extensions and is automtically added to all other extension dependencies.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="managername" type="xs:string" use="optional">
<xs:annotation>
<xs:documentation>Class name of the manager class. Default is "[classprefix]Manager"</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="managersuperclass" type="classType" use="optional">
<xs:annotation>
<xs:documentation>Class name of the manager's superclass. Default is de.hybris.platform.jalo.extension.Extension.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="description" type="xs:string" use="optional">
<xs:annotation>
<xs:documentation>Short description of this extension. Is used by the hybris package manager.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="usemaven" type="xs:string" use="optional">
<xs:annotation>
<xs:documentation>If 'true' uses maven and external-dependencies.xml file for fetching required libraries into \lib and \web\webroot\WEB-INF\lib.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
<xs:complexType name="requires-extensionType">
<xs:annotation>
<xs:documentation>Configures the set of extensions required by the extension at compile time.</xs:documentation>
</xs:annotation>
<xs:attribute name="name" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>Name of an extension which is required at compile time.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="version" type="xs:string" use="optional">
<xs:annotation>
<xs:documentation>Allowed range of versions of the required extension. Is used by the hybris package manager.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
<xs:complexType name="coremoduleType">
<xs:annotation>
<xs:documentation>Configures a core module for the extension. A core module consists of an items.xml file (and therefore allows to add new types to the system), a manager class, classes for the JaLo Layer and the ServiceLayer and JUnit test classes. The following directories are required: /src, /resources, /testsrc.</xs:documentation>
</xs:annotation>
<xs:attribute name="additionalclasspath" type="xs:string" use="optional">
<xs:annotation>
<xs:documentation>Deprecated. Not used anymore.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="packageroot" type="xs:string" use="optional">
<xs:annotation>
<xs:documentation>Package root where extension and item classes will be generated to.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="manager" type="xs:string" use="optional">
<xs:annotation>
<xs:documentation>Fully qualified Java class name of the extension's manager.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="sourceavailable" type="xs:boolean" use="optional">
<xs:annotation>
<xs:documentation>Deprecated. Has no effect and will be evaluated always to 'true' if a 'src' directory is available</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="generated" type="xs:boolean" use="optional">
<xs:annotation>
<xs:documentation>If "true", item and extension classes will be generated. Only needed in case of "sourceavailable=true". Default is "false".</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="java5" type="xs:boolean" use="optional">
<xs:annotation>
<xs:documentation>Deprecated. Will always be evaluated to 'true'. Generated item and extension classes will use java generics and annotations.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="generatePartOf" type="xs:boolean" use="optional">
<xs:annotation>
<xs:documentation>If "true", the generated item and extension classes will use the partOf handler, so partOf references will be removed if the holding item is removed. Default is "true".</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
<xs:complexType name="webmoduleType">
<xs:annotation>
<xs:documentation>Configures an hMC module for the extension. Required directory: /web.</xs:documentation>
</xs:annotation>
<xs:attribute name="webroot" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>Webroot where the web application will be available at.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="additionalclasspath" type="xs:string" use="optional">
<xs:annotation>
<xs:documentation>Deprecated. Not used anymore.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="jspcompile" type="xs:boolean" use="optional">
<xs:annotation>
<xs:documentation>If "true", JSP files will be pre-compiled as part of the build process. If "false", JSP files will be compiled when first used by the application server. Default is "true".</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="sourceavailable" type="xs:boolean" use="optional">
<xs:annotation>
<xs:documentation>Deprecated. Has no effect and will be evaluated always to 'true' if a 'web/src' directory is available</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
<xs:complexType name="hmcmoduleType">
<xs:annotation>
<xs:documentation>Configures an hmc module for the extension. Required directory: /hmc.</xs:documentation>
</xs:annotation>
<xs:attribute name="additionalclasspath" type="xs:string" use="optional">
<xs:annotation>
<xs:documentation>Deprecated. Not used anymore.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="extensionclassname" type="xs:string" use="optional">
<xs:annotation>
<xs:documentation>Name of the extension's HMCExtension class.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="sourceavailable" type="xs:boolean" use="optional">
<xs:annotation>
<xs:documentation>Deprecated. Has no effect and will be evaluated always to 'true' if a 'hmc/src' directory is available</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
<xs:complexType name="metaType">
<xs:annotation>
<xs:documentation>Configures metadata.</xs:documentation>
</xs:annotation>
<xs:attribute name="key" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>Metadata key.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="value" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>Metadata value.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
<xs:simpleType name="classType">
<xs:annotation>
<xs:documentation>A class name including full package name.</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:normalizedString"/>
</xs:simpleType>
</xs:schema>