Package com.evolveum.midpoint.schema.processor

Class ResourceSchemaFactory

java.lang.Object

com.evolveum.midpoint.schema.processor.ResourceSchemaFactory

public class ResourceSchemaFactory
extends Object

The official place where resource schemas are created.

Constructor Summary

Constructors

Constructor	Description
ResourceSchemaFactory()

Method Summary

Modifier and Type	Method	Description
static void	deleteCachedSchemas(PrismObject<ResourceType> resource)	Removes schemas that are attached to the particular prism object using user data.
static BareResourceSchema	getBareSchema(@NotNull PrismObject<ResourceType> resource)
static BareResourceSchema	getBareSchema(@NotNull ResourceType resource)
static CompleteResourceSchema	getCompleteSchema(@NotNull PrismObject<ResourceType> resource)	Obtains refined schema for the resource.
static @Nullable CompleteResourceSchema	getCompleteSchema(@NotNull ResourceType resource)
static CompleteResourceSchema	getCompleteSchema(PrismObject<ResourceType> resource, LayerType layer)	Returned schema is immutable.
static CompleteResourceSchema	getCompleteSchema(ResourceType resourceType, LayerType layer)
static @NotNull CompleteResourceSchema	getCompleteSchemaRequired(@NotNull PrismObject<ResourceType> resource)
static @NotNull CompleteResourceSchema	getCompleteSchemaRequired(@NotNull ResourceType resource)	We assume that missing schema is a configuration (not schema) problem.
static @NotNull ResourceSchema	getCompleteSchemaRequired(PrismObject<ResourceType> resource, LayerType layer)
static @NotNull ResourceSchema	getCompleteSchemaRequired(ResourceType resource, LayerType layer)
static NativeResourceSchema	getNativeSchema(@NotNull PrismObject<ResourceType> resource)	Obtains "raw" schema for the resource, i.e. the one without `schemaHandling` and similar configuration.
static NativeResourceSchema	getNativeSchema(@NotNull ResourceType resource)
static NativeResourceSchema	getNativeSchemaRequired(PrismObject<ResourceType> resource)
static NativeResourceSchema	getNativeSchemaRequired(ResourceType resource)
static boolean	hasParsedSchema(ResourceType resource)
static BareResourceSchema	nativeToBare(@Nullable NativeResourceSchema nativeResourceSchema)
static CompleteResourceSchema	parseCompleteSchema(@NotNull ResourceType resource, NativeResourceSchema nativeSchema)	Parses the complete schema from the provided raw schema plus definitions in the resource.
static CompleteResourceSchema	parseCompleteSchema(ResourceType resource)	Executes the real parsing.
static CompleteResourceSchema	parseCompleteSchemaWithAdditions(ResourceType resource, SchemaHandlingType additions)	Parse "complete schema" of the resource with additional definitions which are not stored in the resource.
static @NotNull NativeResourceSchema	parseNativeSchema(@NotNull Element sourceXsdElement, String description)
static @NotNull BareResourceSchema	parseNativeSchemaAsBare(@NotNull Document sourceXsdDocument)
static @NotNull BareResourceSchema	parseNativeSchemaAsBare(@NotNull Element sourceXsdElement)
static ResourceSchemaExtender	schemaExtenderFor(ResourceType resource)	Creates new schema extender for a given resource.

Methods inherited from class java.lang.Object

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

Constructor Details

ResourceSchemaFactory

public ResourceSchemaFactory()

Method Details

getCompleteSchema

@Nullable
public static @Nullable CompleteResourceSchema getCompleteSchema(@NotNull
 @NotNull ResourceType resource)
                                                          throws SchemaException,
ConfigurationException

Throws:

SchemaException

ConfigurationException

getCompleteSchemaRequired

@NotNull
public static @NotNull CompleteResourceSchema getCompleteSchemaRequired(@NotNull
 @NotNull ResourceType resource)
                                                                 throws ConfigurationException,
SchemaException

We assume that missing schema is a configuration (not schema) problem.

Throws:

ConfigurationException

SchemaException

getCompleteSchemaRequired

@NotNull
public static @NotNull CompleteResourceSchema getCompleteSchemaRequired(@NotNull
 @NotNull PrismObject<ResourceType> resource)
                                                                 throws ConfigurationException,
SchemaException

Throws:

ConfigurationException

SchemaException

getCompleteSchema

public static CompleteResourceSchema getCompleteSchema(ResourceType resourceType,
 LayerType layer)
                                                throws SchemaException,
ConfigurationException

Throws:

SchemaException

ConfigurationException

getCompleteSchemaRequired

@NotNull
public static @NotNull ResourceSchema getCompleteSchemaRequired(PrismObject<ResourceType> resource,
 LayerType layer)
                                                         throws SchemaException,
ConfigurationException

Throws:

SchemaException

ConfigurationException

getCompleteSchemaRequired

@NotNull
public static @NotNull ResourceSchema getCompleteSchemaRequired(ResourceType resource,
 LayerType layer)
                                                         throws SchemaException,
