Package com.evolveum.midpoint.schema.util

Class ShadowUtil

java.lang.Object

com.evolveum.midpoint.schema.util.ShadowUtil

public class ShadowUtil
extends Object

Methods that would belong to the ShadowType class but cannot go there because of JAXB.

Author:

Radovan Semancik

Constructor Summary

Constructors

Constructor	Description
ShadowUtil()

Method Summary

Modifier and Type	Method	Description
static PrismObjectDefinition<ShadowType>	applyObjectDefinition(PrismObjectDefinition<ShadowType> shadowDefinition, ResourceObjectDefinition objectClassDefinition)
static void	applyResourceSchema(PrismObject<? extends ShadowType> shadow, ResourceSchema resourceSchema)	This is not supposed to be used in production code! It is just for the tests.
static void	checkConsistence(PrismObject<? extends ShadowType> shadow, String desc)
static void	checkConsistency(PrismContainerDefinition<ShadowAttributesType> attributesDefinition, String desc)
static void	checkForPartialClassification(@NotNull ShadowType shadow)
static <T extends ShadowType> PolyString	determineShadowName(PrismObject<T> shadow)
static <T extends ShadowType> PolyString	determineShadowNameRequired(PrismObject<T> shadow)
static ResourceAttribute<?>	fixAttributePath(ResourceAttribute<?> attribute)
static Collection<ResourceAttribute<?>>	getAllIdentifiers(PrismObject<? extends ShadowType> shadow)
static Collection<ResourceAttribute<?>>	getAllIdentifiers(ShadowType shadow)
static <T> ResourceAttribute<T>	getAttribute(PrismObject<? extends ShadowType> shadow, QName attrName)
static ItemName	getAttributeName(ItemPath attributePath, String message)
static Collection<ResourceAttribute<?>>	getAttributes(PrismObject<? extends ShadowType> shadow)
static Collection<ResourceAttribute<?>>	getAttributes(ShadowType shadowType)
static ResourceAttributeContainer	getAttributesContainer(PrismContainerValue<?> cval, QName containerName)
static ResourceAttributeContainer	getAttributesContainer(PrismObject<? extends ShadowType> shadow)
static ResourceAttributeContainer	getAttributesContainer(PrismObject<? extends ShadowType> shadow, QName containerName)
static ResourceAttributeContainer	getAttributesContainer(ShadowType shadowType)
static <T> T	getAttributeValue(PrismObject<? extends ShadowType> shadow, QName attrName)
static <T> T	getAttributeValue(ShadowType shadowType, QName attrName)
static <T> List<T>	getAttributeValues(PrismObject<? extends ShadowType> shadow, QName attrName)
static <T> List<T>	getAttributeValues(ShadowType shadowType, QName attrName)
static <T> Collection<T>	getAttributeValues(ShadowType shadow, QName attributeQname, Class<T> type)
static ShadowCorrelationStateType	getCorrelationStateRequired(@NotNull ShadowType shadow)
static <T extends AbstractCorrelatorStateType> T	getCorrelatorStateRequired(@NotNull ShadowType shadow, Class<T> clazz)
static String	getHumanReadableName(PrismObject<? extends ShadowType> shadow)
static String	getHumanReadableName(ShadowType shadowType)
static Object	getHumanReadableNameLazily(PrismObject<? extends ShadowType> shadow)
static String	getIntent(PrismObject<ShadowType> shadow)
static String	getIntent(ShadowType shadow)	Returns intent from the shadow.
static ShadowKindType	getKind(PrismObject<ShadowType> shadow)
static ShadowKindType	getKind(ShadowType shadow)
static String	getMultiStringAttributeValueAsSingle(ShadowType shadow, QName attrName)
static ResourceAttribute<String>	getNamingAttribute(PrismObject<? extends ShadowType> shadow)
static ResourceAttribute<String>	getNamingAttribute(ShadowType shadow)
static ResourceObjectClassDefinition	getObjectClassDefinition(ShadowType shadow)
static @NotNull QName	getObjectClassRequired(@NotNull ShadowType shadow)
static ActivationType	getOrCreateActivation(ShadowType shadowType)
static ResourceAttributeContainer	getOrCreateAttributesContainer(PrismObject<? extends ShadowType> shadow, ResourceObjectDefinition definition)
static ProtectedStringType	getPasswordValue(ShadowType shadowType)
static Collection<ResourceAttribute<?>>	getPrimaryIdentifiers(PrismObject<? extends ShadowType> shadow)
static Collection<ResourceAttribute<?>>	getPrimaryIdentifiers(ShadowType shadowType)
static PolyString	getResourceName(PrismObject<ShadowType> shadow)
static PolyString	getResourceName(ShadowType shadowType)
static @NotNull ResourceObjectIdentification	getResourceObjectIdentification(PrismObject<ShadowType> shadow, ResourceObjectDefinition objectDefinition)
static String	getResourceOid(PrismObject<ShadowType> shadow)
static String	getResourceOid(ShadowType shadowType)
static @NotNull String	getResourceOidRequired(@NotNull ShadowType shadow)
static ResourceAttribute<String>	getSecondaryIdentifier(PrismObject<? extends ShadowType> shadow)
static String	getSecondaryIdentifierRealValue(PrismObject<? extends ShadowType> shadow)
static Collection<ResourceAttribute<?>>	getSecondaryIdentifiers(@Nullable Collection<? extends ResourceAttribute<?>> identifiers, @NotNull ResourceObjectDefinition objectClassDefinition)
static Collection<ResourceAttribute<?>>	getSecondaryIdentifiers(PrismObject<? extends ShadowType> shadow)
static Collection<ResourceAttribute<?>>	getSecondaryIdentifiers(ShadowType shadowType)
static String	getSingleStringAttributeValue(PrismObject<ShadowType> shadow, QName attrName)
static String	getSingleStringAttributeValue(ShadowType shadow, QName attrName)
static ResourceObjectTypeIdentification	getTypeIdentification(ShadowType shadow)
static boolean	hasPrimaryIdentifier(PrismObject<ShadowType> shadow, ResourceObjectDefinition objectDefinition)
static boolean	hasPrimaryIdentifier(Collection<? extends ResourceAttribute<?>> identifiers, ResourceObjectDefinition objectDefinition)
static boolean	hasSecondaryIdentifier(Collection<? extends ResourceAttribute<?>> identifiers, ResourceObjectClassDefinition objectClassDefinition)
static boolean	isAccount(ShadowType shadowType)
static boolean	isAttributesContainerRaw(PrismObject<? extends ShadowType> shadow)
static boolean	isClassified(ShadowKindType kind, String intent)
static boolean	isClassified(ShadowType shadow)
static boolean	isConflicting(ShadowType shadow1, ShadowType shadow2)
static boolean	isDead(PrismObject<ShadowType> shadow)
static boolean	isDead(ObjectReferenceType projectionRef)
static boolean	isDead(ShadowType shadow)
static boolean	isExists(PrismObject<ShadowType> shadow)
static boolean	isExists(ShadowType shadow)
static boolean	isFullShadow(PrismObject<ShadowType> shadow)
static boolean	isGone(@NotNull ShadowType shadow)	Returns true if the shadow state indicates that it is 'gone', i.e.
static boolean	isGoneApproximate(@NotNull ShadowType shadow)	As isGone(ShadowType) but with possibly incomplete information.
static boolean	isKnown(ShadowKindType kind)
static boolean	isKnown(String intent)
static boolean	isNotDead(PrismObject<ShadowType> shadow)
static boolean	isNotDead(ObjectReferenceType projectionRef)
static boolean	isNotDead(ShadowType shadow)
static boolean	isNotKnown(ShadowKindType kind)
static boolean	isNotKnown(String intent)
static boolean	isPartiallyClassified(@NotNull ShadowType shadow)
static boolean	isProtected(@Nullable ShadowType shadow)
static boolean	isProtected(PrismObject<? extends ShadowType> shadow)
static boolean	matches(@NotNull ShadowType shadow, @NotNull ShadowDiscriminatorType discriminator)
static boolean	matches(@NotNull ShadowType shadow, @Nullable String resourceOid, @Nullable ShadowKindType kind, @Nullable String intent)	Null values mean "any" here.
static boolean	matchesAttribute(ItemPath path, QName attributeName)
static boolean	matchesPattern(ShadowType shadowType, ShadowDiscriminatorType discr)	Interprets ShadowDiscriminatorType as a pattern.
static void	removeAllAttributesExceptPrimaryIdentifier(PrismObject<ShadowType> shadow, ResourceObjectDefinition objDef)
static @NotNull ShadowKindType	resolveDefault(ShadowKindType kind)
static @NotNull String	resolveDefault(String intent)
static List<ObjectReferenceType>	selectLiveLinks(List<ObjectReferenceType> refs)
static void	setCorrelatorState(@NotNull ShadowType shadow, @Nullable AbstractCorrelatorStateType state)
static void	setPassword(ShadowType shadowType, ProtectedStringType password)
static void	setPasswordIncomplete(ShadowType shadowType)
static String	shortDumpShadow(PrismObject<ShadowType> shadow)
static Object	shortDumpShadowLazily(PrismObject<ShadowType> shadow)
static void	validateAttributeSchema(ShadowType shadow, ResourceObjectDefinition objectDefinition)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ShadowUtil

