com.evolveum.midpoint.prism.schema

Class SchemaRegistry

java.lang.Object

com.evolveum.midpoint.prism.schema.SchemaRegistry

All Implemented Interfaces:

DebugDumpable, LSResourceResolver, EntityResolver

public class SchemaRegistry
extends Object
implements LSResourceResolver, EntityResolver, DebugDumpable

Registry and resolver of schema files and resources.

Author:

Radovan Semancik

Field Summary

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

INDENT_STRING

Constructor Summary

Constructors

Constructor and Description
SchemaRegistry()

Method Summary

Methods

Modifier and Type	Method and Description
<T extends Objectable> void	applyDefinition(ObjectDelta<T> objectDelta, Class<T> type, boolean force) This method will try to locate the appropriate object definition and apply it.
<C extends Containerable,O extends Objectable> void	applyDefinition(PrismContainerValue<C> prismContainerValue, Class<O> type, ItemPath path, boolean force)
<C extends Containerable> void	applyDefinition(PrismContainerValue<C> prismContainerValue, QName typeName, ItemPath path, boolean force)
<O extends Objectable> void	applyDefinition(PrismObject<O> prismObject, Class<O> type)
<O extends Objectable> void	applyDefinition(PrismObject<O> prismObject, Class<O> type, boolean force) This method will try to locate the appropriate object definition and apply it.
static ItemDefinition	createDefaultItemDefinition(QName itemName, PrismContext prismContext)
String	debugDump() Show the content of the object intended for diagnostics by system administrator.
String	debugDump(int indent)
Class<?>	determineCompileTimeClass(ComplexTypeDefinition complexTypeDefinition)
<T> Class<T>	determineCompileTimeClass(QName typeName)
Class<?>	determineCompileTimeClass(QName elementName, ComplexTypeDefinition complexTypeDefinition)
PrismObjectDefinition	determineDefinitionFromClass(Class type)
ComplexTypeDefinition	determineParentDefinition(ComplexTypeDefinition child, ItemPath rest)
PrismObjectDefinition	determineReferencedObjectDefinition(QName targetTypeName, ItemPath rest)
ComplexTypeDefinition	findComplexTypeDefinition(QName typeName)
<C extends Containerable> ComplexTypeDefinition	findComplexTypeDefinitionByCompileTimeClass(Class<C> compileTimeClass)
<C extends Containerable> PrismContainerDefinition<C>	findContainerDefinitionByCompileTimeClass(Class<C> compileTimeClass)
<C extends Containerable> PrismContainerDefinition<C>	findContainerDefinitionByElementName(QName elementName)
<C extends Containerable> PrismContainerDefinition<C>	findContainerDefinitionByType(QName typeName)
ItemDefinition	findItemDefinitionByElementName(QName elementName)
<T extends ItemDefinition> T	findItemDefinitionByFullPath(Class<? extends Objectable> objectClass, Class<T> defClass, QName... itemNames)
ItemDefinition	findItemDefinitionByType(QName typeName)
<O extends Objectable> PrismObjectDefinition<O>	findObjectDefinitionByCompileTimeClass(Class<O> compileTimeClass)
<T extends Objectable> PrismObjectDefinition<T>	findObjectDefinitionByElementName(QName elementName)
<T extends Objectable> PrismObjectDefinition<T>	findObjectDefinitionByType(QName typeName)
PrismPropertyDefinition	findPropertyDefinitionByElementName(QName elementName)
PrismReferenceDefinition	findReferenceDefinitionByElementName(QName elementName)
PrismSchema	findSchemaByCompileTimeClass(Class<?> compileTimeClass)
PrismSchema	findSchemaByNamespace(String namespaceURI)
PrismSchema	findSchemaByPrefix(String prefix)
SchemaDescription	findSchemaDescriptionByNamespace(String namespaceURI)
SchemaDescription	findSchemaDescriptionByPrefix(String prefix)
EntityResolver	getBuiltinSchemaResolver()
File[]	getCatalogFiles()
String	getCatalogResourceName()
<T> Class<T>	getCompileTimeClass(QName xsdType)
Class<? extends ObjectType>	getCompileTimeClassForObjectType(QName objectType)
Collection<Package>	getCompileTimePackages()
String	getDefaultNamespace()
Schema	getJavaxSchema()
DynamicNamespacePrefixMapper	getNamespacePrefixMapper()
PrismContext	getPrismContext()
PrismSchema	getSchema(String namespace)
Collection<SchemaDescription>	getSchemaDescriptions()
Collection<PrismSchema>	getSchemas()
boolean	hasImplicitTypeDefinition(QName elementName, QName typeName) Returns true if specified element has a definition that matches specified type in the known schemas.
void	initialize() This can be used to read additional schemas even after the registry was initialized.
<T extends Objectable> PrismObject<T>	instantiate(Class<T> compileTimeClass)
void	loadPrismSchemaFile(File file)
SchemaDescription	loadPrismSchemaFileDescription(File file)
void	loadPrismSchemaResource(String resourcePath)
void	loadPrismSchemasFromDirectory(File directory) This can be used to read additional schemas even after the registry was initialized.
QName	qualifyTypeName(QName typeName)
void	registerPrismDefaultSchemaResource(String resourcePath, String usualPrefix, Package compileTimeClassesPackage) Must be called before call to initialize()
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	registerPrismSchemaResource(String resourcePath, String usualPrefix, Package compileTimeClassesPackage, boolean defaultSchema, boolean prefixDeclaredByDefault) Must be called before call to initialize()
void	registerPrismSchemasFromDirectory(File directory)
void	registerPrismSchemasFromWsdlResource(String resourcePath, List<Package> compileTimeClassesPackages)
void	registerSchema(Node node, String sourceDescription) Must be called before call to initialize()
void	registerSchema(Node node, String sourceDescription, String usualPrefix) Must be called before call to initialize()
void	registerSchemaResource(String resourcePath, String usualPrefix) Must be called before call to initialize()
InputSource	resolveEntity(String publicId, String systemId)
ItemDefinition	resolveGlobalItemDefinition(QName elementQName) Looks for a top-level definition for the specified element name (in all schemas).
LSInput	resolveResource(String type, String namespaceURI, String publicId, String systemId, String baseURI)
InputSource	resolveResourceUsingBuiltinResolver(String type, String namespaceURI, String publicId, String systemId, String baseURI)
QName	resolveUnqualifiedTypeName(QName type)
void	setBuiltinSchemaResolver(EntityResolver builtinSchemaResolver)
void	setCatalogFiles(File[] catalogFiles)
void	setCatalogResourceName(String catalogResourceName)
void	setDefaultNamespace(String defaultNamespace)
void	setNamespacePrefixMapper(DynamicNamespacePrefixMapper namespacePrefixMapper)
void	setPrismContext(PrismContext prismContext)

