Package com.evolveum.midpoint.prism.impl.schema

Class SchemaRegistryImpl

java.lang.Object

com.evolveum.midpoint.prism.impl.schema.SchemaRegistryImpl

All Implemented Interfaces:

DefinitionsStore, GlobalDefinitionsStore, SchemaLookup, SchemaRegistry, SchemaRegistryState, DebugDumpable

Direct Known Subclasses:

AxiomEnabledSchemaRegistry

public class SchemaRegistryImpl
extends Object
implements DebugDumpable, SchemaRegistry, SchemaLookup

Registry and resolver of schema files and resources.

Author:

Radovan Semancik

Nested Class Summary

Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.schema.SchemaLookup

SchemaLookup.Aware, SchemaLookup.Based, SchemaLookup.Mutable

Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.schema.SchemaRegistry

SchemaRegistry.ComparisonResult, SchemaRegistry.InvalidationListener

Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.schema.SchemaRegistryState

SchemaRegistryState.DerivationKey<R>, SchemaRegistryState.IsList

Field Summary

Fields

Modifier and Type	Field	Description
protected PrismContext	prismContext	A prism context this schema registry is part of.

Fields inherited from interface com.evolveum.midpoint.util.DebugDumpable

INDENT_STRING

Constructor Summary

Constructors

Constructor	Description
SchemaRegistryImpl()

Method Summary

