Package com.evolveum.midpoint.schema.processor

Interface ShadowAttributeUcfDefinition

All Superinterfaces:

Serializable, ShortDumpable

All Known Subinterfaces:

NativeShadowAttributeDefinition, NativeShadowReferenceAttributeDefinition, NativeShadowSimpleAttributeDefinition<T>, ResourceAttributeDefinitionDelegator<T>, ResourceAttributeWrapper<T>, ShadowAttributeDefinition<V,D,RV,SA>, ShadowAttributeUcfDefinition.Delegable, ShadowReferenceAttributeDefinition, ShadowSimpleAttributeDefinition<T>

All Known Implementing Classes:

NativeShadowAttributeDefinitionImpl, ResourceAttributeWrapperImpl, ShadowAttributeDefinitionImpl, ShadowAttributeUcfDefinition.Data, ShadowReferenceAttributeDefinitionImpl, ShadowSimpleAttributeDefinitionImpl

public interface ShadowAttributeUcfDefinition
extends Serializable, ShortDumpable

Getter interface to "UCF" part of shadow attribute definitions. Supports delegation to real data store.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ShadowAttributeUcfDefinition.Data	Contains real data for UCF aspect of shadow attribute definition.
static interface	ShadowAttributeUcfDefinition.Delegable
static interface	ShadowAttributeUcfDefinition.Mutable	Mutable interface to properties in this class.

Method Summary

Modifier and Type	Method	Description
String	getFrameworkAttributeName()	Returns name of the attribute as given in the connector framework.
String	getNativeAttributeName()	Returns native attribute name.
@Nullable Boolean	getReturnedByDefault()	Is this attribute returned by default? (I.e.

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

shortDump, shortDump, shortDumpLazily

Method Details

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.

getReturnedByDefault

@Nullable
@Nullable Boolean getReturnedByDefault()

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