Package com.evolveum.midpoint.schema.processor

Class ShadowReferenceAttributeDefinitionImpl

java.lang.Object

com.evolveum.midpoint.prism.AbstractFreezable

com.evolveum.midpoint.schema.processor.ShadowAttributeDefinitionImpl<ShadowReferenceAttributeValue,ShadowReferenceAttributeDefinition,Referencable,ShadowReferenceAttribute,NativeShadowReferenceAttributeDefinition>

com.evolveum.midpoint.schema.processor.ShadowReferenceAttributeDefinitionImpl

All Implemented Interfaces:

Definition, Definition.DefinitionMutator, Freezable, ItemDefinition<PrismReference>, ItemDefinition.ItemDefinitionMutator, LivePrismItemDefinition, PrismItemAccessDefinition, PrismItemAccessDefinition.Mutable, PrismItemBasicDefinition, PrismItemBasicDefinition.Mutable, PrismItemMiscDefinition, PrismItemStorageDefinition, PrismItemStorageDefinition.Mutable, PrismLifecycleDefinition, PrismLifecycleDefinition.Mutable, PrismPresentationDefinition, PrismPresentationDefinition.Mutable, PrismReferenceDefinition, PrismReferenceDefinition.PrismReferenceDefinitionMutator, Revivable, SchemaLookup.Aware, SmartVisitable<Definition>, Visitable<Definition>, LayeredDefinition, ResourceObjectInboundProcessingDefinition.ItemInboundProcessingDefinition, ShadowAttributeDefinition<ShadowReferenceAttributeValue,ShadowReferenceAttributeDefinition,Referencable,ShadowReferenceAttribute>, ShadowAttributeUcfDefinition, ShadowItemDefinition, ShadowItemLayeredDefinition, ShadowItemLifecycleDefinitionDefaults, ShadowReferenceAttributeDefinition, DebugDumpable, ShortDumpable, Serializable, Cloneable

public class ShadowReferenceAttributeDefinitionImpl
extends ShadowAttributeDefinitionImpl<ShadowReferenceAttributeValue,ShadowReferenceAttributeDefinition,Referencable,ShadowReferenceAttribute,NativeShadowReferenceAttributeDefinition>
implements ShadowReferenceAttributeDefinition, PrismReferenceDefinition.PrismReferenceDefinitionMutator

Definition of a shadow association item, e.g., `ri:group`. Note that unlike the attributes, here the ShadowAttributeDefinitionImpl.nativeDefinition may be generated artificially based on simulated ReferencesCapabilityType definition.

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.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.PrismItemMiscDefinition

PrismItemMiscDefinition.Data, PrismItemMiscDefinition.Delegable, PrismItemMiscDefinition.Mutable

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

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

PrismReferenceDefinition.PrismReferenceDefinitionBuilder, PrismReferenceDefinition.PrismReferenceDefinitionMutator

Nested classes/interfaces inherited from interface com.evolveum.midpoint.schema.processor.ShadowAttributeUcfDefinition