Modifier and Type	Method	Description
<O extends Objectable> void	applyDefinition(ObjectDelta<O> objectDelta, Class<O> compileTimeClass, boolean force)
<C extends Containerable> void	applyDefinition(PrismContainer<C> container, Class<C> type)	This method will try to locate the appropriate object definition and apply it.
<C extends Containerable> void	applyDefinition(PrismContainer<C> container, Class<C> compileTimeClass, boolean force)
<C extends Containerable, O extends Objectable> void	applyDefinition(PrismContainerValue<C> prismContainerValue, Class<O> compileTimeClass, ItemPath path, boolean force)
<C extends Containerable> void	applyDefinition(PrismContainerValue<C> prismContainerValue, QName typeName, ItemPath path, boolean force)
<ID extends ItemDefinition> SchemaRegistry.ComparisonResult	compareDefinitions(ID def1, ID def2)
ItemDefinition<?>	createAdHocDefinition(QName elementName, QName typeName, int minOccurs, int maxOccurs)
void	customizeNamespacePrefixMapper(Consumer<DynamicNamespacePrefixMapper> customizer)
String	debugDump(int indent)
DefinitionFactory	definitionFactory()
Class<?>	determineClassForItemDefinition(ItemDefinition<?> itemDefinition)
<T> Class<T>	determineClassForType(QName type)
<T> Class<T>	determineCompileTimeClass(QName type)
<T> Class<T>	determineCompileTimeClassInternal(QName type, boolean cacheAlsoNegativeResults)
PrismObjectDefinition	determineDefinitionFromClass(Class compileTimeClass)
ComplexTypeDefinition	determineParentDefinition(@NotNull ComplexTypeDefinition child, @NotNull ItemPath rest)
PrismObjectDefinition	determineReferencedObjectDefinition(@NotNull QName targetTypeName, ItemPath rest)
QName	determineTypeForClass(Class<?> clazz)	Tries to determine type name for any class (primitive, complex one).
boolean	existDynamicSchemaExtensions()
ItemDefinition	findItemDefinitionByElementName(QName elementName, @Nullable List<String> ignoredNamespaces)
<T extends ItemDefinition> T	findItemDefinitionByFullPath(Class<? extends Objectable> objectClass, Class<T> defClass, QName... itemNames)
<ID extends ItemDefinition> ID	findItemDefinitionByType(@NotNull QName typeName, @NotNull Class<ID> definitionClass)	Looking up item definition by type name.
<ID extends ItemDefinition> @NotNull List<ID>	findItemDefinitionsByCompileTimeClass(@NotNull Class<?> compileTimeClass, @NotNull Class<ID> definitionClass)	Looking up item definitions by compile-time class.
<ID extends ItemDefinition> @NotNull List<ID>	findItemDefinitionsByElementName(@NotNull QName elementName, @NotNull Class<ID> definitionClass)	Looking up item definitions by element name.
<O extends Objectable> PrismObjectDefinition<O>	findObjectDefinitionByCompileTimeClass(@NotNull Class<O> compileTimeClass)
<O extends Objectable> PrismObjectDefinition<O>	findObjectDefinitionByType(@NotNull QName typeName)
PrismSchema	findSchemaByCompileTimeClass(@NotNull Class<?> compileTimeClass)
PrismSchema	findSchemaByNamespace(String namespaceURI)
SchemaDescription	findSchemaDescriptionByNamespace(String namespaceURI)
SchemaDescription	findSchemaDescriptionByPrefix(String prefix)
<TD extends TypeDefinition> TD	findTypeDefinitionByCompileTimeClass(@NotNull Class<?> compileTimeClass, @NotNull Class<TD> definitionClass)
<TD extends TypeDefinition> TD	findTypeDefinitionByType(@NotNull QName typeName, @NotNull Class<TD> definitionClass)
<TD extends TypeDefinition> @NotNull Collection<? extends TD>	findTypeDefinitionsByType(@NotNull QName typeName, @NotNull Class<TD> definitionClass)
List<TypeDefinition>	getAllSubTypesByTypeDefinition(List<TypeDefinition> typeDefinitions)
EntityResolver	getBuiltinSchemaResolver()
File[]	getCatalogFiles()
String	getCatalogResourceName()
Class<? extends ObjectType>	getCompileTimeClassForObjectType(QName objectType)
Collection<Package>	getCompileTimePackages()
SchemaLookup.Mutable	getCurrentLookup()
String	getDefaultNamespace()
<R, E extends Exception> R	getDerivedObject(SchemaRegistryState.DerivationKey<R> derivationKey, CheckedFunction<SchemaRegistryState,R,E> mapping)	Returns derived value specific to this schema context state, supplied derivation key and mapping.
XmlEntityResolver	getEntityResolver()
Schema	getJavaxSchema()
Validator	getJavaxSchemaValidator()
DynamicNamespacePrefixMapper	getNamespacePrefixMapper()	Don't use it for edit of mapper.
org.apache.commons.collections4.MultiValuedMap<String,SchemaDescription>	getParsedSchemas()
PrismSchema	getPrismSchema(String namespace)
Collection<SchemaDescription>	getSchemaDescriptions()
Collection<PrismSchema>	getSchemas()
@NotNull PrismContainerDefinition<?>	getValueMetadataDefinition()
QName	getValueMetadataTypeName()
boolean	hasImplicitTypeDefinition(@NotNull QName itemName, @NotNull QName typeName)	Answers the question: "If the receiver would get itemName without any other information, will it be able to derive suitable typeName from it?"
void	initialize()	This can be used to read additional schemas even after the registry was initialized.
boolean	isAssignableFrom(@NotNull Class<?> superClass, @NotNull QName subType)	BEWARE: works only with statically-defined types!
boolean	isAssignableFrom(@NotNull QName superType, @NotNull QName subType)	BEWARE: works only with statically-defined types!
boolean	isAssignableFromGeneral(@NotNull QName superType, @NotNull QName subType)	Crawls through the type definition tree.
boolean	isContainerable(QName typeName)
@NotNull SchemaRegistryState.IsList	isList(@Nullable QName xsiType, @NotNull QName elementName)	Checks whether element with given (declared) xsi:type and name can be a heterogeneous list.
protected void	loadPrismSchemaFileDescription(File file)
void	loadPrismSchemaResource(String resourcePath)
ItemDefinition	locateItemDefinition(@NotNull QName itemName, @Nullable QName explicitTypeName, @Nullable ComplexTypeDefinition complexTypeDefinition, @Nullable Function<QName,ItemDefinition> dynamicDefinitionProvider)
protected void	parseAdditionalSchemas(SchemaRegistryState schemaRegistryStateLocale)
QName	qualifyTypeName(QName typeName)
void	registerDynamicSchemaExtensions(Map<String,Element> dynamicSchemaExtensions)
void	registerInvalidationListener(SchemaRegistry.InvalidationListener listener)
void	registerPrismDefaultSchemaResource(String resourcePath, String usualPrefix, Package compileTimeClassesPackage)	Must be called before call to initialize()
void	registerPrismSchema(InputStream input, String sourceDescription)
void	registerPrismSchemaFile(File file)
void	registerPrismSchemaResource(String resourcePath, String usualPrefix)	Must be called before call to initialize()
void	registerPrismSchemaResource(String resourcePath, String usualPrefix, Package compileTimeClassesPackage)	Must be called before call to initialize()
void	registerPrismSchemaResource(String resourcePath, String usualPrefix, Package compileTimeClassesPackage, boolean prefixDeclaredByDefault)	Must be called before call to initialize()
void	registerPrismSchemasFromDirectory(File directory)
void	registerPrismSchemasFromDirectory(File directory, @NotNull Collection<String> extensionFilesToIgnore)
protected void	registerPrismSchemasFromWsdl(String resourcePath, List<SchemaDescriptionImpl> descriptions, List<Package> compileTimeClassesPackages)
void	registerPrismSchemasFromWsdlResource(String resourcePath, List<Package> compileTimeClassesPackages)
void	registerSchema(Node node, String sourceDescription)	Must be called before call to initialize()
void	registerSchemaResource(String resourcePath, String usualPrefix)	Must be called before call to initialize()
void	registerStaticNamespace(String ns, String prefix, boolean declaredByDefault)
void	registerWsdlSchemaFile(File file)
void	reload()
ItemDefinition	resolveGlobalItemDefinition(QName itemName, @Nullable ComplexTypeDefinition complexTypeDefinition)
SchemaContextResolver	resolverFor(SchemaContextDefinition schemaContextDefinition)
QName	resolveUnqualifiedTypeName(QName type)
<T extends SchemaLookup.Based> T	schemaSpecific(@NotNull Class<T> type)	Returns schema-specific service
<ID extends ItemDefinition> ID	selectMoreSpecific(ID def1, ID def2)
QName	selectMoreSpecific(QName type1, QName type2)	Selects the type that is more specific of the two.
void	setCatalogFiles(File[] catalogFiles)
void	setCatalogResourceName(String catalogResourceName)
void	setDefaultNamespace(String defaultNamespace)	Must be called before call to initialize()
void	setNamespacePrefixMapper(DynamicNamespacePrefixMapper namespacePrefixMapper)	Must be called before call to initialize()
void	setPrismContext(@NotNull PrismContext prismContext)
void	setValueMetadataTypeName(QName typeName)	Must be called before call to initialize()
PrismNamespaceContext	staticNamespaceContext()
QName	unifyTypes(QName type1, QName type2)	Returns most specific common supertype for these two.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.evolveum.midpoint.util.DebugDumpable