public ShadowUtil()

Method Detail

getPrimaryIdentifiers

public static Collection<ResourceAttribute<?>> getPrimaryIdentifiers(ShadowType shadowType)

getPrimaryIdentifiers

public static Collection<ResourceAttribute<?>> getPrimaryIdentifiers(PrismObject<? extends ShadowType> shadow)

getSecondaryIdentifiers

public static Collection<ResourceAttribute<?>> getSecondaryIdentifiers(ShadowType shadowType)

getSecondaryIdentifiers

public static Collection<ResourceAttribute<?>> getSecondaryIdentifiers(PrismObject<? extends ShadowType> shadow)

getSecondaryIdentifier

public static ResourceAttribute<String> getSecondaryIdentifier(PrismObject<? extends ShadowType> shadow)
                                                        throws SchemaException

Throws:

SchemaException

getSecondaryIdentifiers

public static Collection<ResourceAttribute<?>> getSecondaryIdentifiers(@Nullable
                                                                       @Nullable Collection<? extends ResourceAttribute<?>> identifiers,
                                                                       @NotNull
                                                                       @NotNull ResourceObjectDefinition objectClassDefinition)
                                                                throws SchemaException

Throws:

SchemaException

getSecondaryIdentifierRealValue

public static String getSecondaryIdentifierRealValue(PrismObject<? extends ShadowType> shadow)
                                              throws SchemaException

