com.evolveum.midpoint.provisioning.impl

Class ShadowManager

java.lang.Object

com.evolveum.midpoint.provisioning.impl.ShadowManager

@Component
public class ShadowManager
extends Object

Responsibilities: Communicate with the repo Store results in the repo shadows Clean up shadow inconsistencies in repo Limitations: Do NOT communicate with the resource means: do NOT do anything with the connector

Author:

Katarina Valalikova, Radovan Semancik

Constructor Summary

Constructors

Constructor and Description
ShadowManager()

Method Summary

Methods

Modifier and Type	Method and Description
PrismObject<com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType>	addRepositoryShadow(ProvisioningContext ctx, PrismObject<com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType> resourceShadow, OperationResult parentResult)
<T> boolean	compareAttribute(RefinedObjectClassDefinition refinedObjectClassDefinition, ResourceAttribute<T> attributeA, ResourceAttribute<T> attributeB)
<T> boolean	compareAttribute(RefinedObjectClassDefinition refinedObjectClassDefinition, ResourceAttribute<T> attributeA, T... valuesB)
PrismObject<com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType>	createRepositoryShadow(ProvisioningContext ctx, PrismObject<com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType> shadow) Create a copy of a shadow that is suitable for repository storage.
ResourceOperationDescription	createResourceFailureDescription(PrismObject<com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType> conflictedShadow, com.evolveum.midpoint.xml.ns._public.common.common_3.ResourceType resource, OperationResult parentResult)
void	deleteConflictedShadowFromRepo(PrismObject<com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType> shadow, OperationResult parentResult)
PrismObject<com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType>	findOrAddShadowFromChange(ProvisioningContext ctx, Change<com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType> change, OperationResult parentResult)
PrismObject<com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType>	findOrAddShadowFromChangeGlobalContext(ProvisioningContext globalCtx, Change<com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType> change, OperationResult parentResult)
PrismObject<com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType>	fixShadow(ProvisioningContext ctx, PrismObject<com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType> origRepoShadow, OperationResult parentResult) Re-reads the shadow, re-evaluates the identifiers and stored values, updates them if necessary.
PrismObject<com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType>	lookupConflictingShadowBySecondaryIdentifiers(ProvisioningContext ctx, PrismObject<com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType> resourceShadow, OperationResult parentResult)
PrismObject<com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType>	lookupShadowBySecondaryIdentifiers(ProvisioningContext ctx, Collection<ResourceAttribute<?>> secondaryIdentifiers, OperationResult parentResult)
PrismObject<com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType>	lookupShadowInRepository(ProvisioningContext ctx, PrismObject<com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType> resourceShadow, OperationResult parentResult) Locates the appropriate Shadow in repository that corresponds to the provided resource object.
PrismObject<com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType>	lookupShadowInRepository(ProvisioningContext ctx, ResourceAttributeContainer identifierContainer, OperationResult parentResult)
void	normalizeAttributes(PrismObject<com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType> shadow, RefinedObjectClassDefinition objectClassDefinition)
<T> void	normalizeDelta(ItemDelta<PrismPropertyValue<T>,PrismPropertyDefinition<T>> delta, RefinedObjectClassDefinition objectClassDefinition)
<T> void	normalizeDeltas(Collection<? extends ItemDelta<PrismPropertyValue<T>,PrismPropertyDefinition<T>>> deltas, RefinedObjectClassDefinition objectClassDefinition)
SearchResultMetadata	searchObjectsIterativeRepository(ProvisioningContext ctx, ObjectQuery query, Collection<SelectorOptions<GetOperationOptions>> options, ResultHandler<com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType> repoHandler, OperationResult parentResult)
void	setIntentIfNecessary(com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType repoShadowType, RefinedObjectClassDefinition objectClassDefinition)
void	setKindIfNecessary(com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType repoShadowType, RefinedObjectClassDefinition objectClassDefinition)
Collection<ItemDelta>	updateShadow(ProvisioningContext ctx, PrismObject<com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType> resourceShadow, Collection<? extends ItemDelta> aprioriDeltas, OperationResult result)
PrismObject<com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType>	updateShadow(ProvisioningContext ctx, PrismObject<com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType> currentResourceShadow, PrismObject<com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType> oldRepoShadow, OperationResult parentResult) Updates repository shadow based on shadow from resource.

Methods inherited from class java.lang.Object

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

Constructor Detail

