Package com.evolveum.midpoint.schema.config

Class AbstractPolicyRuleConfigItem<R extends PolicyRuleType>

java.lang.Object

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

com.evolveum.midpoint.schema.config.AbstractPolicyRuleConfigItem<R>

All Implemented Interfaces:

Serializable, Cloneable

Direct Known Subclasses:

GlobalPolicyRuleConfigItem, PolicyRuleConfigItem

public abstract class AbstractPolicyRuleConfigItem<R extends PolicyRuleType>
extends ConfigurationItem<R>

Config item that covers both global policy rules (GlobalPolicyRuleType) and regular ones (PolicyRuleType). Note that the former extend the latter. However, for config items we use a different structure: both PolicyRuleConfigItem and GlobalPolicyRuleConfigItem extend this class. It is more natural, because each policy rule is definitely global or is not. So, this presents an exception from naming rules for config items vs beans.

See Also:

• Serialized Form

Field Summary

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

DESC

Constructor Summary

Constructors

Constructor	Description
AbstractPolicyRuleConfigItem(@NotNull ConfigurationItem<R> original)

Method Summary

Modifier and Type	Method	Description
default void	checkNamespace(@NotNull QName name, String expectedNamespace)
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.
default @NotNull QName	enforceNamespace(@NotNull QName name, @NotNull String requiredNamespace)	Just like QNameUtil.enforceNamespace(QName, String) but throwing ConfigurationException.
List<PolicyActionConfigItem<?>>	getAllActions()
@NotNull Collection<String>	getEventMarksOids()
default @NotNull String	getLocalPart(@NotNull QName name, String expectedNamespace)
@Nullable String	getName()
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 @NotNull ConfigurationItemOrigin	originFor(@NotNull ItemPath path)
default <C extends Containerable> @NotNull OriginProvider<C>	originProviderFor(@NotNull ItemPath path)
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, localDescription, ofList, origin, toString, value, value

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractPolicyRuleConfigItem

public AbstractPolicyRuleConfigItem(@NotNull
 @NotNull ConfigurationItem<R> original)

Method Details

getName

@Nullable
public @Nullable String getName()

getAllActions

public List<PolicyActionConfigItem<?>> getAllActions()

getEventMarksOids

@NotNull
public @NotNull Collection<String> getEventMarksOids()

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

enforceNamespace

@NotNull
default @NotNull QName enforceNamespace(@NotNull
 @NotNull QName name,
 @NotNull
 @NotNull String requiredNamespace)
                                 throws ConfigurationException

Just like QNameUtil.enforceNamespace(QName, String) but throwing 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

originProviderFor

@NotNull
default <C extends Containerable>
@NotNull OriginProvider<C> originProviderFor(@NotNull
 @NotNull ItemPath path)

originFor

@NotNull
default @NotNull ConfigurationItemOrigin originFor(@NotNull
 @NotNull ItemPath path)