debugDump, debugDumpLazily, debugDumpLazily

Methods inherited from interface com.evolveum.midpoint.prism.schema.GlobalDefinitionsStore

findComplexTypeDefinitionByCompileTimeClass, findComplexTypeDefinitionByType, findContainerDefinitionByCompileTimeClass, findContainerDefinitionByElementName, findContainerDefinitionByType, findItemDefinitionByCompileTimeClass, findItemDefinitionByElementName, findItemDefinitionByElementName, findItemDefinitionByType, findItemDefinitionsByElementName, findObjectDefinitionByElementName, findPropertyDefinitionByElementName, findReferenceDefinitionByElementName, findSimpleTypeDefinitionByType, findTypeDefinitionByType, findTypeDefinitionsByElementName, findTypeDefinitionsByType

Methods inherited from interface com.evolveum.midpoint.prism.schema.SchemaRegistry

determineClassForTypeRequired, determineClassForTypeRequired, determineJavaClassForType, determineTypeForClassRequired, getCompileTimeClass, getCompileTimeClassForObjectTypeRequired

Field Details

prismContext

protected PrismContext prismContext

A prism context this schema registry is part of. Should be non-null.

Constructor Details

SchemaRegistryImpl

public SchemaRegistryImpl()

Method Details

getNamespacePrefixMapper

public DynamicNamespacePrefixMapper getNamespacePrefixMapper()

Don't use it for edit of mapper. For editing of mapper use customizeNamespacePrefixMapper(java.util.function.Consumer<com.evolveum.midpoint.prism.xml.DynamicNamespacePrefixMapper>)

Specified by:

getNamespacePrefixMapper in interface SchemaRegistryState

customizeNamespacePrefixMapper

public void customizeNamespacePrefixMapper(Consumer<DynamicNamespacePrefixMapper> customizer)

Specified by:

customizeNamespacePrefixMapper in interface SchemaRegistry

setNamespacePrefixMapper

