com.evolveum.midpoint.common.refinery

Class RefinedAttributeDefinition<T>

java.lang.Object

com.evolveum.midpoint.prism.Definition

com.evolveum.midpoint.prism.ItemDefinition<PrismProperty<T>>

com.evolveum.midpoint.prism.PrismPropertyDefinition<T>

com.evolveum.midpoint.schema.processor.ResourceAttributeDefinition<T>

com.evolveum.midpoint.common.refinery.RefinedAttributeDefinition<T>

All Implemented Interfaces:

Revivable, DebugDumpable, Serializable

Direct Known Subclasses:

LayerRefinedAttributeDefinition

public class RefinedAttributeDefinition<T>
extends ResourceAttributeDefinition<T>
implements DebugDumpable

Author:

semancik

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	secondaryIdentifier

Fields inherited from class com.evolveum.midpoint.prism.ItemDefinition

name

Fields inherited from class com.evolveum.midpoint.prism.Definition

deprecated, displayOrder, documentation, emphasized, help, ignored, inherited, isAbstract, isRuntimeSchema, prismContext, typeName

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

INDENT_STRING

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RefinedAttributeDefinition(ResourceAttributeDefinition<T> attrDef, PrismContext prismContext)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canAdd() Returns true if the item can be added.
boolean	canAdd(com.evolveum.midpoint.xml.ns._public.common.common_3.LayerType layer)
boolean	canModify() Returns true if the item can be modified.
boolean	canModify(com.evolveum.midpoint.xml.ns._public.common.common_3.LayerType layer)
boolean	canRead() Returns true if the property can be read.
boolean	canRead(com.evolveum.midpoint.xml.ns._public.common.common_3.LayerType layer)
RefinedAttributeDefinition<T>	clone()
protected void	copyDefinitionData(RefinedAttributeDefinition<T> clone)
String	debugDump(int indent)
Collection<? extends DisplayableValue<T>>	getAllowedValues() Returns allowed values for this property.
ResourceAttributeDefinition<T>	getAttributeDefinition()
protected String	getDebugDumpClassName() Return a human readable name of this class suitable for logs.
String	getDescription()
String	getDisplayName() Returns display name.
com.evolveum.midpoint.xml.ns._public.common.common_3.AttributeFetchStrategyType	getFetchStrategy()
String	getFrameworkAttributeName() Returns name of the attribute as given in the connector framework.
String	getHelp() Returns help string.
List<com.evolveum.midpoint.xml.ns._public.common.common_3.MappingType>	getInboundMappingTypes()
List<String>	getIntolerantValuePattern()
PropertyLimitations	getLimitations(com.evolveum.midpoint.xml.ns._public.common.common_3.LayerType layer)
QName	getMatchingRuleQName() Returns matching rule name.
int	getMaxOccurs() Return the number of maximal value occurrences.
int	getMaxOccurs(com.evolveum.midpoint.xml.ns._public.common.common_3.LayerType layer)
int	getMinOccurs() Return the number of minimal value occurrences.
int	getMinOccurs(com.evolveum.midpoint.xml.ns._public.common.common_3.LayerType layer)
Integer	getModificationPriority()
QName	getName() Returns name of the defined entity.
String	getNativeAttributeName() Returns native attribute name.
com.evolveum.midpoint.xml.ns._public.common.common_3.MappingType	getOutboundMappingType()
Boolean	getReadReplaceMode()
List<String>	getTolerantValuePattern()
QName	getTypeName() Returns the name of the definition type.
QName	getValueType() Returns QName of the property value type.
boolean	hasOutboundMapping()
boolean	isDisplayNameAttribute()
boolean	isExlusiveStrong()
boolean	isIgnored()
boolean	isIgnored(com.evolveum.midpoint.xml.ns._public.common.common_3.LayerType layer)
boolean	isMandatory(com.evolveum.midpoint.xml.ns._public.common.common_3.LayerType layer)
boolean	isMultiValue(com.evolveum.midpoint.xml.ns._public.common.common_3.LayerType layer)
boolean	isOptional(com.evolveum.midpoint.xml.ns._public.common.common_3.LayerType layer)
boolean	isReturnedByDefault()
boolean	isSecondaryIdentifier()
boolean	isSingleValue(com.evolveum.midpoint.xml.ns._public.common.common_3.LayerType layer)
boolean	isTolerant()
boolean	isVolatilityTrigger()
void	setAttributeDefinition(ResourceAttributeDefinition<T> attributeDefinition)
void	setCanAdd(boolean create)
void	setCanModify(boolean update)
void	setCanRead(boolean read)
void	setDescription(String description)
void	setDisplayName(String displayName)
void	setExclusiveStrong(boolean isExclusiveStrong)
void	setFetchStrategy(com.evolveum.midpoint.xml.ns._public.common.common_3.AttributeFetchStrategyType fetchStrategy)
void	setHelp(String help)
void	setIgnored(boolean ignored)
void	setInboundMappingTypes(List<com.evolveum.midpoint.xml.ns._public.common.common_3.MappingType> inboundAssignmentTypes)
void	setMatchingRuleQName(QName matchingRuleQName)
void	setMaxOccurs(int maxOccurs)
void	setMinOccurs(int minOccurs)
void	setModificationPriority(Integer modificationPriority)
void	setNativeAttributeName(String nativeAttributeName)
void	setOutboundMappingType(com.evolveum.midpoint.xml.ns._public.common.common_3.MappingType outboundMappingType)
void	setReadOnly()
void	setReadReplaceMode(Boolean readReplaceMode)
void	setReturnedByDefault(Boolean returnedByDefault)
void	setSecondaryIdentifier(boolean secondaryIdentifier)
void	setTolerant(boolean tolerant)
void	setVolatilityTrigger(boolean isVolatilityTrigger)
String	toString()

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

