SqlRepositoryServiceImpl (midPoint Project 3.4.1 API)

java.lang.Object
- com.evolveum.midpoint.repo.sql.SqlBaseService
- - com.evolveum.midpoint.repo.sql.SqlRepositoryServiceImpl

All Implemented Interfaces:

RepositoryService

Direct Known Subclasses:

TestSqlRepositoryServiceImpl
```
@Repository
public class SqlRepositoryServiceImpl
extends SqlBaseService
implements RepositoryService
```
Author:

lazyman Note: don't autowire this class - because of Spring AOP use it couldn't be found by implementation class; only by its interface.

Field Summary

Fields
Modifier and Type Field and Description

static int MAX_CONSTRAINT_NAME_LENGTH

static String PERFORMANCE_LOG_NAME
- Fields inherited from class com.evolveum.midpoint.repo.sql.SqlBaseService
  LOCKING_EXP_THRESHOLD, LOCKING_MAX_ATTEMPTS, LOCKING_TIMEOUT_STEP
- Fields inherited from interface com.evolveum.midpoint.repo.api.RepositoryService
  ADD_OBJECT, ADVANCE_SEQUENCE, CLAIM_TASK, CLASS_NAME_WITH_DOT, CLEANUP_TASKS, COUNT_OBJECTS, DELETE_OBJECT, EXECUTE_QUERY_DIAGNOSTICS, GET_OBJECT, GET_VERSION, LIST_ACCOUNT_SHADOW, LIST_OBJECTS, LIST_RESOURCE_OBJECT_SHADOWS, MODIFY_OBJECT, RELEASE_TASK, RETURN_UNUSED_VALUES_TO_SEQUENCE, SEARCH_CONTAINERS, SEARCH_OBJECTS, SEARCH_OBJECTS_ITERATIVE, SEARCH_SHADOW_OWNER

Fields
Modifier and Type	Field and Description
`static int`	`MAX_CONSTRAINT_NAME_LENGTH`
`static String`	`PERFORMANCE_LOG_NAME`

Constructor Summary

Constructors
Constructor and Description

SqlRepositoryServiceImpl(SqlRepositoryFactory repositoryFactory)

Constructors
Constructor and Description
`SqlRepositoryServiceImpl(SqlRepositoryFactory repositoryFactory)`

Method Summary

Methods
Modifier and Type	Method and Description
`<T extends com.evolveum.midpoint.xml.ns._public.common.common_3.ObjectType> String`	`addObject(PrismObject<T> object, RepoAddOptions options, OperationResult result)` Add new object.
`long`	`advanceSequence(String oid, OperationResult parentResult)` This operation is guaranteed to be atomic.
`<T extends com.evolveum.midpoint.xml.ns._public.common.common_3.ObjectType> int`	`countObjects(Class<T> type, ObjectQuery query, OperationResult result)` Returns the number of objects that match specified criteria.
`<T extends com.evolveum.midpoint.xml.ns._public.common.common_3.ObjectType> void`	`deleteObject(Class<T> type, String oid, OperationResult result)` Deletes object with specified OID.
`RepositoryQueryDiagResponse`	`executeQueryDiagnostics(RepositoryQueryDiagRequest request, OperationResult result)` A bit of hack - execute arbitrary query, e.g.
`OrgClosureManager`	`getClosureManager()`
`<T extends com.evolveum.midpoint.xml.ns._public.common.common_3.ObjectType> PrismObject<T>`	`getObject(Class<T> type, String oid, Collection<SelectorOptions<GetOperationOptions>> options, OperationResult result)` Returns object for provided OID.
`RepositoryDiag`	`getRepositoryDiag()` Provide repository run-time configuration and diagnostic information.
`<T extends com.evolveum.midpoint.xml.ns._public.common.common_3.ObjectType> String`	`getVersion(Class<T> type, String oid, OperationResult parentResult)` Returns object version for provided OID.
`boolean`	`isAnySubordinate(String upperOrgOid, Collection<String> lowerObjectOids)`
`PrismObject<com.evolveum.midpoint.xml.ns._public.common.common_3.UserType>`	`listAccountShadowOwner(String accountOid, OperationResult result)` Deprecated.
`<T extends com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType> List<PrismObject<T>>`	`listResourceObjectShadows(String resourceOid, Class<T> resourceObjectShadowType, OperationResult result)` Search for resource object shadows of a specified type that belong to the specified resource.
`<T extends com.evolveum.midpoint.xml.ns._public.common.common_3.ObjectType> void`	`modifyObject(Class<T> type, String oid, Collection<? extends ItemDelta> modifications, OperationResult result)` Modifies object using relative change description.
`<T extends com.evolveum.midpoint.xml.ns._public.common.common_3.ObjectType> void`	`modifyObject(Class<T> type, String oid, Collection<? extends ItemDelta> modifications, RepoModifyOptions options, OperationResult result)`
`void`	`repositorySelfTest(OperationResult parentResult)` Runs a short, non-descructive repository self test.
`void`	`returnUnusedValuesToSequence(String oid, Collection<Long> unusedValues, OperationResult parentResult)` The sequence may ignore the values, e.g.
`<T extends Containerable> SearchResultList<T>`	`searchContainers(Class<T> type, ObjectQuery query, Collection<SelectorOptions<GetOperationOptions>> options, OperationResult parentResult)` Search for "sub-object" structures, i.e.
`<T extends com.evolveum.midpoint.xml.ns._public.common.common_3.ObjectType> SearchResultList<PrismObject<T>>`	`searchObjects(Class<T> type, ObjectQuery query, Collection<SelectorOptions<GetOperationOptions>> options, OperationResult result)` Search for objects in the repository.
`<T extends com.evolveum.midpoint.xml.ns._public.common.common_3.ObjectType> SearchResultMetadata`	`searchObjectsIterative(Class<T> type, ObjectQuery query, ResultHandler<T> handler, Collection<SelectorOptions<GetOperationOptions>> options, boolean strictlySequential, OperationResult result)` Search for objects in the repository in an iterative fashion.
`<F extends com.evolveum.midpoint.xml.ns._public.common.common_3.FocusType> PrismObject<F>`	`searchShadowOwner(String shadowOid, Collection<SelectorOptions<GetOperationOptions>> options, OperationResult result)` Returns the object representing owner of specified shadow.
`void`	`testOrgClosureConsistency(boolean repairIfNecessary, OperationResult testResult)` Checks a closure for consistency, repairing any problems found.