public void setNamespacePrefixMapper(DynamicNamespacePrefixMapper namespacePrefixMapper)

Must be called before call to initialize()

registerInvalidationListener

public void registerInvalidationListener(SchemaRegistry.InvalidationListener listener)

Specified by:

registerInvalidationListener in interface SchemaRegistry

setPrismContext

public void setPrismContext(@NotNull
 @NotNull PrismContext prismContext)

getEntityResolver

public XmlEntityResolver getEntityResolver()

getParsedSchemas

public org.apache.commons.collections4.MultiValuedMap<String,SchemaDescription> getParsedSchemas()

getBuiltinSchemaResolver

public EntityResolver getBuiltinSchemaResolver()

getCatalogFiles

public File[] getCatalogFiles()

setCatalogFiles

public void setCatalogFiles(File[] catalogFiles)

getCatalogResourceName

public String getCatalogResourceName()

setCatalogResourceName

public void setCatalogResourceName(String catalogResourceName)

getDefaultNamespace

public String getDefaultNamespace()

Specified by:

getDefaultNamespace in interface SchemaRegistry

setDefaultNamespace

public void setDefaultNamespace(String defaultNamespace)

Must be called before call to initialize()

registerSchemaResource

public void registerSchemaResource(String resourcePath,
 String usualPrefix)
                            throws SchemaException

Must be called before call to initialize()

Throws:

SchemaException

registerPrismSchemaResource

public void registerPrismSchemaResource(String resourcePath,
 String usualPrefix)
                                 throws SchemaException

Must be called before call to initialize()

Throws:

SchemaException

registerWsdlSchemaFile

public void registerWsdlSchemaFile(File file)
                            throws SchemaException,
FileNotFoundException

Throws:

SchemaException

FileNotFoundException

registerPrismSchemasFromWsdlResource

public void registerPrismSchemasFromWsdlResource(String resourcePath,
 List<Package> compileTimeClassesPackages)
                                          throws SchemaException

Throws:

SchemaException

registerPrismSchemasFromWsdl

protected void registerPrismSchemasFromWsdl(String resourcePath,
 List<SchemaDescriptionImpl> descriptions,
 List<Package> compileTimeClassesPackages)
                                     throws SchemaException

Throws:

SchemaException

registerPrismSchemaResource

public void registerPrismSchemaResource(String resourcePath,
 String usualPrefix,
 Package compileTimeClassesPackage)
                                 throws SchemaException

Must be called before call to initialize()

Throws:

SchemaException

registerPrismSchemaResource

public void registerPrismSchemaResource(String resourcePath,
 String usualPrefix,
 Package compileTimeClassesPackage,
 boolean prefixDeclaredByDefault)
                                 throws SchemaException

Must be called before call to initialize()

Throws:

SchemaException

registerPrismDefaultSchemaResource

public void registerPrismDefaultSchemaResource(String resourcePath,
 String usualPrefix,
 Package compileTimeClassesPackage)
                                        throws SchemaException

Must be called before call to initialize()

Throws:

SchemaException

registerSchema

public void registerSchema(Node node,
 String sourceDescription)
                    throws SchemaException

Must be called before call to initialize()

Throws:

SchemaException

registerPrismSchemaFile

public void registerPrismSchemaFile(File file)
                             throws IOException,
SchemaException

Throws:

IOException

SchemaException

registerPrismSchema

public void registerPrismSchema(InputStream input,
 String sourceDescription)
                         throws SchemaException

Throws:

SchemaException

loadPrismSchemaFileDescription

protected void loadPrismSchemaFileDescription(File file)
                                       throws SchemaException,
IOException

Throws:

SchemaException

IOException

registerPrismSchemasFromDirectory

public void registerPrismSchemasFromDirectory(File directory)
                                       throws IOException,
SchemaException

Throws:

IOException

SchemaException

registerPrismSchemasFromDirectory

public void registerPrismSchemasFromDirectory(File directory,
 @NotNull
 @NotNull Collection<String> extensionFilesToIgnore)
                                       throws IOException,
SchemaException

Throws:

IOException

SchemaException

loadPrismSchemaResource

@VisibleForTesting
public void loadPrismSchemaResource(String resourcePath)
                             throws SchemaException

Throws:

SchemaException

reload

public void reload()
            throws SchemaException

Specified by:

reload in interface SchemaRegistry

Throws:

SchemaException