copyDefinitionData, equals, extendToString, getReturnedByDefault, hashCode, instantiate, instantiate, isIdentifier, isIdentifier, isSecondaryIdentifier, setFrameworkAttributeName

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

copyDefinitionData, createEmptyDelta, defaultValue, getDocClassName, isIndexed, setIndexed

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

addNamespaceIfApplicable, adoptElementDefinitionFrom, copyDefinitionData, debugFlags, debugMultiplicity, deepClone, getNamespace, getValueEnumerationRef, isDynamic, isMandatory, isMultiValue, isOperational, isOptional, isSingleValue, isValidFor, isValidFor, revive, setDynamic, setName, setOperational, setValueEnumerationRef

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

copyDefinitionData, debugDump, getDisplayOrder, getDocumentation, getDocumentationPreview, getPrismContext, getSchemaRegistry, getTypeClass, getTypeClassIfKnown, isAbstract, isDeprecated, isEmphasized, isInherited, isRuntimeSchema, setAbstract, setDeprecated, setDisplayOrder, setDocumentation, setEmphasized, setInherited, setRuntimeSchema, setTypeName

Methods inherited from class java.lang.Object

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

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

debugDump

Field Detail

secondaryIdentifier

protected boolean secondaryIdentifier

Constructor Detail

RefinedAttributeDefinition

protected RefinedAttributeDefinition(ResourceAttributeDefinition<T> attrDef,
                          PrismContext prismContext)

Method Detail

setNativeAttributeName

public void setNativeAttributeName(String nativeAttributeName)

Overrides:

setNativeAttributeName in class ResourceAttributeDefinition<T>

isTolerant

public boolean isTolerant()

setTolerant

public void setTolerant(boolean tolerant)

isSecondaryIdentifier

public boolean isSecondaryIdentifier()

setSecondaryIdentifier

public void setSecondaryIdentifier(boolean secondaryIdentifier)

canAdd

public boolean canAdd()

Description copied from class: ItemDefinition

Returns true if the item can be added. I.e. if it can be present in the object when a new object is created.

Overrides:

canAdd in class ItemDefinition<PrismProperty<T>>

canAdd

public boolean canAdd(com.evolveum.midpoint.xml.ns._public.common.common_3.LayerType layer)

canRead

public boolean canRead()

Description copied from class: ItemDefinition

Returns true if the property can be read. I.e. if it is returned in objects retrieved from "get", "search" and similar operations.

Overrides:

canRead in class ItemDefinition<PrismProperty<T>>

canRead

public boolean canRead(com.evolveum.midpoint.xml.ns._public.common.common_3.LayerType layer)

canModify

public boolean canModify()

Description copied from class: ItemDefinition

Returns true if the item can be modified. I.e. if it can be changed during a modification of existing object.

Overrides:

canModify in class ItemDefinition<PrismProperty<T>>

canModify

public boolean canModify(com.evolveum.midpoint.xml.ns._public.common.common_3.LayerType layer)

setReadOnly

public void setReadOnly()

Overrides:

setReadOnly in class ItemDefinition<PrismProperty<T>>

getValueType

public QName getValueType()

