Package com.evolveum.midpoint.common.refinery

Class RefinedResourceSchemaImpl

java.lang.Object

com.evolveum.midpoint.common.refinery.RefinedResourceSchemaImpl

All Implemented Interfaces:

RefinedResourceSchema, Freezable, PrismContextSensitive, DefinitionSearchImplementation, DefinitionsStore, GlobalDefinitionsStore, PrismSchema, ResourceSchema, DebugDumpable

public final class RefinedResourceSchemaImpl
extends Object
implements RefinedResourceSchema

TODO: this whole class would benefit from more refactoring. TODO: especially the parsing part.

Author:

semancik, mederly

Field Summary

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

INDENT_STRING

Method Summary

Modifier and Type	Method	Description
String	debugDump()	Show the content of the object intended for diagnostics by system administrator.
String	debugDump(int indent)
CompositeRefinedObjectClassDefinition	determineCompositeObjectClassDefinition(PrismObject<ShadowType> shadow)
CompositeRefinedObjectClassDefinition	determineCompositeObjectClassDefinition(PrismObject<ShadowType> shadow, Collection<QName> additionalAuxiliaryObjectClassQNames)
CompositeRefinedObjectClassDefinition	determineCompositeObjectClassDefinition(ResourceShadowDiscriminator discriminator)
CompositeRefinedObjectClassDefinition	determineCompositeObjectClassDefinition(QName structuralObjectClassQName, ShadowKindType kind, String intent)
ObjectClassComplexTypeDefinition	findDefaultObjectClassDefinition(ShadowKindType kind)
<ID extends ItemDefinition> ID	findItemDefinitionByType(@NotNull QName typeName, @NotNull Class<ID> definitionType)	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.
ObjectClassComplexTypeDefinition	findObjectClassDefinition(ShadowKindType kind, String intent)
ObjectClassComplexTypeDefinition	findObjectClassDefinition(QName objectClassQName)
RefinedObjectClassDefinition	findRefinedDefinitionByObjectClassQName(ShadowKindType kind, QName objectClass)
<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)
LayerRefinedResourceSchema	forLayer(LayerType layer)
void	freeze()
@NotNull Collection<Definition>	getDefinitions()	Returns set of definitions.
<T extends Definition> @NotNull List<T>	getDefinitions(@NotNull Class<T> type)	Returns set of definitions of a given type.
static RefinedResourceSchema	getExistingRefinedSchema(PrismObject<ResourceType> resource)
static List<String>	getIntentsForKind(RefinedResourceSchema rSchema, ShadowKindType kind)
@NotNull String	getNamespace()	Returns schema namespace.
Collection<ObjectClassComplexTypeDefinition>	getObjectClassDefinitions()
ResourceSchema	getOriginalResourceSchema()
PrismContext	getPrismContext()
RefinedObjectClassDefinition	getRefinedDefinition(ShadowKindType kind, String intent)	if null accountType is provided, default account definition is returned.
RefinedObjectClassDefinition	getRefinedDefinition(ShadowKindType kind, Collection<String> intents)	If no intents are provided, default account definition is returned.
RefinedObjectClassDefinition	getRefinedDefinition(QName objectClassName)
List<? extends RefinedObjectClassDefinition>	getRefinedDefinitions()
List<? extends RefinedObjectClassDefinition>	getRefinedDefinitions(ShadowKindType kind)
static RefinedResourceSchema	getRefinedSchema(PrismObject<ResourceType> resource)
static RefinedResourceSchema	getRefinedSchema(PrismObject<ResourceType> resource, PrismContext prismContext)	Obtains refined schema for the resource.
static LayerRefinedResourceSchema	getRefinedSchema(PrismObject<ResourceType> resource, LayerType layer, PrismContext prismContext)
static RefinedResourceSchema	getRefinedSchema(ResourceType resourceType)
static RefinedResourceSchema	getRefinedSchema(ResourceType resourceType, PrismContext prismContext)
static LayerRefinedResourceSchema	getRefinedSchema(ResourceType resourceType, LayerType layer)
static LayerRefinedResourceSchema	getRefinedSchema(ResourceType resourceType, LayerType layer, PrismContext prismContext)
static ResourceSchema	getResourceSchema(PrismObject<ResourceType> resource, PrismContext prismContext)	Obtains schema for the resource.
static ResourceSchema	getResourceSchema(ResourceType resourceType, PrismContext prismContext)
com.google.common.collect.Multimap<QName,ItemDefinition<?>>	getSubstitutions()
static boolean	hasParsedSchema(ResourceType resourceType)
static boolean	hasRefinedSchema(ResourceType resourceType)
boolean	isEmpty()
boolean	isImmutable()
static RefinedResourceSchema	parse(PrismObject<ResourceType> resource, PrismContext prismContext)
static RefinedResourceSchema	parse(ResourceType resourceType, PrismContext prismContext)
@NotNull Document	serializeToXsd()
MutableResourceSchema	toMutable()
String	toString()
static void	validateRefinedSchema(RefinedResourceSchema refinedSchema, PrismObject<ResourceType> resource)