initialize

public void initialize()
                throws SAXException,
IOException,
SchemaException

This can be used to read additional schemas even after the registry was initialized.

Specified by:

initialize in interface SchemaRegistry

Throws:

SAXException

IOException

SchemaException

parseAdditionalSchemas

protected void parseAdditionalSchemas(SchemaRegistryState schemaRegistryStateLocale)
                               throws SchemaException

Throws:

SchemaException

getJavaxSchema

public Schema getJavaxSchema()

Specified by:

getJavaxSchema in interface SchemaRegistryState

getJavaxSchemaValidator

public Validator getJavaxSchemaValidator()

Specified by:

getJavaxSchemaValidator in interface SchemaRegistry

getCompileTimePackages

public Collection<Package> getCompileTimePackages()

Specified by:

getCompileTimePackages in interface SchemaRegistryState

debugDump

public String debugDump(int indent)

Specified by:

debugDump in interface DebugDumpable

applyDefinition

public <C extends Containerable> void applyDefinition(PrismContainer<C> container,
 Class<C> type)
                                               throws SchemaException

Description copied from interface: SchemaRegistry

This method will try to locate the appropriate object definition and apply it.

Specified by:

applyDefinition in interface SchemaRegistry

Throws:

SchemaException

applyDefinition

public <C extends Containerable> void applyDefinition(PrismContainer<C> container,
 Class<C> compileTimeClass,
 boolean force)
                                               throws SchemaException

Specified by:

applyDefinition in interface SchemaRegistry

Throws:

SchemaException

applyDefinition

public <O extends Objectable> void applyDefinition(ObjectDelta<O> objectDelta,
 Class<O> compileTimeClass,
 boolean force)
                                            throws SchemaException

Specified by:

applyDefinition in interface SchemaRegistry

Throws:

SchemaException

applyDefinition

public <C extends Containerable,
O extends Objectable>
void applyDefinition(PrismContainerValue<C> prismContainerValue,
 Class<O> compileTimeClass,
 ItemPath path,
 boolean force)
              throws SchemaException

Specified by:

applyDefinition in interface SchemaRegistry

Throws:

SchemaException

applyDefinition

public <C extends Containerable> void applyDefinition(PrismContainerValue<C> prismContainerValue,
 QName typeName,
 ItemPath path,
 boolean force)
                                               throws SchemaException

Specified by:

applyDefinition in interface SchemaRegistry

Throws:

SchemaException

findItemDefinitionsByCompileTimeClass

@NotNull
public <ID extends ItemDefinition>
@NotNull List<ID> findItemDefinitionsByCompileTimeClass(@NotNull
 @NotNull Class<?> compileTimeClass,
 @NotNull
 @NotNull Class<ID> definitionClass)

Description copied from interface: GlobalDefinitionsStore

Looking up item definitions by compile-time class. So, for example having AssignmentType.class we try to find a definition of "assignment" item. BEWARE. This method is unsound. There might be many items of AssignmentType.class.

Specified by:

findItemDefinitionsByCompileTimeClass in interface GlobalDefinitionsStore

findItemDefinitionByType

@Nullable
public <ID extends ItemDefinition> ID findItemDefinitionByType(@NotNull
 @NotNull QName typeName,
 @NotNull
 @NotNull Class<ID> definitionClass)

Description copied from interface: GlobalDefinitionsStore

Looking up item definition by type name. So, for example having c:AssignmentType we try to find a definition of "assignment" item. BEWARE. This method is unsound. There might be many items with c:AssignmentType type.

Specified by:

findItemDefinitionByType in interface GlobalDefinitionsStore

findItemDefinitionsByElementName

@NotNull
public <ID extends ItemDefinition>
@NotNull List<ID> findItemDefinitionsByElementName(@NotNull
 @NotNull QName elementName,
 @NotNull
 @NotNull Class<ID> definitionClass)

Description copied from interface: GlobalDefinitionsStore

Looking up item definitions by element name. The name can be qualified or unqualified. In the latter case there can be more than one definition returned.

Specified by:

findItemDefinitionsByElementName in interface GlobalDefinitionsStore

findTypeDefinitionByCompileTimeClass

@Nullable
public <TD extends TypeDefinition> TD findTypeDefinitionByCompileTimeClass(@NotNull
 @NotNull Class<?> compileTimeClass,
 @NotNull
 @NotNull Class<TD> definitionClass)