ConfigurationException

Throws:

SchemaException

ConfigurationException

getCompleteSchema

public static CompleteResourceSchema getCompleteSchema(@NotNull
 @NotNull PrismObject<ResourceType> resource)
                                                throws SchemaException,
ConfigurationException

Obtains refined schema for the resource. Returns null if the resource does not contain any (native) schema. If the resource does NOT contain the schema, it must be mutable. Returned schema is immutable.

Throws:

SchemaException

ConfigurationException

deleteCachedSchemas

public static void deleteCachedSchemas(PrismObject<ResourceType> resource)

Removes schemas that are attached to the particular prism object using user data.

getCompleteSchema

public static CompleteResourceSchema getCompleteSchema(PrismObject<ResourceType> resource,
 LayerType layer)
                                                throws SchemaException,
ConfigurationException

Returned schema is immutable. FIXME there is a lot of cloning if layer != MODEL!

Throws:

SchemaException

ConfigurationException

getNativeSchema

public static NativeResourceSchema getNativeSchema(@NotNull
 @NotNull ResourceType resource)
                                            throws SchemaException

Throws:

SchemaException

getNativeSchemaRequired

public static NativeResourceSchema getNativeSchemaRequired(ResourceType resource)
                                                    throws SchemaException,
ConfigurationException

Throws:

SchemaException

ConfigurationException

getNativeSchemaRequired

public static NativeResourceSchema getNativeSchemaRequired(PrismObject<ResourceType> resource)
                                                    throws SchemaException,
ConfigurationException

Throws:

SchemaException

ConfigurationException

getBareSchema

public static BareResourceSchema getBareSchema(@NotNull
 @NotNull PrismObject<ResourceType> resource)
                                        throws SchemaException

Throws:

SchemaException

getBareSchema

public static BareResourceSchema getBareSchema(@NotNull
 @NotNull ResourceType resource)
                                        throws SchemaException

Throws:

SchemaException

getNativeSchema

public static NativeResourceSchema getNativeSchema(@NotNull
 @NotNull PrismObject<ResourceType> resource)
                                            throws SchemaException

Obtains "raw" schema for the resource, i.e. the one without `schemaHandling` and similar configuration. If the resource does NOT contain the schema, it must be mutable. The returned schema is immutable.

Throws:

SchemaException

hasParsedSchema

@VisibleForTesting
public static boolean hasParsedSchema(ResourceType resource)

parseCompleteSchema

public static CompleteResourceSchema parseCompleteSchema(ResourceType resource)
                                                  throws SchemaException,
ConfigurationException

Executes the real parsing. Returns complete schema (raw + refined).

Throws:

SchemaException

ConfigurationException

parseCompleteSchemaWithAdditions

public static CompleteResourceSchema parseCompleteSchemaWithAdditions(ResourceType resource,
 SchemaHandlingType additions)
                                                               throws SchemaException,
ConfigurationException

Parse "complete schema" of the resource with additional definitions which are not stored in the resource. During the parsing the provided additional schema handling is considered as well as the schema handling and native schema which are already present in the resource.

Parameters:

resource - The resource schema of which should be parsed.

additions - The additional definitions specified in schema handling.

Returns:

Instance of parsed complete schema.

Throws:

SchemaException

ConfigurationException

schemaExtenderFor

public static ResourceSchemaExtender schemaExtenderFor(ResourceType resource)
                                                throws SchemaException

Creates new schema extender for a given resource.

Parameters:

resource - The resource schema of which you would like to extend.

Returns:

The new instance of the schema extender

Throws:

SchemaException - When error occurs during parsing of resource native schema.

parseCompleteSchema

@Contract("_, null -> null; _, !null -> !null")
public static CompleteResourceSchema parseCompleteSchema(@NotNull
 @NotNull ResourceType resource,
 NativeResourceSchema nativeSchema)
                                                  throws SchemaException,
ConfigurationException

Parses the complete schema from the provided raw schema plus definitions in the resource.

Throws:

SchemaException

ConfigurationException

parseNativeSchema

@NotNull
public static @NotNull NativeResourceSchema parseNativeSchema(@NotNull
 @NotNull Element sourceXsdElement,
 String description)
                                                       throws SchemaException

Throws:

SchemaException

parseNativeSchemaAsBare

@TestOnly
@NotNull
public static @NotNull BareResourceSchema parseNativeSchemaAsBare(@NotNull
 @NotNull Document sourceXsdDocument)
                                                           throws SchemaException

Throws:

SchemaException

parseNativeSchemaAsBare

@TestOnly
@NotNull
public static @NotNull BareResourceSchema parseNativeSchemaAsBare(@NotNull
 @NotNull Element sourceXsdElement)
                                                           throws SchemaException

Throws:

SchemaException

nativeToBare

@Contract("null -> null; !null -> !null")
public static BareResourceSchema nativeToBare(@Nullable
 @Nullable NativeResourceSchema nativeResourceSchema)
                                       throws SchemaException

Throws:

SchemaException