public class RepositoryCache extends Object implements RepositoryService
ADD_OBJECT, CLAIM_TASK, CLASS_NAME_WITH_DOT, CLEANUP_TASKS, COUNT_OBJECTS, DELETE_OBJECT, GET_OBJECT, GET_VERSION, LIST_ACCOUNT_SHADOW, LIST_OBJECTS, LIST_RESOURCE_OBJECT_SHADOWS, MODIFY_OBJECT, RELEASE_TASK, SEARCH_OBJECTS, SEARCH_OBJECTS_ITERATIVE
Constructor and Description |
---|
RepositoryCache() |
RepositoryCache(RepositoryService repository) |
Modifier and Type | Method and Description |
---|---|
<T extends ObjectType> |
addObject(PrismObject<T> object,
RepoAddOptions options,
OperationResult parentResult)
Add new object.
|
void |
cleanupTasks(CleanupPolicyType policy,
OperationResult parentResult)
Clean up closed tasks that are older than specified.
|
<T extends ObjectType> |
countObjects(Class<T> type,
ObjectQuery query,
OperationResult parentResult)
Returns the number of objects that match specified criteria.
|
<T extends ObjectType> |
deleteObject(Class<T> type,
String oid,
OperationResult parentResult)
Deletes object with specified OID.
|
static void |
destroy() |
static String |
dump() |
static void |
enter() |
static boolean |
exists() |
static void |
exit() |
<T extends ObjectType> |
getObject(Class<T> type,
String oid,
Collection<SelectorOptions<GetOperationOptions>> options,
OperationResult parentResult)
Returns object for provided OID.
|
RepositoryDiag |
getRepositoryDiag()
Provide repository run-time configuration and diagnostic information.
|
<T extends ObjectType> |
getVersion(Class<T> type,
String oid,
OperationResult parentResult)
Returns object version for provided OID.
|
static void |
init() |
PrismObject<UserType> |
listAccountShadowOwner(String accountOid,
OperationResult parentResult)
Returns the User object representing owner of specified account (account
shadow).
|
<T extends ShadowType> |
listResourceObjectShadows(String resourceOid,
Class<T> resourceObjectShadowType,
OperationResult parentResult)
Search for resource object shadows of a specified type that belong to the
specified resource.
|
<T extends ObjectType> |
modifyObject(Class<T> type,
String oid,
Collection<? extends ItemDelta> modifications,
OperationResult parentResult)
Modifies object using relative change description.
|
void |
repositorySelfTest(OperationResult parentResult)
Runs a short, non-descructive repository self test.
|
<T extends ObjectType> |
searchObjects(Class<T> type,
ObjectQuery query,
Collection<SelectorOptions<GetOperationOptions>> options,
OperationResult parentResult)
Search for objects in the repository.
|
<T extends ObjectType> |
searchObjectsIterative(Class<T> type,
ObjectQuery query,
ResultHandler<T> handler,
Collection<SelectorOptions<GetOperationOptions>> options,
OperationResult parentResult)
Search for objects in the repository in an iterative fashion.
|
void |
setRepository(RepositoryService service) |
public RepositoryCache()
public RepositoryCache(RepositoryService repository)
public void setRepository(RepositoryService service)
public static void init()
public static boolean exists()
public static void destroy()
public static void enter()
public static void exit()
public static String dump()
public <T extends ObjectType> PrismObject<T> getObject(Class<T> type, String oid, Collection<SelectorOptions<GetOperationOptions>> options, OperationResult parentResult) throws ObjectNotFoundException, SchemaException
RepositoryService
getObject
in interface RepositoryService
oid
- OID of the object to getparentResult
- parent OperationResult (in/out)ObjectNotFoundException
- requested object does not existSchemaException
- error dealing with storage schemapublic <T extends ObjectType> String addObject(PrismObject<T> object, RepoAddOptions options, OperationResult parentResult) throws ObjectAlreadyExistsException, SchemaException
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.
addObject
in interface RepositoryService
object
- object to createparentResult
- parent OperationResult (in/out)ObjectAlreadyExistsException
- object with specified identifiers already exists, cannot addSchemaException
- error dealing with storage schema, e.g. schema violationpublic <T extends ObjectType> List<PrismObject<T>> searchObjects(Class<T> type, ObjectQuery query, Collection<SelectorOptions<GetOperationOptions>> options, OperationResult parentResult) throws SchemaException
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.
searchObjects
in interface RepositoryService
query
- search queryparentResult
- parent OperationResult (in/out)SchemaException
- unknown property used in search querypublic <T extends ObjectType> void searchObjectsIterative(Class<T> type, ObjectQuery query, ResultHandler<T> handler, Collection<SelectorOptions<GetOperationOptions>> options, OperationResult parentResult) throws SchemaException
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.
searchObjectsIterative
in interface RepositoryService
query
- search queryhandler
- result handlerparentResult
- parent OperationResult (in/out)SchemaException
- unknown property used in search querypublic <T extends ObjectType> int countObjects(Class<T> type, ObjectQuery query, OperationResult parentResult) throws SchemaException
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.
countObjects
in interface RepositoryService
query
- search queryparentResult
- parent OperationResult (in/out)SchemaException
- unknown property used in search querypublic <T extends ObjectType> void modifyObject(Class<T> type, String oid, Collection<? extends ItemDelta> modifications, OperationResult parentResult) throws ObjectNotFoundException, SchemaException, ObjectAlreadyExistsException
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 lockingmodifyObject
in interface RepositoryService
parentResult
- parent OperationResult (in/out)ObjectNotFoundException
- specified object does not existSchemaException
- resulting object would violate the schemaObjectAlreadyExistsException
- if resulting object would have name which already exists in another object of the same typepublic <T extends ObjectType> void deleteObject(Class<T> type, String oid, OperationResult parentResult) throws ObjectNotFoundException
RepositoryService
Deletes object with specified OID.
Must fail if object with specified OID does not exists. Should be atomic.
deleteObject
in interface RepositoryService
oid
- OID of object to deleteparentResult
- parent OperationResult (in/out)ObjectNotFoundException
- specified object does not existpublic PrismObject<UserType> listAccountShadowOwner(String accountOid, OperationResult parentResult) throws ObjectNotFoundException
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.
listAccountShadowOwner
in interface RepositoryService
accountOid
- OID of account shadowparentResult
- parentResult parent OperationResult (in/out)ObjectNotFoundException
- specified object does not existpublic <T extends ShadowType> List<PrismObject<T>> listResourceObjectShadows(String resourceOid, Class<T> resourceObjectShadowType, OperationResult parentResult) throws ObjectNotFoundException, SchemaException
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.
listResourceObjectShadows
in interface RepositoryService
resourceOid
- OID of resource definition (ResourceType)parentResult
- parentResult parent OperationResult (in/out)ObjectNotFoundException
- specified object does not existSchemaException
- found object is not type of ShadowType
public <T extends ObjectType> String getVersion(Class<T> type, String oid, OperationResult parentResult) throws ObjectNotFoundException, SchemaException
RepositoryService
getVersion
in interface RepositoryService
oid
- OID of the object to getparentResult
- parent OperationResult (in/out)ObjectNotFoundException
- requested object does not existSchemaException
- error dealing with storage schemapublic RepositoryDiag getRepositoryDiag()
RepositoryService
getRepositoryDiag
in interface RepositoryService
public void repositorySelfTest(OperationResult parentResult)
RepositoryService
repositorySelfTest
in interface RepositoryService
public void cleanupTasks(CleanupPolicyType policy, OperationResult parentResult)
RepositoryService
cleanupTasks
in interface RepositoryService
policy
- Tasks will be deleted based on this policy.Copyright © 2013 evolveum. All rights reserved.