Specified by:

findTypeDefinitionByCompileTimeClass in interface GlobalDefinitionsStore

findTypeDefinitionByType

@Nullable
public <TD extends TypeDefinition> TD findTypeDefinitionByType(@NotNull
 @NotNull QName typeName,
 @NotNull
 @NotNull Class<TD> definitionClass)

Specified by:

findTypeDefinitionByType in interface GlobalDefinitionsStore

findTypeDefinitionsByType

@NotNull
public <TD extends TypeDefinition>
@NotNull Collection<? extends TD> findTypeDefinitionsByType(@NotNull
 @NotNull QName typeName,
 @NotNull
 @NotNull Class<TD> definitionClass)

Specified by:

findTypeDefinitionsByType in interface GlobalDefinitionsStore

findObjectDefinitionByCompileTimeClass

@Experimental
public <O extends Objectable>
PrismObjectDefinition<O> findObjectDefinitionByCompileTimeClass(@NotNull
 @NotNull Class<O> compileTimeClass)

Specified by:

findObjectDefinitionByCompileTimeClass in interface GlobalDefinitionsStore

findObjectDefinitionByType

public <O extends Objectable>
PrismObjectDefinition<O> findObjectDefinitionByType(@NotNull
 @NotNull QName typeName)

Specified by:

findObjectDefinitionByType in interface GlobalDefinitionsStore

findItemDefinitionByFullPath

public <T extends ItemDefinition> T findItemDefinitionByFullPath(Class<? extends Objectable> objectClass,
 Class<T> defClass,
 QName... itemNames)
                                                          throws SchemaException

Specified by:

findItemDefinitionByFullPath in interface SchemaRegistry

Throws:

SchemaException

findItemDefinitionByElementName

public ItemDefinition findItemDefinitionByElementName(QName elementName,
 @Nullable
 @Nullable List<String> ignoredNamespaces)

Specified by:

findItemDefinitionByElementName in interface SchemaRegistry

getCompileTimeClassForObjectType

public Class<? extends ObjectType> getCompileTimeClassForObjectType(QName objectType)

Specified by:

getCompileTimeClassForObjectType in interface SchemaRegistry

determineDefinitionFromClass

public PrismObjectDefinition determineDefinitionFromClass(Class compileTimeClass)

Specified by:

determineDefinitionFromClass in interface SchemaRegistry

locateItemDefinition

public ItemDefinition locateItemDefinition(@NotNull
 @NotNull QName itemName,
 @Nullable
 @Nullable QName explicitTypeName,
 @Nullable
 @Nullable ComplexTypeDefinition complexTypeDefinition,
 @Nullable
 @Nullable Function<QName,ItemDefinition> dynamicDefinitionProvider)

Specified by:

locateItemDefinition in interface SchemaRegistry

resolveUnqualifiedTypeName

public QName resolveUnqualifiedTypeName(QName type)
                                 throws SchemaException

Specified by:

resolveUnqualifiedTypeName in interface SchemaRegistryState

Throws:

SchemaException

qualifyTypeName

public QName qualifyTypeName(QName typeName)
                      throws SchemaException

Specified by:

qualifyTypeName in interface SchemaRegistry

Throws:

SchemaException

determineParentDefinition

public ComplexTypeDefinition determineParentDefinition(@NotNull
 @NotNull ComplexTypeDefinition child,
 @NotNull
 @NotNull ItemPath rest)

Specified by:

determineParentDefinition in interface SchemaRegistryState

determineReferencedObjectDefinition

public PrismObjectDefinition determineReferencedObjectDefinition(@NotNull
 @NotNull QName targetTypeName,
 ItemPath rest)

Specified by:

determineReferencedObjectDefinition in interface SchemaRegistry

resolveGlobalItemDefinition

public ItemDefinition resolveGlobalItemDefinition(QName itemName,
 @Nullable
 @Nullable ComplexTypeDefinition complexTypeDefinition)

Specified by:

resolveGlobalItemDefinition in interface SchemaRegistry

getPrismSchema

public PrismSchema getPrismSchema(String namespace)

Specified by:

getPrismSchema in interface SchemaRegistryState

getSchemas

public Collection<PrismSchema> getSchemas()

Specified by:

getSchemas in interface SchemaRegistryState

getSchemaDescriptions

