syncope-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From cohei...@apache.org
Subject syncope git commit: Updating the javadoc for AnyService to make it clearer how the "key" parameter is used
Date Wed, 26 Apr 2017 13:27:36 GMT
Repository: syncope
Updated Branches:
  refs/heads/2_0_X 0cae76119 -> 355e1e70c


Updating the javadoc for AnyService to make it clearer how the "key" parameter is used


Project: http://git-wip-us.apache.org/repos/asf/syncope/repo
Commit: http://git-wip-us.apache.org/repos/asf/syncope/commit/355e1e70
Tree: http://git-wip-us.apache.org/repos/asf/syncope/tree/355e1e70
Diff: http://git-wip-us.apache.org/repos/asf/syncope/diff/355e1e70

Branch: refs/heads/2_0_X
Commit: 355e1e70cb4139154850eefbe251e3f5a3d8ac8a
Parents: 0cae761
Author: Colm O hEigeartaigh <coheigea@apache.org>
Authored: Wed Apr 26 14:26:28 2017 +0100
Committer: Colm O hEigeartaigh <coheigea@apache.org>
Committed: Wed Apr 26 14:27:27 2017 +0100

----------------------------------------------------------------------
 .../apache/syncope/common/rest/api/service/AnyService.java  | 9 +++++++++
 1 file changed, 9 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/syncope/blob/355e1e70/common/rest-api/src/main/java/org/apache/syncope/common/rest/api/service/AnyService.java
----------------------------------------------------------------------
diff --git a/common/rest-api/src/main/java/org/apache/syncope/common/rest/api/service/AnyService.java
b/common/rest-api/src/main/java/org/apache/syncope/common/rest/api/service/AnyService.java
index ac958e1..d288e59 100644
--- a/common/rest-api/src/main/java/org/apache/syncope/common/rest/api/service/AnyService.java
+++ b/common/rest-api/src/main/java/org/apache/syncope/common/rest/api/service/AnyService.java
@@ -47,6 +47,9 @@ public interface AnyService<TO extends AnyTO, P extends AnyPatch>
extends JAXRSS
     /**
      * Reads the list of attributes owned by the given any object for the given schema type.
      *
+     * Note that for the UserService, GroupService and AnyObjectService subclasses, if the
key parameter
+     * looks like a UUID then it is interpreted as as key, otherwise as a (user)name.
+     *
      * @param key any object key
      * @param schemaType schema type
      * @return list of attributes, owned by the given any object, for the given schema type
@@ -59,6 +62,9 @@ public interface AnyService<TO extends AnyTO, P extends AnyPatch>
extends JAXRSS
     /**
      * Reads the attribute, owned by the given any object, for the given schema type and
schema.
      *
+     * Note that for the UserService, GroupService and AnyObjectService subclasses, if the
key parameter
+     * looks like a UUID then it is interpreted as as key, otherwise as a (user)name.
+     *
      * @param key any object key
      * @param schemaType schema type
      * @param schema schema
@@ -75,6 +81,9 @@ public interface AnyService<TO extends AnyTO, P extends AnyPatch>
extends JAXRSS
     /**
      * Reads the any object matching the provided key.
      *
+     * Note that for the UserService, GroupService and AnyObjectService subclasses, if the
key parameter
+     * looks like a UUID then it is interpreted as as key, otherwise as a (user)name.
+     *
      * @param key key of any object to be read
      * @return any object with matching key
      */


Mime
View raw message