ShadowManager

public ShadowManager()

Method Detail

deleteConflictedShadowFromRepo

public void deleteConflictedShadowFromRepo(PrismObject<com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType> shadow,
                                  OperationResult parentResult)

createResourceFailureDescription

public ResourceOperationDescription createResourceFailureDescription(PrismObject<com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType> conflictedShadow,
                                                            com.evolveum.midpoint.xml.ns._public.common.common_3.ResourceType resource,
                                                            OperationResult parentResult)

lookupShadowInRepository

public PrismObject<com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType> lookupShadowInRepository(ProvisioningContext ctx,
                                                                                                    PrismObject<com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType> resourceShadow,
                                                                                                    OperationResult parentResult)
                                                                                                      throws SchemaException,
                                                                                                             ConfigurationException,
                                                                                                             ObjectNotFoundException,
                                                                                                             CommunicationException

Locates the appropriate Shadow in repository that corresponds to the provided resource object. DEAD flag is cleared - in memory as well as in repository.

Parameters:

parentResult -

Returns:

current shadow object that corresponds to provided resource object or null if the object does not exist

Throws:

SchemaException

ConfigurationException

ObjectNotFoundException

CommunicationException

lookupShadowInRepository

public PrismObject<com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType> lookupShadowInRepository(ProvisioningContext ctx,
                                                                                                    ResourceAttributeContainer identifierContainer,
                                                                                                    OperationResult parentResult)
                                                                                                      throws SchemaException,
                                                                                                             ConfigurationException,
                                                                                                             ObjectNotFoundException,
                                                                                                             CommunicationException

Throws:

SchemaException

ConfigurationException

ObjectNotFoundException

CommunicationException

lookupConflictingShadowBySecondaryIdentifiers

public PrismObject<com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType> lookupConflictingShadowBySecondaryIdentifiers(ProvisioningContext ctx,
                                                                                                                         PrismObject<com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType> resourceShadow,
                                                                                                                         OperationResult parentResult)
                                                                                                                           throws SchemaException,
                                                                                                                                  ConfigurationException,
                                                                                                                                  ObjectNotFoundException,
                                                                                                                                  CommunicationException

Throws:

SchemaException

ConfigurationException

ObjectNotFoundException

CommunicationException

lookupShadowBySecondaryIdentifiers

public PrismObject<com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType> lookupShadowBySecondaryIdentifiers(ProvisioningContext ctx,
                                                                                                              Collection<ResourceAttribute<?>> secondaryIdentifiers,
                                                                                                              OperationResult parentResult)
                                                                                                                throws SchemaException,
                                                                                                                       ConfigurationException,
                                                                                                                       ObjectNotFoundException,
                                                                                                                       CommunicationException

Throws:

SchemaException

ConfigurationException

ObjectNotFoundException

CommunicationException

addRepositoryShadow

public PrismObject<com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType> addRepositoryShadow(ProvisioningContext ctx,
                                                                                               PrismObject<com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType> resourceShadow,
                                                                                               OperationResult parentResult)
                                                                                                 throws SchemaException,
                                                                                                        ConfigurationException,
                                                                                                        ObjectNotFoundException,
                                                                                                        CommunicationException,
                                                                                                        ObjectAlreadyExistsException

Throws:

SchemaException

ConfigurationException

ObjectNotFoundException

CommunicationException

ObjectAlreadyExistsException

findOrAddShadowFromChange

public PrismObject<com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType> findOrAddShadowFromChange(ProvisioningContext ctx,
                                                                                                     Change<com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType> change,
                                                                                                     OperationResult parentResult)
                                                                                                       throws SchemaException,
                                                                                                              CommunicationException,
                                                                                                              ConfigurationException,
                                                                                                              SecurityViolationException,
                                                                                                              ObjectNotFoundException

Throws:

SchemaException

CommunicationException

ConfigurationException

SecurityViolationException

ObjectNotFoundException

findOrAddShadowFromChangeGlobalContext

public PrismObject<com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType> findOrAddShadowFromChangeGlobalContext(ProvisioningContext globalCtx,
                                                                                                                  Change<com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType> change,
                                                                                                                  OperationResult parentResult)
                                                                                                                    throws SchemaException,
                                                                                                                           CommunicationException,
                                                                                                                           ConfigurationException,
                                                                                                                           SecurityViolationException,
                                                                                                                           ObjectNotFoundException

Throws:

SchemaException

CommunicationException

