-
Notifications
You must be signed in to change notification settings - Fork 188
/
PrismContext.java
388 lines (311 loc) · 12.7 KB
/
PrismContext.java
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
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
/*
* Copyright (c) 2010-2018 Evolveum and contributors
*
* This work is dual-licensed under the Apache License 2.0
* and European Union Public License. See LICENSE file for details.
*/
package com.evolveum.midpoint.prism;
import com.evolveum.midpoint.prism.crypto.Protector;
import com.evolveum.midpoint.prism.crypto.ProtectorCreator;
import com.evolveum.midpoint.prism.delta.DeltaFactory;
import com.evolveum.midpoint.prism.delta.ObjectDelta;
import com.evolveum.midpoint.prism.delta.builder.S_ItemEntry;
import com.evolveum.midpoint.prism.marshaller.ParsingMigrator;
import com.evolveum.midpoint.prism.metadata.ValueMetadataFactory;
import com.evolveum.midpoint.prism.metadata.ValueMetadataMockUpFactory;
import com.evolveum.midpoint.prism.path.CanonicalItemPath;
import com.evolveum.midpoint.prism.path.ItemPath;
import com.evolveum.midpoint.prism.path.UniformItemPath;
import com.evolveum.midpoint.prism.polystring.PolyStringNormalizer;
import com.evolveum.midpoint.prism.query.QueryFactory;
import com.evolveum.midpoint.prism.query.QueryConverter;
import com.evolveum.midpoint.prism.query.builder.S_FilterEntryOrEmpty;
import com.evolveum.midpoint.prism.schema.SchemaFactory;
import com.evolveum.midpoint.prism.schema.SchemaRegistry;
import com.evolveum.midpoint.prism.util.PrismMonitor;
import com.evolveum.midpoint.prism.xnode.RootXNode;
import com.evolveum.midpoint.prism.xnode.XNodeFactory;
import com.evolveum.midpoint.prism.xnode.XNodeMutator;
import com.evolveum.midpoint.util.annotation.Experimental;
import com.evolveum.midpoint.util.exception.SchemaException;
import com.evolveum.prism.xml.ns._public.types_3.ItemPathType;
import com.evolveum.prism.xml.ns._public.types_3.PolyStringNormalizerConfigurationType;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import org.w3c.dom.Element;
import org.xml.sax.SAXException;
import javax.xml.namespace.QName;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.util.List;
/**
*
* @author semancik
* @author mederly
*/
public interface PrismContext extends ProtectorCreator {
String LANG_XML = "xml";
String LANG_JSON = "json";
String LANG_YAML = "yaml";
/**
* Initializes the prism context, e.g. loads and parses all the schemas.
*/
void initialize() throws SchemaException, SAXException, IOException;
void configurePolyStringNormalizer(PolyStringNormalizerConfigurationType configuration) throws ClassNotFoundException, InstantiationException, IllegalAccessException;
/**
* Returns the schema registry.
*/
@NotNull
SchemaRegistry getSchemaRegistry();
/**
* Returns the default PolyString normalizer.
*/
@NotNull
PolyStringNormalizer getDefaultPolyStringNormalizer();
/**
* Returns the default protector. (TODO)
*/
Protector getDefaultProtector();
@NotNull
QueryConverter getQueryConverter();
//region Parsing
/**
* Creates a parser ready to process the given file.
* @param file File to be parsed.
* @return Parser that can be invoked to retrieve the (parsed) content of the file.
*/
@NotNull
PrismParser parserFor(@NotNull File file);
/**
* Creates a parser ready to process data from the given input stream.
* @param stream Input stream to be parsed.
* @return Parser that can be invoked to retrieve the (parsed) content of the input stream.
*/
@NotNull
PrismParser parserFor(@NotNull InputStream stream);
/**
* Creates a parser ready to process data from the given string.
* @param data String with the data to be parsed. It has be in UTF-8 encoding.
* (For other encodings please use InputStream or File source.)
* @return Parser that can be invoked to retrieve the (parsed) content.
*/
@NotNull
PrismParserNoIO parserFor(@NotNull String data);
/**
* Creates a parser ready to process data from the given XNode tree.
* @param xnode XNode tree with the data to be parsed.
* @return Parser that can be invoked to retrieve the (parsed) content.
*/
@NotNull
PrismParserNoIO parserFor(@NotNull RootXNode xnode);
/**
* Creates a parser ready to process data from the given DOM element.
* @param element Element with the data to be parsed.
* @return Parser that can be invoked to retrieve the (parsed) content.
*/
@NotNull
PrismParserNoIO parserFor(@NotNull Element element);
@NotNull
String detectLanguage(@NotNull File file) throws IOException;
default <T extends Objectable> PrismObject<T> parseObject(File file) throws SchemaException, IOException {
return parserFor(file).parse();
}
default <T extends Objectable> PrismObject<T> parseObject(String dataString) throws SchemaException {
return parserFor(dataString).parse();
}
ParsingMigrator getParsingMigrator();
void setParsingMigrator(ParsingMigrator migrator);
//endregion
//region Adopt methods
<C extends Containerable> void adopt(PrismContainer<C> object, Class<C> declaredType) throws SchemaException;
<T extends Containerable> void adopt(PrismContainer<T> object) throws SchemaException;
void adopt(Objectable objectable) throws SchemaException;
void adopt(Containerable containerable) throws SchemaException;
void adopt(PrismContainerValue value) throws SchemaException;
<T extends Objectable> void adopt(ObjectDelta<T> delta) throws SchemaException;
<C extends Containerable, O extends Objectable> void adopt(C containerable, Class<O> type, ItemPath path) throws SchemaException;
<C extends Containerable, O extends Objectable> void adopt(PrismContainerValue<C> prismContainerValue, Class<O> type,
ItemPath path) throws SchemaException;
<C extends Containerable, O extends Objectable> void adopt(PrismContainerValue<C> prismContainerValue, QName typeName,
ItemPath path) throws SchemaException;
//endregion
//region Serializing
/**
* Creates a serializer for the given language.
* @param language Language (like xml, json, yaml).
* @return The serializer.
*/
@NotNull
PrismSerializer<String> serializerFor(@NotNull String language);
/**
* Creates a serializer for XML language.
* @return The serializer.
*/
@NotNull
PrismSerializer<String> xmlSerializer();
/**
* Creates a serializer for JSON language.
* @return The serializer.
*/
@NotNull
PrismSerializer<String> jsonSerializer();
/**
* Creates a serializer for YAML language.
* @return The serializer.
*/
@NotNull
PrismSerializer<String> yamlSerializer();
/**
* Creates a serializer for DOM. The difference from XML serializer is that XML produces String output
* whereas this one produces a DOM Element.
* @return The serializer.
*/
@NotNull
PrismSerializer<Element> domSerializer();
/**
* Creates a serializer for XNode. The output of this serializer is intermediate XNode representation.
* @return The serializer.
*/
@NotNull
PrismSerializer<RootXNode> xnodeSerializer();
/**
* TODO
* @param value
* @return
*/
boolean canSerialize(Object value);
//endregion
/**
* Creates a new PrismObject of a given type.
* @param clazz Static type of the object to be created.
* @return New PrismObject.
* @throws SchemaException If a definition for the given class couldn't be found.
*/
@NotNull
<O extends Objectable> PrismObject<O> createObject(@NotNull Class<O> clazz) throws SchemaException;
/**
* Creates a new Objectable of a given type.
* @param clazz Static type of the object to be created.
* @return New PrismObject's objectable content.
* @throws SchemaException If a definition for the given class couldn't be found.
*/
@NotNull
<O extends Objectable> O createObjectable(@NotNull Class<O> clazz) throws SchemaException;
/**
* Creates a new PrismObject of a given static type. It is expected that the type exists, so any SchemaExceptions
* will be thrown as run-time exception.
* @param clazz Static type of the object to be created.
* @return New PrismObject.
*/
@NotNull
<O extends Objectable> PrismObject<O> createKnownObject(@NotNull Class<O> clazz);
/**
* Creates a new Objectable of a given static type. It is expected that the type exists, so any SchemaExceptions
* will be thrown as run-time exception.
* @param clazz Static type of the object to be created.
* @return New PrismObject's objectable content.
*/
@NotNull
<O extends Objectable> O createKnownObjectable(@NotNull Class<O> clazz);
PrismMonitor getMonitor();
void setMonitor(PrismMonitor monitor);
/**
* If defined, it is considered to be the same as the relation of 'null'. Currently in midPoint, it is the value of org:default.
*/
QName getDefaultRelation();
void setDefaultRelation(QName name);
/**
* If defined, marks the 'multiple objects' element.
*/
QName getObjectsElementName();
/**
* Type name for serialization of Referencable that's not of XML type (e.g. DefaultReferencableImpl).
* In midPoint it's c:ObjectReferenceType.
*
* VERY EXPERIMENTAL. Maybe we should simply use t:ObjectReferenceType in such cases.
*/
@Experimental
QName getDefaultReferenceTypeName();
boolean isDefaultRelation(QName relation);
// TODO improve this method to avoid false positives when unqualified relations are defined (minor priority, as that's unsupported anyway)
boolean relationsEquivalent(QName relation1, QName relation2);
boolean relationMatches(QName relationQuery, QName relation);
/**
* Returns true of any of the relation in the relationQuery list matches specified relation.
*/
boolean relationMatches(@NotNull List<QName> relationQuery, QName relation);
ParsingContext getDefaultParsingContext();
ParsingContext createParsingContextForAllowMissingRefTypes();
ParsingContext createParsingContextForCompatibilityMode();
UniformItemPath emptyPath();
UniformItemPath path(Object... namesOrIdsOrSegments);
Hacks hacks();
XNodeFactory xnodeFactory();
XNodeMutator xnodeMutator();
/**
* Temporary
*/
@NotNull
UniformItemPath toUniformPath(ItemPath path);
@Nullable
UniformItemPath toUniformPathKeepNull(ItemPath path);
UniformItemPath toUniformPath(ItemPathType path);
default ItemPath toPath(ItemPathType path) {
return path != null ? path.getItemPath() : null;
}
/**
* Temporary
*/
CanonicalItemPath createCanonicalItemPath(ItemPath itemPath, Class<? extends Containerable> clazz);
/**
* Temporary
*/
CanonicalItemPath createCanonicalItemPath(ItemPath itemPath);
<C extends Containerable> S_ItemEntry deltaFor(Class<C> objectClass) throws SchemaException;
S_FilterEntryOrEmpty queryFor(Class<? extends Containerable> queryClass);
/**
* Access point to the "old" way of creating deltas. It is generally considered deprecated.
* DeltaBuilder (accessed via deltaFor method) should be used instead.
*
* However, because there is some functionality (like creation of empty deltas) that is not covered by the delta
* builder, we keep this method not marked as deprecated. Only particular parts of DeltaFactory are marked as deprecated.
*/
@NotNull
DeltaFactory deltaFactory();
/**
* Access point to the "old" way of creating queries, filters and paging instructions.
* It is generally considered deprecated. QueryBuilder (accessed via queryFor method) should be used instead.
*
* However, because there is some functionality (like creation of standalone paging instructions) that is not covered
* by the query builder, we keep this method not marked as deprecated. Only particular parts of QueryFactory are marked
* as deprecated.
*/
@NotNull
QueryFactory queryFactory();
@NotNull
ItemFactory itemFactory();
@NotNull
DefinitionFactory definitionFactory();
@NotNull
ItemPathParser itemPathParser();
// TEMPORARY/EXPERIMENTAL
@Experimental
void setExtraValidation(boolean value);
@NotNull
SchemaFactory schemaFactory();
/**
* TEMPORARY. WILL BE REMOVED AFTER PROTOTYPING IS OVER.
*/
@Experimental
void setValueMetadataMockUpFactory(ValueMetadataMockUpFactory factory);
/**
* TEMPORARY. WILL BE REMOVED AFTER PROTOTYPING IS OVER.
*/
@Experimental
ValueMetadataMockUpFactory getValueMetadataMockUpFactory();
@Experimental
void setValueMetadataFactory(ValueMetadataFactory factory);
@Experimental
ValueMetadataFactory getValueMetadataFactory();
}