com.evolveum.midpoint.repo.xml
Class XmlRepositoryService

java.lang.Object
  com.evolveum.midpoint.repo.xml.XmlRepositoryService

All Implemented Interfaces:

RepositoryService

public class XmlRepositoryService
extends java.lang.Object
implements RepositoryService

Method Summary

java.lang.String	addObject(ObjectType object, OperationResult parentResult) Add new object.
void	claimTask(java.lang.String oid, OperationResult parentResult) Claim a task.
void	deleteObject(java.lang.String oid, OperationResult parentResult) Deletes object with specified OID.
ObjectType	getObject(java.lang.String oid, PropertyReferenceListType resolve, OperationResult parentResult) Returns object for provided OID.
PropertyAvailableValuesListType	getPropertyAvailableValues(java.lang.String oid, PropertyReferenceListType properties, OperationResult parentResult) Returns list of available values for specified properties.
UserType	listAccountShadowOwner(java.lang.String accountOid, OperationResult parentResult) Returns the User object representing owner of specified account (account shadow).
ObjectListType	listObjects(java.lang.Class objectType, PagingType paging, OperationResult parentResult) Returns all objects of specified type in the repository.
<T extends ResourceObjectShadowType> java.util.List<T>	listResourceObjectShadows(java.lang.String resourceOid, java.lang.Class<T> resourceObjectShadowType, OperationResult parentResult) Search for resource object shadows of a specified type that belong to the specified resource.
void	modifyObject(ObjectModificationType objectChange, OperationResult parentResult) Modifies object using relative change description.
void	releaseTask(java.lang.String oid, OperationResult parentResult) Release a claimed task.
ObjectListType	searchObjects(QueryType query, PagingType paging, OperationResult parentResult) Search for objects in the repository.

Methods inherited from class java.lang.Object

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

Method Detail

addObject

public java.lang.String addObject(ObjectType object,
                                  OperationResult parentResult)
                           throws ObjectAlreadyExistsException,
                                  SchemaException

Description copied from interface: RepositoryService

Add new object. The OID provided in the input message may be empty. In that case the OID will be assigned by the implementation of this method and it will be provided as return value. This operation should fail if such object already exists (if object with the provided OID already exists). The operation may fail if provided OID is in an unusable format for the storage. Generating own OIDs and providing them to this method is not recommended for normal operation. Should be atomic. Should not allow creation of two objects with the same OID (even if created in parallel). The operation may fail if the object to be created does not conform to the underlying schema of the storage system or the schema enforced by the implementation.

Specified by:

addObject in interface RepositoryService

Parameters:

object - object to create

parentResult - parent OperationResult (in/out)

Returns:

OID assigned to the created object

Throws:

ObjectAlreadyExistsException - object with specified identifiers already exists, cannot add

SchemaException - error dealing with storage schema, e.g. schema violation

getObject

public ObjectType getObject(java.lang.String oid,
                            PropertyReferenceListType resolve,
                            OperationResult parentResult)
                     throws ObjectNotFoundException,
                            SchemaException

Description copied from interface: RepositoryService

Returns object for provided OID. Must fail if object with the OID does not exists.

Specified by:

getObject in interface RepositoryService

Parameters:

oid - OID of the object to get

resolve - list of properties to resolve in the fetched object

Returns:

Object fetched from repository

Throws:

ObjectNotFoundException - requested object does not exist

SchemaException - error dealing with storage schema

listObjects

public ObjectListType listObjects(java.lang.Class objectType,
                                  PagingType paging,
                                  OperationResult parentResult)

Description copied from interface: RepositoryService

Returns all objects of specified type in the repository. This can be considered as a simplified search operation. Returns empty list if object type is correct but there are no objects of that type. The ordering of the results is not significant and may be arbitrary unless sorting in the paging is used. Should fail if object type is wrong.

Specified by:

listObjects in interface RepositoryService

paging - paging specification to limit operation result (optional)

parentResult - parent OperationResult (in/out)

Returns:

all objects of specified type (subject to paging)

searchObjects

public ObjectListType searchObjects(QueryType query,
                                    PagingType paging,
                                    OperationResult parentResult)
                             throws SchemaException

Description copied from interface: RepositoryService

Search for objects in the repository. Searches through all object types. Returns a list of objects that match search criteria. Returns empty list if object type is correct but there are no objects of that type. The ordering of the results is not significant and may be arbitrary unless sorting in the paging is used. Should fail if object type is wrong. Should fail if unknown property is specified in the query.

Specified by:

searchObjects in interface RepositoryService

Parameters:

query - search query

paging - paging specification to limit operation result (optional)

parentResult - parent OperationResult (in/out)

Returns:

all objects of specified type that match search criteria (subject to paging)

Throws:

SchemaException - unknown property used in search query

modifyObject

public void modifyObject(ObjectModificationType objectChange,
                         OperationResult parentResult)
                  throws ObjectNotFoundException,
                         SchemaException

Description copied from interface: RepositoryService