ShadowAttributeUcfDefinition.Data, ShadowAttributeUcfDefinition.Delegable, ShadowAttributeUcfDefinition.Mutable

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)
@NotNull ShadowReferenceAttributeDefinitionImpl	clone()
@NotNull ShadowReferenceAttributeDefinition	cloneWithNewCardinality(int newMinOccurs, int newMaxOccurs)
@NotNull ItemDefinition<PrismReference>	cloneWithNewName(@NotNull ItemName itemName)	Returns a clone of this definition, but with name changed to the provided one.
ReferenceDelta	createEmptyDelta()
@NotNull ReferenceDelta	createEmptyDelta(ItemPath path)	Creates an empty delta (with appropriate implementation class), pointing to this item definition, with a given path.
ShadowReferenceAttributeValue	createPrismValueFromRealValue(@NotNull Object realValue)
String	debugDump(int indent)
void	debugDumpShortToString(StringBuilder sb)	Used in debugDumping items.
ShadowReferenceAttributeDefinitionImpl	deepClone(@NotNull DeepCloneOperation operation)	TODO document
boolean	equals(Object o)
protected void	extendToString(StringBuilder sb)
<ID extends ItemDefinition<?>> ID	findItemDefinition(@NotNull ItemPath path, @NotNull Class<ID> clazz)	Used to find a matching item definition _within_ this definition.
@NotNull ShadowReferenceAttributeDefinitionImpl	forLayer(@NotNull LayerType layer)	Creates a view of the current definition for a given layer.
ItemCorrelatorDefinitionType	getCorrelatorDefinition()
String	getDebugDumpClassName()	Return a human readable name of this class suitable for logs.
@NotNull ResourceObjectDefinition	getGeneralizedObjectSideObjectDefinition()	ONLY FOR SUBJECT-SIDE PARTICIPANT (and always non-null for it) Returns generalized definition for objects at the object (target) side.
String	getHumanReadableDescription()
@NotNull ShadowReferenceParticipantRole	getParticipantRole()	What is the role of the object that holds this reference attribute in the subject-object relationship?
@Nullable SchemaContextDefinition	getSchemaContextDefinition()
@Nullable SimulatedShadowReferenceTypeDefinition	getSimulationDefinition()
SimulatedShadowReferenceTypeDefinition	getSimulationDefinitionRequired()
@NotNull Collection<ShadowRelationParticipantType>	getTargetParticipantTypes()	Returns types of the objects on the other side.
QName	getTargetTypeName()
@NotNull Class<Referencable>	getTypeClass()	Returns a compile-time class that is used to represent items.
@NotNull QName	getTypeName()	Returns a name of the type for this definition.
int	hashCode()
boolean	isComposite()
boolean	isSimulated()	If `true`, the item does not exist on the resource, but is simulated by midPoint.
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.
@NotNull PrismReferenceValue	migrateIfNeeded(@NotNull PrismReferenceValue value)	See ShadowAssociationDefinitionImpl.createComplexTypeDefinition() for analogous functionality (via value migrator).
PrismReferenceDefinition.PrismReferenceDefinitionMutator	mutator()	Returns an interface to mutate this definition.
void	revive(PrismContext prismContext)	TODO: Is revive necessary if prism context is static?
void	setAlwaysUseForEquals(boolean alwaysUseForEquals)
void	setCanAdd(boolean val)
void	setCanModify(boolean val)
void	setCanRead(boolean val)
void	setComposite(boolean value)
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	setTargetObjectDefinition(PrismObjectDefinition<?> definition)
void	setTargetTypeName(QName typeName)
void	setValueEnumerationRef(PrismReferenceValue valueEnumerationRef)
void	shortDump(StringBuilder sb)	Show the content of the object intended for diagnostics.

Methods inherited from class com.evolveum.midpoint.schema.processor.ShadowAttributeDefinitionImpl

canAdd, canAdd, canModify, canModify, canRead, canRead, debugDump, getAnnotation, getAnnotations, getChangeApplicationMode, getCurrentLayer, getDescription, getDiagrams, getDisplayHint, getDisplayName, getDisplayOrder, getDocumentation, getDocumentationPreview, getFetchStrategy, getFrameworkAttributeName, getHelp, getInboundMappingBeans, getIntolerantValuePatterns, getItemName, getLifecycleState, getLimitations, getMaxOccurs, getMaxOccurs, getMergerIdentifier, getMergerInstance, getMinOccurs, getMinOccurs, getModificationPriority, getNativeAttributeName, getNaturalKeyConstituents, getNaturalKeyInstance, getOutboundMappingBean, getProcessing, getProcessing, getReadReplaceMode, getReturnedByDefault, getSchemaMigrations, getStorageStrategy, getSubstitutionHead, getTolerantValuePatterns, getValueEnumerationRef, hasRefinements, instantiate, instantiate, isAbstract, isAlwaysUseForEquals, isCached, isDynamic, isElaborate, isEmphasized, isExclusiveStrong, isHeterogeneousListItem, isIndexed, isIndexOnly, isInherited, isOperational, isOptionalCleanup, isRuntimeSchema, isTolerant, isVolatileOnAddOperation, isVolatileOnModifyOperation, isVolatilityTrigger, performFreeze, setAnnotation, setOverrideCanAdd, setOverrideCanModify, setOverrideCanRead, structuredType, toString

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

freeze, freeze, freezeAll, freezeNullableList, isImmutable, isMutable

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, getAnnotation, getAnnotations, getMergerIdentifier, getMergerInstance, getMutabilityFlag, getNaturalKeyConstituents, getNaturalKeyInstance, isAbstract, isElaborate, isOptionalCleanup, isRuntimeSchema

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

setAnnotation

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

checkImmutable, checkMutable, freeze, isImmutable

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

