com.evolveum.midpoint.common.refinery
Class RefinedAccountDefinition
java.lang.Object
com.evolveum.midpoint.prism.Definition
com.evolveum.midpoint.prism.ItemDefinition
com.evolveum.midpoint.prism.PrismContainerDefinition<ResourceObjectShadowAttributesType>
com.evolveum.midpoint.schema.processor.ResourceAttributeContainerDefinition
com.evolveum.midpoint.common.refinery.RefinedAccountDefinition
- All Implemented Interfaces:
- DebugDumpable, Dumpable, Serializable
public class RefinedAccountDefinition
- extends ResourceAttributeContainerDefinition
- implements Dumpable, DebugDumpable
- Author:
- semancik
- See Also:
- Serialized Form
Methods inherited from class com.evolveum.midpoint.prism.PrismContainerDefinition |
cloneWithReplacedDefinition, copyDefinitionData, createContainerDefinition, createContainerDefinition, createContainerDefinition, createEmptyDelta, createPropertyDefinition, createPropertyDefinition, createPropertyDefinition, createPropertyDefinition, createPropertyDefinition, createPropertyDefinition, extendToString, findContainerDefinition, findContainerDefinition, findContainerDefinition, findItemDefinition, findItemDefinition, findItemDefinition, findItemDefinition, findPropertyDefinition, findPropertyDefinition, findReferenceDefinition, getCompileTimeClass, getDebugDumpClassName, getSchemaNamespace, isEmpty, setCompileTimeClass, setComplexTypeDefinition, setRuntimeSchema |
Methods inherited from class com.evolveum.midpoint.prism.ItemDefinition |
copyDefinitionData, equals, getDefaultName, getMaxOccurs, getMinOccurs, getName, getNameOrDefaultName, hashCode, isDynamic, isMandatory, isMultiValue, isOptional, isSingleValue, isValidFor, setDynamic, setMaxOccurs, setMinOccurs, setName |
Methods inherited from class com.evolveum.midpoint.prism.Definition |
copyDefinitionData, getDisplayOrder, getHelp, getSchemaRegistry, getTypeClass, getTypeName, isIgnored, setDisplayOrder, setHelp, setIgnored, setTypeName |
getDescriptionAttribute
public ResourceAttributeDefinition getDescriptionAttribute()
- Description copied from class:
ResourceAttributeContainerDefinition
- Returns the definition of description attribute of a resource object.
Returns null if there is no description attribute.
The exception should be never thrown unless there is some bug in the
code. The validation of model consistency should be done at the time of
schema parsing.
- Overrides:
getDescriptionAttribute
in class ResourceAttributeContainerDefinition
- Returns:
- definition of secondary identifier attributes
setDescriptionAttribute
public void setDescriptionAttribute(ResourceAttributeDefinition descriptionAttribute)
- Overrides:
setDescriptionAttribute
in class ResourceAttributeContainerDefinition
getNamingAttribute
public ResourceAttributeDefinition getNamingAttribute()
- Description copied from class:
ResourceAttributeContainerDefinition
- Specifies which resource attribute should be used as a "technical" name
for the account. This name will appear in log files and other troubleshooting
tools. The name should be a form of unique identifier that can be used to
locate the resource object for diagnostics. It should not contain white chars and
special chars if that can be avoided and it should be reasonable short.
It is different from a display name attribute. Display name is intended for a
common user or non-technical administrator (such as role administrator). The
naming attribute is intended for technical IDM administrators and developers.
- Overrides:
getNamingAttribute
in class ResourceAttributeContainerDefinition
- Returns:
- resource attribute definition that should be used as a "technical" name
for the account.
getNativeObjectClass
public String getNativeObjectClass()
- Description copied from class:
ResourceAttributeContainerDefinition
- Returns the native object class string for the resource object.
Native object class is the name of the Resource Object Definition (Object
Class) as it is seen by the resource itself. The name of the Resource
Object Definition may be constrained by XSD or other syntax and therefore
may be "mangled" to conform to such syntax. The native object
class value will contain unmangled name (if available).
Returns null if there is no native object class.
The exception should be never thrown unless there is some bug in the
code. The validation of model consistency should be done at the time of
schema parsing.
- Overrides:
getNativeObjectClass
in class ResourceAttributeContainerDefinition
- Returns:
- native object class
setAccountType
public void setAccountType(boolean accountType)
- Overrides:
setAccountType
in class ResourceAttributeContainerDefinition
isDefaultAccountType
public boolean isDefaultAccountType()
- Description copied from class:
ResourceAttributeContainerDefinition
- Indicates whether definition is should be used as default account type.
If true value is returned then the definition should be used as a default
account type definition. This is a way how a resource connector may
suggest applicable object classes (resource object definitions) for
accounts.
If no information about account type is present, false should be
returned. This method must return true only if isAccountType() returns
true.
The exception should be never thrown unless there is some bug in the
code. The validation of at-most-one value should be done at the time of
schema parsing. The exception may not even be thrown at all if the
implementation is not able to determine duplicity.
- Overrides:
isDefaultAccountType
in class ResourceAttributeContainerDefinition
- Returns:
- true if the definition should be used as account type.
setDefaultAccountType
public void setDefaultAccountType(boolean defaultAccountType)
- Overrides:
setDefaultAccountType
in class ResourceAttributeContainerDefinition
getAccountTypeName
public String getAccountTypeName()
- Overrides:
getAccountTypeName
in class ResourceAttributeContainerDefinition
setAccountTypeName
public void setAccountTypeName(String accountTypeName)
- Overrides:
setAccountTypeName
in class ResourceAttributeContainerDefinition
getDisplayNameAttribute
public ResourceAttributeDefinition getDisplayNameAttribute()
- Description copied from class:
ResourceAttributeContainerDefinition
- Returns the definition of display name attribute.
Display name attribute specifies which resource attribute should be used
as title when displaying objects of a specific resource object class. It
must point to an attribute of String type. If not present, primary
identifier should be used instead (but this method does not handle this
default behavior).
Returns null if there is no display name attribute.
The exception should be never thrown unless there is some bug in the
code. The validation of model consistency should be done at the time of
schema parsing.
- Overrides:
getDisplayNameAttribute
in class ResourceAttributeContainerDefinition
- Returns:
- native object class
setDisplayNameAttribute
public void setDisplayNameAttribute(QName displayName)
- Description copied from class:
ResourceAttributeContainerDefinition
- TODO
Convenience method. It will internally look up the correct definition.
- Overrides:
setDisplayNameAttribute
in class ResourceAttributeContainerDefinition
getIdentifiers
public Collection<ResourceAttributeDefinition> getIdentifiers()
- Description copied from class:
ResourceAttributeContainerDefinition
- Returns the definition of identifier attributes of a resource object.
May return empty set if there are no identifier attributes. Must not
return null.
The exception should be never thrown unless there is some bug in the
code. The validation of model consistency should be done at the time of
schema parsing.
- Overrides:
getIdentifiers
in class ResourceAttributeContainerDefinition
- Returns:
- definition of identifier attributes
getSecondaryIdentifiers
public Collection<ResourceAttributeDefinition> getSecondaryIdentifiers()
- Description copied from class:
ResourceAttributeContainerDefinition
- Returns the definition of secondary identifier attributes of a resource
object.
May return empty set if there are no secondary identifier attributes.
Must not return null.
The exception should be never thrown unless there is some bug in the
code. The validation of model consistency should be done at the time of
schema parsing.
- Overrides:
getSecondaryIdentifiers
in class ResourceAttributeContainerDefinition
- Returns:
- definition of secondary identifier attributes
getProtectedAccounts
public Collection<ResourceObjectPattern> getProtectedAccounts()
getPrismContext
public PrismContext getPrismContext()
- Overrides:
getPrismContext
in class Definition
getComplexTypeDefinition
public ObjectClassComplexTypeDefinition getComplexTypeDefinition()
- Overrides:
getComplexTypeDefinition
in class ResourceAttributeContainerDefinition
instantiate
public ResourceAttributeContainer instantiate()
- Description copied from class:
PrismContainerDefinition
- Create property container instance with a default name.
This is a preferred way how to create property container.
- Overrides:
instantiate
in class ResourceAttributeContainerDefinition
- Returns:
- created item instance
instantiate
public ResourceAttributeContainer instantiate(QName name)
- Description copied from class:
PrismContainerDefinition
- Create property container instance with a specified name and element.
This is a preferred way how to create property container.
- Overrides:
instantiate
in class ResourceAttributeContainerDefinition
- Returns:
- created item instance
clone
public RefinedAccountDefinition clone()
- Description copied from class:
PrismContainerDefinition
- Shallow clone
- Overrides:
clone
in class ResourceAttributeContainerDefinition
copyDefinitionData
protected void copyDefinitionData(RefinedAccountDefinition clone)
findAttributeDefinition
public RefinedAttributeDefinition findAttributeDefinition(QName elementQName)
- Overrides:
findAttributeDefinition
in class ResourceAttributeContainerDefinition
findAttributeDefinition
public RefinedAttributeDefinition findAttributeDefinition(String elementLocalname)
- Overrides:
findAttributeDefinition
in class ResourceAttributeContainerDefinition
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
isRuntimeSchema
public boolean isRuntimeSchema()
- Overrides:
isRuntimeSchema
in class PrismContainerDefinition<ResourceObjectShadowAttributesType>
getDescription
public String getDescription()
setDescription
public void setDescription(String description)
getNamespace
public String getNamespace()
- Overrides:
getNamespace
in class ItemDefinition
isDefault
public boolean isDefault()
setDefault
public void setDefault(boolean isDefault)
getObjectClassDefinition
public ObjectClassComplexTypeDefinition getObjectClassDefinition()
setObjectClassDefinition
public void setObjectClassDefinition(ObjectClassComplexTypeDefinition objectClassDefinition)
isAccountType
public boolean isAccountType()
- Description copied from class:
ResourceAttributeContainerDefinition
- Indicates whether definition is should be used as account type.
If true value is returned then the definition should be used as an
account type definition. This is a way how a resource connector may
suggest applicable object classes (resource object definitions) for
accounts.
If no information about account type is present, false should be
returned.
- Overrides:
isAccountType
in class ResourceAttributeContainerDefinition
- Returns:
- true if the definition should be used as account type.
getAttributeDefinitions
public Collection<RefinedAttributeDefinition> getAttributeDefinitions()
- Overrides:
getAttributeDefinitions
in class ResourceAttributeContainerDefinition
getPropertyDefinitions
public Set<PrismPropertyDefinition> getPropertyDefinitions()
- Description copied from class:
PrismContainerDefinition
- Returns set of property definitions.
The set contains all property definitions of all types that were parsed.
Order of definitions is insignificant.
The returned set is immutable! All changes may be lost.
- Overrides:
getPropertyDefinitions
in class PrismContainerDefinition<ResourceObjectShadowAttributesType>
- Returns:
- set of definitions
getDefinitions
public Collection<ItemDefinition> getDefinitions()
- Description copied from class:
PrismContainerDefinition
- Returns set of property definitions.
WARNING: This may return definitions from the associated complex type.
Therefore changing the returned set may influence also the complex type definition.
The set contains all property definitions of all types that were parsed.
Order of definitions is insignificant.
- Overrides:
getDefinitions
in class PrismContainerDefinition<ResourceObjectShadowAttributesType>
- Returns:
- set of definitions
getResourceType
public ResourceType getResourceType()
getObjectDefinition
public PrismObjectDefinition<AccountShadowType> getObjectDefinition()
getAttributeDefinition
public RefinedAttributeDefinition getAttributeDefinition(QName attributeName)
add
public void add(RefinedAttributeDefinition refinedAttributeDefinition)
containsAttributeDefinition
public boolean containsAttributeDefinition(QName attributeName)
debugDump
public String debugDump()
- Description copied from interface:
DebugDumpable
- Show the content of the object intended for diagnostics by system administrator. The out
put should be suitable to use in system logs at "debug" level. It may be multi-line, but in
that case it should be well indented and quite terse.
As it is intended to be used by system administrator, it should not use any developer terms
such as class names, exceptions or stack traces.
- Specified by:
debugDump
in interface DebugDumpable
- Overrides:
debugDump
in class Definition
- Returns:
- content of the object intended for diagnostics by system administrator.
debugDump
public String debugDump(int indent)
- Specified by:
debugDump
in interface DebugDumpable
- Overrides:
debugDump
in class ResourceAttributeContainerDefinition
dump
public String dump()
- Description copied from interface:
Dumpable
- Show the content of the object intended for diagnostics by developer.
The content may be multi-line, in case of hierarchical objects it may be intended.
The use of this method may not be efficient. It is not supposed to be used in normal operation.
However, it is very useful in tests or in case of dumping objects in severe error situations.
- Specified by:
dump
in interface Dumpable
- Overrides:
dump
in class Definition
- Returns:
- content of the object intended for diagnostics.
createBlankShadow
public PrismObject<AccountShadowType> createBlankShadow()
getResourceAccountType
public ResourceShadowDiscriminator getResourceAccountType()
getNamesOfAttributesWithOutboundExpressions
public Collection<? extends QName> getNamesOfAttributesWithOutboundExpressions()
getNamesOfAttributesWithInboundExpressions
public Collection<? extends QName> getNamesOfAttributesWithInboundExpressions()
getCredentialsInbound
public MappingType getCredentialsInbound()
getCredentialsOutbound
public MappingType getCredentialsOutbound()
getPasswordPolicy
public ObjectReferenceType getPasswordPolicy()
getActivationInbound
public MappingType getActivationInbound()
getActivationOutbound
public MappingType getActivationOutbound()
Copyright © 2013 evolveum. All Rights Reserved.