Methods inherited from class java.lang.Object

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

Constructor Detail

SchemaRegistry

public SchemaRegistry()

Method Detail

getNamespacePrefixMapper

public DynamicNamespacePrefixMapper getNamespacePrefixMapper()

setNamespacePrefixMapper

public void setNamespacePrefixMapper(DynamicNamespacePrefixMapper namespacePrefixMapper)

getPrismContext

public PrismContext getPrismContext()

setPrismContext

public void setPrismContext(PrismContext prismContext)

getBuiltinSchemaResolver

public EntityResolver getBuiltinSchemaResolver()

setBuiltinSchemaResolver

public void setBuiltinSchemaResolver(EntityResolver builtinSchemaResolver)

getCatalogFiles

public File[] getCatalogFiles()

setCatalogFiles

public void setCatalogFiles(File[] catalogFiles)

getCatalogResourceName

public String getCatalogResourceName()

setCatalogResourceName

public void setCatalogResourceName(String catalogResourceName)

getDefaultNamespace

public String getDefaultNamespace()

setDefaultNamespace

public void setDefaultNamespace(String defaultNamespace)

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

registerPrismSchemasFromWsdlResource

public void registerPrismSchemasFromWsdlResource(String resourcePath,
                                        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

registerPrismSchemaResource

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

Must be called before call to initialize()

Parameters:

prefixDeclaredByDefault - Whether this prefix will be declared in top element in all XML serializations (MID-2198)

Throws:

SchemaException

registerSchema

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

Must be called before call to initialize()

Parameters:

node -

Throws:

SchemaException

registerSchema

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

Must be called before call to initialize()

Parameters:

node -

Throws:

SchemaException

registerPrismSchemaFile

public void registerPrismSchemaFile(File file)
                             throws FileNotFoundException,
                                    SchemaException

Throws:

FileNotFoundException

SchemaException

loadPrismSchemaFileDescription

public SchemaDescription loadPrismSchemaFileDescription(File file)
                                                 throws FileNotFoundException,
                                                        SchemaException

Throws:

FileNotFoundException

SchemaException

registerPrismSchemasFromDirectory

public void registerPrismSchemasFromDirectory(File directory)
                                       throws FileNotFoundException,
                                              SchemaException

Throws:

FileNotFoundException

SchemaException

loadPrismSchemasFromDirectory

public void loadPrismSchemasFromDirectory(File directory)
                                   throws FileNotFoundException,
                                          SchemaException

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

Throws:

FileNotFoundException

SchemaException

loadPrismSchemaFile

public void loadPrismSchemaFile(File file)
                         throws FileNotFoundException,
                                SchemaException

Throws:

FileNotFoundException

SchemaException

loadPrismSchemaResource

public void loadPrismSchemaResource(String resourcePath)
                             throws SchemaException

Throws:

SchemaException

initialize

public void initialize()
                throws SAXException,
                       IOException,
                       SchemaException

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

Throws:

SAXException

IOException

SchemaException

getJavaxSchema

public Schema getJavaxSchema()

getSchema

public PrismSchema getSchema(String namespace)

getSchemas

public Collection<PrismSchema> getSchemas()

getSchemaDescriptions

public Collection<SchemaDescription> getSchemaDescriptions()

getCompileTimePackages

public Collection<Package> getCompileTimePackages()

resolveEntity

public InputSource resolveEntity(String publicId,
                        String systemId)
                          throws SAXException,
                                 IOException

Specified by:

resolveEntity in interface EntityResolver

Throws:

SAXException

IOException

resolveResource

public LSInput resolveResource(String type,
                      String namespaceURI,
                      String publicId,
                      String systemId,
                      String baseURI)

Specified by:

resolveResource in interface LSResourceResolver

resolveResourceUsingBuiltinResolver

public InputSource resolveResourceUsingBuiltinResolver(String type,
                                              String namespaceURI,
                                              String publicId,
                                              String systemId,
                                              String baseURI)

resolveUnqualifiedTypeName

public QName resolveUnqualifiedTypeName(QName type)
                                 throws SchemaException

Throws:

SchemaException

qualifyTypeName

public QName qualifyTypeName(QName typeName)
                      throws SchemaException

Throws:

SchemaException

determineParentDefinition

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

determineReferencedObjectDefinition

public PrismObjectDefinition determineReferencedObjectDefinition(QName targetTypeName,
                                                        ItemPath rest)

getCompileTimeClassForObjectType

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

debugDump

public String debugDump()

Description copied from interface: DebugDumpable

Show the content of the object intended for diagnostics by system administrator. The out put should be suitable to use in system logs at "debug" level. It may be multi-line, but in that case it should be well indented and quite terse. As it is intended to be used by system administrator, it should not use any developer terms such as class names, exceptions or stack traces.

Specified by:

debugDump in interface DebugDumpable

Returns:

content of the object intended for diagnostics by system administrator.

debugDump

public String debugDump(int indent)

Specified by:

debugDump in interface DebugDumpable

determineCompileTimeClass

public Class<?> determineCompileTimeClass(QName elementName,
                                 ComplexTypeDefinition complexTypeDefinition)

determineCompileTimeClass

public Class<?> determineCompileTimeClass(ComplexTypeDefinition complexTypeDefinition)

determineCompileTimeClass

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

getCompileTimeClass

public <T> Class<T> getCompileTimeClass(QName xsdType)

findSchemaByCompileTimeClass

public PrismSchema findSchemaByCompileTimeClass(Class<?> compileTimeClass)

findObjectDefinitionByCompileTimeClass

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

applyDefinition

public <O extends Objectable> void applyDefinition(PrismObject<O> prismObject,
                                          Class<O> type)
                     throws SchemaException

Throws:

SchemaException

applyDefinition

public <O extends Objectable> void applyDefinition(PrismObject<O> prismObject,
                                          Class<O> type,
                                          boolean force)
                     throws SchemaException

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

Throws:

SchemaException

applyDefinition

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

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

Throws:

SchemaException

applyDefinition

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

Throws:

SchemaException

applyDefinition

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

Throws:

SchemaException

findObjectDefinitionByType

public <T extends Objectable> PrismObjectDefinition<T> findObjectDefinitionByType(QName typeName)

findObjectDefinitionByElementName

public <T extends Objectable> PrismObjectDefinition<T> findObjectDefinitionByElementName(QName elementName)

findContainerDefinitionByType

public <C extends Containerable> PrismContainerDefinition<C> findContainerDefinitionByType(QName typeName)

findContainerDefinitionByElementName

public <C extends Containerable> PrismContainerDefinition<C> findContainerDefinitionByElementName(QName elementName)

findContainerDefinitionByCompileTimeClass

public <C extends Containerable> PrismContainerDefinition<C> findContainerDefinitionByCompileTimeClass(Class<C> compileTimeClass)

findComplexTypeDefinitionByCompileTimeClass

public <C extends Containerable> ComplexTypeDefinition findComplexTypeDefinitionByCompileTimeClass(Class<C> compileTimeClass)

findItemDefinitionByFullPath

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

Throws:

SchemaException

findItemDefinitionByElementName

public ItemDefinition findItemDefinitionByElementName(QName elementName)

findItemDefinitionByType

public ItemDefinition findItemDefinitionByType(QName typeName)

findPropertyDefinitionByElementName

public PrismPropertyDefinition findPropertyDefinitionByElementName(QName elementName)

findReferenceDefinitionByElementName

public PrismReferenceDefinition findReferenceDefinitionByElementName(QName elementName)

findComplexTypeDefinition

public ComplexTypeDefinition findComplexTypeDefinition(QName typeName)

findSchemaByNamespace

public PrismSchema findSchemaByNamespace(String namespaceURI)

findSchemaDescriptionByNamespace

public SchemaDescription findSchemaDescriptionByNamespace(String namespaceURI)

findSchemaByPrefix

public PrismSchema findSchemaByPrefix(String prefix)

findSchemaDescriptionByPrefix

public SchemaDescription findSchemaDescriptionByPrefix(String prefix)

determineDefinitionFromClass

public PrismObjectDefinition determineDefinitionFromClass(Class type)

hasImplicitTypeDefinition

public boolean hasImplicitTypeDefinition(QName elementName,
                                QName typeName)

Returns true if specified element has a definition that matches specified type in the known schemas.

createDefaultItemDefinition

public static ItemDefinition createDefaultItemDefinition(QName itemName,
                                         PrismContext prismContext)

resolveGlobalItemDefinition

public ItemDefinition resolveGlobalItemDefinition(QName elementQName)
                                           throws SchemaException

Looks for a top-level definition for the specified element name (in all schemas).

Throws:

SchemaException

instantiate

public <T extends Objectable> PrismObject<T> instantiate(Class<T> compileTimeClass)
                                              throws SchemaException

Throws:

SchemaException