public Collection<SchemaDescription> getSchemaDescriptions()

Specified by:

getSchemaDescriptions in interface SchemaRegistry

findSchemaByCompileTimeClass

public PrismSchema findSchemaByCompileTimeClass(@NotNull
 @NotNull Class<?> compileTimeClass)

Specified by:

findSchemaByCompileTimeClass in interface SchemaRegistryState

findSchemaByNamespace

public PrismSchema findSchemaByNamespace(String namespaceURI)

Specified by:

findSchemaByNamespace in interface SchemaRegistryState

findSchemaDescriptionByNamespace

public SchemaDescription findSchemaDescriptionByNamespace(String namespaceURI)

Specified by:

findSchemaDescriptionByNamespace in interface SchemaRegistryState

findSchemaDescriptionByPrefix

public SchemaDescription findSchemaDescriptionByPrefix(String prefix)

Specified by:

findSchemaDescriptionByPrefix in interface SchemaRegistryState

isList

@NotNull
public @NotNull SchemaRegistryState.IsList isList(@Nullable
 @Nullable QName xsiType,
 @NotNull
 @NotNull QName elementName)

Description copied from interface: SchemaRegistryState

Checks whether element with given (declared) xsi:type and name can be a heterogeneous list.

Specified by:

isList in interface SchemaRegistryState

Returns:

YES if it is a list, NO if it's not, MAYBE if it probably is a list but some further content-based checks are needed

setValueMetadataTypeName

public void setValueMetadataTypeName(QName typeName)

Must be called before call to initialize()

getValueMetadataDefinition

@NotNull
public @NotNull PrismContainerDefinition<?> getValueMetadataDefinition()

Specified by:

getValueMetadataDefinition in interface SchemaRegistry

hasImplicitTypeDefinition

public boolean hasImplicitTypeDefinition(@NotNull
 @NotNull QName itemName,
 @NotNull
 @NotNull QName typeName)

Answers the question: "If the receiver would get itemName without any other information, will it be able to derive suitable typeName from it?" If not, we have to provide explicit type definition for serialization.

By suitable we mean such that can be used to determine specific object type.

Specified by:

hasImplicitTypeDefinition in interface SchemaRegistry

determineTypeForClass

public QName determineTypeForClass(Class<?> clazz)

Description copied from interface: SchemaRegistry

Tries to determine type name for any class (primitive, complex one). Does not use schemas (TODO explanation)

Specified by:

determineTypeForClass in interface SchemaRegistry

Returns:

determineClassForType

public <T> Class<T> determineClassForType(QName type)

Specified by:

determineClassForType in interface SchemaRegistryState

determineCompileTimeClass

public <T> Class<T> determineCompileTimeClass(QName type)

Specified by:

determineCompileTimeClass in interface SchemaRegistryState

determineCompileTimeClassInternal

public <T> Class<T> determineCompileTimeClassInternal(QName type,
 boolean cacheAlsoNegativeResults)

Specified by:

determineCompileTimeClassInternal in interface SchemaRegistryState

determineClassForItemDefinition

public Class<?> determineClassForItemDefinition(ItemDefinition<?> itemDefinition)

Specified by:

determineClassForItemDefinition in interface SchemaRegistry

selectMoreSpecific

public <ID extends ItemDefinition> ID selectMoreSpecific(ID def1,
 ID def2)
                                                  throws SchemaException

Specified by:

selectMoreSpecific in interface SchemaRegistry

Throws:

SchemaException

selectMoreSpecific

public QName selectMoreSpecific(QName type1,
 QName type2)

Description copied from interface: SchemaRegistry

Selects the type that is more specific of the two. For example, if the input is `FocusType` and `UserType`, the output is `UserType`. Returns `null` if there's no such type. Limitations/specific handling: - Assumes both types have compile-time representation. May return `null` if that's not true. - The treatment of `PolyStringType` vs `String` is rather strange. Should be reviewed. FIXME

Specified by:

selectMoreSpecific in interface SchemaRegistry

compareDefinitions

public <ID extends ItemDefinition>
SchemaRegistry.ComparisonResult compareDefinitions(@NotNull
 ID def1,
 @NotNull
 ID def2)

Specified by:

compareDefinitions in interface SchemaRegistry

Returns:

null means we cannot decide (types are different, and no compile time class for def1 and/or def2)

isAssignableFrom