ConfigurationException

SecurityViolationException

ObjectNotFoundException

searchObjectsIterativeRepository

public SearchResultMetadata searchObjectsIterativeRepository(ProvisioningContext ctx,
                                                    ObjectQuery query,
                                                    Collection<SelectorOptions<GetOperationOptions>> options,
                                                    ResultHandler<com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType> repoHandler,
                                                    OperationResult parentResult)
                                                      throws SchemaException,
                                                             ConfigurationException,
                                                             ObjectNotFoundException,
                                                             CommunicationException

Throws:

SchemaException

ConfigurationException

ObjectNotFoundException

CommunicationException

createRepositoryShadow

public PrismObject<com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType> createRepositoryShadow(ProvisioningContext ctx,
                                                                                                  PrismObject<com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType> shadow)
                                                                                                    throws SchemaException,
                                                                                                           ConfigurationException,
                                                                                                           ObjectNotFoundException,
                                                                                                           CommunicationException

Create a copy of a shadow that is suitable for repository storage.

Throws:

SchemaException

ConfigurationException

ObjectNotFoundException

CommunicationException

updateShadow

public Collection<ItemDelta> updateShadow(ProvisioningContext ctx,
                                 PrismObject<com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType> resourceShadow,
                                 Collection<? extends ItemDelta> aprioriDeltas,
                                 OperationResult result)
                                   throws SchemaException,
                                          ConfigurationException,
                                          ObjectNotFoundException,
                                          CommunicationException

Throws:

SchemaException

ConfigurationException

ObjectNotFoundException

CommunicationException

updateShadow

public PrismObject<com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType> updateShadow(ProvisioningContext ctx,
                                                                                        PrismObject<com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType> currentResourceShadow,
                                                                                        PrismObject<com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType> oldRepoShadow,
                                                                                        OperationResult parentResult)
                                                                                          throws SchemaException,
                                                                                                 ObjectNotFoundException,
                                                                                                 ObjectAlreadyExistsException,
                                                                                                 ConfigurationException,
                                                                                                 CommunicationException

Updates repository shadow based on shadow from resource. Handles rename cases, change of auxiliary object classes, etc.

Throws:

SchemaException

ObjectNotFoundException

ObjectAlreadyExistsException

ConfigurationException

CommunicationException

fixShadow

public PrismObject<com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType> fixShadow(ProvisioningContext ctx,
                                                                                     PrismObject<com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType> origRepoShadow,
                                                                                     OperationResult parentResult)
                                                                                       throws ObjectNotFoundException,
                                                                                              SchemaException,
                                                                                              ConfigurationException,
                                                                                              CommunicationException

Re-reads the shadow, re-evaluates the identifiers and stored values, updates them if necessary. Returns fixed shadow.

Throws:

ObjectNotFoundException

SchemaException

ConfigurationException

CommunicationException

setKindIfNecessary

public void setKindIfNecessary(com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType repoShadowType,
                      RefinedObjectClassDefinition objectClassDefinition)

setIntentIfNecessary

public void setIntentIfNecessary(com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType repoShadowType,
                        RefinedObjectClassDefinition objectClassDefinition)

normalizeAttributes

public void normalizeAttributes(PrismObject<com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType> shadow,
                       RefinedObjectClassDefinition objectClassDefinition)
                         throws SchemaException

Throws:

SchemaException

normalizeDeltas

public <T> void normalizeDeltas(Collection<? extends ItemDelta<PrismPropertyValue<T>,PrismPropertyDefinition<T>>> deltas,
                       RefinedObjectClassDefinition objectClassDefinition)
                     throws SchemaException

Throws:

SchemaException

normalizeDelta

public <T> void normalizeDelta(ItemDelta<PrismPropertyValue<T>,PrismPropertyDefinition<T>> delta,
                      RefinedObjectClassDefinition objectClassDefinition)
                    throws SchemaException

Throws:

SchemaException

compareAttribute

public <T> boolean compareAttribute(RefinedObjectClassDefinition refinedObjectClassDefinition,
                           ResourceAttribute<T> attributeA,
                           T... valuesB)
                         throws SchemaException

Throws:

SchemaException

compareAttribute

public <T> boolean compareAttribute(RefinedObjectClassDefinition refinedObjectClassDefinition,
                           ResourceAttribute<T> attributeA,
                           ResourceAttribute<T> attributeB)
                         throws SchemaException

Throws:

SchemaException