Methods inherited from class java.lang.Object

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

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

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, findObjectDefinitionByCompileTimeClass, findObjectDefinitionByElementName, findObjectDefinitionByType, findPropertyDefinitionByElementName, findReferenceDefinitionByElementName, findSimpleTypeDefinitionByType, findTypeDefinitionByType, findTypeDefinitionsByType

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

getComplexTypeDefinitions, getObjectDefinitions

Methods inherited from interface com.evolveum.midpoint.common.refinery.RefinedResourceSchema

getDefaultRefinedDefinition, getObjectDefinition, getObjectDefinition, getRefinedDefinition

Methods inherited from interface com.evolveum.midpoint.schema.processor.ResourceSchema

findObjectClassDefinition, findObjectClassDefinition, getObjectClassList

Method Detail

getObjectClassDefinitions

public Collection<ObjectClassComplexTypeDefinition> getObjectClassDefinitions()

Specified by:

getObjectClassDefinitions in interface ResourceSchema

getRefinedDefinitions

public List<? extends RefinedObjectClassDefinition> getRefinedDefinitions()

Specified by:

getRefinedDefinitions in interface RefinedResourceSchema

getRefinedDefinitions

public List<? extends RefinedObjectClassDefinition> getRefinedDefinitions(ShadowKindType kind)

Specified by:

getRefinedDefinitions in interface RefinedResourceSchema

getOriginalResourceSchema

public ResourceSchema getOriginalResourceSchema()

Specified by:

getOriginalResourceSchema in interface RefinedResourceSchema

getRefinedDefinition

public RefinedObjectClassDefinition getRefinedDefinition(ShadowKindType kind,
                                                         String intent)

Description copied from interface: RefinedResourceSchema

if null accountType is provided, default account definition is returned.

Specified by:

getRefinedDefinition in interface RefinedResourceSchema

determineCompositeObjectClassDefinition

public CompositeRefinedObjectClassDefinition determineCompositeObjectClassDefinition(ResourceShadowDiscriminator discriminator)

Specified by:

determineCompositeObjectClassDefinition in interface RefinedResourceSchema

determineCompositeObjectClassDefinition

public CompositeRefinedObjectClassDefinition determineCompositeObjectClassDefinition(PrismObject<ShadowType> shadow)
                                                                              throws SchemaException

Specified by:

determineCompositeObjectClassDefinition in interface RefinedResourceSchema

Throws:

SchemaException

determineCompositeObjectClassDefinition

public CompositeRefinedObjectClassDefinition determineCompositeObjectClassDefinition(PrismObject<ShadowType> shadow,
                                                                                     Collection<QName> additionalAuxiliaryObjectClassQNames)
                                                                              throws SchemaException

Specified by:

determineCompositeObjectClassDefinition in interface RefinedResourceSchema

Throws:

SchemaException

determineCompositeObjectClassDefinition

public CompositeRefinedObjectClassDefinition determineCompositeObjectClassDefinition(QName structuralObjectClassQName,
                                                                                     ShadowKindType kind,
                                                                                     String intent)

Specified by:

determineCompositeObjectClassDefinition in interface RefinedResourceSchema

getRefinedDefinition

public RefinedObjectClassDefinition getRefinedDefinition(ShadowKindType kind,
                                                         Collection<String> intents)
                                                  throws SchemaException

Description copied from interface: RefinedResourceSchema

If no intents are provided, default account definition is returned. We check whether there is only one relevant rOCD.

Specified by:

getRefinedDefinition in interface RefinedResourceSchema

Throws:

SchemaException

getRefinedDefinition

public RefinedObjectClassDefinition getRefinedDefinition(QName objectClassName)

Specified by:

getRefinedDefinition in interface RefinedResourceSchema

findRefinedDefinitionByObjectClassQName

public RefinedObjectClassDefinition findRefinedDefinitionByObjectClassQName(ShadowKindType kind,
                                                                            QName objectClass)

Specified by:

findRefinedDefinitionByObjectClassQName in interface RefinedResourceSchema

forLayer

public LayerRefinedResourceSchema forLayer(LayerType layer)

Specified by:

forLayer in interface RefinedResourceSchema

toString

public String toString()

Overrides:

toString in class Object

getRefinedSchema

public static RefinedResourceSchema getRefinedSchema(ResourceType resourceType)
                                              throws SchemaException

Throws:

SchemaException

getRefinedSchema

public static LayerRefinedResourceSchema getRefinedSchema(ResourceType resourceType,
                                                          LayerType layer)
                                                   throws SchemaException

Throws:

SchemaException

getRefinedSchema

public static RefinedResourceSchema getRefinedSchema(ResourceType resourceType,
                                                     PrismContext prismContext)
                                              throws SchemaException

Throws:

SchemaException

getRefinedSchema