public boolean isAssignableFrom(@NotNull
 @NotNull QName superType,
 @NotNull
 @NotNull QName subType)

Description copied from interface: SchemaRegistry

BEWARE: works only with statically-defined types!

Specified by:

isAssignableFrom in interface SchemaRegistry

isAssignableFromGeneral

public boolean isAssignableFromGeneral(@NotNull
 @NotNull QName superType,
 @NotNull
 @NotNull QName subType)

Description copied from interface: SchemaRegistry

Crawls through the type definition tree. May be slower.

Specified by:

isAssignableFromGeneral in interface SchemaRegistry

isAssignableFrom

public boolean isAssignableFrom(@NotNull
 @NotNull Class<?> superClass,
 @NotNull
 @NotNull QName subType)

Description copied from interface: SchemaRegistry

BEWARE: works only with statically-defined types!

Specified by:

isAssignableFrom in interface SchemaRegistry

unifyTypes

public QName unifyTypes(QName type1,
 QName type2)

Description copied from interface: SchemaRegistry

Returns most specific common supertype for these two. If any of input params is null, it means it is ignored. FIXME is the implementation correct regarding this spec? E.g. for `UserType` and `RoleType` it should return `FocusType` but it returns `null` instead!

Specified by:

unifyTypes in interface SchemaRegistry

Returns:

null if unification cannot be done (or if both input types are null)

isContainerable

public boolean isContainerable(QName typeName)

Specified by:

isContainerable in interface SchemaRegistry

Returns:

true if the typeName corresponds to statically-typed class that is Containerable. TODO The utility of this method is questionable. Reconsider its removal/update.

createAdHocDefinition

public ItemDefinition<?> createAdHocDefinition(QName elementName,
 QName typeName,
 int minOccurs,
 int maxOccurs)

Specified by:

createAdHocDefinition in interface SchemaRegistry

getValueMetadataTypeName

public QName getValueMetadataTypeName()

staticNamespaceContext

public PrismNamespaceContext staticNamespaceContext()

Specified by:

staticNamespaceContext in interface SchemaRegistry

registerDynamicSchemaExtensions

public void registerDynamicSchemaExtensions(Map<String,Element> dynamicSchemaExtensions)
                                     throws SchemaException

Specified by:

registerDynamicSchemaExtensions in interface SchemaRegistry

Throws:

SchemaException

existDynamicSchemaExtensions

public boolean existDynamicSchemaExtensions()

Specified by:

existDynamicSchemaExtensions in interface SchemaRegistry

registerStaticNamespace

public void registerStaticNamespace(String ns,
 String prefix,
 boolean declaredByDefault)

getAllSubTypesByTypeDefinition

public List<TypeDefinition> getAllSubTypesByTypeDefinition(List<TypeDefinition> typeDefinitions)

Specified by:

getAllSubTypesByTypeDefinition in interface SchemaRegistry

getDerivedObject

public <R,
E extends Exception> R getDerivedObject(SchemaRegistryState.DerivationKey<R> derivationKey,
 CheckedFunction<SchemaRegistryState,R,E> mapping)
                                           throws E

Description copied from interface: SchemaRegistryState

Returns derived value specific to this schema context state, supplied derivation key and mapping. Returns cached value if it was already computed and is available. If value is not available, it is computed by supplied mapping function. Do not use for short-lived values. Use-cases should be like caching parser instances with already done lookups for repository or other long-lived components, which needs to be recomputed when schemas are changed.

Specified by:

getDerivedObject in interface SchemaRegistryState

Returns:

Throws:

E

resolverFor

public SchemaContextResolver resolverFor(SchemaContextDefinition schemaContextDefinition)

Specified by:

resolverFor in interface SchemaLookup

definitionFactory

public DefinitionFactory definitionFactory()

Specified by:

definitionFactory in interface SchemaLookup

getCurrentLookup

public SchemaLookup.Mutable getCurrentLookup()

Specified by:

getCurrentLookup in interface SchemaRegistry

schemaSpecific

@Nullable
public <T extends SchemaLookup.Based> T schemaSpecific(@NotNull
 @NotNull Class<T> type)

Description copied from interface: SchemaLookup

Returns schema-specific service

Specified by:

schemaSpecific in interface SchemaLookup

Type Parameters:

T - Type of schema specific service

Returns:

Requested service or null, if service is not available.