Throws:

SchemaException

getAllIdentifiers

public static Collection<ResourceAttribute<?>> getAllIdentifiers(PrismObject<? extends ShadowType> shadow)

getAllIdentifiers

public static Collection<ResourceAttribute<?>> getAllIdentifiers(ShadowType shadow)

getNamingAttribute

public static ResourceAttribute<String> getNamingAttribute(ShadowType shadow)

getNamingAttribute

public static ResourceAttribute<String> getNamingAttribute(PrismObject<? extends ShadowType> shadow)

getAttributes

public static Collection<ResourceAttribute<?>> getAttributes(ShadowType shadowType)

getAttributes

public static Collection<ResourceAttribute<?>> getAttributes(PrismObject<? extends ShadowType> shadow)

getAttribute

public static <T> ResourceAttribute<T> getAttribute(PrismObject<? extends ShadowType> shadow,
                                                    QName attrName)

getAttributesContainer

public static ResourceAttributeContainer getAttributesContainer(ShadowType shadowType)

getAttributesContainer

public static ResourceAttributeContainer getAttributesContainer(PrismObject<? extends ShadowType> shadow)

getAttributesContainer

public static ResourceAttributeContainer getAttributesContainer(PrismObject<? extends ShadowType> shadow,
                                                                QName containerName)

isAttributesContainerRaw

public static boolean isAttributesContainerRaw(PrismObject<? extends ShadowType> shadow)

getAttributesContainer

public static ResourceAttributeContainer getAttributesContainer(PrismContainerValue<?> cval,
                                                                QName containerName)

getOrCreateAttributesContainer

public static ResourceAttributeContainer getOrCreateAttributesContainer(PrismObject<? extends ShadowType> shadow,
                                                                        ResourceObjectDefinition definition)

getObjectClassDefinition

public static ResourceObjectClassDefinition getObjectClassDefinition(ShadowType shadow)

getResourceOid

public static String getResourceOid(ShadowType shadowType)

getResourceOidRequired

@NotNull
public static @NotNull String getResourceOidRequired(@NotNull
                                                     @NotNull ShadowType shadow)

getResourceOid

public static String getResourceOid(PrismObject<ShadowType> shadow)

getResourceName

public static PolyString getResourceName(ShadowType shadowType)

getResourceName

public static PolyString getResourceName(PrismObject<ShadowType> shadow)

getSingleStringAttributeValue

public static String getSingleStringAttributeValue(ShadowType shadow,
                                                   QName attrName)

getSingleStringAttributeValue

public static String getSingleStringAttributeValue(PrismObject<ShadowType> shadow,
                                                   QName attrName)

getMultiStringAttributeValueAsSingle

public static String getMultiStringAttributeValueAsSingle(ShadowType shadow,
                                                          QName attrName)

getAttributeValues

public static <T> List<T> getAttributeValues(ShadowType shadowType,
                                             QName attrName)