Description copied from class: PrismPropertyDefinition

Returns QName of the property value type.

The returned type is either XSD simple type or complex type. It may not be defined in the same schema (especially if it is standard XSD simple type).

Overrides:

getValueType in class PrismPropertyDefinition<T>

Returns:

QName of the property value type

setMinOccurs

public void setMinOccurs(int minOccurs)

Overrides:

setMinOccurs in class ItemDefinition<PrismProperty<T>>

setMaxOccurs

public void setMaxOccurs(int maxOccurs)

Overrides:

setMaxOccurs in class ItemDefinition<PrismProperty<T>>

setCanRead

public void setCanRead(boolean read)

Overrides:

setCanRead in class ItemDefinition<PrismProperty<T>>

setCanModify

public void setCanModify(boolean update)

Overrides:

setCanModify in class ItemDefinition<PrismProperty<T>>

setCanAdd

public void setCanAdd(boolean create)

Overrides:

setCanAdd in class ItemDefinition<PrismProperty<T>>

isIgnored

public boolean isIgnored()

Overrides:

isIgnored in class Definition

isIgnored

public boolean isIgnored(com.evolveum.midpoint.xml.ns._public.common.common_3.LayerType layer)

setIgnored

public void setIgnored(boolean ignored)

Overrides:

setIgnored in class Definition

setHelp

public void setHelp(String help)

Overrides:

setHelp in class Definition

getDisplayName

public String getDisplayName()

Description copied from class: Definition

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.

Overrides:

getDisplayName in class Definition

Returns:

display name string or catalog key

setDisplayName

public void setDisplayName(String displayName)

Overrides:

setDisplayName in class Definition

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

getAttributeDefinition

public ResourceAttributeDefinition<T> getAttributeDefinition()

setAttributeDefinition

public void setAttributeDefinition(ResourceAttributeDefinition<T> attributeDefinition)

getOutboundMappingType

public com.evolveum.midpoint.xml.ns._public.common.common_3.MappingType getOutboundMappingType()

setOutboundMappingType

public void setOutboundMappingType(com.evolveum.midpoint.xml.ns._public.common.common_3.MappingType outboundMappingType)

hasOutboundMapping

public boolean hasOutboundMapping()

getInboundMappingTypes

public List<com.evolveum.midpoint.xml.ns._public.common.common_3.MappingType> getInboundMappingTypes()

setInboundMappingTypes

public void setInboundMappingTypes(List<com.evolveum.midpoint.xml.ns._public.common.common_3.MappingType> inboundAssignmentTypes)

getName

public QName getName()

Description copied from class: ItemDefinition

Returns name of the defined entity. The name is a name of the entity instance if it is fixed by the schema. E.g. it may be a name of the property in the container that cannot be changed. The name corresponds to the XML element name in the XML representation of the schema. It does NOT correspond to a XSD type name. Name is optional. If name is not set the null value is returned. If name is not set the type is "abstract", does not correspond to the element.

Overrides:

getName in class ItemDefinition<PrismProperty<T>>

Returns:

the name name of the entity or null.

getTypeName

public QName getTypeName()

Description copied from class: Definition

Returns the name of the definition type. Returns a name of the type for this definition. In XML representation that corresponds to the name of the XSD type.

Overrides:

getTypeName in class Definition

Returns:

the typeName

getNativeAttributeName

public String getNativeAttributeName()

Description copied from class: ResourceAttributeDefinition

Returns native attribute name. Native name of the attribute is a name as it is used on the resource or as seen by the connector. It is used for diagnostics purposes and may be used by the connector itself. As the attribute names in XSD have to comply with XML element name limitations, this may be the only way how to determine original attribute name. Returns null if native attribute name is not set or unknown. The name should be the same as the one used by the resource, if the resource supports naming of attributes. E.g. in case of LDAP this annotation should contain "cn", "givenName", etc. If the resource is not that flexible, the native attribute names may be hardcoded (e.g. "username", "homeDirectory") or may not be present at all.

Overrides:

getNativeAttributeName in class ResourceAttributeDefinition<T>

Returns:

native attribute name

getFrameworkAttributeName

public String getFrameworkAttributeName()

Description copied from class: ResourceAttributeDefinition

Returns name of the attribute as given in the connector framework. This is not used for any significant logic. It is mostly for diagnostics.

Overrides:

getFrameworkAttributeName in class ResourceAttributeDefinition<T>

Returns:

name of the attribute as given in the connector framework.

getAllowedValues

