com.evolveum.midpoint.schema.processor
Class ResourceObjectAttributeDefinition

java.lang.Object
  extended by com.evolveum.midpoint.schema.processor.Definition
      extended by com.evolveum.midpoint.schema.processor.PropertyDefinition
          extended by com.evolveum.midpoint.schema.processor.ResourceObjectAttributeDefinition

public class ResourceObjectAttributeDefinition
extends PropertyDefinition

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

Constructor Summary
ResourceObjectAttributeDefinition(javax.xml.namespace.QName name, javax.xml.namespace.QName defaultName, javax.xml.namespace.QName typeName)
           
ResourceObjectAttributeDefinition(ResourceObjectDefinition objectDefinition, javax.xml.namespace.QName name, javax.xml.namespace.QName defaultName, javax.xml.namespace.QName typeName)
           
 
Method Summary
 java.lang.String getNativeAttributeName()
          Returns native attribute name.
 javax.xml.namespace.QName getResourceObjectReference()
          Returns resource object reference target Qname.
 ResourceObjectAttribute instantiate()
           
 boolean isIdentifier()
          Returns true if the attribute is a (primary) identifier.
 void setObjectDefinition(ResourceObjectDefinition objectDefinition)
           
 
Methods inherited from class com.evolveum.midpoint.schema.processor.PropertyDefinition
canCreate, canRead, canUpdate, getAllowedValues, getMaxOccurs, getMinOccurs, getValueType, isMandatory, isMultiValue, isOptional, isSingleValue, setCreate, setMaxOccurs, setMinOccurs, setRead, setUpdate
 
Methods inherited from class com.evolveum.midpoint.schema.processor.Definition
debugDump, getDefaultName, getDisplayName, getHelp, getName, getNameOrDefaultName, getTypeName, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ResourceObjectAttributeDefinition

public ResourceObjectAttributeDefinition(javax.xml.namespace.QName name,
                                         javax.xml.namespace.QName defaultName,
                                         javax.xml.namespace.QName typeName)

ResourceObjectAttributeDefinition

public ResourceObjectAttributeDefinition(ResourceObjectDefinition objectDefinition,
                                         javax.xml.namespace.QName name,
                                         javax.xml.namespace.QName defaultName,
                                         javax.xml.namespace.QName typeName)
Method Detail

setObjectDefinition

public void setObjectDefinition(ResourceObjectDefinition objectDefinition)

instantiate

public ResourceObjectAttribute instantiate()
Overrides:
instantiate in class PropertyDefinition

isIdentifier

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

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

getNativeAttributeName

public java.lang.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

getResourceObjectReference

public javax.xml.namespace.QName getResourceObjectReference()
Returns resource object reference target Qname. Contains specification (QName) of a XSD type that is the type of reference target objects. Returns null if resource object reference is not set or unknown. It is used as an annotation for attribute types that point to resource objects, such as group members lists, role lists, etc. The clients can use this annotation to detect that the attribute points to a different object and follow the reference or display it appropriately.

Returns:
resource object reference target Qname


Copyright © 2011 evolveum. All Rights Reserved.