getAttributeValues

public static <T> List<T> getAttributeValues(PrismObject<? extends ShadowType> shadow,
                                             QName attrName)

getAttributeValue

public static <T> T getAttributeValue(ShadowType shadowType,
                                      QName attrName)
                               throws SchemaException

Throws:

SchemaException

getAttributeValue

public static <T> T getAttributeValue(PrismObject<? extends ShadowType> shadow,
                                      QName attrName)
                               throws SchemaException

Throws:

SchemaException

setPassword

public static void setPassword(ShadowType shadowType,
                               ProtectedStringType password)

setPasswordIncomplete

public static void setPasswordIncomplete(ShadowType shadowType)
                                  throws SchemaException

Throws:

SchemaException

getOrCreateActivation

public static ActivationType getOrCreateActivation(ShadowType shadowType)

applyResourceSchema

@VisibleForTesting
public static void applyResourceSchema(PrismObject<? extends ShadowType> shadow,
                                       ResourceSchema resourceSchema)
                                throws SchemaException

This is not supposed to be used in production code! It is just for the tests.

Throws:

SchemaException

applyObjectDefinition

public static PrismObjectDefinition<ShadowType> applyObjectDefinition(PrismObjectDefinition<ShadowType> shadowDefinition,
                                                                      ResourceObjectDefinition objectClassDefinition)
                                                               throws SchemaException

Throws:

SchemaException

getIntent

public static String getIntent(PrismObject<ShadowType> shadow)

getIntent

@Contract("null -> null")
public static String getIntent(ShadowType shadow)

Returns intent from the shadow. Backwards compatible with older accountType. May also adjust for default intent if necessary.

getKind

public static ShadowKindType getKind(PrismObject<ShadowType> shadow)

getKind

@Contract("!null -> !null; null -> null")
public static ShadowKindType getKind(ShadowType shadow)

getAttributeValues

public static <T> Collection<T> getAttributeValues(ShadowType shadow,
                                                   QName attributeQname,
                                                   Class<T> type)

getAttributeName

public static ItemName getAttributeName(ItemPath attributePath,
                                        String message)
                                 throws SchemaException

Throws:

SchemaException

checkConsistence

public static void checkConsistence(PrismObject<? extends ShadowType> shadow,
                                    String desc)

checkConsistency

public static void checkConsistency(PrismContainerDefinition<ShadowAttributesType> attributesDefinition,
                                    String desc)

isAccount

public static boolean isAccount(ShadowType shadowType)

isProtected

public static boolean isProtected(@Nullable
                                  @Nullable ShadowType shadow)

isProtected

public static boolean isProtected(PrismObject<? extends ShadowType> shadow)

isDead

public static boolean isDead(ShadowType shadow)

isDead

public static boolean isDead(PrismObject<ShadowType> shadow)

isNotDead

public static boolean isNotDead(PrismObject<ShadowType> shadow)

isNotDead

public static boolean isNotDead(ShadowType shadow)

isDead

public static boolean isDead(ObjectReferenceType projectionRef)

isNotDead

public static boolean isNotDead(ObjectReferenceType projectionRef)

isExists

public static boolean isExists(ShadowType shadow)

isExists

public static boolean isExists(PrismObject<ShadowType> shadow)

matches

public static boolean matches(@NotNull
                              @NotNull ShadowType shadow,
                              @Nullable
                              @Nullable String resourceOid,
                              @Nullable
                              @Nullable ShadowKindType kind,
                              @Nullable
                              @Nullable String intent)

Null values mean "any" here.

matches

public static boolean matches(@NotNull
                              @NotNull ShadowType shadow,
                              @NotNull
                              @NotNull ShadowDiscriminatorType discriminator)

matchesPattern

public static boolean matchesPattern(ShadowType shadowType,
                                     ShadowDiscriminatorType discr)

Interprets ShadowDiscriminatorType as a pattern. E.g. null discriminator kind is interpreted to match any shadow kind.

isConflicting

public static boolean isConflicting(ShadowType shadow1,
                                    ShadowType shadow2)

getHumanReadableNameLazily

public static Object getHumanReadableNameLazily(PrismObject<? extends ShadowType> shadow)

getHumanReadableName

public static String getHumanReadableName(PrismObject<? extends ShadowType> shadow)

getHumanReadableName

public static String getHumanReadableName(ShadowType shadowType)

isFullShadow

public static boolean isFullShadow(PrismObject<ShadowType> shadow)

determineShadowName