Methods inherited from class com.evolveum.midpoint.repo.sql.SqlBaseService
getConfiguration, getMatchingRuleRegistry, getPerformanceMonitor, getPrismContext, setMatchingRuleRegistry, setPrismContext

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PERFORMANCE_LOG_NAME

public static final String PERFORMANCE_LOG_NAME

MAX_CONSTRAINT_NAME_LENGTH
```
public static final int MAX_CONSTRAINT_NAME_LENGTH
```
See Also:
Constant Field Values

Constructor Detail

SqlRepositoryServiceImpl

public SqlRepositoryServiceImpl(SqlRepositoryFactory repositoryFactory)

Method Detail

getClosureManager

public OrgClosureManager getClosureManager()

getObject

public <T extends com.evolveum.midpoint.xml.ns._public.common.common_3.ObjectType> PrismObject<T> getObject(Class<T> type,
                                                                                                   String oid,
                                                                                                   Collection<SelectorOptions<GetOperationOptions>> options,
                                                                                                   OperationResult result)
                                                                                                 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; oid - OID of the object to get; result - parent OperationResult (in/out)
Returns:: Object fetched from repository
Throws:: ObjectNotFoundException - requested object does not exist; SchemaException - error dealing with storage schema

searchShadowOwner
```
public <F extends com.evolveum.midpoint.xml.ns._public.common.common_3.FocusType> PrismObject<F> searchShadowOwner(String shadowOid,
                                                                                                          Collection<SelectorOptions<GetOperationOptions>> options,
                                                                                                          OperationResult result)
```
Description copied from interface: RepositoryService

Returns the object representing owner of specified shadow.

Implements the backward "owns" association between account shadow and user. Forward association is implemented by linkRef reference in subclasses of FocusType.
Returns null if there is no owner for the shadow.

This is a "search" 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 "search" to indicate that there may be non-negligible overhead.

This method should not die even if the specified shadow does not exist. Even if the shadow is gone, it still may be used in some linkRefs. This method should be able to find objects with such linkeRefs otherwise we will not be able to do proper cleanup.

Specified by:

searchShadowOwner in interface RepositoryService

Parameters:
shadowOid - OID of shadow
result - parentResult parent OperationResult (in/out)

Returns:
Object representing owner of specified account (subclass of FocusType)

listAccountShadowOwner
```
@Deprecated
public PrismObject<com.evolveum.midpoint.xml.ns._public.common.common_3.UserType> listAccountShadowOwner(String accountOid,
                                                                                                           OperationResult result)
                                                                                                  throws ObjectNotFoundException
```
Deprecated.

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
result - parentResult parent OperationResult (in/out)

Returns:
User object representing owner of specified account

Throws:

ObjectNotFoundException - specified object does not exist

searchObjects

public <T extends com.evolveum.midpoint.xml.ns._public.common.common_3.ObjectType> SearchResultList<PrismObject<T>> searchObjects(Class<T> type,
                                                                                                                         ObjectQuery query,
                                                                                                                         Collection<SelectorOptions<GetOperationOptions>> options,
                                                                                                                         OperationResult result)
                                                                                                                       throws SchemaException

Description copied from interface: RepositoryService