public static LayerRefinedResourceSchema getRefinedSchema(ResourceType resourceType,
                                                          LayerType layer,
                                                          PrismContext prismContext)
                                                   throws SchemaException

Throws:

SchemaException

getRefinedSchema

public static RefinedResourceSchema getRefinedSchema(PrismObject<ResourceType> resource)
                                              throws SchemaException

Throws:

SchemaException

getExistingRefinedSchema

public static RefinedResourceSchema getExistingRefinedSchema(PrismObject<ResourceType> resource)

getRefinedSchema

public static RefinedResourceSchema getRefinedSchema(PrismObject<ResourceType> resource,
                                                     PrismContext prismContext)
                                              throws SchemaException

Obtains refined schema for the resource. If the resource does NOT contain the schema, it must be mutable. TODO rework this -- management of refined resource schemas will be the responsibility of ResourceManager

Throws:

SchemaException

getRefinedSchema

public static LayerRefinedResourceSchema getRefinedSchema(PrismObject<ResourceType> resource,
                                                          LayerType layer,
                                                          PrismContext prismContext)
                                                   throws SchemaException

Throws:

SchemaException

hasRefinedSchema

public static boolean hasRefinedSchema(ResourceType resourceType)

getResourceSchema

public static ResourceSchema getResourceSchema(ResourceType resourceType,
                                               PrismContext prismContext)
                                        throws SchemaException

Throws:

SchemaException

getResourceSchema

public static ResourceSchema getResourceSchema(PrismObject<ResourceType> resource,
                                               PrismContext prismContext)
                                        throws SchemaException

Obtains schema for the resource. If the resource does NOT contain the schema, it must be mutable. TODO rework this -- management of resource schemas will be the responsibility of ResourceManager

Throws:

SchemaException

hasParsedSchema

public static boolean hasParsedSchema(ResourceType resourceType)

parse

public static RefinedResourceSchema parse(PrismObject<ResourceType> resource,
                                          PrismContext prismContext)
                                   throws SchemaException

Throws:

SchemaException

parse

public static RefinedResourceSchema parse(ResourceType resourceType,
                                          PrismContext prismContext)
                                   throws SchemaException

Throws:

SchemaException

getIntentsForKind

public static List<String> getIntentsForKind(RefinedResourceSchema rSchema,
                                             ShadowKindType kind)

findObjectClassDefinition

public ObjectClassComplexTypeDefinition findObjectClassDefinition(QName objectClassQName)

Specified by:

findObjectClassDefinition in interface RefinedResourceSchema

Specified by:

findObjectClassDefinition in interface ResourceSchema

findObjectClassDefinition

public ObjectClassComplexTypeDefinition findObjectClassDefinition(ShadowKindType kind,
                                                                  String intent)

Specified by:

findObjectClassDefinition in interface ResourceSchema

findDefaultObjectClassDefinition

public ObjectClassComplexTypeDefinition findDefaultObjectClassDefinition(ShadowKindType kind)

Specified by:

findDefaultObjectClassDefinition in interface ResourceSchema

getNamespace

@NotNull
public @NotNull String getNamespace()

Description copied from interface: PrismSchema

Returns schema namespace. All schema definitions are placed in the returned namespace.

Specified by:

getNamespace in interface PrismSchema

Returns:

schema namespace

getDefinitions

@NotNull
public @NotNull Collection<Definition> getDefinitions()

Description copied from interface: PrismSchema

Returns set of definitions. The set contains all definitions of all types that were parsed. Order of definitions is insignificant.

Specified by:

getDefinitions in interface PrismSchema

Returns:

set of definitions

getDefinitions

@NotNull
public <T extends Definition> @NotNull List<T> getDefinitions(@NotNull
                                                              @NotNull Class<T> type)

Description copied from interface: PrismSchema

Returns set of definitions of a given type. The set contains all definitions of the given type that were parsed. Order of definitions is insignificant.

Specified by:

getDefinitions in interface PrismSchema

Returns:

set of definitions

getPrismContext

public PrismContext getPrismContext()

Specified by:

getPrismContext in interface PrismContextSensitive

serializeToXsd

@NotNull
public @NotNull Document serializeToXsd()
                                 throws SchemaException

Specified by:

serializeToXsd in interface PrismSchema

Throws:

SchemaException

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface PrismSchema

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

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

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

findItemDefinitionByType

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

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

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

validateRefinedSchema

public static void validateRefinedSchema(RefinedResourceSchema refinedSchema,
                                         PrismObject<ResourceType> resource)
                                  throws SchemaException

Throws:

SchemaException

toMutable

public MutableResourceSchema toMutable()

Specified by:

toMutable in interface ResourceSchema

isImmutable

public boolean isImmutable()

Specified by:

isImmutable in interface Freezable

getSubstitutions

public com.google.common.collect.Multimap<QName,ItemDefinition<?>> getSubstitutions()

Specified by:

getSubstitutions in interface PrismSchema

freeze

public void freeze()

Specified by:

freeze in interface Freezable