Package com.evolveum.midpoint.schema.config

Class PolicyActionConfigItem<A extends PolicyActionType>

java.lang.Object

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

com.evolveum.midpoint.schema.config.PolicyActionConfigItem<A>

All Implemented Interfaces:

Serializable, Cloneable

Direct Known Subclasses:

ScriptExecutionPolicyActionConfigItem

public class PolicyActionConfigItem<A extends PolicyActionType>
extends ConfigurationItem<A>

See Also:

• Serialized Form

Field Summary

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

DESC

Constructor Summary

Constructors

Constructor	Description
PolicyActionConfigItem(@NotNull ConfigurationItem<A> original)
PolicyActionConfigItem(A value, @NotNull ConfigurationItemOrigin origin)

Method Summary

Modifier and Type	Method	Description
default void	checkNamespace(@NotNull QName name, String expectedNamespace)
PolicyActionConfigItem<A>	clone()	Intentionally not calling super.clone, as the value is final (and we have to clone it); so we would have to hack this using reflection turning off the `final` flag.
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.
@Nullable ExpressionConfigItem	getCondition()
default @NotNull String	getLocalPart(@NotNull QName name, String expectedNamespace)
@Nullable String	getName()
@NotNull String	getTypeName()	Preliminary implementation, will probably change.
@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 @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, configItem, configItem, configItemNullable, embedded, embeddedNullable, equals, fullDescription, fullOriginLessDescription, hashCode, of, ofList, origin, toString, value, value

Methods inherited from class java.lang.Object

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

Constructor Details

PolicyActionConfigItem

public PolicyActionConfigItem(@NotNull
 @NotNull ConfigurationItem<A> original)

PolicyActionConfigItem

public PolicyActionConfigItem(@NotNull
 A value,
 @NotNull
 @NotNull ConfigurationItemOrigin origin)

Method Details

localDescription

@NotNull
public @NotNull String localDescription()

Description copied from class: ConfigurationItem

To be overridden in specific subclasses.

Overrides:

localDescription in class ConfigurationItem<A extends PolicyActionType>

clone

public PolicyActionConfigItem<A> clone()

Description copied from class: ConfigurationItem

Intentionally not calling super.clone, as the value is final (and we have to clone it); so we would have to hack this using reflection turning off the `final` flag.

Overrides:

clone in class ConfigurationItem<A extends PolicyActionType>

getName

@Nullable
public @Nullable String getName()

getCondition

@Nullable
public @Nullable ExpressionConfigItem getCondition()

getTypeName

@NotNull
public @NotNull String getTypeName()

Preliminary implementation, will probably change.

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)