Search for objects in the repository.

If no search criteria specified, list of all objects of specified type is returned.

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; query - search query; result - 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

searchContainers

public <T extends Containerable> SearchResultList<T> searchContainers(Class<T> type,
                                                             ObjectQuery query,
                                                             Collection<SelectorOptions<GetOperationOptions>> options,
                                                             OperationResult parentResult)
                                                           throws SchemaException

Description copied from interface: RepositoryService

Search for "sub-object" structures, i.e. containers. Currently, only one type of search is available: certification case search.

Specified by:: searchContainers in interface RepositoryService
Returns:
Throws:: SchemaException

addObject
```
public <T extends com.evolveum.midpoint.xml.ns._public.common.common_3.ObjectType> String addObject(PrismObject<T> object,
                                                                                           RepoAddOptions options,
                                                                                           OperationResult result)
                 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.
Note: no need for explicit type parameter here. The object parameter contains the information.

Specified by:

addObject in interface RepositoryService

Parameters:
object - object to create
result - 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

deleteObject

public <T extends com.evolveum.midpoint.xml.ns._public.common.common_3.ObjectType> void deleteObject(Class<T> type,
                                                                                            String oid,
                                                                                            OperationResult result)
                  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; oid - OID of object to delete; result - parent OperationResult (in/out)
Throws:: ObjectNotFoundException - specified object does not exist

countObjects

public <T extends com.evolveum.midpoint.xml.ns._public.common.common_3.ObjectType> int countObjects(Class<T> type,
                                                                                           ObjectQuery query,
                                                                                           OperationResult result)

Description copied from interface: RepositoryService

Returns the number of objects that match specified criteria.

If no search criteria specified, count of all objects of specified type is returned.

Should fail if object type is wrong. Should fail if unknown property is specified in the query.

Specified by:: countObjects in interface RepositoryService; query - search query; result - parent OperationResult (in/out)
Returns:: count of objects of specified type that match search criteria (subject to paging)

modifyObject
```
public <T extends com.evolveum.midpoint.xml.ns._public.common.common_3.ObjectType> void modifyObject(Class<T> type,
                                                                                            String oid,
                                                                                            Collection<? extends ItemDelta> modifications,
                                                                                            OperationResult result)
                  throws ObjectNotFoundException,
                         SchemaException,
                         ObjectAlreadyExistsException
```
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

result - parent OperationResult (in/out)

Throws:

ObjectNotFoundException - specified object does not exist

SchemaException - resulting object would violate the schema

ObjectAlreadyExistsException - if resulting object would have name which already exists in another object of the same type

modifyObject

public <T extends com.evolveum.midpoint.xml.ns._public.common.common_3.ObjectType> void modifyObject(Class<T> type,
                                                                                            String oid,
                                                                                            Collection<? extends ItemDelta> modifications,
                                                                                            RepoModifyOptions options,
                                                                                            OperationResult result)
                  throws ObjectNotFoundException,
                         SchemaException,
                         ObjectAlreadyExistsException

Specified by:: modifyObject in interface RepositoryService
Throws:: ObjectNotFoundException; SchemaException; ObjectAlreadyExistsException

listResourceObjectShadows

public <T extends com.evolveum.midpoint.xml.ns._public.common.common_3.ShadowType> List<PrismObject<T>> listResourceObjectShadows(String resourceOid,
                                                                                                                         Class<T> resourceObjectShadowType,
                                                                                                                         OperationResult result)
                                                                                                                       throws ObjectNotFoundException,
                                                                                                                              SchemaException

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); result - parentResult parent OperationResult (in/out)
Returns:: resource object shadows of a specified type from specified resource
Throws:: ObjectNotFoundException - specified object does not exist; SchemaException - found object is not type of ShadowType

getRepositoryDiag
```
public RepositoryDiag getRepositoryDiag()
```
Description copied from interface: RepositoryService

Provide repository run-time configuration and diagnostic information.

Specified by:

getRepositoryDiag in interface RepositoryService

repositorySelfTest
```
public void repositorySelfTest(OperationResult parentResult)
```
Description copied from interface: RepositoryService

Runs a short, non-descructive repository self test. This methods should never throw a (checked) exception. All the results should be recorded under the provided result structure (including fatal errors). This should implement ONLY self-tests that are IMPLEMENTATION-SPECIFIC. It must not implement self-tests that are generic and applies to all repository implementations. Such self-tests must be implemented in higher layers. If the repository has no self-tests then the method should return immediately without changing the result structure. It must not throw an exception in this case.

Specified by:

repositorySelfTest in interface RepositoryService

testOrgClosureConsistency
```
public void testOrgClosureConsistency(boolean repairIfNecessary,
                             OperationResult testResult)
