Package com.evolveum.midpoint.schema.processor

Class ShadowAssociationDefinitionImpl

java.lang.Object

com.evolveum.midpoint.prism.AbstractFreezable

com.evolveum.midpoint.schema.processor.ShadowAssociationDefinitionImpl

All Implemented Interfaces:

Definition, Definition.DefinitionMutator, Freezable, ItemDefinition<PrismContainer<ShadowAssociationValueType>>, ItemDefinition.ItemDefinitionMutator, LivePrismItemDefinition, LocalItemDefinitionStore, PrismContainerDefinition<ShadowAssociationValueType>, PrismContainerDefinition.PrismContainerDefinitionMutator<ShadowAssociationValueType>, PrismItemAccessDefinition, PrismItemAccessDefinition.Mutable, PrismItemBasicDefinition, PrismItemBasicDefinition.Mutable, PrismItemStorageDefinition, PrismItemStorageDefinition.Mutable, PrismLifecycleDefinition, PrismLifecycleDefinition.Mutable, PrismPresentationDefinition, PrismPresentationDefinition.Mutable, Revivable, SchemaLookup.Aware, SmartVisitable<Definition>, Visitable<Definition>, ShadowAssociationDefinition, ShadowItemDefinition, DebugDumpable, Serializable, Cloneable

public class ShadowAssociationDefinitionImpl
extends AbstractFreezable
implements ShadowAssociationDefinition, PrismContainerDefinition.PrismContainerDefinitionMutator<ShadowAssociationValueType>

The (currently) only implementation of ShadowAssociationDefinition. TODO Effectively immutable? (if constituent definitions are immutable), except for the ability of changing the maxOccurs value. - is this still true?

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.Definition

Definition.DefinitionBuilder, Definition.DefinitionMutator

Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.ItemDefinition

ItemDefinition.ItemDefinitionLikeBuilder, ItemDefinition.ItemDefinitionMutator

Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.PrismContainerDefinition

PrismContainerDefinition.PrismContainerDefinitionMutator<C extends Containerable>

Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.PrismItemAccessDefinition

PrismItemAccessDefinition.Data, PrismItemAccessDefinition.Delegable, PrismItemAccessDefinition.Info, PrismItemAccessDefinition.Mutable

Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.PrismItemAccessDefinition.Mutable

PrismItemAccessDefinition.Mutable.Delegable

Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.PrismItemBasicDefinition

PrismItemBasicDefinition.Data, PrismItemBasicDefinition.Delegable, PrismItemBasicDefinition.Mutable

Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.PrismItemBasicDefinition.Mutable

PrismItemBasicDefinition.Mutable.Delegable

Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.PrismItemStorageDefinition

PrismItemStorageDefinition.Mutable

Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.PrismLifecycleDefinition

PrismLifecycleDefinition.Data, PrismLifecycleDefinition.Delegable, PrismLifecycleDefinition.Mutable

Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.PrismLifecycleDefinition.Mutable

PrismLifecycleDefinition.Mutable.Delegable

Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.PrismPresentationDefinition

PrismPresentationDefinition.Data, PrismPresentationDefinition.Delegable, PrismPresentationDefinition.Mutable

Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.PrismPresentationDefinition.Mutable

PrismPresentationDefinition.Mutable.Delegable

Field Summary

Fields inherited from interface com.evolveum.midpoint.util.DebugDumpable

INDENT_STRING

Method Summary

