com.evolveum.midpoint.schema.processor

Class ResourceAttributeDefinition

java.lang.Object

com.evolveum.midpoint.prism.Definition

com.evolveum.midpoint.prism.ItemDefinition

com.evolveum.midpoint.prism.PrismPropertyDefinition

com.evolveum.midpoint.schema.processor.ResourceAttributeDefinition

All Implemented Interfaces:

com.evolveum.midpoint.prism.Revivable, DebugDumpable, Serializable

Direct Known Subclasses:

RefinedAttributeDefinition

public class ResourceAttributeDefinition
extends com.evolveum.midpoint.prism.PrismPropertyDefinition

Resource Object Attribute Definition. Resource Object Attribute is a Property of Resource Object. All that applies to property applies also to attribute, e.g. only a whole attributes can be changed, they may be simple or complex types, they should be representable in XML, etc. In addition, attribute definition may have some annotations that suggest its purpose and use on the Resource. Resource Object Attribute understands resource-specific annotations such as native attribute name. This class represents schema definition for resource object attribute. See Definition for more details.

Author:

Radovan Semancik

See Also:

Serialized Form

Field Summary

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

name

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

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

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

INDENT_STRING

Constructor Summary

Constructors

Constructor and Description
ResourceAttributeDefinition(QName elementName, QName typeName, com.evolveum.midpoint.prism.PrismContext prismContext)

Method Summary

Methods

Modifier and Type	Method and Description
ResourceAttributeDefinition	clone()
protected void	copyDefinitionData(ResourceAttributeDefinition clone)
protected void	extendToString(StringBuilder sb)
protected String	getDebugDumpClassName() Return a human readable name of this class suitable for logs.
String	getNativeAttributeName() Returns native attribute name.
Boolean	getReturnedByDefault()
ResourceAttribute	instantiate()
ResourceAttribute	instantiate(QName name)
boolean	isIdentifier(ObjectClassComplexTypeDefinition objectDefinition)
boolean	isIdentifier(ResourceAttributeContainerDefinition objectDefinition) Returns true if the attribute is a (primary) identifier.
boolean	isReturnedByDefault()
boolean	isSecondaryIdentifier(ObjectClassComplexTypeDefinition objectDefinition)
void	setNativeAttributeName(String nativeAttributeName)
void	setReturnedByDefault(Boolean returnedByDefault)

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

copyDefinitionData, createEmptyDelta, equals, getAllowedValues, getDocClassName, getValueType, hashCode, isIndexed, setIndexed

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

addNamespaceIfApplicable, adoptElementDefinitionFrom, canAdd, canModify, canRead, copyDefinitionData, debugFlags, debugMultiplicity, getMaxOccurs, getMinOccurs, getName, getNamespace, isDynamic, isMandatory, isMultiValue, isOperational, isOptional, isSingleValue, isValidFor, revive, setCanAdd, setCanModify, setCanRead, setDynamic, setMaxOccurs, setMinOccurs, setName, setOperational, setReadOnly, toString

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

copyDefinitionData, debugDump, debugDump, getDisplayName, getDisplayOrder, getDocumentation, getDocumentationPreview, getHelp, getPrismContext, getSchemaRegistry, getTypeClass, getTypeClassIfKnown, getTypeName, isAbstract, isDeprecated, isIgnored, isInherited, isRuntimeSchema, setAbstract, setDeprecated, setDisplayName, setDisplayOrder, setDocumentation, setHelp, setIgnored, setInherited, setRuntimeSchema, setTypeName

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceAttributeDefinition

public ResourceAttributeDefinition(QName elementName,
                           QName typeName,
                           com.evolveum.midpoint.prism.PrismContext prismContext)

Method Detail

instantiate

public ResourceAttribute instantiate()

Overrides:

instantiate in class com.evolveum.midpoint.prism.PrismPropertyDefinition

instantiate

public ResourceAttribute instantiate(QName name)

Overrides:

instantiate in class com.evolveum.midpoint.prism.PrismPropertyDefinition

getReturnedByDefault

public Boolean getReturnedByDefault()

isReturnedByDefault

public boolean isReturnedByDefault()

setReturnedByDefault

public void setReturnedByDefault(Boolean returnedByDefault)

isIdentifier

public boolean isIdentifier(ResourceAttributeContainerDefinition objectDefinition)

Returns true if the attribute is a (primary) identifier. Convenience method.

Returns:

true if the attribute is a (primary) identifier.

isIdentifier

public boolean isIdentifier(ObjectClassComplexTypeDefinition objectDefinition)

isSecondaryIdentifier

public boolean isSecondaryIdentifier(ObjectClassComplexTypeDefinition objectDefinition)

getNativeAttributeName

public String getNativeAttributeName()

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.

Returns:

native attribute name

setNativeAttributeName

public void setNativeAttributeName(String nativeAttributeName)

clone

public ResourceAttributeDefinition clone()

Overrides:

clone in class com.evolveum.midpoint.prism.PrismPropertyDefinition

copyDefinitionData

protected void copyDefinitionData(ResourceAttributeDefinition clone)

extendToString

protected void extendToString(StringBuilder sb)

Overrides:

extendToString in class com.evolveum.midpoint.prism.PrismPropertyDefinition

getDebugDumpClassName

protected String getDebugDumpClassName()

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

Overrides:

getDebugDumpClassName in class com.evolveum.midpoint.prism.PrismPropertyDefinition