getProcessing, getSubstitutionHead, getValueEnumerationRef, isAlwaysUseForEquals, isDynamic, isHeterogeneousListItem, isIgnored, isInherited, isOperational, structuredType

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

setIgnored

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

getCurrentLayer

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

canAdd, canModify, canRead, getInfo

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

setInfo

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

getItemName, getMaxOccurs, getMinOccurs, isMandatory, isMultiValue, isOptional, isSingleValue

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

getProcessing

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

isIndexed, isIndexOnly, isSearchable

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

getSchemaMigrations

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

getDiagrams, getDisplayHint, getDisplayName, getDisplayOrder, getDocumentation, getDocumentationPreview, getHelp, isEmphasized

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

getTargetObjectDefinition, instantiate, instantiate

Methods inherited from interface com.evolveum.midpoint.prism.schema.SchemaLookup.Aware

schemaLookup

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

debugDump, getChangeApplicationMode, getDescription, getFetchStrategy, getInboundMappingBeans, getIntolerantValuePatterns, getLifecycleState, getModificationPriority, getOutboundMappingBean, getReadReplaceMode, getStandardPath, getStorageStrategy, getTolerantValuePatterns, hasOutboundMapping, hasRefinements, instantiate, instantiate, instantiateFrom, instantiateFromRealValue, instantiateFromRealValues, isCached, isEffectivelyCached, isExclusiveStrong, isIgnored, isReturnedByDefault, isTolerant, isVisible, isVolatileOnAddOperation, isVolatileOnModifyOperation, isVolatilityTrigger, setOverrideCanAdd, setOverrideCanModify, setOverrideCanRead

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

getFrameworkAttributeName, getNativeAttributeName, getReturnedByDefault

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

isVisible

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

canAdd, canModify, canRead, getLimitations, getMaxOccurs, getMinOccurs, getProcessing, isMandatory, isMultiValue, isOptional, isSingleValue

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

getDeprecatedSince, getPlannedRemoval, getRemovedSince, isDeprecated, isExperimental, isRemoved

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

checkSubjectSide, createTargetObjectsFilter, getResourceOid, getTargetObjectClassName, isTargetingSingleEmbeddedObjectClass, matches

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

shortDump, shortDumpLazily

Method Details

getGeneralizedObjectSideObjectDefinition

@NotNull
public @NotNull ResourceObjectDefinition getGeneralizedObjectSideObjectDefinition()

Description copied from interface: ShadowReferenceAttributeDefinition