public Collection<? extends DisplayableValue<T>> getAllowedValues()

Description copied from class: PrismPropertyDefinition

Returns allowed values for this property.

Overrides:

getAllowedValues in class PrismPropertyDefinition<T>

Returns:

Object array. May be null.

isReturnedByDefault

public boolean isReturnedByDefault()

Overrides:

isReturnedByDefault in class ResourceAttributeDefinition<T>

setReturnedByDefault

public void setReturnedByDefault(Boolean returnedByDefault)

Overrides:

setReturnedByDefault in class ResourceAttributeDefinition<T>

getMaxOccurs

public int getMaxOccurs()

Description copied from class: ItemDefinition

Return the number of maximal value occurrences.

Any negative number means "unbounded".

Overrides:

getMaxOccurs in class ItemDefinition<PrismProperty<T>>

Returns:

the maxOccurs

getMaxOccurs

public int getMaxOccurs(com.evolveum.midpoint.xml.ns._public.common.common_3.LayerType layer)

getMinOccurs

public int getMinOccurs()

Description copied from class: ItemDefinition

Return the number of minimal value occurrences.

Overrides:

getMinOccurs in class ItemDefinition<PrismProperty<T>>

Returns:

the minOccurs

getMinOccurs

public int getMinOccurs(com.evolveum.midpoint.xml.ns._public.common.common_3.LayerType layer)

isOptional

public boolean isOptional(com.evolveum.midpoint.xml.ns._public.common.common_3.LayerType layer)

isMandatory

public boolean isMandatory(com.evolveum.midpoint.xml.ns._public.common.common_3.LayerType layer)

isMultiValue

public boolean isMultiValue(com.evolveum.midpoint.xml.ns._public.common.common_3.LayerType layer)

isSingleValue

public boolean isSingleValue(com.evolveum.midpoint.xml.ns._public.common.common_3.LayerType layer)

isExlusiveStrong

public boolean isExlusiveStrong()

setExclusiveStrong

public void setExclusiveStrong(boolean isExclusiveStrong)

getLimitations

public PropertyLimitations getLimitations(com.evolveum.midpoint.xml.ns._public.common.common_3.LayerType layer)

getHelp

public String getHelp()

Description copied from class: Definition

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.

Overrides:

getHelp in class Definition

Returns:

help string or catalog key

getFetchStrategy

public com.evolveum.midpoint.xml.ns._public.common.common_3.AttributeFetchStrategyType getFetchStrategy()

setFetchStrategy

public void setFetchStrategy(com.evolveum.midpoint.xml.ns._public.common.common_3.AttributeFetchStrategyType fetchStrategy)

getMatchingRuleQName

public QName getMatchingRuleQName()

Description copied from class: PrismPropertyDefinition

Returns matching rule name. Matching rules are algorithms that specify how to compare, normalize and/or order the values. E.g. there are matching rules for case insensitive string comparison, for LDAP DNs, etc.

Overrides:

getMatchingRuleQName in class PrismPropertyDefinition<T>

Returns:

matching rule name

setMatchingRuleQName

public void setMatchingRuleQName(QName matchingRuleQName)

Overrides:

setMatchingRuleQName in class PrismPropertyDefinition<T>

getTolerantValuePattern

public List<String> getTolerantValuePattern()

getIntolerantValuePattern

public List<String> getIntolerantValuePattern()

isVolatilityTrigger

public boolean isVolatilityTrigger()

setVolatilityTrigger

public void setVolatilityTrigger(boolean isVolatilityTrigger)

clone

public RefinedAttributeDefinition<T> clone()

Overrides:

clone in class ResourceAttributeDefinition<T>

copyDefinitionData

protected void copyDefinitionData(RefinedAttributeDefinition<T> clone)

toString

public String toString()

Overrides:

toString in class ItemDefinition<PrismProperty<T>>

getDebugDumpClassName

protected String getDebugDumpClassName()

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

Overrides:

getDebugDumpClassName in class ResourceAttributeDefinition<T>

debugDump

public String debugDump(int indent)

Specified by:

debugDump in interface DebugDumpable

Overrides:

debugDump in class Definition

setModificationPriority

public void setModificationPriority(Integer modificationPriority)

getModificationPriority

public Integer getModificationPriority()

getReadReplaceMode

public Boolean getReadReplaceMode()

setReadReplaceMode

public void setReadReplaceMode(Boolean readReplaceMode)

isDisplayNameAttribute

public boolean isDisplayNameAttribute()