Difference between revisions of "ClientContextLibrary"

From Gcube Wiki
Jump to: navigation, search
(→‎Getting the Client Context in Javascript)
(→‎Case 2 - HTTP GET or POST made with GWT RequestBuilder)
 
(16 intermediate revisions by the same user not shown)
Line 13: Line 13:
 
</source>
 
</source>
  
 +
Read more about Liferay Javascript Object: [1]
  
 
== Getting the Client Context in GWT (Widget) ==
 
== Getting the Client Context in GWT (Widget) ==
Line 42: Line 43:
 
</source>
 
</source>
  
−
Either if you pass this identifier explicitly as parameter, or embed it in the header of your cal, in the server you can use the following snippet to get the infrastructure scope:
+
Either if you pass this identifier explicitly as parameter, or embed it in the header of your call, in the server you can use the following method to get the infrastructure scope (note: scopeGroupId parameter is the value returned from the GCubeClientContext.getCurrentContextId() method described previously:
  
 
<source lang="java">
 
<source lang="java">
−
//groupIdNo is the String in the server passed from the client
+
import org.gcube.common.portal;
 +
...
 +
PortalContext pContext = PortalContext.getConfiguration();
 +
 
 +
/**
 +
*
 +
* @param scopeGroupId the liferay groupid number (as String) of the VRE/VO
 +
* @return the scope (context)
 +
*/
 +
String currentScope = pContext.getCurrentScope(String scopeGroupId);
  
−
if (groupIdNo != null) {
 
−
long groupId = -1;
 
−
try {
 
−
groupId = Long.parseLong(groupIdNo);
 
−
LiferayGroupManager gm = new LiferayGroupManager();
 
−
if (gm.isRootVO(groupId)) {
 
−
return SCOPE_SEPARATOR + getInfrastructureName();
 
−
} else
 
−
return new LiferayGroupManager().getInfrastructureScope(groupId);
 
−
} catch (NumberFormatException e) {
 
−
_log.error("The groupId is not a number -> " + groupId);
 
−
} catch (Exception e) {
 
−
_log.error("This groupId does not belong to any group in this portal -> " + groupId);
 
−
}
 
−
}
 
 
</source>
 
</source>
  
−
== Tips for Development Environment ==
+
==Examples for passing the Client Context via Standard HTTP POST or GET ==
−
The client context relies on Liferay.ThemeDisplay javascript object, which obviously is not available if you run your application outside the real D4Science's portals. Moreover, the Portal Manager allows to retrieve the current context, the current user (plus some other information, such as his/her current security token) at server side.  To overcome such limitation and allow developers to test their applications in Eclipse, a file like this one can be used:
+
  
−
<source lang="xml">
+
It can happen that in your web applications you have to use standard HTTP POST or GET for your servlet. This is true, for instance, when you have to '''upload a file from the browser'''.
−
# ONLY FOR LOCAL (IDE) DEVELOPMENT - NOT FOR PRODUCTION USE!
+
−
# change the properties with your user data and desired scope / token
+
−
# Author: Massimiliano Assante, CNR-ISTI
+
  
−
# a development user
+
Other cases may involve the usage of the GWT '''RequestBuilder''' object (com.google.gwt.http.client.RequestBuilder) for standard HTTP Calls.
−
user.username=test.user
+
−
user.name=aTestName
+
−
user.lastname=aTestLastName
+
−
user.email=testing.user@gcube-system.org
+
  
−
# a development scope (the scope must be bound to the token below)
+
For both cases we here suggests to possible solution, in order to pass the ClientContext to your servlets.
−
development.scope=/gcube/devsec/devVRE
+
  
−
# a valid user token on the (above) development scope.
+
=== Case 1 - HTTP POST requests ===
−
# you can obtain it by registering on one development VRE and using Token Generator portlet
+
 
−
user.token= ....
+
A possible approach is to use one (HTML) Hidden field in the form and to read this hidden field value in the doPost servlet's method.
 +
 
 +
The following example is written in GWT.
 +
 
 +
<source lang="java">
 +
//client side code
 +
...
 +
VerticalPanel panel = new VerticalPanel();
 +
formPanel.setWidget(panel); //com.google.gwt.user.client.ui.FormPanel
 +
fileUpload.setName(...);  //com.google.gwt.user.client.ui.FileUpload
 +
 
 +
 
 +
// Add hidden parameters
 +
String currentContextId = GCubeClientContext.getCurrentContextId();
 +
 
 +
//$YourAttributeName is any attribute name you like, it has to be the same when you'll read it in the servlet's doPost
 +
panel.add(new Hidden($YourAttributeName, currentContextId)); <-- here is where you put the clientContextId,
 +
 
 +
...
 
</source>
 
</source>
  
 +
---
 +
 +
<source lang="java">
 +
//server side code
 +
...
 +
public void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
 +
...
 +
/**
 +
* An iterator to instances of <code>FileItemStream</code>
 +
* parsed from the request, in the order that they were
 +
*transmitted.
 +
*/
 +
FileItemIterator fileItemIterator = servletFileUpload.getItemIterator(request);
 +
String clientContextId = "";
 +
//GET FILE STREAM
 +
while (fileItemIterator.hasNext()) {
 +
FileItemStream item = fileItemIterator.next();
 +
        ...
 +
        if (item.isFormField() && $YourAttributeName.equals(item.getFieldName())){  <-- here is where you read the clientContextId in the server  $YourAttributeName must match the hidden value above
 +
        clientContextId = Streams.asString(item.openStream());
 +
}
 +
        ...
 +
 +
}
 +
String currentScope= PortalContext.getConfiguration().getCurrentScope(clientContextId));  <-- here  where you get the currentScope from the clientContextId
 +
