Package com.evolveum.midpoint.schema.config

Class SchemaHandlingConfigItem

java.lang.Object

com.evolveum.midpoint.schema.config.ConfigurationItem<SchemaHandlingType>

com.evolveum.midpoint.schema.config.SchemaHandlingConfigItem

All Implemented Interfaces:

Serializable, Cloneable

public class SchemaHandlingConfigItem
extends ConfigurationItem<SchemaHandlingType>

This is intended to help with refined resource definition parsing process.

See Also:

• Serialized Form

Field Summary

Fields inherited from class com.evolveum.midpoint.schema.config.ConfigurationItem

DESC

Constructor Summary

Constructors

Constructor	Description
SchemaHandlingConfigItem(@NotNull ConfigurationItem<SchemaHandlingType> original)

Method Summary

Modifier and Type	Method	Description
default void	checkNamespace(@NotNull QName name, String expectedNamespace)
void	checkSyntaxOfAttributeNames()	Checks that all attribute names (`ref` elements) are valid - before even starting to parse the schema.
default void	configCheck(boolean value, String template, Object... arguments)	Checks the value, and if it's `false`, emits a ConfigurationException.
default @NotNull ConfigurationException	configException(String template, Object... arguments)
default @NotNull ConfigurationException	configException(Throwable cause, String template, Object... arguments)
default <V> V	configNonNull(V value, String template, Object... arguments)	As configCheck(boolean, String, Object...), but checks that the value is not null.
List<AbstractResourceObjectTypeDefinitionConfigItem<?>>	getAllObjectTypes()
List<ShadowAssociationTypeDefinitionConfigItem>	getAssociationTypes()
@NotNull Collection<ShadowAssociationTypeDefinitionConfigItem>	getAssociationTypesFor(@NotNull ResourceObjectTypeIdentification typeIdentification, @NotNull ItemName itemName)
default @NotNull String	getLocalPart(@NotNull QName name, String expectedNamespace)
List<ResourceObjectClassDefinitionConfigItem>	getObjectClasses()
@NotNull String	localDescription()	To be overridden in specific subclasses.
default <C extends Collection<?>> C	nonEmpty(C collection, Object itemDescription)
default <C extends Collection<?>> C	nonEmpty(C collection, String template, Object... arguments)
default <V> V	nonNull(V value, Object itemDesc)	Even more shortened version.
default <C> C	single(Collection<? extends C> collection, String template, Object... arguments)
default @NotNull ItemName	singleNameRequired(ItemPathType name, Object itemDesc)

Methods inherited from class com.evolveum.midpoint.schema.config.ConfigurationItem

as, as, asList, child, child, clone, configItem, configItem, configItemNullable, embedded, embeddedNullable, equals, fullDescription, fullOriginLessDescription, hashCode, of, ofList, origin, originFor, originProviderFor, toString, value, value

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

SchemaHandlingConfigItem

public SchemaHandlingConfigItem(@NotNull
 @NotNull ConfigurationItem<SchemaHandlingType> original)

Method Details

getObjectClasses

public List<ResourceObjectClassDefinitionConfigItem> getObjectClasses()

getAllObjectTypes

public List<AbstractResourceObjectTypeDefinitionConfigItem<?>> getAllObjectTypes()

getAssociationTypes

public List<ShadowAssociationTypeDefinitionConfigItem> getAssociationTypes()

checkSyntaxOfAttributeNames

public void checkSyntaxOfAttributeNames()
                                 throws ConfigurationException

Checks that all attribute names (`ref` elements) are valid - before even starting to parse the schema. Otherwise, the parsing may fail at unusual places, generating confusing error messages. See also MID-8162. Maybe we can remove this method, as we migrated the beans to config items here.

Throws:

ConfigurationException

localDescription

@NotNull
public @NotNull String localDescription()

Description copied from class: ConfigurationItem

To be overridden in specific subclasses.

Overrides:

localDescription in class ConfigurationItem<SchemaHandlingType>

getAssociationTypesFor

@NotNull
public @NotNull Collection<ShadowAssociationTypeDefinitionConfigItem> getAssociationTypesFor(@NotNull
 @NotNull ResourceObjectTypeIdentification typeIdentification,
 @NotNull
 @NotNull ItemName itemName)
                                                                                      throws ConfigurationException

Throws:

ConfigurationException

configCheck

@Contract("false, _, _ -> fail")
default void configCheck(boolean value,
 String template,
 Object... arguments)
                  throws ConfigurationException

Checks the value, and if it's `false`, emits a ConfigurationException. Note that ConfigurationItem.DESC can be used as a placeholder for fullDescription() in the `arguments`.

Throws:

ConfigurationException

checkNamespace

default void checkNamespace(@NotNull
 @NotNull QName name,
 String expectedNamespace)
                     throws ConfigurationException

Throws:

ConfigurationException

getLocalPart

@NotNull
default @NotNull String getLocalPart(@NotNull
 @NotNull QName name,
 String expectedNamespace)
                              throws ConfigurationException

Throws:

ConfigurationException

configException

@NotNull
default @NotNull ConfigurationException configException(Throwable cause,
 String template,
 Object... arguments)

configException

@NotNull
default @NotNull ConfigurationException configException(String template,
 Object... arguments)

configNonNull

@Contract("null, _, _ -> fail")
@NotNull
default <V> V configNonNull(V value,
 String template,
 Object... arguments)
                     throws ConfigurationException

As configCheck(boolean, String, Object...), but checks that the value is not null.

Throws:

ConfigurationException

nonNull

@Contract("null, _ -> fail")
@NotNull
default <V> V nonNull(V value,
 Object itemDesc)
               throws ConfigurationException

Even more shortened version.

Throws:

ConfigurationException

nonEmpty

@NotNull
default <C extends Collection<?>> C nonEmpty(C collection,
 Object itemDescription)
                                      throws ConfigurationException

Throws:

ConfigurationException

nonEmpty

@NotNull
default <C extends Collection<?>> C nonEmpty(C collection,
 String template,
 Object... arguments)
                                      throws ConfigurationException

Throws:

ConfigurationException

singleNameRequired

@NotNull
default @NotNull ItemName singleNameRequired(ItemPathType name,
 Object itemDesc)
                                      throws ConfigurationException

Throws:

ConfigurationException

single

@Nullable
default <C> C single(Collection<? extends C> collection,
 String template,
 Object... arguments)
              throws ConfigurationException

Throws:

ConfigurationException