Difference between revisions of "Portal Context"

Revision as of 11:55, 29 August 2016

Introduction

The gCube Portal Manager is a component all portlets need to use to get the portal context where they are running into & to get the centralised email manager for sending emails from your application.

Moreover, passing an HttpServletRequest object to its methods, you can also:

• retrieve the list of Virtual Organizations available on a given portal;
• retrieve the configured senders of emails sent by the portal;
• retrieve the gateway of the portal.

Maven Dependency

In order to use it in your project, add the following dependency to the project's pom.xml file

<dependency>
	<groupId>org.gcube.common.portal</groupId>
	<artifactId>portal-manager</artifactId>
	<scope>provided</scope>
</dependency>

PortalContext

A new instance of the manager can be retrieved by invoking

PortalContext instance = PortalContext.getConfiguration();

Now it allows you to retrieve:

• The name of the gateway and its URL

package org.gcube.common.portal;
...
// get the gateway name given the HttpServletRequest
String gatewayName = instance.getGatewayName(request);
 
// get the gateway url given the HttpServletRequest
String gatewayUrl = instance.getGatewayUrl(request);

• The landing page path of the current Site e.g. "/group/i-marine"

package org.gcube.common.portal;
...
// get the landing page path of the current Site e.g. "/group/i-marine"
String landingPagePath = instance.getSiteLandingPagePath(request);

• mail sender for the current site

// get the current site email's sender (used when notifications are sent, for example), given the HttpServletRequest 
String sender = instance.getSenderEmail(request);

• the name of the current infrastructure in which the client is running

package org.gcube.common.portal;
....
// get the current infrastructure name
String infrastructureName = instance.getInfrastructureName();

• retrieve the list of VOs

// get the VOs
List<String> listVo = instance.getVOs();

Centralised Email Manager

The constructor expects the following parameters:

public EmailNotification(String recipient, String subject, String body, HttpServletRequest httpServletRequest)

once the object is instantiated just use the public void sendEmail() method to add the email to queue. The email will be delivered within minutes.

How to use it:

package org.gcube.common.portal.mailing;
 
//instanciate
EmailNotification mailToSend = new EmailNotification(
					email , 
					subject, 
					emailText, 
					request);
//send
mailToSend sendEmail();