Merge pull request #229 from wallner/filter_resources

Filtering of attributes of the queried resources

Author: tkrille

CHANGELOG.md

@@ -8,6 +8,8 @@ Please update to OSIAM 3.0 as soon as possible.
 
 ### Features
 
+- It is now possible to filter the attributes of the returned `User` and `Group` resources by supplying the
+  attributes as arguments to the the appropriate methods. 
 - Introduce a `getMe()` method to retrieve the currently logged in user
   from OSIAM. This is supposed to be the new method to retrieve the logged in
   user and also works with OSIAM 2.x.

docs/working-with-groups.md

@@ -76,28 +76,36 @@ To retrieve a single Group you need her UUID (for example
 94bbe688-4b1e-4e4e-80e7-e5ba5c4d6db4):
 
 ```java
-OsiamConnector oConnector = [Retrieving an OsiamConnector](create-osiam-connector.md)
-AccessToken accessToken = [Retrieving an AccessToken](login-and-getting-an-access-token.md#retrieving-an-accesstoken)
 Group group = oConnector.getGroup(<GROUP_UUID>, accessToken);
 ```
 (please consider the possible runtimeException which are explained in the
 Javadoc)
 
+It is possible to filter the attributes of the returned resource by specifying the attributes to return as parameters 
+to the method: 
+
+ ```java
+Group group = osiamConnector.getGroup(<GROUP_ID>, accessToken, "displayName", "meta.created");
+ ```
 ## Retrieve all Groups
 
 If you want to retrieve all groups you can call the following method:
 
 ```java
-OsiamConnector oConnector = [Retrieving an OsiamConnector](create-osiam-connector.md)
-AccessToken accessToken = [Retrieving an AccessToken](login-and-getting-an-access-token.md#retrieving-an-accesstoken)
-SCIMSearchResult<Group> searchResult = oConnector.getAllGroups(accessToken);
+List<Group> searchResult = oConnector.getAllGroups(accessToken);
 int numberOfGroups = searchResult.getTotalResults();
 for (Group actGroup : searchResult.Resources()) {
 	//...
 }
 //...
 ```
 
+It is possible to filter the attributes of the returned groups by supplying the attributes as parameters to the method:
+
+```java
+List<Group> searchResult = oConnector.getAllGroups(accessToken, "displayName", "meta.created");
+```
+
 ## Search for groups
 
 The [Query](query.md) class helps you
@@ -107,8 +115,6 @@ examples in the page are for users. Please adapt them for groups)
 A complete example how you can run a search for a user is described below:
 
 ```java
-OsiamConnector oConnector = [Retrieving an OsiamConnector](create-osiam-connector.md)
-AccessToken accessToken = [Retrieving an AccessToken](login-and-getting-an-access-token.md#retrieving-an-accesstoken)
 Query query = [Create an Query](query.md)
 SCIMSearchResult<Group> result = oConnector.searchGroups(query, accessToken);
 ```

docs/working-with-user.md

@@ -74,51 +74,58 @@ To retrieve a single user you need his UUID (for example:
 94bbe688-4b1e-4e4e-80e7-e5ba5c4d6db4):
 
 ```java
-OsiamConnector oConnector = [Retrieving an OsiamConnector](create-osiam-connector.md)
-AccessToken accessToken = [Retrieving an AccessToken](login-and-getting-an-access-token.md#retrieving-an-accesstoken)
-User user = oConnector.getUser(<USER_UUID>, accessToken);
+User user = osiamConnector.getUser(<USER_UUID>, accessToken);
 ```
 
+It is possible to filter the attributes of the returned resource by specifying the attributes to return as parameters 
+to the method:
+
+ ```java
+User user = osiamConnector.getUser(<USER_ID>, accessToken, "userName", "displayName", "meta.created");
+ ```
+
 (please consider the possible runtimeException which are explained in the
 Javadoc)
 
-# Retrieve the current logged in user by his access token
+# Retrieve the currently logged in user by their access token
 
-If you are logged in with the client scope and you try to retrieve the current
-logged user you will retrieve a ConflictException.
+To retrieve the user that the currently held access token belongs to, the `getMe()` method is avaiable:
 
-```sh
-OsiamConnector oConnector = [Retrieving an OsiamConnector](create-osiam-connector.md)
-AccessToken accessToken = [Retrieving an AccessToken](login-and-getting-an-access-token.md#retrieving-an-accesstoken)
+```java
 // retrieves the complete currently logged in User.
-User user = oConnector.getMe(accessToken);
+User user = osiamConnector.getMe(accessToken);
+```
+It is possible to filter the attributes of the returned user by supplying the wanted attributes as parameters
+to the method:
+
+```java
+User user = osiamConnector.getUser(<USER_ID>, accessToken, "userName", "displayName", "meta.created");
 ```
 
 # Retrieve all Users
 
 If you want to retrieve all users you can call the following method:
 
 ```java
