Merge pull request #178 from tkrille/legacy-mode

Restore support for OSIAM 2.x

Author: Florian Wallner

CHANGELOG.md

@@ -2,10 +2,21 @@
 
 ## 1.8 - Unreleased
 
-### Changes
+### Features
 
 - Ability to set timeouts on per connector basis
 - Add client management
+- Add legacy schemas mode for connecting to OSIAM <= 2.3
+
+    Please, see [Create an OSIAM connector](docs/create-osiam-connector.md#legacy-schemas),
+    if you use an OSIAM version <= 2.3.
+
+- Restore support for OSIAM 2.x
+
+### Changes
+
+- `OsiamConnector#setMaxConnections(int maxConnections)` will also set
+  the maximum connections per route to the given value.
 
 ## 1.7 - 2015-09-11
 

docs/create-osiam-connector.md

@@ -2,17 +2,55 @@ To be able to log in, and create or change users or groups you need to create
 an `org.osiam.client.connector.OsiamConnector` instance. You can do this by
 using the `OsiamConnector.Builder()` class.
 
+## OSIAM 3.x
+
+In OSIAM 3.x auth-server and resource-server have been merged to create a better
+user experience. Thus you have to provide only 1 endpoint for the Connector to
+connect to OSIAM:
+
+
 ```java
 OsiamConnector osiamConnector = new OsiamConnector.Builder()
-       .setEndpoint(OSIAM_ENDPOINT)
+       .withEndpoint(OSIAM_ENDPOINT)
        .setClientId(CLIENT_ID)
        .setClientSecret(CLIENT_SECRET)
        .build();
 ```
 
+## OSIAM 2.x
+
+OSIAM consists of 2 servers, namely auth-server and resource-server. Therefore
+you have to provide 2 endpoints for the Connector to connect to OSIAM:
+
+```java
+OsiamConnector osiamConnector = new OsiamConnector.Builder()
+        .setAuthServerEndpoint(AUTH_ENDPOINT_ADDRESS)
+        .setResourceServerEndpoint(RESOURCE_ENDPOINT_ADDRESS)
+        .setClientId(CLIENT_ID)
+        .setClientSecret(CLIENT_SECRET)
+        .build();
+```
+
+In case your auth and resource server are located at the same location and
+follow the specified naming convention you can also use:
+
+```java
+OsiamConnector osiamConnector = new OsiamConnector.Builder()
+        .setEndpoint(OSIAM_ENDPOINT)
+        .setClientId(CLIENT_ID)
+        .setClientSecret(CLIENT_SECRET)
+        .build();
+```
+
+This will append the default context roots to the given endpoint:
+
+- auth-server: `/osiam-auth-server`
+- resource-server: `/osiam-resource-server`
+
 ## Timeouts
 
-(since 1.4) You can also set the connect and read timeouts like this:
+Starting with version 1.4 you can also set the connect and read timeouts
+like this:
 
 ```java
 OsiamConnector.setConnectTimeout(2500);
@@ -24,3 +62,20 @@ define them for **all** connectors you create. This will be addressed in a
 future version, but note that it is recommended to use only **one** connector
 instance for the whole application, unless you need to use different OAuth
 clients.
+
+## Legacy Schemas
+
+Starting with version 1.8 you can configure the use of legacy schemas, i.e.
+schemas that were defined before SCIM 2 draft 09, like this:
+
+```java
+OsiamConnector osiamConnector = new OsiamConnector.Builder()
+       ...
+       .withLegacySchemas(true)
+       ...
+       .build();
+```
+
+This enables compatibility with OSIAM releases up to version 2.3 (resource-server 2.2). This
+behavior is not enabled by default. Set it to `true` if you connect to an OSIAM version <= 2.3 and,
+please, update to 2.5 or later immediately.

docs/login-and-getting-an-access-token.md

@@ -26,7 +26,7 @@ With **new Scope("your scope");** you can also create and add your own scopes th
 # Retrieving an access token
 
 In a trusted environment getting an access token from OSIAM implies a successful
-login of the user. 
+login of the user.
 
 ## [Authorization Code Grant](https://github.com/osiam/osiam/blob/master/docs/api_documentation.md#authorization-code-grant)
 
@@ -73,7 +73,7 @@ AccessToken the following way
 
     AccessToken accessToken = new AccessToken.Builder(<token>).build();
 
-## [Resource Owner Password Credentials Grant](https://github.com/osiam/osiam/blob/master/docs/api_documentation.md#resource-owner-password-credentials-grant) 
+## [Resource Owner Password Credentials Grant](https://github.com/osiam/osiam/blob/master/docs/api_documentation.md#resource-owner-password-credentials-grant)
 and
 ## [Client Credentials Grant](https://github.com/osiam/osiam/blob/master/docs/api_documentation.md#client-credentials-grant)
 

docs/vertx-example.md

@@ -26,7 +26,10 @@ public class Main {
 
             {
                 oConnector = new OsiamConnector.Builder()
-                .setEndpoint("http://localhost:8180/osiam")
+                // OSIAM 3.x
+                .withEndpoint("http://localhost:8080/osiam")
+                // OSIAM 2.x
+                .setEndpoint("http://localhost:8080")
                 .setClientId("example-client")
                 .setClientSecret("secret")
                 .setClientRedirectUri("http://localhost:5000/oauth2")

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

@@ -28,25 +28,17 @@
 import com.fasterxml.jackson.core.type.TypeReference;
 import com.fasterxml.jackson.databind.JavaType;
 import com.fasterxml.jackson.databind.module.SimpleModule;
+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.Strings;
 import org.glassfish.jersey.client.ClientProperties;
-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.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;
@@ -80,6 +72,7 @@ abstract class AbstractOsiamService<T extends Resource> {
     private final String typeName;
     private final int connectTimeout;
     private final int readTimeout;
+    private final boolean legacySchemas;
 
     protected final WebTarget targetEndpoint;
 
@@ -88,9 +81,12 @@ protected AbstractOsiamService(Builder<T> builder) {
         typeName = builder.typeName;
         connectTimeout = builder.connectTimeout;
         readTimeout = builder.readTimeout;
+        legacySchemas = builder.legacySchemas;
 
+        UserDeserializer userDeserializer =
+                legacySchemas ? new UserDeserializer(OsiamUserService.LEGACY_SCHEMA) : new UserDeserializer();
         SimpleModule userDeserializerModule = new SimpleModule("userDeserializerModule", Version.unknownVersion())
-                .addDeserializer(User.class, new UserDeserializer(User.class));
+                .addDeserializer(User.class, userDeserializer);
         objectMapper.registerModule(userDeserializerModule);
 
         targetEndpoint = OsiamConnector.getClient().target(builder.endpoint);
@@ -192,8 +188,8 @@ protected T createResource(T resource, AccessToken accessToken) {
 
         String resourceAsString;
         try {
-            resourceAsString = objectMapper.writeValueAsString(resource);
-        } catch (JsonProcessingException e) {
+            resourceAsString = mapToString(resource);
+        } catch (JsonProcessingException | ClassCastException e) {
             throw new ConnectionInitializationException(CONNECTION_SETUP_ERROR_STRING, e);
         }
 
@@ -232,7 +228,7 @@ private T modifyResource(String id, T resource, String method, AccessToken acces
 
         String resourceAsString;
         try {
-            resourceAsString = objectMapper.writeValueAsString(resource);
+            resourceAsString = mapToString(resource);
         } catch (JsonProcessingException e) {
             throw new ConnectionInitializationException(CONNECTION_SETUP_ERROR_STRING, e);
         }
@@ -257,18 +253,48 @@ private T modifyResource(String id, T resource, String method, AccessToken acces
         return mapToResource(content);
     }
 
-    protected T mapToResource(String content) {
+    private T mapToResource(String content) {
         return mapToType(content, type);
     }
 
     protected <U> U mapToType(String content, Class<U> type) {
         try {
-            return objectMapper.readValue(content, type);
-        } catch (IOException e) {
+            if (legacySchemas && (type == User.class || type == Group.class)) {
+                ObjectNode resourceNode = (ObjectNode) objectMapper.readTree(content);
+                switchToLegacySchema(resourceNode);
+                return objectMapper.readValue(objectMapper.treeAsTokens(resourceNode), type);
+            } else {
+                return objectMapper.readValue(content, type);
+            }
+        } catch (IOException | ClassCastException e) {
             throw new OsiamClientException(String.format("Unable to parse %s: %s", typeName, content), e);
         }
     }
 
+    private String mapToString(T resource) throws JsonProcessingException {
+        if (legacySchemas) {
+            ObjectNode resourceNode = objectMapper.valueToTree(resource);
+            switchToLegacySchema(resourceNode);
+            return resourceNode.toString();
+        } else {
+            return objectMapper.writeValueAsString(resource);
+        }
+    }
+
+    private void switchToLegacySchema(ObjectNode resourceNode) {
+        ArrayNode schemas = (ArrayNode) resourceNode.get("schemas");
+        for (int i = 0; i < schemas.size(); i++) {
+            if (getSchema().equals(schemas.get(i).textValue())) {
+                schemas.remove(i);
+            }
+        }
+        schemas.add(getLegacySchema());
+    }
+
+    protected abstract String getSchema();
+
+    protected abstract String getLegacySchema();
+
     protected void checkAndHandleResponse(String content, StatusType status, AccessToken accessToken) {
         if (status.getFamily() == Family.SUCCESSFUL) {
             return;
@@ -309,25 +335,29 @@ protected String extractErrorMessageDefault(String content, StatusType status) {
     }
 
     protected String extractErrorMessage(String content, StatusType status) {
-
-        String message = getScimErrorMessageSinceOsiam3(content);
-        if (message == null) {
-            message = getScimErrorMessageUpToOsiam2(content);
+        String message;
+        if (legacySchemas) {
+            message = getScimErrorMessageLegacy(content);
+        } else {
+            message = getScimErrorMessage(content);
         }
+
         if (message == null) {
             message = getOAuthErrorMessage(content);
         }
+
         if (message == null) {
             message = String.format("Could not deserialize the error response for the HTTP status '%s'.",
                     status.getReasonPhrase());
             if (content != null) {
                 message += String.format(" Original response: %s", content);
             }
         }
+
         return message;
     }
 
-    private String getScimErrorMessageSinceOsiam3(String content) {
+    private String getScimErrorMessage(String content) {
         try {
             ErrorResponse error = objectMapper.readValue(content, ErrorResponse.class);
             return error.getDetail();
@@ -336,7 +366,7 @@ private String getScimErrorMessageSinceOsiam3(String content) {
         }
     }
 
-    private String getScimErrorMessageUpToOsiam2(String content) {
+    private String getScimErrorMessageLegacy(String content) {
         try {
             Map<String, String> error = objectMapper.readValue(content, new TypeReference<Map<String, String>>() {
             });
@@ -374,6 +404,7 @@ protected static class Builder<T> {
         private String typeName;
         protected int connectTimeout = OsiamConnector.DEFAULT_CONNECT_TIMEOUT;
         protected int readTimeout = OsiamConnector.DEFAULT_READ_TIMEOUT;
+        protected boolean legacySchemas = OsiamConnector.DEFAULT_LEGACY_SCHEMAS;
 
         @SuppressWarnings("unchecked")
         protected Builder(String endpoint) {