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

Class SchemaRegistryStateImpl

java.lang.Object

com.evolveum.midpoint.prism.AbstractFreezable

com.evolveum.midpoint.prism.impl.schema.SchemaRegistryStateImpl

All Implemented Interfaces:

Freezable, DefinitionsStore, GlobalDefinitionsStore, SchemaLookup, SchemaLookup.Mutable, SchemaRegistryState, DebugDumpable

public class SchemaRegistryStateImpl
extends AbstractFreezable
implements DebugDumpable, SchemaLookup.Mutable

Contains caches and provides definitions.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SchemaRegistryStateImpl.Builder	Builder for SchemaRegistryState.

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.SchemaRegistryState

SchemaRegistryState.DerivationKey<R>, SchemaRegistryState.IsList

Field Summary

Fields

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

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

INDENT_STRING

Method Summary

Modifier and Type	Method	Description
String	debugDump(int indent)
DefinitionFactoryImpl	definitionFactory()
<T> Class<T>	determineClassForType(QName type)
<T> Class<T>	determineCompileTimeClass(QName type)
<T> Class<T>	determineCompileTimeClassInternal(QName type, boolean cacheAlsoNegativeResults)
ComplexTypeDefinition	determineParentDefinition(@NotNull ComplexTypeDefinition child, @NotNull ItemPath rest)
<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)
Collection<Package>	getCompileTimePackages()
<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.
Schema	getJavaxSchema()
DynamicNamespacePrefixMapper	getNamespacePrefixMapper()	// * @return System-wide "standard prefixes" registry.
org.apache.commons.collections4.MultiValuedMap<String,SchemaDescription>	getParsedSchemas()
PrismSchema	getPrismSchema(String namespace)
Collection<PrismSchema>	getSchemas()
PrismContainerDefinition<?>	getValueMetadataDefinition()
@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	performFreeze()
<T extends SchemaLookup.Based> void	registerSchemaSpecific(Class<T> serviceClass, Function<SchemaLookup,T> factory)
SchemaContextResolver	resolverFor(SchemaContextDefinition schemaContextDefinition)
QName	resolveUnqualifiedTypeName(QName type)
<T extends SchemaLookup.Based> T	schemaSpecific(@NotNull Class<T> type)	Returns schema-specific service

Methods inherited from class com.evolveum.midpoint.prism.AbstractFreezable

freeze, freeze, freezeAll, freezeNullableList, isImmutable, isMutable

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.Freezable

checkImmutable, checkMutable

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

Field Details

prismContext

protected final PrismContext prismContext

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

Method Details

getParsedSchemas

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

getValueMetadataDefinition

public PrismContainerDefinition<?> getValueMetadataDefinition()

getJavaxSchema

public Schema getJavaxSchema()

Specified by:

getJavaxSchema in interface SchemaRegistryState

getNamespacePrefixMapper

public DynamicNamespacePrefixMapper getNamespacePrefixMapper()

Description copied from interface: SchemaRegistryState

// * @return System-wide "standard prefixes" registry. //

Specified by:

getNamespacePrefixMapper in interface SchemaRegistryState

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

findSchemaDescriptionByNamespace

public SchemaDescription findSchemaDescriptionByNamespace(String namespaceURI)

Specified by:

findSchemaDescriptionByNamespace in interface SchemaRegistryState

findSchemaDescriptionByPrefix

public SchemaDescription findSchemaDescriptionByPrefix(String prefix)

Specified by:

findSchemaDescriptionByPrefix in interface SchemaRegistryState

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

resolveUnqualifiedTypeName

public QName resolveUnqualifiedTypeName(QName type)
                                 throws SchemaException

Specified by:

resolveUnqualifiedTypeName in interface SchemaRegistryState

Throws:

SchemaException

determineParentDefinition

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

Specified by:

determineParentDefinition in interface SchemaRegistryState

getPrismSchema

public PrismSchema getPrismSchema(String namespace)

Specified by:

getPrismSchema in interface SchemaRegistryState

getSchemas

public Collection<PrismSchema> getSchemas()

Specified by:

getSchemas in interface SchemaRegistryState

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

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

determineClassForType

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

Specified by:

determineClassForType in interface SchemaRegistryState

getCompileTimePackages

public Collection<Package> getCompileTimePackages()

Specified by:

getCompileTimePackages 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

performFreeze

protected void performFreeze()

Overrides:

performFreeze in class AbstractFreezable

debugDump

public String debugDump(int indent)

Specified by:

debugDump in interface DebugDumpable

resolverFor

public SchemaContextResolver resolverFor(SchemaContextDefinition schemaContextDefinition)

Specified by:

resolverFor in interface SchemaLookup

definitionFactory

public DefinitionFactoryImpl definitionFactory()

Specified by:

definitionFactory in interface SchemaLookup

registerSchemaSpecific

public <T extends SchemaLookup.Based> void registerSchemaSpecific(Class<T> serviceClass,
 Function<SchemaLookup,T> factory)

Specified by:

registerSchemaSpecific in interface SchemaLookup.Mutable

schemaSpecific

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.