summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAntje Fuhrmann2013-05-16 02:45:17 (EDT)
committerStephan Born2013-09-06 07:18:37 (EDT)
commit8086ae31f9bb515efd3a2b0d6326430f137b8313 (patch)
tree66f39637ae123d10088a0fd2b4e77f8230ce048b
parentd1d8967b2b17c1911830877449f663b1f38fac0d (diff)
downloadorg.eclipse.stardust.engine-8086ae31f9bb515efd3a2b0d6326430f137b8313.zip
org.eclipse.stardust.engine-8086ae31f9bb515efd3a2b0d6326430f137b8313.tar.gz
org.eclipse.stardust.engine-8086ae31f9bb515efd3a2b0d6326430f137b8313.tar.bz2
Jira-ID: CRNT-18394
API's calls which trigger a synchronization are not documented. git-svn-id: https://svn.csa.sungard.com/repos/ipp2/product/trunk/stardust/engine@64862 8100b5e0-4d52-466c-ae9c-bdeccbdeaf6b Signed-off-by: Antje Fuhrmann <antje.fuhrmann@sungard.com>
-rw-r--r--stardust-engine-core/src/main/java/org/eclipse/stardust/engine/api/runtime/QueryService.java47
-rw-r--r--stardust-engine-core/src/main/java/org/eclipse/stardust/engine/api/runtime/UserService.java51
2 files changed, 66 insertions, 32 deletions
diff --git a/stardust-engine-core/src/main/java/org/eclipse/stardust/engine/api/runtime/QueryService.java b/stardust-engine-core/src/main/java/org/eclipse/stardust/engine/api/runtime/QueryService.java
index 9c02579..55b3197 100644
--- a/stardust-engine-core/src/main/java/org/eclipse/stardust/engine/api/runtime/QueryService.java
+++ b/stardust-engine-core/src/main/java/org/eclipse/stardust/engine/api/runtime/QueryService.java
@@ -663,8 +663,8 @@ public interface QueryService extends Service
throws ObjectNotFoundException;
/**
- * Retrieves all the departments satisfying the search criteria. The search is performed
- * as following:
+ * Retrieves all the departments satisfying the search criteria. The search is
+ * performed as following:
* <ul>
* <li>if both parent and organization are null, then the result contains all top level
* departments, regardless of the organization to which they are assigned.</li>
@@ -677,13 +677,19 @@ public interface QueryService extends Service
* departments assigned to the organization, that have as direct parent the specified
* department.</li>
* </ul>
- *
- * @param parent the parent department.
- * @param organization the organization to which the retrieved departments are assigned.
- * @return the list of departments. The list can be empty if no departments are matching
- * the search criteria.
+ * On synchronization departments will be updated when existing in audit trail and
+ * having any changes. If a department does not exist in audit trail but is present in
+ * external repository the department will not be created in audit trail on
+ * synchronization with external repository.
+ *
+ * @param parent
+ * the parent department.
+ * @param organization
+ * the organization to which the retrieved departments are assigned.
+ * @return the list of departments. The list can be empty if no departments are
+ * matching the search criteria.
* @throws ObjectNotFoundException
- * if either the parent or the organization could not be resolved.
+ * if either the parent or the organization could not be resolved.
*/
@ExecutionPermission(id=ExecutionPermission.Id.readDepartments,
defaults={ExecutionPermission.Default.ALL})
@@ -708,17 +714,24 @@ public interface QueryService extends Service
throws ObjectNotFoundException;*/
/**
- * Searches for a department having the specified id in the scope defined by the
- * parent department.
- *
- * @param parent the search scope. It can be null, in which case the search scope
- * is the top level.
- * @param id the id of the department. Must not be null or empty.
- * @param organization the organization to which the retrieved departments are assigned.
+ * Searches for a department having the specified id in the scope defined by the parent
+ * department. On synchronization with external repository the specified department
+ * will be created in audit trail if it is not already present there but exists in
+ * external repository. If the department exists in audit trail it will be updated on
+ * synchronization if there are any changes.
+ *
+ * @param parent
+ * the search scope. It can be null, in which case the search scope is the
+ * top level.
+ * @param id
+ * the id of the department. Must not be null or empty.
+ * @param organization
+ * the organization to which the retrieved departments are assigned.
* @return the department having the specified id.
* @throws ObjectNotFoundException
- * if the parent could not be resolved or if the specified id is null or empty
- * or if there is no department with the specified id in the parent scope.
+ * if the parent could not be resolved or if the specified id is null or
+ * empty or if there is no department with the specified id in the parent
+ * scope.
*/
@ExecutionPermission(id=ExecutionPermission.Id.readDepartments,
defaults={ExecutionPermission.Default.ALL})
diff --git a/stardust-engine-core/src/main/java/org/eclipse/stardust/engine/api/runtime/UserService.java b/stardust-engine-core/src/main/java/org/eclipse/stardust/engine/api/runtime/UserService.java
index e2923bc..cbdac2e 100644
--- a/stardust-engine-core/src/main/java/org/eclipse/stardust/engine/api/runtime/UserService.java
+++ b/stardust-engine-core/src/main/java/org/eclipse/stardust/engine/api/runtime/UserService.java
@@ -150,16 +150,21 @@ public interface UserService extends Service
/**
* Resets the password of specified user by generated password according to configured
- * password rules.
+ * password rules. On synchronization with external repository the specified user will
+ * be created in audit trail if it is not already present there but exists in external
+ * repository. If the user exists in audit trail it will be updated on synchronization
+ * if there are any changes.
*
- * @param account the user account to be modified.
- * @param properties Map providing further login properties.
+ * @param account
+ * the user account to be modified.
+ * @param properties
+ * Map providing further login properties.
*
- * @throws ConcurrencyException
+ * @throws ConcurrencyException
* if another user operates on the specified one.
- * @throws ObjectNotFoundException
+ * @throws ObjectNotFoundException
* if the user or a given grant is not found.
- * @throws IllegalOperationException
+ * @throws IllegalOperationException
* if the authentication is not internal.
*/
@ExecutionPermission(
@@ -260,14 +265,17 @@ public interface UserService extends Service
throws UserExistsException, IllegalOperationException, InvalidPasswordException;
/**
- * Retrieves the user associated with the given account.
+ * Retrieves the user associated with the given account. On synchronization with
+ * external repository the specified user will be created in audit trail if it is not
+ * already present there but exists in external repository. If the user exists in audit
+ * trail it will be updated on synchronization if there are any changes.
*
* @param account
* the account name of the user to retrieve.
*
* @return the user.
*
- * @throws ObjectNotFoundException
+ * @throws ObjectNotFoundException
* if there is no user with the specified account.
*/
@ExecutionPermission(
@@ -276,7 +284,10 @@ public interface UserService extends Service
User getUser(String account) throws ObjectNotFoundException, IllegalOperationException;
/**
- * Retrieves the user associated with the given account.
+ * Retrieves the user associated with the given account. On synchronization with
+ * external repository the specified user will be created in audit trail if it is not
+ * already present there but exists in external repository. If the user exists in audit
+ * trail it will be updated on synchronization if there are any changes.
*
* @param realm
* the realm ID of the user to retrieve.
@@ -294,14 +305,17 @@ public interface UserService extends Service
User getUser(String realm, String account) throws ObjectNotFoundException;
/**
- * Retrieves the specified user.
+ * Retrieves the specified user. On synchronization the user with specified oid will be
+ * updated if this user exists in audit trail and there are any changes. If this user
+ * does not exist in audit trail but is present in external repository it will not be
+ * created in audit trail on synchronization with external repository.
*
* @param userOID
* the OID of the user to retrieve.
*
* @return the user.
*
- * @throws ObjectNotFoundException
+ * @throws ObjectNotFoundException
* if there is no user with the specified oid.
*/
@ExecutionPermission(
@@ -383,7 +397,10 @@ public interface UserService extends Service
InvalidPasswordException, InvalidArgumentException;
/**
- * Retrieves the user group associated with the given ID.
+ * Retrieves the user group associated with the given ID. On synchronization with
+ * external repository the specified user group will be created in audit trail if it is not
+ * already present there but exists in external repository. If the user group exists in audit
+ * trail it will be updated on synchronization if there are any changes.
*
* @param id
* the id of the user group to retrieve.
@@ -399,15 +416,19 @@ public interface UserService extends Service
UserGroup getUserGroup(String id) throws ObjectNotFoundException;
/**
- * Retrieves the specified user group.
+ * Retrieves the specified user group. On synchronization the user group with specified
+ * oid will be updated if this user group exists in audit trail and there are any
+ * changes. If this user group does not exist in audit trail but is present in external
+ * repository it will not be created in audit trail on synchronization with external
+ * repository.
*
* @param oid
* the OID of the user group to retrieve.
*
* @return the user group.
*
- * @throws ObjectNotFoundException
- * if there is no user group with the specified OID.
+ * @throws ObjectNotFoundException
+ * if there is no user group with the specified OID.
*/
@ExecutionPermission(
id=ExecutionPermission.Id.readUserData,