ONLY FOR SUBJECT-SIDE PARTICIPANT (and always non-null for it) Returns generalized definition for objects at the object (target) side. It should cover all possible objects; so it contains definitions of all possible auxiliary object classes. May be: - embedded (for references used to implement complex associations) - or standalone (for references used to implement simple associations, or references without associations). May be: - genuine ResourceObjectClassDefinition - or ResourceObjectTypeDefinition (if there's a default type for that object class; hopefully removed soon, see MID-10309) - or CompositeObjectDefinition if there are auxiliary object classes. Immutable after the resource schema is frozen.

Specified by:

getGeneralizedObjectSideObjectDefinition in interface ShadowReferenceAttributeDefinition

See Also:

• AbstractShadowReferenceTypeDefinition.generalizedObjectSideObjectDefinition

forLayer

@NotNull
public @NotNull ShadowReferenceAttributeDefinitionImpl forLayer(@NotNull
 @NotNull LayerType layer)

Description copied from interface: ShadowAttributeDefinition

Creates a view of the current definition for a given layer. (May return even the original object e.g. if the layer matches the current one.)

Specified by:

forLayer in interface ShadowAttributeDefinition<ShadowReferenceAttributeValue,ShadowReferenceAttributeDefinition,Referencable,ShadowReferenceAttribute>

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

accept

public void accept(Visitor visitor)

Specified by:

accept in interface Visitable<Definition>

Overrides:

accept in class ShadowAttributeDefinitionImpl<ShadowReferenceAttributeValue,ShadowReferenceAttributeDefinition,Referencable,ShadowReferenceAttribute,NativeShadowReferenceAttributeDefinition>

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

createEmptyDelta

@NotNull
public @NotNull ReferenceDelta 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<PrismReference>

getTargetTypeName

public QName getTargetTypeName()

Specified by:

getTargetTypeName in interface PrismReferenceDefinition

isComposite

public boolean isComposite()

Specified by:

isComposite in interface PrismReferenceDefinition

clone

@NotNull
public @NotNull ShadowReferenceAttributeDefinitionImpl clone()

Specified by:

clone in interface Definition

Specified by:

clone in interface ItemDefinition<PrismReference>

Specified by:

clone in interface PrismReferenceDefinition

Specified by:

clone in interface ShadowAttributeDefinition<ShadowReferenceAttributeValue,ShadowReferenceAttributeDefinition,Referencable,ShadowReferenceAttribute>

Specified by:

clone in interface ShadowReferenceAttributeDefinition

Specified by:

clone in class ShadowAttributeDefinitionImpl<ShadowReferenceAttributeValue,ShadowReferenceAttributeDefinition,Referencable,ShadowReferenceAttribute,NativeShadowReferenceAttributeDefinition>

cloneWithNewCardinality

@NotNull
public @NotNull ShadowReferenceAttributeDefinition cloneWithNewCardinality(int newMinOccurs,
 int newMaxOccurs)

Specified by:

cloneWithNewCardinality in interface ShadowReferenceAttributeDefinition

mutator

public PrismReferenceDefinition.PrismReferenceDefinitionMutator 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<PrismReference>

Specified by:

mutator in interface PrismReferenceDefinition

deepClone

public ShadowReferenceAttributeDefinitionImpl deepClone(@NotNull
 @NotNull DeepCloneOperation operation)

Description copied from interface: ItemDefinition

TODO document

Specified by:

deepClone in interface ItemDefinition<PrismReference>

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<PrismReference>

extendToString

protected void extendToString(StringBuilder sb)

Specified by:

extendToString in class ShadowAttributeDefinitionImpl<ShadowReferenceAttributeValue,ShadowReferenceAttributeDefinition,Referencable,ShadowReferenceAttribute,NativeShadowReferenceAttributeDefinition>

getDebugDumpClassName

public String getDebugDumpClassName()

Description copied from class: ShadowAttributeDefinitionImpl

Return a human readable name of this class suitable for logs.

Specified by:

getDebugDumpClassName in class ShadowAttributeDefinitionImpl<ShadowReferenceAttributeValue,ShadowReferenceAttributeDefinition,Referencable,ShadowReferenceAttribute,NativeShadowReferenceAttributeDefinition>

debugDump

public String debugDump(int indent)

Specified by:

debugDump in interface DebugDumpable

Overrides:

debugDump in class ShadowAttributeDefinitionImpl<ShadowReferenceAttributeValue,ShadowReferenceAttributeDefinition,Referencable,ShadowReferenceAttribute,NativeShadowReferenceAttributeDefinition>

createEmptyDelta

public ReferenceDelta createEmptyDelta()

Specified by:

createEmptyDelta in interface ShadowReferenceAttributeDefinition

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>

Overrides:

accept in class ShadowAttributeDefinitionImpl<ShadowReferenceAttributeValue,ShadowReferenceAttributeDefinition,Referencable,ShadowReferenceAttribute,NativeShadowReferenceAttributeDefinition>

Returns:

false if we already was here

getHumanReadableDescription

public String getHumanReadableDescription()

Specified by:

getHumanReadableDescription in interface ShadowAttributeDefinition<ShadowReferenceAttributeValue,ShadowReferenceAttributeDefinition,Referencable,ShadowReferenceAttribute>

getSimulationDefinition

@Nullable
public @Nullable SimulatedShadowReferenceTypeDefinition getSimulationDefinition()

Specified by:

getSimulationDefinition in interface ShadowReferenceAttributeDefinition

isSimulated

public boolean isSimulated()

Description copied from interface: ShadowAttributeDefinition

If `true`, the item does not exist on the resource, but is simulated by midPoint. Applies to reference attributes for now.

Specified by:

isSimulated in interface ShadowAttributeDefinition<ShadowReferenceAttributeValue,ShadowReferenceAttributeDefinition,Referencable,ShadowReferenceAttribute>

getSimulationDefinitionRequired

public SimulatedShadowReferenceTypeDefinition getSimulationDefinitionRequired()

Specified by:

getSimulationDefinitionRequired in interface ShadowReferenceAttributeDefinition

shortDump

public void shortDump(StringBuilder sb)

Description copied from interface: ShortDumpable

Show the content of the object intended for diagnostics. This method is supposed to append a compact, human-readable output in a single line. Unlike toString() method, there is no requirement to identify the actual class or type of the object. It is assumed that the class/type will be obvious from the context in which the output is used.

Specified by:

shortDump in interface ShortDumpable

Overrides:

shortDump in class ShadowAttributeDefinitionImpl<ShadowReferenceAttributeValue,ShadowReferenceAttributeDefinition,Referencable,ShadowReferenceAttribute,NativeShadowReferenceAttributeDefinition>

Parameters:

sb - StringBuilder to which to a compact one-line content of the object intended for diagnostics by system administrator should be appended.

getTypeClass

@NotNull
public @NotNull Class<Referencable> 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 ShadowAttributeDefinition<ShadowReferenceAttributeValue,ShadowReferenceAttributeDefinition,Referencable,ShadowReferenceAttribute>

createPrismValueFromRealValue

public ShadowReferenceAttributeValue createPrismValueFromRealValue(@NotNull
 @NotNull Object realValue)
                                                            throws SchemaException

Specified by:

createPrismValueFromRealValue in interface ShadowAttributeDefinition<ShadowReferenceAttributeValue,ShadowReferenceAttributeDefinition,Referencable,ShadowReferenceAttribute>

Throws:

SchemaException

getSchemaContextDefinition

@Nullable
public @Nullable SchemaContextDefinition getSchemaContextDefinition()

Specified by:

getSchemaContextDefinition in interface Definition

cloneWithNewName

@NotNull
public @NotNull ItemDefinition<PrismReference> 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<PrismReference>

See Also:

• PrismContainerDefinition.cloneWithNewDefinition(QName, ItemDefinition)

equals

public boolean equals(Object o)

Overrides:

equals in class ShadowAttributeDefinitionImpl<ShadowReferenceAttributeValue,ShadowReferenceAttributeDefinition,Referencable,ShadowReferenceAttribute,NativeShadowReferenceAttributeDefinition>

hashCode

public int hashCode()

Overrides:

hashCode in class ShadowAttributeDefinitionImpl<ShadowReferenceAttributeValue,ShadowReferenceAttributeDefinition,Referencable,ShadowReferenceAttribute,NativeShadowReferenceAttributeDefinition>

getCorrelatorDefinition

public ItemCorrelatorDefinitionType getCorrelatorDefinition()

Specified by:

getCorrelatorDefinition in interface ResourceObjectInboundProcessingDefinition.ItemInboundProcessingDefinition

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

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

getTargetParticipantTypes

@NotNull
public @NotNull Collection<ShadowRelationParticipantType> getTargetParticipantTypes()

Description copied from interface: ShadowReferenceAttributeDefinition

Returns types of the objects on the other side. Always non-empty.

Specified by:

getTargetParticipantTypes in interface ShadowReferenceAttributeDefinition

setTargetTypeName

public void setTargetTypeName(QName typeName)

Specified by:

setTargetTypeName in interface PrismReferenceDefinition.PrismReferenceDefinitionMutator

setTargetObjectDefinition

public void setTargetObjectDefinition(PrismObjectDefinition<?> definition)

Specified by:

setTargetObjectDefinition in interface PrismReferenceDefinition.PrismReferenceDefinitionMutator

setComposite

public void setComposite(boolean value)

Specified by:

setComposite in interface PrismReferenceDefinition.PrismReferenceDefinitionMutator

migrateIfNeeded

@NotNull
public @NotNull PrismReferenceValue migrateIfNeeded(@NotNull
 @NotNull PrismReferenceValue value)
                                             throws SchemaException

See ShadowAssociationDefinitionImpl.createComplexTypeDefinition() for analogous functionality (via value migrator).

Specified by:

migrateIfNeeded in interface PrismReferenceDefinition

Throws:

SchemaException

getParticipantRole

@NotNull
public @NotNull ShadowReferenceParticipantRole getParticipantRole()

Description copied from interface: ShadowReferenceAttributeDefinition

What is the role of the object that holds this reference attribute in the subject-object relationship? For example, when considering `ri:group` reference attribute on `ri:user` object class pointing to the `ri:group` object class, the participant role for this attribute is ShadowReferenceParticipantRole.SUBJECT, because `ri:user` object class participates in this relation as the subject. For the other side of this reference, the `ri:member` reference attribute on `ri:group` object class will have participant role of ShadowReferenceParticipantRole.OBJECT, because `ri:group` object class participates in this relation as the object.

Specified by:

getParticipantRole in interface ShadowReferenceAttributeDefinition