```
Description copied from interface: RepositoryService

Checks a closure for consistency, repairing any problems found. This methods should never throw a (checked) exception. All the results should be in the returned result structure (including fatal errors). The current implementation expects closure to be of reasonable size - so it could be fetched into main memory as well as recomputed online (perhaps up to ~250K entries). In future, this method will be reimplemented. BEWARE, this method locks out the M_ORG_CLOSURE table, so org-related operations would wait until it completes. TODO this method is SQL service specific; it should be generalized/fixed somehow.

Specified by:

testOrgClosureConsistency in interface RepositoryService

getVersion

public <T extends com.evolveum.midpoint.xml.ns._public.common.common_3.ObjectType> String getVersion(Class<T> type,
                                                                                            String oid,
                                                                                            OperationResult parentResult)
                  throws ObjectNotFoundException,
                         SchemaException

Description copied from interface: RepositoryService

Returns object version for provided OID. Must fail if object with the OID does not exists. This is a supposed to be a very lightweight and cheap operation. It is used to support efficient caching of expensive objects.

Specified by:: getVersion in interface RepositoryService; oid - OID of the object to get; parentResult - parent OperationResult (in/out)
Returns:: Object version
Throws:: ObjectNotFoundException - requested object does not exist; SchemaException - error dealing with storage schema

searchObjectsIterative

public <T extends com.evolveum.midpoint.xml.ns._public.common.common_3.ObjectType> SearchResultMetadata searchObjectsIterative(Class<T> type,
                                                                                                                      ObjectQuery query,
                                                                                                                      ResultHandler<T> handler,
                                                                                                                      Collection<SelectorOptions<GetOperationOptions>> options,
                                                                                                                      boolean strictlySequential,
                                                                                                                      OperationResult result)
                                            throws SchemaException

Description copied from interface: RepositoryService

Search for objects in the repository in an iterative fashion.

Searches through all object types. Calls a specified handler for each object found. If no search criteria specified, list of all objects of specified type is returned.

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:: searchObjectsIterative in interface RepositoryService; query - search query; handler - result handler; strictlySequential - takes care not to skip any object nor to process objects more than once; currently requires paging NOT to be used - uses its own paging; result - 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

isAnySubordinate

public boolean isAnySubordinate(String upperOrgOid,
                       Collection<String> lowerObjectOids)
                         throws SchemaException

Specified by:: isAnySubordinate in interface RepositoryService
Throws:: SchemaException

advanceSequence
```
public long advanceSequence(String oid,
                   OperationResult parentResult)
                     throws ObjectNotFoundException,
                            SchemaException
```
Description copied from interface: RepositoryService

This operation is guaranteed to be atomic. If two threads or even two nodes request a value from the same sequence at the same time then different values will be returned.

Specified by:

advanceSequence in interface RepositoryService

Parameters:
oid - sequence OID

Returns:
next unallocated counter value

Throws:

ObjectNotFoundException - the sequence does not exist

SchemaException - the sequence cannot produce a value (e.g. maximum counter reached)

returnUnusedValuesToSequence

public void returnUnusedValuesToSequence(String oid,
                                Collection<Long> unusedValues,
                                OperationResult parentResult)
                                  throws ObjectNotFoundException,
                                         SchemaException

Description copied from interface: RepositoryService

The sequence may ignore the values, e.g. if value re-use is disabled or when the list of unused values is full. In such a case the values will be ignored silently and no error is indicated.

Specified by:: returnUnusedValuesToSequence in interface RepositoryService
Throws:: ObjectNotFoundException; SchemaException

executeQueryDiagnostics
```
public RepositoryQueryDiagResponse executeQueryDiagnostics(RepositoryQueryDiagRequest request,
                                                  OperationResult result)
```
Description copied from interface: RepositoryService

A bit of hack - execute arbitrary query, e.g. hibernate query in case of SQL repository. Use with all the care!

Specified by:

executeQueryDiagnostics in interface RepositoryService

Returns:

Class SqlRepositoryServiceImpl

Field Summary

Fields inherited from class com.evolveum.midpoint.repo.sql.SqlBaseService

Fields inherited from interface com.evolveum.midpoint.repo.api.RepositoryService

Constructor Summary

Method Summary

Methods inherited from class com.evolveum.midpoint.repo.sql.SqlBaseService

Methods inherited from class java.lang.Object

Field Detail

PERFORMANCE_LOG_NAME

MAX_CONSTRAINT_NAME_LENGTH

Constructor Detail

SqlRepositoryServiceImpl

Method Detail

getClosureManager

getObject

searchShadowOwner

listAccountShadowOwner

searchObjects

searchContainers

addObject

deleteObject

countObjects

modifyObject

modifyObject

listResourceObjectShadows

getRepositoryDiag

repositorySelfTest

testOrgClosureConsistency

getVersion

searchObjectsIterative

isAnySubordinate

advanceSequence

returnUnusedValuesToSequence

executeQueryDiagnostics