Package com.evolveum.midpoint.schema.config

Interface ShadowAssociationTypeParticipantDefinitionConfigItem<PT extends ShadowAssociationTypeParticipantDefinitionType>

All Known Implementing Classes:

ShadowAssociationTypeObjectDefinitionConfigItem, ShadowAssociationTypeSubjectDefinitionConfigItem

public interface ShadowAssociationTypeParticipantDefinitionConfigItem<PT extends ShadowAssociationTypeParticipantDefinitionType>

Method Summary

Modifier and Type	Method	Description
<X extends ConfigurationItem<T>> X	as(@NotNull Class<X> clazz)
default void	checkNamespace(@NotNull QName name, String expectedNamespace)
<X extends Serializable & Cloneable, CI extends ConfigurationItem<X>> CI	child(X value, @NotNull Class<CI> clazz, Object... pathSegments)
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.
@NotNull String	fullDescription()
default @Nullable ShadowAssociationDefinitionConfigItem	getAssociation()
default @NotNull ItemName	getAssociationNameRequired()	This is the name under which we declare the association.
default @NotNull String	getLocalPart(@NotNull QName name, String expectedNamespace)
default @Nullable ItemName	getReferenceAttributeNameOptional()	Returns the name of the reference attribute (native/simulated) this association type participation is based on.
default @NotNull ItemName	getReferenceAttributeNameRequired()	Returns the name of the reference attribute (native/simulated) this association type participation is based on.
default @NotNull Collection<? extends ResourceObjectTypeIdentification>	getTypeIdentifiers()
default boolean	isBasedOnReferenceAttribute(@NotNull ItemName refAttrName)
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.
@NotNull ConfigurationItemOrigin	origin()	See ConfigurationItem.origin.
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)
PT	value()	See ConfigurationItem.value.

Method Details

getTypeIdentifiers

@NotNull
default @NotNull Collection<? extends ResourceObjectTypeIdentification> getTypeIdentifiers()
                                                                                    throws ConfigurationException

Throws:

ConfigurationException

getAssociationNameRequired

@NotNull
default @NotNull ItemName getAssociationNameRequired()
                                              throws ConfigurationException

This is the name under which we declare the association. It may be the same as the foundational (native/simulated) reference attribute, or it can be a different one.

Throws:

ConfigurationException

getReferenceAttributeNameRequired

@NotNull
default @NotNull ItemName getReferenceAttributeNameRequired()
                                                     throws ConfigurationException

Returns the name of the reference attribute (native/simulated) this association type participation is based on. Useful for subject-side participant.

Throws:

ConfigurationException

getReferenceAttributeNameOptional

@Nullable
default @Nullable ItemName getReferenceAttributeNameOptional()
                                                      throws ConfigurationException

Returns the name of the reference attribute (native/simulated) this association type participation is based on. Useful for object-side participant.

Throws:

ConfigurationException

isBasedOnReferenceAttribute

default boolean isBasedOnReferenceAttribute(@NotNull
 @NotNull ItemName refAttrName)
                                     throws ConfigurationException

Throws:

ConfigurationException

getAssociation

@Nullable
default @Nullable ShadowAssociationDefinitionConfigItem getAssociation()

value

@NotNull
PT value()

See ConfigurationItem.value.

origin

@NotNull
@NotNull ConfigurationItemOrigin origin()

See ConfigurationItem.origin.

as

@NotNull
<X extends ConfigurationItem<T>> X as(@NotNull
 @NotNull Class<X> clazz)

child

@Contract("null, _, _ -> null; !null, _, _ -> !null")
<X extends Serializable & Cloneable,
CI extends ConfigurationItem<X>>
CI child(@Nullable
 X value,
 @NotNull
 @NotNull Class<CI> clazz,
 Object... pathSegments)

fullDescription

@NotNull
@NotNull String fullDescription()

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)