...
 +
}
 +
</source>
 +
 +
 +
=== Case 2 - HTTP GET or POST made with GWT RequestBuilder ===
 +
 +
This case is even easier than the Case 1,  ClientContext injection for GWT RequestBuilder is already supported, nothing to do client side (we report the client snippet just for clarification). Server side code is the same as in PortalContext
 +
 +
<source lang="java">
 +
 +
import com.google.gwt.http.client.*;
 +
 +
//client side code
 +
String url = "http://www.myserver.com/getData?type=3";
 +
RequestBuilder builder = new RequestBuilder(RequestBuilder.GET, URL.encode(url));
 +
try {
 +
  Request request = builder.sendRequest(null, new RequestCallback() {
 +
....
 +
...
 +
</source>
 +
 +
 +
<source lang="java">
 +
//server side code
 +
 +
import org.gcube.common.portal;
 +
 +
public void doGet(HttpServletRequest request, HttpServletResponse response) {
 +
...
 +
PortalContext pContext = PortalContext.getConfiguration();
 +
String currentScope = pContext.getCurrentScope(request);
 +
...
 +
</source>
 +
 +
== Related links and references ==
 +
 +
[1] Liferay Javascript Object usage: https://web.liferay.com/web/pankaj.kathiriya/blog/-/blogs/usage-of-liferay-js-object
  
−
The name of the file must be '''gcube-dev-context.properties''', and must be placed under the CATALINA_HOME system variable. The PortalManager will recognize if the application is running on a real or fake portal and, in the latter case, will retrieve and use the information written in this file.  
+
[2] gCube Portal Manager API: https://wiki.gcube-system.org/gcube/Portal_Context
  
−
'''NOTE''' : depending on the current implementation, the PortalManager set/doesn't set in the ThreadLocal variables the retrieved user's security Token and current Context, once it is queried for this information. ''Be sure to always set them in your own code, if you need them.''
+
[3] gCube UsersManagement Library https://wiki.gcube-system.org/gcube/UserManagement_Core#UserManager_APIs

Latest revision as of 16:44, 25 November 2016

Client Context library for gCube Portlets

Starting from gCube 4.2, the current Context identifier resides client side. If your Portlet does use AJAX calls (i.e. XMLHttpRequest to exchange data with a server behind the scenes) you don't need this component. Everything is already set up for you by the gCube Portal/Gateway in which your application is running.

If you use standard http GET or POST to exchange data with the server instead, and you need to pass to the server the current Infrastructure scope identifier (the Liferay groupId).

Getting the Client Context in Javascript

<script>
var groupId = Liferay.ThemeDisplay.getScopeGroupId();
</script>

Read more about Liferay Javascript Object: [1]

Getting the Client Context in GWT (Widget)

The Client Context has been wrapped as a GWT Widget. Its source code is available in the gCube SVN repository, at this url.

To use the widget, you need to declare the following maven dependency in your project's pom.xml 

<dependency>
        <groupId>org.gcube.portal</groupId>
	<artifactId>client-context-library</artifactId>
	<version>[1.0.0-SNAPSHOT,)</version>
	<scope>compile</scope>
</dependency>

as well as the following line in the gwt.xml file of your gwt-portlet: 

<!--Inherit the GCubeClientContext widget code -->
<inherits name='org.gcube.portal.clientcontext.GCubeClientContext' />

then you just use the GCubeClientContext.getCurrentContextId() method: 

public static native String getCurrentContextId();

Either if you pass this identifier explicitly as parameter, or embed it in the header of your call, in the server you can use the following method to get the infrastructure scope (note: scopeGroupId parameter is the value returned from the GCubeClientContext.getCurrentContextId() method described previously: 

import org.gcube.common.portal;
...
PortalContext pContext = PortalContext.getConfiguration();
 
/**
 * 
 * @param scopeGroupId the liferay groupid number (as String) of the VRE/VO
 * @return the scope (context)
 */
String currentScope = pContext.getCurrentScope(String scopeGroupId);

Examples for passing the Client Context via Standard HTTP POST or GET

It can happen that in your web applications you have to use standard HTTP POST or GET for your servlet. This is true, for instance, when you have to upload a file from the browser.

Other cases may involve the usage of the GWT RequestBuilder object (com.google.gwt.http.client.RequestBuilder) for standard HTTP Calls.

For both cases we here suggests to possible solution, in order to pass the ClientContext to your servlets.

Case 1 - HTTP POST requests

A possible approach is to use one (HTML) Hidden field in the form and to read this hidden field value in the doPost servlet's method.

The following example is written in GWT. 

//client side code
...
VerticalPanel panel = new VerticalPanel();
formPanel.setWidget(panel); //com.google.gwt.user.client.ui.FormPanel
fileUpload.setName(...);  //com.google.gwt.user.client.ui.FileUpload
 
 
// Add hidden parameters
String currentContextId = GCubeClientContext.getCurrentContextId();
 
//$YourAttributeName is any attribute name you like, it has to be the same when you'll read it in the servlet's doPost
panel.add(new Hidden($YourAttributeName, currentContextId)); <-- here is where you put the clientContextId, 
 
...

--- 

//server side code
...
public void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
...
/**
 * An iterator to instances of <code>FileItemStream</code>
 * parsed from the request, in the order that they were
 *transmitted.
 */
FileItemIterator fileItemIterator = servletFileUpload.getItemIterator(request);
String clientContextId = "";
//GET FILE STREAM
while (fileItemIterator.hasNext()) {
	FileItemStream item = fileItemIterator.next();
        ...
        if (item.isFormField() && $YourAttributeName.equals(item.getFieldName())){  <-- here is where you read the clientContextId in the server  $YourAttributeName must match the hidden value above
	         clientContextId = Streams.asString(item.openStream());
	}
        ...
 
}
String currentScope= PortalContext.getConfiguration().getCurrentScope(clientContextId));  <-- here  where you get the currentScope from the clientContextId
...
}


Case 2 - HTTP GET or POST made with GWT RequestBuilder

This case is even easier than the Case 1, ClientContext injection for GWT RequestBuilder is already supported, nothing to do client side (we report the client snippet just for clarification). Server side code is the same as in PortalContext 

import com.google.gwt.http.client.*;
 
//client side code
String url = "http://www.myserver.com/getData?type=3";
RequestBuilder builder = new RequestBuilder(RequestBuilder.GET, URL.encode(url));
try {
  Request request = builder.sendRequest(null, new RequestCallback() {
....
...


//server side code
 
import org.gcube.common.portal;
 
public void doGet(HttpServletRequest request, HttpServletResponse response) {
...
PortalContext pContext = PortalContext.getConfiguration();
String currentScope = pContext.getCurrentScope(request);
...

Related links and references

[1] Liferay Javascript Object usage: https://web.liferay.com/web/pankaj.kathiriya/blog/-/blogs/usage-of-liferay-js-object

[2] gCube Portal Manager API: https://wiki.gcube-system.org/gcube/Portal_Context

[3] gCube UsersManagement Library https://wiki.gcube-system.org/gcube/UserManagement_Core#UserManager_APIs

Retrieved from "https://wiki.gcube-system.org/index.php?title=ClientContextLibrary&oldid=27898"