public static <T extends ShadowType> PolyString determineShadowName(PrismObject<T> shadow)
                                                             throws SchemaException

Throws:

SchemaException

determineShadowNameRequired

public static <T extends ShadowType> PolyString determineShadowNameRequired(PrismObject<T> shadow)
                                                                     throws SchemaException

Throws:

SchemaException

getResourceObjectIdentification

@NotNull
public static @NotNull ResourceObjectIdentification getResourceObjectIdentification(PrismObject<ShadowType> shadow,
                                                                                    ResourceObjectDefinition objectDefinition)

matchesAttribute

public static boolean matchesAttribute(ItemPath path,
                                       QName attributeName)

hasPrimaryIdentifier

public static boolean hasPrimaryIdentifier(PrismObject<ShadowType> shadow,
                                           ResourceObjectDefinition objectDefinition)

hasPrimaryIdentifier

public static boolean hasPrimaryIdentifier(Collection<? extends ResourceAttribute<?>> identifiers,
                                           ResourceObjectDefinition objectDefinition)

hasSecondaryIdentifier

public static boolean hasSecondaryIdentifier(Collection<? extends ResourceAttribute<?>> identifiers,
                                             ResourceObjectClassDefinition objectClassDefinition)

fixAttributePath

public static ResourceAttribute<?> fixAttributePath(ResourceAttribute<?> attribute)
                                             throws SchemaException

Throws:

SchemaException

validateAttributeSchema

public static void validateAttributeSchema(ShadowType shadow,
                                           ResourceObjectDefinition objectDefinition)
                                    throws SchemaException

Throws:

SchemaException

getPasswordValue

public static ProtectedStringType getPasswordValue(ShadowType shadowType)

shortDumpShadowLazily

public static Object shortDumpShadowLazily(PrismObject<ShadowType> shadow)

shortDumpShadow

public static String shortDumpShadow(PrismObject<ShadowType> shadow)

isKnown

public static boolean isKnown(ShadowKindType kind)

isNotKnown

public static boolean isNotKnown(ShadowKindType kind)

isKnown

public static boolean isKnown(String intent)

isNotKnown

public static boolean isNotKnown(String intent)

isClassified

public static boolean isClassified(ShadowType shadow)

isClassified

public static boolean isClassified(ShadowKindType kind,
                                   String intent)

getTypeIdentification

@Contract("null -> null")
public static ResourceObjectTypeIdentification getTypeIdentification(ShadowType shadow)

removeAllAttributesExceptPrimaryIdentifier

public static void removeAllAttributesExceptPrimaryIdentifier(PrismObject<ShadowType> shadow,
                                                              ResourceObjectDefinition objDef)

selectLiveLinks

public static List<ObjectReferenceType> selectLiveLinks(List<ObjectReferenceType> refs)

isGone

public static boolean isGone(@NotNull
                             @NotNull ShadowType shadow)

Returns true if the shadow state indicates that it is 'gone', i.e. no longer on the resource. This could be determined from the `dead` property or from the `shadowLifecycleState`. The latter is more precise for shadows that have been fetched with the future point-in-time. PRECONDITION: shadow lifecycle state must be set up.

isGoneApproximate

public static boolean isGoneApproximate(@NotNull
                                        @NotNull ShadowType shadow)

As isGone(ShadowType) but with possibly incomplete information.

getCorrelationStateRequired

public static ShadowCorrelationStateType getCorrelationStateRequired(@NotNull
                                                                     @NotNull ShadowType shadow)

getCorrelatorStateRequired

public static <T extends AbstractCorrelatorStateType> T getCorrelatorStateRequired(@NotNull
                                                                                   @NotNull ShadowType shadow,
                                                                                   Class<T> clazz)
                                                                            throws SchemaException

Throws:

SchemaException

setCorrelatorState

public static void setCorrelatorState(@NotNull
                                      @NotNull ShadowType shadow,
                                      @Nullable
                                      @Nullable AbstractCorrelatorStateType state)

getObjectClassRequired

@NotNull
public static @NotNull QName getObjectClassRequired(@NotNull
                                                    @NotNull ShadowType shadow)
                                             throws SchemaException

Throws:

SchemaException

isPartiallyClassified

public static boolean isPartiallyClassified(@NotNull
                                            @NotNull ShadowType shadow)

checkForPartialClassification

public static void checkForPartialClassification(@NotNull
                                                 @NotNull ShadowType shadow)

resolveDefault

@NotNull
public static @NotNull ShadowKindType resolveDefault(ShadowKindType kind)

resolveDefault

@NotNull
public static @NotNull String resolveDefault(String intent)