GUACAMOLE-5: Expose session as a REST resource. Refactor /api/data to /api/session/data.

guacamole/src/main/java/org/apache/guacamole/rest/RESTServiceModule.java

@@ -20,7 +20,7 @@
 package org.apache.guacamole.rest;
 
 import org.apache.guacamole.rest.session.UserContextResourceFactory;
-import org.apache.guacamole.rest.session.SessionDataRESTService;
+import org.apache.guacamole.rest.session.SessionRESTService;
 import com.google.inject.Scopes;
 import com.google.inject.assistedinject.FactoryModuleBuilder;
 import com.google.inject.matcher.Matchers;
@@ -38,6 +38,7 @@ import org.apache.guacamole.rest.connection.ConnectionModule;
 import org.apache.guacamole.rest.connectiongroup.ConnectionGroupModule;
 import org.apache.guacamole.rest.language.LanguageRESTService;
 import org.apache.guacamole.rest.patch.PatchRESTService;
+import org.apache.guacamole.rest.session.SessionResourceFactory;
 import org.apache.guacamole.rest.tunnel.TunnelRESTService;
 import org.apache.guacamole.rest.user.UserModule;
 
@@ -92,7 +93,8 @@ public class RESTServiceModule extends ServletModule {
         bind(TunnelRESTService.class);
 
         // Root-level resources
-        bind(SessionDataRESTService.class);
+        bind(SessionRESTService.class);
+        install(new FactoryModuleBuilder().build(SessionResourceFactory.class));
         install(new FactoryModuleBuilder().build(UserContextResourceFactory.class));
 
         // Resources below root

guacamole/src/main/java/org/apache/guacamole/rest/session/SessionRESTService.java

@@ -0,0 +1,81 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.guacamole.rest.session;
+
+import com.google.inject.Inject;
+import javax.ws.rs.Consumes;
+import javax.ws.rs.Path;
+import javax.ws.rs.Produces;
+import javax.ws.rs.QueryParam;
+import javax.ws.rs.core.MediaType;
+import org.apache.guacamole.GuacamoleException;
+import org.apache.guacamole.GuacamoleSession;
+import org.apache.guacamole.rest.auth.AuthenticationService;
+
+/**
+ * A REST service which exposes all data associated with Guacamole users'
+ * sessions.
+ *
+ * @author Michael Jumper
+ */
+@Path("/session")
+@Produces(MediaType.APPLICATION_JSON)
+@Consumes(MediaType.APPLICATION_JSON)
+public class SessionRESTService {
+
+    /**
+     * A service for authenticating users from auth tokens.
+     */
+    @Inject
+    private AuthenticationService authenticationService;
+
+    /**
+     * Factory for creating SessionResources which expose a given
+     * GuacamoleSession.
+     */
+    @Inject
+    private SessionResourceFactory sessionResourceFactory;
+
+    /**
+     * Retrieves a resource representing the GuacamoleSession associated with
+     * the given authentication token.
+     *
+     * @param authToken
+     *     The authentication token that is used to authenticate the user
+     *     having the session being exposed.
+     *
+     * @return
+     *     A resource representing the GuacamoleSession associated with the
+     *     given authentication token.
+     *
+     * @throws GuacamoleException
+     *     If the authentication token is invalid.
+     */
+    @Path("/")
+    public SessionResource getSessionResource(@QueryParam("token") String authToken)
+            throws GuacamoleException {
+
+        // Return a resource exposing the retrieved session
+        GuacamoleSession session = authenticationService.getGuacamoleSession(authToken);
+        return sessionResourceFactory.create(session);
+
+    }
+
+}

guacamole/src/main/java/org/apache/guacamole/rest/session/SessionResource.java

@@ -20,34 +20,32 @@
 package org.apache.guacamole.rest.session;
 
 import com.google.inject.Inject;
+import com.google.inject.assistedinject.Assisted;
+import com.google.inject.assistedinject.AssistedInject;
 import javax.ws.rs.Consumes;
 import javax.ws.rs.Path;
 import javax.ws.rs.PathParam;
 import javax.ws.rs.Produces;
-import javax.ws.rs.QueryParam;
 import javax.ws.rs.core.MediaType;
 import org.apache.guacamole.GuacamoleException;
 import org.apache.guacamole.GuacamoleSession;
 import org.apache.guacamole.net.auth.UserContext;
 import org.apache.guacamole.rest.ObjectRetrievalService;
-import org.apache.guacamole.rest.auth.AuthenticationService;
 
 /**
- * A REST service which exposes all data associated with a Guacamole user's
+ * A REST resource which exposes all data associated with a Guacamole user's
  * session via the underlying UserContexts.
  *
  * @author Michael Jumper
  */
-@Path("/data")
 @Produces(MediaType.APPLICATION_JSON)
 @Consumes(MediaType.APPLICATION_JSON)
-public class SessionDataRESTService {
+public class SessionResource {
 
     /**
-     * A service for authenticating users from auth tokens.
+     * The GuacamoleSession being exposed by this SessionResource.
      */
-    @Inject
-    private AuthenticationService authenticationService;
+    private final GuacamoleSession session;
 
     /**
      * Service for convenient retrieval of objects.
@@ -62,14 +60,23 @@ public class SessionDataRESTService {
     @Inject
     private UserContextResourceFactory userContextResourceFactory;
 
+    /**
+     * Creates a new SessionResource which exposes the data within the given
+     * GuacamoleSession.
+     *
+     * @param session
+     *     The GuacamoleSession which should be exposed through this
+     *     SessionResource.
+     */
+    @AssistedInject
+    public SessionResource(@Assisted GuacamoleSession session) {
+        this.session = session;
+    }
+
     /**
      * Retrieves a resource representing the UserContext associated with the
      * AuthenticationProvider having the given identifier.
      *
-     * @param authToken
-     *     The authentication token that is used to authenticate the user
-     *     performing the operation.
-     *
      * @param authProviderIdentifier
      *     The unique identifier of the AuthenticationProvider associated with
      *     the UserContext being retrieved.
@@ -79,17 +86,14 @@ public class SessionDataRESTService {
      *     AuthenticationProvider having the given identifier.
      *
      * @throws GuacamoleException
-     *     If the authentication token or AuthenticationProvider identifier are
-     *     invalid.
+     *     If the AuthenticationProvider identifier is invalid.
      */
-    @Path("{dataSource}")
+    @Path("data/{dataSource}")
     public UserContextResource getUserContextResource(
-            @QueryParam("token") String authToken,
             @PathParam("dataSource") String authProviderIdentifier)
             throws GuacamoleException {
 
         // Pull UserContext defined by the given auth provider identifier
-        GuacamoleSession session = authenticationService.getGuacamoleSession(authToken);
         UserContext userContext = retrievalService.retrieveUserContext(session, authProviderIdentifier);
 
         // Return a resource exposing the retrieved UserContext

guacamole/src/main/java/org/apache/guacamole/rest/session/SessionResourceFactory.java

@@ -0,0 +1,45 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.guacamole.rest.session;
+
+import org.apache.guacamole.GuacamoleSession;
+
+/**
+ * Factory which creates resources that expose the contents of a given
+ * GuacamoleSession.
+ *
+ * @author Michael Jumper
+ */
+public interface SessionResourceFactory {
+
+    /**
+     * Creates a new SessionResource which exposes the contents of the
+     * given GuacamoleSession.
+     *
+     * @param session
+     *     The GuacamoleSession whose contents should be exposed.
+     *
+     * @return
+     *     A new SessionResource which exposes the contents of the given
+     *     GuacamoleSession.
+     */
+    SessionResource create(GuacamoleSession session);
+
+}