-OsiamConnector oConnector = [Retrieving an OsiamConnector](create-osiam-connector.md)
-AccessToken accessToken = [Retrieving an AccessToken](login-and-getting-an-access-token.md#retrieving-an-accesstoken)
-SCIMSearchResult<User> searchResult = oConnector.getAllUsers(accessToken);
+List<User> users = oConnector.getAllUsers(accessToken);
 int numberOfUsers = searchResult.getTotalResults();
 for (User actUser : searchResult.Resources()) {
 	//...
 }
-//...
+```
+It is possible to filter the attributes of the returned users by supplying the attributes as parameters to the method:
+
+```java
+List<User> users = oConnector.getAllUsers(accessToken, "userName", "meta.created");
 ```
 
 # Search for User
 
 The [Query](query.md) class helps you
 to create an Query based on the needed filter and other attributes.
 
-A complete example how you can run a search for a user is described below:
+An example how to run a search for a user is shown below:
 
 ```java
-OsiamConnector oConnector = [Retrieving an OsiamConnector](create-osiam-connector.md)
-AccessToken accessToken = [Retrieving an AccessToken](login-and-getting-an-access-token.md#retrieving-an-accesstoken)
-Query query = [Create an Query](query.md)
 SCIMSearchResult<User> result = oConnector.searchUsers(query, accessToken);
 ```

src/main/java/org/osiam/client/AbstractOsiamService.java

@@ -30,26 +30,15 @@
 import com.fasterxml.jackson.databind.node.ArrayNode;
 import com.fasterxml.jackson.databind.node.ObjectNode;
 import com.fasterxml.jackson.databind.type.TypeFactory;
+import com.google.common.base.Joiner;
 import com.google.common.base.Strings;
 import org.glassfish.jersey.client.ClientProperties;
-import org.osiam.client.exception.BadRequestException;
-import org.osiam.client.exception.ConflictException;
-import org.osiam.client.exception.ConnectionInitializationException;
-import org.osiam.client.exception.ForbiddenException;
-import org.osiam.client.exception.NoResultException;
-import org.osiam.client.exception.OAuthErrorMessage;
-import org.osiam.client.exception.OsiamClientException;
-import org.osiam.client.exception.OsiamRequestException;
-import org.osiam.client.exception.UnauthorizedException;
+import org.osiam.client.exception.*;
 import org.osiam.client.oauth.AccessToken;
 import org.osiam.client.query.Query;
 import org.osiam.client.query.QueryBuilder;
 import org.osiam.resources.helper.UserDeserializer;
-import org.osiam.resources.scim.ErrorResponse;
-import org.osiam.resources.scim.Group;
-import org.osiam.resources.scim.Resource;
-import org.osiam.resources.scim.SCIMSearchResult;
-import org.osiam.resources.scim.User;
+import org.osiam.resources.scim.*;
 
 import javax.ws.rs.ProcessingException;
 import javax.ws.rs.client.Entity;
@@ -60,7 +49,6 @@
 import javax.ws.rs.core.Response.Status.Family;
 import javax.ws.rs.core.Response.StatusType;
 import java.io.IOException;
-import java.lang.reflect.ParameterizedType;
 import java.util.List;
 import java.util.Map;
 
@@ -104,14 +92,21 @@ static void checkAccessTokenIsNotNull(AccessToken accessToken) {
         checkNotNull(accessToken, "The given accessToken must not be null.");
     }
 
-    T getResource(String id, AccessToken accessToken) {
+    T getResource(String id, AccessToken accessToken, String... attributes) {
         checkArgument(!Strings.isNullOrEmpty(id), "The given id must not be null nor empty.");
         checkAccessTokenIsNotNull(accessToken);
 
         StatusType status;
         String content;
+
+        WebTarget target;
+        if (attributes == null || attributes.length == 0) {
+            target = targetEndpoint;
+        } else {
+            target = targetEndpoint.queryParam("attributes", Joiner.on(",").join(attributes));
+        }
         try {
-            Response response = targetEndpoint.path(typeName + "s").path(id).request(MediaType.APPLICATION_JSON)
+            Response response = target.path(typeName + "s").path(id).request(MediaType.APPLICATION_JSON)
                     .header(AUTHORIZATION, BEARER + accessToken.getToken())
                     .property(ClientProperties.CONNECT_TIMEOUT, connectTimeout)
                     .property(ClientProperties.READ_TIMEOUT, readTimeout)
@@ -128,8 +123,12 @@ T getResource(String id, AccessToken accessToken) {
         return mapToResource(content);
     }
 
-    List<T> getAllResources(AccessToken accessToken) {
-        Query query = new QueryBuilder().count(Integer.MAX_VALUE).build();
+    List<T> getAllResources(AccessToken accessToken, String... attributes) {
+        QueryBuilder qBuilder = new QueryBuilder().count(Integer.MAX_VALUE);
+        if (attributes != null && attributes.length > 0) {
+            qBuilder.attributes(Joiner.on(',').join(attributes));
+        }
+        Query query = qBuilder.build();
         return searchResources(query, accessToken).getResources();
     }