Modifies object using relative change description. Must fail if user with provided OID does not exists. Must fail if any of the described changes cannot be applied. Should be atomic. If two or more modify operations are executed in parallel, the operations should be merged. In case that the operations are in conflict (e.g. one operation adding a value and the other removing the same value), the result is not deterministic. The operation may fail if the modified object does not conform to the underlying schema of the storage system or the schema enforced by the implementation. TODO: optimistic locking

Specified by:

modifyObject in interface RepositoryService

Parameters:

objectChange - specification of object changes

parentResult - parent OperationResult (in/out)

Throws:

ObjectNotFoundException - specified object does not exist

SchemaException - resulting object would violate the schema

deleteObject

public void deleteObject(java.lang.String oid,
                         OperationResult parentResult)
                  throws ObjectNotFoundException

Description copied from interface: RepositoryService

Deletes object with specified OID. Must fail if object with specified OID does not exists. Should be atomic.

Specified by:

deleteObject in interface RepositoryService

Parameters:

oid - OID of object to delete

parentResult - parent OperationResult (in/out)

Throws:

ObjectNotFoundException - specified object does not exist

getPropertyAvailableValues

public PropertyAvailableValuesListType getPropertyAvailableValues(java.lang.String oid,
                                                                  PropertyReferenceListType properties,
                                                                  OperationResult parentResult)
                                                           throws ObjectNotFoundException

Description copied from interface: RepositoryService

Returns list of available values for specified properties. The returned values can be used as valid values for properties of the specific object. The provided values can be used e.g. for listing them in GUI list boxes, for early validation (pre-validation), displaying help messages, auto-complete, etc. In case the list of available values is too big or it is not available, the empty list should be returned, setting the "closed" flag to false.

Specified by:

getPropertyAvailableValues in interface RepositoryService

Parameters:

oid - OID of the object for which to determine values

properties - list of properties for which to determine values

parentResult - parentResult parent OperationResult (in/out)

Returns:

list of available values

Throws:

ObjectNotFoundException - specified object does not exist

listAccountShadowOwner

public UserType listAccountShadowOwner(java.lang.String accountOid,
                                       OperationResult parentResult)
                                throws ObjectNotFoundException

Description copied from interface: RepositoryService

Returns the User object representing owner of specified account (account shadow). May return null if there is no owner specified for the account. May only be called with OID of AccountShadow object. Implements the backward "owns" association between account shadow and user. Forward association is implemented by property "account" of user object. This is a "list" operation even though it may return at most one owner. However the operation implies searching the repository for an owner, which may be less efficient that following a direct association. Hence it is called "list" to indicate that there may be non-negligible overhead.

Specified by:

listAccountShadowOwner in interface RepositoryService

Parameters:

accountOid - OID of account shadow

parentResult - parentResult parent OperationResult (in/out)

Returns:

User object representing owner of specified account

Throws:

ObjectNotFoundException - specified object does not exist

listResourceObjectShadows

public <T extends ResourceObjectShadowType> java.util.List<T> listResourceObjectShadows(java.lang.String resourceOid,
                                                                                        java.lang.Class<T> resourceObjectShadowType,
                                                                                        OperationResult parentResult)
                                                                             throws ObjectNotFoundException

Description copied from interface: RepositoryService

Search for resource object shadows of a specified type that belong to the specified resource. Returns a list of such object shadows or empty list if nothing was found. Implements the backward "has" association between resource and resource object shadows. Forward association is implemented by property "resource" of resource object shadow. May only be called with OID of Resource object.

Specified by:

listResourceObjectShadows in interface RepositoryService

Parameters:

resourceOid - OID of resource definition (ResourceType)

parentResult - parentResult parent OperationResult (in/out)

Returns:

resource object shadows of a specified type from specified resource

Throws:

ObjectNotFoundException - specified object does not exist

claimTask

public void claimTask(java.lang.String oid,
                      OperationResult parentResult)
               throws ObjectNotFoundException,
                      ConcurrencyException,
                      SchemaException

Description copied from interface: RepositoryService

Claim a task. The task can be claimed only by a single node in the cluster. Attempt to claim an already claimed task results in an exception. The claim must be atomic. It is kind of a lock for the system. TODO: better description

Specified by:

claimTask in interface RepositoryService

Parameters:

oid - task OID

parentResult - parentResult parent OperationResult (in/out)

Throws:

ObjectNotFoundException - the task with specified OID was not found

ConcurrencyException - attempt to claim already claimed task

SchemaException - error dealing with storage schema

releaseTask

public void releaseTask(java.lang.String oid,
                        OperationResult parentResult)
                 throws ObjectNotFoundException,
                        SchemaException

Description copied from interface: RepositoryService

Release a claimed task. TODO: better description Note: Releasing a task that is not claimed is not an error. Warning should be logged, but this should not throw any exception.

Specified by:

releaseTask in interface RepositoryService

Parameters:

oid - task OID

parentResult - parentResult parent OperationResult (in/out)

Throws:

ObjectNotFoundException - the task with specified OID was not found

SchemaException - error dealing with storage schema