com.evolveum.midpoint.provisioning.impl
Class ShadowCache

java.lang.Object
  com.evolveum.midpoint.provisioning.impl.ShadowCache

@Component
public class ShadowCache
extends java.lang.Object

This class manages the "cache" of ResourceObjectShadows in the repository.

In short, this class takes care of aligning the shadow objects in repository with the real state of the resource.

The repository content is considered a "cache" when it comes to Shadow objects. That's why they are called "shadow" objects after all. When a new state (values) of the resource object is detected, the shadow in the repository should be updated. No matter if that was detected by synchronization, reconciliation or an ordinary get from resource. This class is supposed to do that.

Therefore all operations that deal with "shadows" should pass through this class. It forms yet another layer of the provisioning subsystem.

Current implementation assumes we are only storing primary identifier in the repository. That should be made configurable later. It also only support Account objects now.

Author:

Radovan Semancik

Constructor Summary

ShadowCache()

Method Summary

java.lang.String	addShadow(ResourceObjectShadowType shadow, ScriptsType scripts, ResourceType resource, OperationResult parentResult)
void	deleteShadow(ObjectType objectType, ScriptsType scripts, ResourceType resource, OperationResult parentResult)
java.util.List<Change>	fetchChanges(ResourceType resourceType, Property lastToken, OperationResult parentResult)
Property	fetchCurrentToken(ResourceType resourceType, OperationResult parentResult)
RepositoryService	getRepositoryService() Get the value of repositoryService.
ResourceObjectShadowType	getShadow(java.lang.String oid, ResourceObjectShadowType repositoryShadow, OperationResult parentResult) Gets the shadow with specified OID The shadow will be read from the repository and missing information will be fetched from the resource.
void	modifyShadow(ObjectType objectType, ResourceType resource, ObjectModificationType objectChange, ScriptsType scripts, OperationResult parentResult)
void	setRepositoryService(RepositoryService repositoryService) Set the value of repositoryService Expected to be injected.

Methods inherited from class java.lang.Object

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

Constructor Detail

ShadowCache

public ShadowCache()

Method Detail

getRepositoryService

public RepositoryService getRepositoryService()

Get the value of repositoryService.

Returns:

the value of repositoryService

setRepositoryService

public void setRepositoryService(RepositoryService repositoryService)

Set the value of repositoryService

Expected to be injected.

Parameters:

repositoryService - new value of repositoryService

getShadow

public ResourceObjectShadowType getShadow(java.lang.String oid,
                                          ResourceObjectShadowType repositoryShadow,
                                          OperationResult parentResult)
                                   throws ObjectNotFoundException,
                                          CommunicationException,
                                          SchemaException

Gets the shadow with specified OID

The shadow will be read from the repository and missing information will be fetched from the resource.

If no repositoryShadow is specified, the shadow will be retrieved from the repository. This is just an optimization if the object was already fetched (which is a usual case).

This method is using identification by OID. This is intended for normal usage. Method that uses native identification will be provided later.

Parameters:

oid - OID of shadow to get.

repositoryShadow - shadow that was read from the repository

Returns:

retrieved shadow (merged attributes from repository and resource)

Throws:

ObjectNotFoundException - shadow was not found or object was not found on the resource

CommunicationException - problem communicating with the resource

SchemaException - problem processing schema or schema violation

addShadow

public java.lang.String addShadow(ResourceObjectShadowType shadow,
                                  ScriptsType scripts,
                                  ResourceType resource,
                                  OperationResult parentResult)
                           throws CommunicationException,
                                  GenericFrameworkException,
                                  ObjectAlreadyExistsException,
                                  SchemaException,
                                  ObjectNotFoundException

Throws:

CommunicationException

GenericFrameworkException

ObjectAlreadyExistsException

SchemaException

ObjectNotFoundException

deleteShadow

public void deleteShadow(ObjectType objectType,
                         ScriptsType scripts,
                         ResourceType resource,
                         OperationResult parentResult)
                  throws CommunicationException,
                         GenericFrameworkException,
                         ObjectNotFoundException,
                         SchemaException

Throws:

CommunicationException

GenericFrameworkException

ObjectNotFoundException

SchemaException

modifyShadow

public void modifyShadow(ObjectType objectType,
                         ResourceType resource,
                         ObjectModificationType objectChange,
                         ScriptsType scripts,
                         OperationResult parentResult)
                  throws CommunicationException,
                         GenericFrameworkException,
                         ObjectNotFoundException,
                         SchemaException

Throws:

CommunicationException

GenericFrameworkException

ObjectNotFoundException

SchemaException

fetchCurrentToken

public Property fetchCurrentToken(ResourceType resourceType,
                                  OperationResult parentResult)
                           throws ObjectNotFoundException,
                                  CommunicationException,
                                  SchemaException

Throws:

ObjectNotFoundException

CommunicationException

SchemaException

fetchChanges

public java.util.List<Change> fetchChanges(ResourceType resourceType,
                                           Property lastToken,
                                           OperationResult parentResult)
                                    throws ObjectNotFoundException,
                                           CommunicationException,
                                           GenericFrameworkException,
                                           SchemaException

Throws:

ObjectNotFoundException

CommunicationException

GenericFrameworkException

SchemaException