Modifier and Type	Method	Description
void	accept(Visitor visitor)
boolean	accept(Visitor<Definition> visitor, SmartVisitation<Definition> visitation)
void	addSchemaMigration(SchemaMigration value)
boolean	canAdd()	Returns true if this item can be added: it can be part of an object that is created.
boolean	canModify()	Returns true if this item can be modified (updated).
boolean	canRead()	Returns true if this item can be read (displayed).
boolean	canRepresent(@NotNull QName type)	TODO
@NotNull ShadowAssociationDefinitionImpl	clone()
PrismContainerDefinition<ShadowAssociationValueType>	cloneWithNewDefinition(QName newItemName, ItemDefinition<?> newDefinition)	TODO
@NotNull ItemDefinition<PrismContainer<ShadowAssociationValueType>>	cloneWithNewName(@NotNull ItemName itemName)	Returns a clone of this definition, but with name changed to the provided one.
@NotNull PrismContainerDefinition<?>	cloneWithNewType(@NotNull QName newTypeName, @NotNull ComplexTypeDefinition newCtd)	Changes the type name and definition for this PCD.
PrismContainerDefinition<?>	createContainerDefinition(@NotNull QName name, @NotNull ComplexTypeDefinition ctd, int minOccurs, int maxOccurs)
PrismContainerDefinition<?>	createContainerDefinition(QName name, QName typeName, int minOccurs, int maxOccurs)
ContainerDelta<ShadowAssociationValueType>	createEmptyDelta()
@NotNull ContainerDelta<ShadowAssociationValueType>	createEmptyDelta(ItemPath path)	Creates an empty delta (with appropriate implementation class), pointing to this item definition, with a given path.
PrismPropertyDefinition<?>	createPropertyDefinition(String localName, QName propType)
PrismPropertyDefinition<?>	createPropertyDefinition(QName name, QName propType)
PrismPropertyDefinition<?>	createPropertyDefinition(QName name, QName propType, int minOccurs, int maxOccurs)
ShadowAssociationValue	createValue()	TODO
String	debugDump(int indent)
void	debugDumpShortToString(StringBuilder sb)	Used in debugDumping items.
ShadowAssociationDefinitionImpl	deepClone(@NotNull DeepCloneOperation operation)	TODO document
boolean	equals(Object o)
<ID extends ItemDefinition<?>> ID	findItemDefinition(@NotNull ItemPath path, @NotNull Class<ID> clazz)	Used to find a matching item definition _within_ this definition.
<A> A	getAnnotation(QName qname)	Returns generic definition annotation.
@Nullable Map<QName,Object>	getAnnotations()	Returns all annotations, as unmodifiable map.
@NotNull ResourceObjectDefinition	getAssociationDataObjectDefinition()	Returns the association object definition (for complex associations), or fails (for simple ones).
Class<ShadowAssociationValueType>	getCompileTimeClass()	Static (compile-time) class holding the container values.
@NotNull ComplexTypeDefinition	getComplexTypeDefinition()	Definition of the container values.
String	getDebugDumpClassName()
@NotNull List<? extends ItemDefinition<?>>	getDefinitions()	Returns a list of item definitions in this container.
String	getDeprecatedSince()
List<ItemDiagramSpecification>	getDiagrams()
DisplayHint	getDisplayHint()	Enumeration annotation that specifies how/whether the item should be displayed.
String	getDisplayName()	Returns display name.
Integer	getDisplayOrder()	Specifies an order in which the item should be displayed relative to other items at the same level.
String	getDocumentation()	Must contains tag because of html tags used in text.
String	getDocumentationPreview()	Returns only a first sentence of documentation.
@NotNull Collection<InboundMappingType>	getExplicitInboundMappingBeans()
@NotNull Collection<MappingType>	getExplicitOutboundMappingBeans()
String	getHelp()	Returns help string.
String	getHumanReadableDescription()
@NotNull ItemName	getItemName()	Gets the "canonical" name of the item for the definition.
int	getMaxOccurs()	Returns the number of maximal value occurrences.
@Nullable String	getMergerIdentifier()
@Nullable ItemMerger	getMergerInstance(@NotNull MergeStrategy strategy, @Nullable OriginMarker originMarker)
int	getMinOccurs()	Returns the number of minimal value occurrences.
@Nullable ShadowAssociationDefinitionType	getModernAssociationDefinitionBean()	Use with care.
@Nullable ShadowAssociationTypeDefinitionType	getModernAssociationTypeDefinitionBean()	Use with care.
@Nullable List<QName>	getNaturalKeyConstituents()
@Nullable NaturalKeyDefinition	getNaturalKeyInstance()
@NotNull com.google.common.collect.Multimap<QName,ShadowRelationParticipantType>	getObjectParticipants()	Provides information on acceptable types of shadows participating in this association as objects.
String	getPlannedRemoval()	Version of data model in which the item is likely to be removed.
ItemProcessing	getProcessing()
List<PrismPropertyDefinition<?>>	getPropertyDefinitions()	Returns set of property definitions.
@NotNull ShadowReferenceAttributeDefinition	getReferenceAttributeDefinition()
String	getRemovedSince()
@Nullable SchemaContextDefinition	getSchemaContextDefinition()
@Nullable List<SchemaMigration>	getSchemaMigrations()
@NotNull ItemPath	getStandardPath()
QName	getSubstitutionHead()	Returns the name of an element this one can be substituted for (e.g.
@NotNull Class<ShadowAssociationValueType>	getTypeClass()	Returns a compile-time class that is used to represent items.
@NotNull QName	getTypeName()	Returns a name of the type for this definition.
PrismReferenceValue	getValueEnumerationRef()	Reference to an object that directly or indirectly represents possible values for this item.
int	hashCode()
@NotNull ShadowAssociation	instantiate()	Create an item instance.
@NotNull PrismContainer<ShadowAssociationValueType>	instantiate(QName name)	Create an item instance.
boolean	isAbstract()	For types: is the type abstract so that it should not be instantiated directly? For items: TODO
boolean	isAlwaysUseForEquals()	Item which should always be used for equals even if it is operational and strategy does not consider operational items.
boolean	isComplex()	True if this is a "complex" association (with association data object), false if it's a trivial one.
boolean	isDeprecated()
boolean	isDynamic()	Returns true if definition was created during the runtime based on a dynamic information such as xsi:type attributes in XML.
boolean	isElaborate()	Elaborate items are complicated data structure that may deviate from normal principles of the system.
boolean	isEmphasized()	True for definitions that are more important than others and that should be emphasized during presentation.
boolean	isEmpty()	TODO
boolean	isEntitlement()
boolean	isExperimental()	Experimental functionality is not stable and it may be changed in any future release without any warning.
boolean	isHeterogeneousListItem()	Can be used in heterogeneous lists as a list item.
Boolean	isIndexed()	This is XSD annotation that specifies whether a property should be indexed in the storage.
boolean	isIndexOnly()	If true, this item is not stored in XML representation in repo.
boolean	isInherited()	Whether the item is inherited from a supertype.
boolean	isOperational()	Marks operational item.
boolean	isOptionalCleanup()	Marks item that could be ignored by SCM tools (e.g.
boolean	isRemoved()
boolean	isRuntimeSchema()	This means that this particular definition (of an item or of a type) is part of the runtime schema, e.g.
boolean	isTolerant()
boolean	isValidFor(@NotNull QName elementQName, @NotNull Class<? extends ItemDefinition<?>> clazz, boolean caseInsensitive)	Returns true if this definition is valid for given element name and definition class, in either case-sensitive (the default) or case-insensitive way.
boolean	isVisible(ExecutionModeProvider modeProvider)
@NotNull PrismContainerDefinition.PrismContainerDefinitionMutator<ShadowAssociationValueType>	mutator()	Returns an interface to mutate this definition.
void	replaceDefinition(QName itemName, ItemDefinition<?> newDefinition)	TODO
void	revive(PrismContext prismContext)	TODO: Is revive necessary if prism context is static? TODO document (if it's found to be necessary)
void	setAlwaysUseForEquals(boolean alwaysUseForEquals)
<A> void	setAnnotation(QName qname, A value)
void	setCanAdd(boolean val)
void	setCanModify(boolean val)
void	setCanRead(boolean val)
void	setCompileTimeClass(Class<ShadowAssociationValueType> compileTimeClass)
void	setComplexTypeDefinition(ComplexTypeDefinition complexTypeDefinition)
void	setDeprecated(boolean deprecated)
void	setDeprecatedSince(String value)
void	setDiagrams(List<ItemDiagramSpecification> value)
void	setDisplayHint(DisplayHint displayHint)
void	setDisplayName(String displayName)
void	setDisplayOrder(Integer displayOrder)
void	setDocumentation(String documentation)
void	setDynamic(boolean value)
void	setElaborate(boolean value)
void	setEmphasized(boolean emphasized)
void	setExperimental(boolean experimental)
void	setHelp(String help)
void	setHeterogeneousListItem(boolean value)
void	setIndexed(Boolean indexed)
void	setIndexOnly(boolean value)
void	setInherited(boolean value)
void	setMaxOccurs(int value)
void	setMergerIdentifier(String value)
void	setMinOccurs(int value)
void	setNaturalKeyConstituents(List<QName> naturalKeyConstituents)
void	setOperational(boolean operational)
void	setOptionalCleanup(boolean optionalCleanup)
void	setPlannedRemoval(String value)
void	setProcessing(ItemProcessing processing)
void	setReadOnly()
void	setRemoved(boolean removed)
void	setRemovedSince(String removedSince)
void	setRuntimeSchema(boolean value)
void	setSchemaContextDefinition(SchemaContextDefinition schemaContextDefinition)
void	setSchemaMigrations(List<SchemaMigration> value)
void	setSearchable(boolean value)
void	setSubstitutionHead(QName value)
void	setValueEnumerationRef(PrismReferenceValue valueEnumerationRef)
void	shortDump(StringBuilder sb)
String	toString()

Methods inherited from class com.evolveum.midpoint.prism.AbstractFreezable

freeze, freeze, freezeAll, freezeNullableList, isImmutable, isMutable, performFreeze

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.evolveum.midpoint.util.DebugDumpable

debugDump, debugDumpLazily, debugDumpLazily

Methods inherited from interface com.evolveum.midpoint.prism.Definition

checkMutableOnExposing, debugDump, getMutabilityFlag

Methods inherited from interface com.evolveum.midpoint.prism.Freezable

checkImmutable, checkMutable, freeze, isImmutable

Methods inherited from interface com.evolveum.midpoint.prism.ItemDefinition

isIgnored

Methods inherited from interface com.evolveum.midpoint.prism.ItemDefinition.ItemDefinitionMutator

setIgnored

Methods inherited from interface com.evolveum.midpoint.prism.LocalItemDefinitionStore

containsItemDefinition, findContainerDefinition, findItemDefinition, findLocalItemDefinition, findLocalItemDefinition, findPropertyDefinition, findReferenceDefinition

Methods inherited from interface com.evolveum.midpoint.prism.PrismContainerDefinition

getAlwaysUseForEquals, getItemNames, isAlwaysUseForEquals, isCompletelyDefined, schemaLookup, structuredType

Methods inherited from interface com.evolveum.midpoint.prism.PrismContainerDefinition.PrismContainerDefinitionMutator

setAlwaysUseForEquals

Methods inherited from interface com.evolveum.midpoint.prism.PrismItemAccessDefinition

getInfo

Methods inherited from interface com.evolveum.midpoint.prism.PrismItemAccessDefinition.Mutable

setInfo

Methods inherited from interface com.evolveum.midpoint.prism.PrismItemBasicDefinition

isMandatory, isMultiValue, isOptional, isSingleValue

Methods inherited from interface com.evolveum.midpoint.prism.PrismItemStorageDefinition

isSearchable

Methods inherited from interface com.evolveum.midpoint.schema.processor.ShadowAssociationDefinition

createTargetObjectsFilter, createValueFromDefaultObject, createValueFromDefaultObjectRef, createValueFromFullDefaultObject, getIntolerantValuePatterns, getObjectParticipant, getObjectParticipantNames, getRepresentativeTargetObjectDefinition, getResourceOid, getTolerantValuePatterns, matches

Method Details

isComplex

public boolean isComplex()

Description copied from interface: ShadowAssociationDefinition

True if this is a "complex" association (with association data object), false if it's a trivial one.

Specified by:

isComplex in interface ShadowAssociationDefinition

getAssociationDataObjectDefinition

@NotNull
public @NotNull ResourceObjectDefinition getAssociationDataObjectDefinition()

Description copied from interface: ShadowAssociationDefinition

Returns the association object definition (for complex associations), or fails (for simple ones).

Specified by:

getAssociationDataObjectDefinition in interface ShadowAssociationDefinition

getProcessing

public ItemProcessing getProcessing()

Specified by:

getProcessing in interface ItemDefinition<PrismContainer<ShadowAssociationValueType>>

isOperational

public boolean isOperational()

Description copied from interface: ItemDefinition

Marks operational item. Operational properties are auxiliary data (or meta-data) that are usually not modifiable by the end user. They are generated and maintained by the system. Operational items are also not usually displayed unless it is explicitly requested. The example of operational items are modification timestamps, create timestamps, user that made the last change, etc. They are also treated in a special way when comparing values. See ParameterizedEquivalenceStrategy.

Specified by:

isOperational in interface ItemDefinition<PrismContainer<ShadowAssociationValueType>>

isAlwaysUseForEquals

public boolean isAlwaysUseForEquals()

Description copied from interface: ItemDefinition

Item which should always be used for equals even if it is operational and strategy does not consider operational items. EXPERIMENTAL

Specified by:

isAlwaysUseForEquals in interface ItemDefinition<PrismContainer<ShadowAssociationValueType>>

isInherited

public boolean isInherited()

Description copied from interface: ItemDefinition

Whether the item is inherited from a supertype.

Specified by:

isInherited in interface ItemDefinition<PrismContainer<ShadowAssociationValueType>>

isDynamic

public boolean isDynamic()

Description copied from interface: ItemDefinition

Returns true if definition was created during the runtime based on a dynamic information such as xsi:type attributes in XML. This means that the definition needs to be stored alongside the data to have a successful serialization "roundtrip". The definition is not part of any schema and therefore cannot be determined. It may even be different for every instance of the associated item (element name).

Specified by:

isDynamic in interface ItemDefinition<PrismContainer<ShadowAssociationValueType>>

getSubstitutionHead

public QName getSubstitutionHead()

Description copied from interface: ItemDefinition

Returns the name of an element this one can be substituted for (e.g. c:user -> c:object, s:pipeline -> s:expression, etc). EXPERIMENTAL

Specified by:

getSubstitutionHead in interface ItemDefinition<PrismContainer<ShadowAssociationValueType>>

isHeterogeneousListItem

public boolean isHeterogeneousListItem()

Description copied from interface: ItemDefinition

Can be used in heterogeneous lists as a list item. EXPERIMENTAL.

Specified by:

isHeterogeneousListItem in interface ItemDefinition<PrismContainer<ShadowAssociationValueType>>

getValueEnumerationRef

public PrismReferenceValue getValueEnumerationRef()

Description copied from interface: ItemDefinition

Reference to an object that directly or indirectly represents possible values for this item. We do not define here what exactly the object has to be. It can be a lookup table, script that dynamically produces the values or anything similar. The object must produce the values of the correct type for this item otherwise an error occurs.

Specified by:

getValueEnumerationRef in interface ItemDefinition<PrismContainer<ShadowAssociationValueType>>

instantiate

@NotNull
public @NotNull ShadowAssociation instantiate()
                                       throws SchemaException

Description copied from interface: ItemDefinition

Create an item instance. Definition name or default name will be used as an element name for the instance. The instance will otherwise be empty.

Specified by:

instantiate in interface ItemDefinition<PrismContainer<ShadowAssociationValueType>>

Specified by:

instantiate in interface ShadowAssociationDefinition

Throws:

SchemaException

instantiate

@NotNull
public @NotNull PrismContainer<ShadowAssociationValueType> instantiate(QName name)
                                                                throws SchemaException

Description copied from interface: ItemDefinition

Create an item instance. Definition name will use provided name. for the instance. The instance will otherwise be empty.

Specified by:

instantiate in interface ItemDefinition<PrismContainer<ShadowAssociationValueType>>

Throws:

SchemaException

getItemName

@NotNull
public @NotNull ItemName getItemName()

Description copied from interface: PrismItemBasicDefinition

Gets the "canonical" name of the item for the definition. Should be qualified, if at all possible.

Specified by:

getItemName in interface PrismItemBasicDefinition

getTypeName

@NotNull
public @NotNull QName getTypeName()

Description copied from interface: Definition

Returns a name of the type for this definition. The type can be part of the compile-time schema or it can be defined at run time. Examples of the former case are types like c:UserType, xsd:string, or even flexible ones like c:ExtensionType or c:ShadowAttributesType. Examples of the latter case are types used in - custom extensions, like ext:LocationsType (where ext = e.g. http://example.com/extension), - resource schema, like ri:inetOrgPerson (ri = http://.../resource/instance-3), - connector schema, like TODO In XML representation that corresponds to the name of the XSD type. Although beware, the run-time types do not have statically defined structure. And the resource and connector-related types may even represent different kinds of objects within different contexts (e.g. two distinct resources both with ri:AccountObjectClass types). Also note that for complex type definitions, the type name serves as a unique identifier. On the other hand, for item definitions, it is just one of its attributes; primary key is item name in that case. The type name should be fully qualified. (TODO reconsider this)

Specified by:

getTypeName in interface Definition

Specified by:

getTypeName in interface PrismItemBasicDefinition

Returns:

the type name

getMinOccurs

public int getMinOccurs()

Description copied from interface: PrismItemBasicDefinition

Returns the number of minimal value occurrences.

Specified by:

getMinOccurs in interface PrismItemBasicDefinition

isRuntimeSchema

public boolean isRuntimeSchema()

Description copied from interface: Definition

This means that this particular definition (of an item or of a type) is part of the runtime schema, e.g. extension schema, resource schema or connector schema or something like that. I.e. it is not defined statically.

Specified by:

isRuntimeSchema in interface Definition

isAbstract

public boolean isAbstract()

Description copied from interface: Definition

For types: is the type abstract so that it should not be instantiated directly? For items: TODO

Specified by:

isAbstract in interface Definition

isOptionalCleanup

public boolean isOptionalCleanup()

Description copied from interface: Definition

Marks item that could be ignored by SCM tools (e.g. Git), or removed before commit.

Specified by:

isOptionalCleanup in interface Definition

isElaborate

public boolean isElaborate()

Description copied from interface: Definition

Elaborate items are complicated data structure that may deviate from normal principles of the system. For example elaborate items may not be supported in user interface and may only be manageable by raw edits or a special-purpose tools. Elaborate items may be not fully supported by authorizations, schema tools and so on.

Specified by:

isElaborate in interface Definition

accept

public void accept(Visitor visitor)

Specified by:

accept in interface Visitable<Definition>

getMaxOccurs

public int getMaxOccurs()

Description copied from interface: PrismItemBasicDefinition

Returns the number of maximal value occurrences. Any negative number means "unbounded".

Specified by:

getMaxOccurs in interface PrismItemBasicDefinition

setMinOccurs

public void setMinOccurs(int value)

Specified by:

setMinOccurs in interface PrismItemBasicDefinition.Mutable

setMaxOccurs

public void setMaxOccurs(int value)

Specified by:

setMaxOccurs in interface PrismItemBasicDefinition.Mutable

isValidFor

public boolean isValidFor(@NotNull
 @NotNull QName elementQName,
 @NotNull
 @NotNull Class<? extends ItemDefinition<?>> clazz,
 boolean caseInsensitive)

Description copied from interface: LivePrismItemDefinition

Returns true if this definition is valid for given element name and definition class, in either case-sensitive (the default) or case-insensitive way. Used e.g. for "slow" path lookup where we iterate over all definitions in a complex type.

Specified by:

isValidFor in interface LivePrismItemDefinition

findItemDefinition

public <ID extends ItemDefinition<?>> ID findItemDefinition(@NotNull
 @NotNull ItemPath path,
 @NotNull
 @NotNull Class<ID> clazz)

Description copied from interface: LivePrismItemDefinition

Used to find a matching item definition _within_ this definition. Treats e.g. de-referencing in prism references.

Specified by:

findItemDefinition in interface LivePrismItemDefinition

Specified by:

findItemDefinition in interface LocalItemDefinitionStore

Specified by:

findItemDefinition in interface ShadowAssociationDefinition

Specified by:

findItemDefinition in interface ShadowItemDefinition

getExplicitOutboundMappingBeans

@NotNull
public @NotNull Collection<MappingType> getExplicitOutboundMappingBeans()

Specified by:

getExplicitOutboundMappingBeans in interface ShadowAssociationDefinition

getExplicitInboundMappingBeans

@NotNull
public @NotNull Collection<InboundMappingType> getExplicitInboundMappingBeans()

Specified by:

getExplicitInboundMappingBeans in interface ShadowAssociationDefinition

isVisible

public boolean isVisible(ExecutionModeProvider modeProvider)

Specified by:

isVisible in interface ShadowAssociationDefinition

getCompileTimeClass

public Class<ShadowAssociationValueType> getCompileTimeClass()

Description copied from interface: PrismContainerDefinition

Static (compile-time) class holding the container values. May be null. (Let's not mark it as @Nullable to avoid lots of warnings.)

Specified by:

getCompileTimeClass in interface PrismContainerDefinition<ShadowAssociationValueType>

getComplexTypeDefinition

@NotNull
public @NotNull ComplexTypeDefinition getComplexTypeDefinition()

Description copied from interface: PrismContainerDefinition

Definition of the container values. May be null. (Let's not mark it as @Nullable to avoid lots of warnings.) Note that individual values can hold their own (more specific) complex type definitions.

Specified by:

getComplexTypeDefinition in interface PrismContainerDefinition<ShadowAssociationValueType>

getDefinitions

@NotNull
public @NotNull List<? extends ItemDefinition<?>> getDefinitions()

Description copied from interface: PrismContainerDefinition

Returns a list of item definitions in this container. It is intentionally a List because it is ordered. (To provide standard format for serialization.) Usually obtained from ComplexTypeDefinition. So please do not modify the content of the list!

Specified by:

getDefinitions in interface LocalItemDefinitionStore

Specified by:

getDefinitions in interface PrismContainerDefinition<ShadowAssociationValueType>

getPropertyDefinitions

public List<PrismPropertyDefinition<?>> getPropertyDefinitions()

Description copied from interface: PrismContainerDefinition

Returns set of property definitions. The set contains all property definitions of all types that were parsed. Order of definitions is insignificant. The returned collection is immutable or detached from the source. Don't try to modify it. It may fail or the changes may be lost.

Specified by:

getPropertyDefinitions in interface PrismContainerDefinition<ShadowAssociationValueType>

createEmptyDelta

@NotNull
public @NotNull ContainerDelta<ShadowAssociationValueType> createEmptyDelta(ItemPath path)

Description copied from interface: ItemDefinition

Creates an empty delta (with appropriate implementation class), pointing to this item definition, with a given path.

Specified by:

createEmptyDelta in interface ItemDefinition<PrismContainer<ShadowAssociationValueType>>

Specified by:

createEmptyDelta in interface PrismContainerDefinition<ShadowAssociationValueType>

clone

@NotNull
public @NotNull ShadowAssociationDefinitionImpl clone()

Specified by:

clone in interface Definition

Specified by:

clone in interface ItemDefinition<PrismContainer<ShadowAssociationValueType>>

Specified by:

clone in interface PrismContainerDefinition<ShadowAssociationValueType>

Specified by:

clone in interface ShadowAssociationDefinition

Overrides:

clone in class Object

cloneWithNewDefinition

public PrismContainerDefinition<ShadowAssociationValueType> cloneWithNewDefinition(QName newItemName,
 ItemDefinition<?> newDefinition)

Description copied from interface: PrismContainerDefinition

TODO

Specified by:

cloneWithNewDefinition in interface PrismContainerDefinition<ShadowAssociationValueType>

replaceDefinition

public void replaceDefinition(QName itemName,
 ItemDefinition<?> newDefinition)

Description copied from interface: PrismContainerDefinition

TODO

Specified by:

replaceDefinition in interface PrismContainerDefinition<ShadowAssociationValueType>

createValue

public ShadowAssociationValue createValue()

Description copied from interface: PrismContainerDefinition

TODO

Specified by:

createValue in interface PrismContainerDefinition<ShadowAssociationValueType>

isEmpty

public boolean isEmpty()

Description copied from interface: PrismContainerDefinition

TODO

Specified by:

isEmpty in interface PrismContainerDefinition<ShadowAssociationValueType>

canRepresent

public boolean canRepresent(@NotNull
 @NotNull QName type)

Description copied from interface: PrismContainerDefinition

TODO

Specified by:

canRepresent in interface PrismContainerDefinition<ShadowAssociationValueType>

mutator

@NotNull
public @NotNull PrismContainerDefinition.PrismContainerDefinitionMutator<ShadowAssociationValueType> mutator()

Description copied from interface: Definition

Returns an interface to mutate this definition.

Specified by:

mutator in interface Definition

Specified by:

mutator in interface ItemDefinition<PrismContainer<ShadowAssociationValueType>>

Specified by:

mutator in interface PrismContainerDefinition<ShadowAssociationValueType>

deepClone

public ShadowAssociationDefinitionImpl deepClone(@NotNull
 @NotNull DeepCloneOperation operation)

Description copied from interface: ItemDefinition

TODO document

Specified by:

deepClone in interface ItemDefinition<PrismContainer<ShadowAssociationValueType>>

debugDumpShortToString

public void debugDumpShortToString(StringBuilder sb)

Description copied from interface: ItemDefinition

Used in debugDumping items. Does not need to have name in it as item already has it. Does not need to have class as that is just too much info that is almost anytime pretty obvious anyway.

Specified by:

debugDumpShortToString in interface ItemDefinition<PrismContainer<ShadowAssociationValueType>>

getDebugDumpClassName

public String getDebugDumpClassName()

debugDump

public String debugDump(int indent)

Specified by:

debugDump in interface DebugDumpable

getStandardPath

@NotNull
public @NotNull ItemPath getStandardPath()

Specified by:

getStandardPath in interface ShadowAssociationDefinition

createEmptyDelta

public ContainerDelta<ShadowAssociationValueType> createEmptyDelta()

Specified by:

createEmptyDelta in interface ShadowAssociationDefinition

revive

public void revive(PrismContext prismContext)

Description copied from interface: Revivable

TODO: Is revive necessary if prism context is static? TODO document (if it's found to be necessary)

Specified by:

revive in interface Revivable

accept

public boolean accept(Visitor<Definition> visitor,
 SmartVisitation<Definition> visitation)

Specified by:

accept in interface SmartVisitable<Definition>

Returns:

false if we already was here

getHumanReadableDescription

public String getHumanReadableDescription()

isEntitlement

public boolean isEntitlement()

Specified by:

isEntitlement in interface ShadowAssociationDefinition

shortDump

public void shortDump(StringBuilder sb)

getTypeClass

@NotNull
public @NotNull Class<ShadowAssociationValueType> getTypeClass()

Description copied from interface: Definition

Returns a compile-time class that is used to represent items. E.g. returns String, Integer, subclasses of Objectable and Containerable and so on.

Specified by:

getTypeClass in interface Definition

Specified by:

getTypeClass in interface PrismContainerDefinition<ShadowAssociationValueType>

getAnnotation

public <A> A getAnnotation(QName qname)

Description copied from interface: Definition

Returns generic definition annotation. Annotations are a method to extend schema definitions. This may be annotation stored in the schema definition file (e.g. XSD) or it may be a dynamic annotation determined at run-time. Annotation value should be a prism-supported object. E.g. a prims "bean" (JAXB annotated class), prism item, prism value or something like that. EXPERIMENTAL. Hic sunt leones. This may change at any moment. Note: annotations are only partially supported now (3.8). They are somehow transient. E.g. they are not serialized to XSD schema definitions (yet).

Specified by:

getAnnotation in interface Definition

getAnnotations

@Nullable
public @Nullable Map<QName,Object> getAnnotations()

Description copied from interface: Definition

Returns all annotations, as unmodifiable map. Nullable by design, to avoid creating lots of empty maps.

Specified by:

getAnnotations in interface Definition

getMergerIdentifier

@Nullable
public @Nullable String getMergerIdentifier()

Specified by:

getMergerIdentifier in interface Definition

getMergerInstance

@Nullable
public @Nullable ItemMerger getMergerInstance(@NotNull
 @NotNull MergeStrategy strategy,
 @Nullable
 @Nullable OriginMarker originMarker)

Specified by:

getMergerInstance in interface Definition

getNaturalKeyConstituents

@Nullable
public @Nullable List<QName> getNaturalKeyConstituents()

Specified by:

getNaturalKeyConstituents in interface Definition

getNaturalKeyInstance

@Nullable
public @Nullable NaturalKeyDefinition getNaturalKeyInstance()

Specified by:

getNaturalKeyInstance in interface Definition

getSchemaContextDefinition

@Nullable
public @Nullable SchemaContextDefinition getSchemaContextDefinition()

Specified by:

getSchemaContextDefinition in interface Definition

cloneWithNewName

@NotNull
public @NotNull ItemDefinition<PrismContainer<ShadowAssociationValueType>> cloneWithNewName(@NotNull
 @NotNull ItemName itemName)

Description copied from interface: ItemDefinition

Returns a clone of this definition, but with name changed to the provided one.

Specified by:

cloneWithNewName in interface ItemDefinition<PrismContainer<ShadowAssociationValueType>>

See Also:

• PrismContainerDefinition.cloneWithNewDefinition(QName, ItemDefinition)

cloneWithNewType

@NotNull
public @NotNull PrismContainerDefinition<?> cloneWithNewType(@NotNull
 @NotNull QName newTypeName,
 @NotNull
 @NotNull ComplexTypeDefinition newCtd)

Description copied from interface: PrismContainerDefinition

Changes the type name and definition for this PCD. Use only in special cases.

Specified by:

cloneWithNewType in interface PrismContainerDefinition<ShadowAssociationValueType>

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

setCompileTimeClass

public void setCompileTimeClass(Class<ShadowAssociationValueType> compileTimeClass)

Specified by:

setCompileTimeClass in interface PrismContainerDefinition.PrismContainerDefinitionMutator<ShadowAssociationValueType>

createPropertyDefinition

public PrismPropertyDefinition<?> createPropertyDefinition(QName name,
 QName propType,
 int minOccurs,
 int maxOccurs)

Specified by:

createPropertyDefinition in interface PrismContainerDefinition.PrismContainerDefinitionMutator<ShadowAssociationValueType>

createPropertyDefinition

public PrismPropertyDefinition<?> createPropertyDefinition(QName name,
 QName propType)

Specified by:

createPropertyDefinition in interface PrismContainerDefinition.PrismContainerDefinitionMutator<ShadowAssociationValueType>

createPropertyDefinition

public PrismPropertyDefinition<?> createPropertyDefinition(String localName,
 QName propType)

Specified by:

createPropertyDefinition in interface PrismContainerDefinition.PrismContainerDefinitionMutator<ShadowAssociationValueType>

createContainerDefinition

public PrismContainerDefinition<?> createContainerDefinition(QName name,
 QName typeName,
 int minOccurs,
 int maxOccurs)

Specified by:

createContainerDefinition in interface PrismContainerDefinition.PrismContainerDefinitionMutator<ShadowAssociationValueType>

createContainerDefinition

public PrismContainerDefinition<?> createContainerDefinition(@NotNull
 @NotNull QName name,
 @NotNull
 @NotNull ComplexTypeDefinition ctd,
 int minOccurs,
 int maxOccurs)

Specified by:

createContainerDefinition in interface PrismContainerDefinition.PrismContainerDefinitionMutator<ShadowAssociationValueType>

setComplexTypeDefinition

public void setComplexTypeDefinition(ComplexTypeDefinition complexTypeDefinition)

Specified by:

setComplexTypeDefinition in interface PrismContainerDefinition.PrismContainerDefinitionMutator<ShadowAssociationValueType>

setProcessing

public void setProcessing(ItemProcessing processing)

Specified by:

setProcessing in interface ItemDefinition.ItemDefinitionMutator

setValueEnumerationRef

public void setValueEnumerationRef(PrismReferenceValue valueEnumerationRef)

Specified by:

setValueEnumerationRef in interface ItemDefinition.ItemDefinitionMutator

setOperational

public void setOperational(boolean operational)

Specified by:

setOperational in interface ItemDefinition.ItemDefinitionMutator

setAlwaysUseForEquals

public void setAlwaysUseForEquals(boolean alwaysUseForEquals)

Specified by:

setAlwaysUseForEquals in interface ItemDefinition.ItemDefinitionMutator

setDynamic

public void setDynamic(boolean value)

Specified by:

setDynamic in interface ItemDefinition.ItemDefinitionMutator

setReadOnly

public void setReadOnly()

Specified by:

setReadOnly in interface ItemDefinition.ItemDefinitionMutator

setDeprecatedSince

public void setDeprecatedSince(String value)

Specified by:

setDeprecatedSince in interface ItemDefinition.ItemDefinitionMutator

Specified by:

setDeprecatedSince in interface PrismLifecycleDefinition.Mutable

addSchemaMigration

public void addSchemaMigration(SchemaMigration value)

Specified by:

addSchemaMigration in interface PrismLifecycleDefinition.Mutable

setSchemaMigrations

public void setSchemaMigrations(List<SchemaMigration> value)

Specified by:

setSchemaMigrations in interface PrismLifecycleDefinition.Mutable

setDeprecated

public void setDeprecated(boolean deprecated)

Specified by:

setDeprecated in interface PrismLifecycleDefinition.Mutable

setRemoved

public void setRemoved(boolean removed)

Specified by:

setRemoved in interface PrismLifecycleDefinition.Mutable

setRemovedSince

public void setRemovedSince(String removedSince)

Specified by:

setRemovedSince in interface PrismLifecycleDefinition.Mutable

setExperimental

public void setExperimental(boolean experimental)

Specified by:

setExperimental in interface PrismLifecycleDefinition.Mutable

setPlannedRemoval

public void setPlannedRemoval(String value)

Specified by:

setPlannedRemoval in interface ItemDefinition.ItemDefinitionMutator

Specified by:

setPlannedRemoval in interface PrismLifecycleDefinition.Mutable

setElaborate

public void setElaborate(boolean value)

Specified by:

setElaborate in interface ItemDefinition.ItemDefinitionMutator

setHeterogeneousListItem

public void setHeterogeneousListItem(boolean value)

Specified by:

setHeterogeneousListItem in interface ItemDefinition.ItemDefinitionMutator

setSubstitutionHead

public void setSubstitutionHead(QName value)

Specified by:

setSubstitutionHead in interface ItemDefinition.ItemDefinitionMutator

setIndexed

public void setIndexed(Boolean indexed)

Specified by:

setIndexed in interface PrismItemStorageDefinition.Mutable

setIndexOnly

public void setIndexOnly(boolean value)

Specified by:

setIndexOnly in interface ItemDefinition.ItemDefinitionMutator

Specified by:

setIndexOnly in interface PrismItemStorageDefinition.Mutable

setInherited

public void setInherited(boolean value)

Specified by:

setInherited in interface ItemDefinition.ItemDefinitionMutator

setSearchable

public void setSearchable(boolean value)

Specified by:

setSearchable in interface ItemDefinition.ItemDefinitionMutator

Specified by:

setSearchable in interface PrismItemStorageDefinition.Mutable

setOptionalCleanup

public void setOptionalCleanup(boolean optionalCleanup)

Specified by:

setOptionalCleanup in interface Definition.DefinitionMutator

setRuntimeSchema

public void setRuntimeSchema(boolean value)

Specified by:

setRuntimeSchema in interface Definition.DefinitionMutator

setMergerIdentifier

public void setMergerIdentifier(String value)

Specified by:

setMergerIdentifier in interface Definition.DefinitionMutator

setNaturalKeyConstituents

public void setNaturalKeyConstituents(List<QName> naturalKeyConstituents)

Specified by:

setNaturalKeyConstituents in interface Definition.DefinitionMutator

setAnnotation

public <A> void setAnnotation(QName qname,
 A value)

Specified by:

setAnnotation in interface Definition.DefinitionMutator

setSchemaContextDefinition

public void setSchemaContextDefinition(SchemaContextDefinition schemaContextDefinition)

Specified by:

setSchemaContextDefinition in interface Definition.DefinitionMutator

setCanRead

public void setCanRead(boolean val)

Specified by:

setCanRead in interface PrismItemAccessDefinition.Mutable

setCanModify

public void setCanModify(boolean val)

Specified by:

setCanModify in interface PrismItemAccessDefinition.Mutable

setCanAdd

public void setCanAdd(boolean val)

Specified by:

setCanAdd in interface PrismItemAccessDefinition.Mutable

setDisplayHint

public void setDisplayHint(DisplayHint displayHint)

Specified by:

setDisplayHint in interface PrismPresentationDefinition.Mutable

setEmphasized

public void setEmphasized(boolean emphasized)

Specified by:

setEmphasized in interface PrismPresentationDefinition.Mutable

setDisplayName

public void setDisplayName(String displayName)

Specified by:

setDisplayName in interface PrismPresentationDefinition.Mutable

setDisplayOrder

public void setDisplayOrder(Integer displayOrder)

Specified by:

setDisplayOrder in interface PrismPresentationDefinition.Mutable

setHelp

public void setHelp(String help)

Specified by:

setHelp in interface PrismPresentationDefinition.Mutable

setDocumentation

public void setDocumentation(String documentation)

Specified by:

setDocumentation in interface PrismPresentationDefinition.Mutable

setDiagrams

public void setDiagrams(List<ItemDiagramSpecification> value)

Specified by:

setDiagrams in interface PrismPresentationDefinition.Mutable

getReferenceAttributeDefinition

@NotNull
public @NotNull ShadowReferenceAttributeDefinition getReferenceAttributeDefinition()

Specified by:

getReferenceAttributeDefinition in interface ShadowAssociationDefinition

canRead

public boolean canRead()

Description copied from interface: PrismItemAccessDefinition

Returns true if this item can be read (displayed). In case of containers this flag is, strictly speaking, not applicable. Container is an empty shell. What matters is access to individual sub-item. However, for containers this value has a "hint" meaning. It means that the container itself contains something that is readable. Which can be used as a hint by the presentation to display container label or block. This usually happens if the container contains at least one readable item. This does NOT mean that also all the container items can be displayed. The sub-item permissions are controlled by similar properties on the items. This property only applies to the container itself: the "shell" of the container.

Note: It was considered to use a different meaning for this flag - a meaning that would allow canRead()=false containers to have readable items. However, this was found not to be very useful. Therefore the "something readable inside" meaning was confirmed instead.

Specified by:

canRead in interface PrismItemAccessDefinition

canModify

public boolean canModify()

Description copied from interface: PrismItemAccessDefinition

Returns true if this item can be modified (updated). In case of containers this means that the container itself should be displayed in modification forms E.g. that the container label or block should be displayed. This usually happens if the container contains at least one modifiable item. This does NOT mean that also all the container items can be modified. The sub-item permissions are controlled by similar properties on the items. This property only applies to the container itself: the "shell" of the container.

Specified by:

canModify in interface PrismItemAccessDefinition

canAdd

public boolean canAdd()

Description copied from interface: PrismItemAccessDefinition

Returns true if this item can be added: it can be part of an object that is created. In case of containers this means that the container itself should be displayed in creation forms E.g. that the container label or block should be displayed. This usually happens if the container contains at least one createable item. This does NOT mean that also all the container items can be created. The sub-item permissions are controlled by similar properties on the items. This property only applies to the container itself: the "shell" of the container.

Specified by:

canAdd in interface PrismItemAccessDefinition

isIndexed

public Boolean isIndexed()

Description copied from interface: PrismItemStorageDefinition

This is XSD annotation that specifies whether a property should be indexed in the storage. It can only apply to properties. It has following meaning: true: the property must be indexed. If the storage is not able to index the value, it should indicate an error. false: the property should not be indexed. null: data store decides whether to index the property or not.

Specified by:

isIndexed in interface PrismItemStorageDefinition

isIndexOnly

public boolean isIndexOnly()

Description copied from interface: PrismItemStorageDefinition

If true, this item is not stored in XML representation in repo. TODO better name

Specified by:

isIndexOnly in interface PrismItemStorageDefinition

isDeprecated

public boolean isDeprecated()

Specified by:

isDeprecated in interface PrismLifecycleDefinition

getDeprecatedSince

public String getDeprecatedSince()

Specified by:

getDeprecatedSince in interface PrismLifecycleDefinition

getPlannedRemoval

public String getPlannedRemoval()

Description copied from interface: PrismLifecycleDefinition

Version of data model in which the item is likely to be removed. This annotation is used for deprecated item to indicate imminent incompatibility in future versions of data model.

Specified by:

getPlannedRemoval in interface PrismLifecycleDefinition

isRemoved

public boolean isRemoved()

Specified by:

isRemoved in interface PrismLifecycleDefinition

getRemovedSince

public String getRemovedSince()

Specified by:

getRemovedSince in interface PrismLifecycleDefinition

isExperimental

public boolean isExperimental()

Description copied from interface: PrismLifecycleDefinition

Experimental functionality is not stable and it may be changed in any future release without any warning. Use at your own risk.

Specified by:

isExperimental in interface PrismLifecycleDefinition

getSchemaMigrations

@Nullable
public @Nullable List<SchemaMigration> getSchemaMigrations()

Specified by:

getSchemaMigrations in interface PrismLifecycleDefinition

getDisplayHint

public DisplayHint getDisplayHint()

Description copied from interface: PrismPresentationDefinition

Enumeration annotation that specifies how/whether the item should be displayed. It is also a replacement for the old "emphasized" annotation.

Specified by:

getDisplayHint in interface PrismPresentationDefinition

isEmphasized

public boolean isEmphasized()

Description copied from interface: PrismPresentationDefinition

True for definitions that are more important than others and that should be emphasized during presentation. E.g. the emphasized definitions will always be displayed in the user interfaces (even if they are empty), they will always be included in the dumps, etc. TODO probably deprecated, isn't it?

Specified by:

isEmphasized in interface PrismPresentationDefinition

getDisplayName

public String getDisplayName()

Description copied from interface: PrismPresentationDefinition

Returns display name. Specifies the printable name of the object class or attribute. It must contain a printable string. It may also contain a key to catalog file. Returns null if no display name is set. Corresponds to "displayName" XSD annotation.

Specified by:

getDisplayName in interface PrismPresentationDefinition

Returns:

display name string or catalog key

getDisplayOrder

public Integer getDisplayOrder()

Description copied from interface: PrismPresentationDefinition

Specifies an order in which the item should be displayed relative to other items at the same level. The items will be displayed by sorting them by the values of displayOrder annotation (ascending). Items that do not have any displayOrder annotation will be displayed last. The ordering of values with the same displayOrder is undefined and it may be arbitrary.

Specified by:

getDisplayOrder in interface PrismPresentationDefinition

getHelp

public String getHelp()

Description copied from interface: PrismPresentationDefinition

Returns help string. Specifies the help text or a key to catalog file for a help text. The help text may be displayed in any suitable way by the GUI. It should explain the meaning of an attribute or object class. Returns null if no help string is set. Corresponds to "help" XSD annotation.

Specified by:

getHelp in interface PrismPresentationDefinition

Returns:

help string or catalog key

getDocumentation

public String getDocumentation()

Description copied from interface: PrismPresentationDefinition

Must contains tag because of html tags used in text.

Specified by:

getDocumentation in interface PrismPresentationDefinition

getDiagrams

public List<ItemDiagramSpecification> getDiagrams()

Specified by:

getDiagrams in interface PrismPresentationDefinition

getDocumentationPreview

public String getDocumentationPreview()

Description copied from interface: PrismPresentationDefinition

Returns only a first sentence of documentation.

Specified by:

getDocumentationPreview in interface PrismPresentationDefinition

getObjectParticipants

@NotNull
public @NotNull com.google.common.collect.Multimap<QName,ShadowRelationParticipantType> getObjectParticipants()

Description copied from interface: ShadowAssociationDefinition

Provides information on acceptable types of shadows participating in this association as objects. These come from the underlying reference attribute definition, but can be further restricted by the association type definition.

Specified by:

getObjectParticipants in interface ShadowAssociationDefinition

isTolerant

public boolean isTolerant()

Specified by:

isTolerant in interface ShadowAssociationDefinition

getModernAssociationDefinitionBean

@Nullable
public @Nullable ShadowAssociationDefinitionType getModernAssociationDefinitionBean()

Description copied from interface: ShadowAssociationDefinition

Use with care. Please do not modify the returned value.

Specified by:

getModernAssociationDefinitionBean in interface ShadowAssociationDefinition

getModernAssociationTypeDefinitionBean

@Nullable
public @Nullable ShadowAssociationTypeDefinitionType getModernAssociationTypeDefinitionBean()

Description copied from interface: ShadowAssociationDefinition

Use with care. Please do not modify the returned value.

Specified by:

getModernAssociationTypeDefinitionBean in interface ShadowAssociationDefinition

toString

public String toString()

Overrides:

toString in class Object