Interface RawResourceAttributeDefinition<T>

All Superinterfaces:
Cloneable, DebugDumpable, Definition, Freezable, ItemDefinition<PrismProperty<T>>, PrismContextSensitive, PrismItemAccessDefinition, PrismPropertyDefinition<T>, Revivable, Serializable, SmartVisitable<Definition>, Visitable<Definition>
All Known Subinterfaces:
AttributeDefinitionDelegator<T>, MutableRawResourceAttributeDefinition<T>, PartiallyMutableItemDefinition.Attribute<T>, RefinedAttributeDefinitionDelegator<T>, ResourceAttributeDefinition<T>, ResourceAttributeWrapper<T>
All Known Implementing Classes:
RawResourceAttributeDefinitionImpl, ResourceAttributeDefinitionImpl, ResourceAttributeWrapperImpl, TransformablePropertyDefinition.RefinedAttribute, TransformablePropertyDefinition.ResourceAttribute

public interface RawResourceAttributeDefinition<T> extends PrismPropertyDefinition<T>
  • Method Details

    • getReturnedByDefault

      @Nullable @Nullable Boolean getReturnedByDefault()
      Is this attribute returned by default? (I.e. if no specific options are sent to the connector?)
    • isReturnedByDefault

      default boolean isReturnedByDefault()
      Is this attribute returned by default? (I.e. if no specific options are sent to the connector?)
    • getNativeAttributeName

      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
    • getFrameworkAttributeName

      String getFrameworkAttributeName()
      Returns name of the attribute as given in the connector framework. This is not used for any significant logic. It is mostly for diagnostics.
      Returns:
      name of the attribute as given in the connector framework.
    • instantiate

      @NotNull @NotNull ResourceAttribute<T> instantiate()
      TODO what to do with this?
      Specified by:
      instantiate in interface ItemDefinition<T>
      Specified by:
      instantiate in interface PrismPropertyDefinition<T>
    • instantiate

      @NotNull @NotNull ResourceAttribute<T> instantiate(QName name)
      TODO what to do with this?
      Specified by:
      instantiate in interface ItemDefinition<T>
      Specified by:
      instantiate in interface PrismPropertyDefinition<T>