Retrieving Sites

A specific site can be retrieved by its SiteId. The SiteId is constructed by passing either the name for a standard site, the group for a group space or the user for a user dashboard. Alternatively it can be constructed by passing the SiteType and name.

Example of Retrieving Sites is Shown below:

Site standardSite = portal.getSite(new SiteId("classic"));
Site groupSpace = portal.getSite(new SiteId(new Group("platform", "administrators")));
Site userDashboard = portal.getSite(new SiteId(new User("john")));

It is also possible to query for sites using the SiteQuery. The SiteQuery supports filtering, sorting and pagination when querying for sites.

The example below finds standard sites that a user has access permissions to, limited to the 10 first results:

SiteQuery.Builder qb = new SiteQuery.Builder();

qb.withSiteTypes(SiteType.SITE).withPagination(0, 10).withFilter(new Filter<Site>() {
    public boolean accept(Site site) {
        return portal.hasPermission(user, site.getAccessPermission());
    }
});

List<Site> sites = portal.findSites(qb.build());

Creating a Site

To create a site, first create a new site through the Portal, then set the configuration for the site (such as localized display names and skin), and finally saved it using the Portal.

The example below creates a new standard site with the name mysite and a non-localized display name:

Site site = portal.createSite(new SiteId("foo"));
site.setDisplayName("My Site");
portal.saveSite(site);

The site is not visible (or persisted) until saveSite is invoked.

site.getAttributes().put(Site.AttributeKeys.SESSION_BEHAVIOR, "always");

site.setAccessPermission(Permission.everyone());
site.setEditPermission(Permission.any("platform", "administrators"));

portal.saveSite(site);

Deleting a Site

A site is deleted by invoking removeSite on the Portal.

Retrieving Navigation Nodes

When retrieving navigation nodes, it is possible to either retrieve the root node, or a specific node in the hierarchy. It is also possible to control which if any of the children are loaded.

This example below shows a very simple navigation portlet that displays the top level of entries in the navigation menu:

public void doView(RenderRequest request, RenderResponse response) throws IOException {
    PrintWriter pw = response.getWriter();
    Navigation navigation = PortalRequest.getInstance().getNavigation();

    pw.print("<ul>");
    for (Node n : navigation.getRootNode(Nodes.visitChildren())) {
        pw.printf("<li><a href='%s'>%s</a></li>", n.getURI(), n.getDisplayName());
    }
    pw.print("</ul>");
}

To retrieve a specific node in the tree it's retrieved by specifying the NodePath to the node:

Node node = navigation.getNode(NodePath.path("home"));

Node rootNode = navigation.getRootNode(Nodes.visitNodes(2));

Node filtered = node.filter().showDefault();

Node filtered = root.filter().show(new Filter<Node>() {
    public boolean accept(Node node) {
        return node.getDisplayName().startsWith("A");
    }
});

Creating a Navigation Node

To create a node, first retrieve the parent node you want to add it to, and invoke the addChild method on the parent node. Then set the configuration for the node (such as the display name and the page it should link to) and finally save it using saveNode on Navigation.

The example below creates a node as a child of the home node:

Node home = navigation.getNode(NodePath.path("home"));
Node child = home.addChild("mynode");
child.setDisplayName("My Node");
child.setPageId(new PageId("classic", "mypage"));
navigation.saveNode(home);

The node is not visible (or persisted) until saveNode is invoked.

LocalizedString localizedString = node.getDisplayNames();
localizedString.setLocalizedValue(Locale.ENGLISH, "My node");
localizedString.setLocalizedValue(Locale.FRENCH, "Mon noeud");
node.setDisplayNames(localizedString);

navigation.saveNode(node);

Deleting a Navigation Node

A node is deleted by removing it from the parent node. The example below removes the child with the name mynode:

node.removeChild("mynode");
navigation.saveNode(node);

The node is not removed until saveNode is invoked.

Moving a Navigation Node

A node can be moved to a different parent, or it can be moved to a different index in the same parent. When moving to a different parent the new parent is required to be in the same tree.

The example belows moves a node from one parent to another:

root.getNode("parent1", "child").moveTo(root.getNode("parent2"));
navigation.saveNode(root);

Or to move a node to a different index in the same parent:

root.getNode("parent", "child").moveTo(0);
navigation.saveNode(root);

A more convinient way to sort children for a parent is to use the sort method on the parent, for example to sort the children of the root node by their display names:

root.sort(new Comparator<Node>() {
    public int compare(Node o1, Node o2) {
        return o1.getDisplayName().compareTo(o2.getDisplayName());
    }
});
navigation.saveNode(root);

As with creating a node, the changes are not visible (or persisted) until saveNode is invoked.

Retrieving Pages

A specific page can be retrieved by its PageId. The PageId is constructed by passing either the name for a standard site, the group for a group space or the user for a user dashboard, and the name of the page. Alternatively it can be constructed by passing the SiteId and name of the page.

Example of retrieving specific pages is shown below:

Page standardSitePage = portal.getPage("classic", "home");
Page groupSpacePage = portal.getSite(new Group("platform", "administrators"), "grouppage");
Page userDashboardPage = portal.getSite(new User("john", "johnspage"));

It is also possible to query for pages using the PageQuery. The PageQuery supports filtering, sorting and pagination when querying for pages.

The example below finds pages with a display name that starts with "A":

PageQuery.Builder qb = new PageQuery.Builder();

qb.withSiteType(SiteType.SITE).withFilter(new Filter<Page>() {
    public boolean accept(Page page) {
        return page.getDisplayName().startsWith("A");
    }
});

List<Page> pages = portal.findPages(qb.build());

Creating a Page

To create a page, first create a new page through the Portal, then set the configuration for the page (such as localized display names), and finally saved it using the Portal.

The example below creates a new page in the classic site with the name mypage and a non-localized display name:

Page page = portal.createPage(new PageId("classic", "mypage"));
page.setDisplayName("My Page");
portal.savePage(page);

The page is not visible (or persisted) until portal.savePage is invoked.

page.setAccessPermission(Permission.everyone());
page.setEditPermission(Permission.any("platform", "administrators"));

portal.savePage(page);

PageBuilder pageBuilder = portal.newPageBuilder();
Application calculator = portal.getApplicationRegistry().getApplication("Gadgets/Calculator");
Page page = pageBuilder.child(calculator).siteName("classic").siteType("portal").name("awesome").build();

PageBuilder pageBuilder = portal.newPageBuilder();
ApplicationRegistry appRegistry = portal.getApplicationRegistry();
Page page = pageBuilder
        .newRowsBuilder()
            .newColumnsBuilder()
                .child(appRegistry.getApplication("Gadgets/Calculator"))
                .child(appRegistry.getApplication("Gadgets/rssAggregator"))
            .buildToParentBuilder()

            .newColumnsBuilder()
                .child(appRegistry.getApplication("Gadgets/Calendar"))
                .child(appRegistry.getApplication("Gadgets/Todo"))
            .buildToParentBuilder()

        .buildToTopBuilder()
        .siteName("classic")
        .siteType("portal")
        .name("awesome_" + UUID.randomUUID().toString())
        .displayName("Awesome page")
        .showMaxWindow(false)
        .accessPermission(Permission.everyone())
        .editPermission(Permission.any("platform", "administrators"))
        .moveAppsPermission(Permission.everyone())
        .moveContainersPermission(Permission.everyone())
        .build();

Deleting a Page

A page is deleted by invoking removePage on the Portal.

Retrieve an Instance of OAuthProvider

First, you need to retrieve the appropriate instance of OAuthProvider from Portal:

Portal portal = PortalRequest.getInstance().getPortal();
OAuthProvider facebookProvider = portal.getOAuthProvider(OAuthProvider.FACEBOOK)

Currently GateIn Portal supports three OAuth providers:

• OAuthProvider.FACEBOOK for Facebook

• OAuthProvider.GOOGLE for Google+

• OAuthProvider.TWITTER for Twitter

OAuthProvider Operations

The following snippet shows some basic use of OAuthProvider API:

// Retrieve instance of Google OAuth provider
OAuthProvider googleProvider = PortalRequest.getInstance().getPortal().getOAuthProvider(OAuthProvider.GOOGLE);

// Check if Google was enabled in configuration.properties
if (googleProvider == null) {
    renderResp.getWriter().println("Authentication with Google not available. See OAuth section in Reference Guide for how to enable it");
    return;
}

// Retrieve the key and display name of the social network
String key = googleProvider.getKey();
String friendlyName = googleProvider.getFriendlyName();
renderResp.getWriter().println(friendlyName + " is enabled");

// Retrieve access token of the current user
AccessToken accessToken = googleProvider.loadAccessToken(renderReq.getRemoteUser());

// Check if access token is available. It's the case when this user was registered/authenticated into portal
// through Google+ or if he linked his account with Google+
if (accessToken == null) {
    renderResp.getWriter().println("Your account is not linked with Google+. You can link it in 'Social network' tab of " +
        "user settings or you can authenticate through Google into portal");
    return;
}

// Check if access token is valid and refresh it if necessary
try {
    accessToken = googleProvider.validateTokenAndUpdateScopes(accessToken);
} catch (OAuthApiException oauthException) {
    if (oauthException.getExceptionCode().equals(OAuthApiExceptionCode.ACCESS_TOKEN_ERROR)) {
        renderResp.getWriter().println("Your access token is invalid or has been revoked");
    } else if (oauthException.getExceptionCode().equals(OAuthApiExceptionCode.IO_ERROR)) {
        renderResp.getWriter().println("Network error during the communication with Google");
    }
}

// Check all available scopes
String availableScopes = accessToken.getAvailableScopes();

// Check if we have scope to call Google+ operations
if (!availableScopes.contains("https://www.googleapis.com/auth/plus.login")) {
    // Redirect to Google+ and ask for plus.login scope
    googleProvider.startOAuthWorkflow("https://www.googleapis.com/auth/plus.login");
    return;
}

// Obtain Google API object to call Google plus API operations
Plus service = googleProvider.getAuthorizedSocialApiObject(accessToken, Plus.class);

// Retrieve activities from Google+ wall of user
ActivityFeed activityFeed = service.activities().list("me", "public").execute();
for (Activity activity : activityFeed.getItems()) {
    renderResp.getWriter().println(activity.getTitle());
}

// Revoke the access token. It won't be possible to run any operations with it anymore.
// And your application will be cleared from Google applications of current user on page https://plus.google.com/apps
googleProvider.revokeToken(accessToken);

// Remove the token from the UserProfile of the current user
googleProvider.removeAccessToken(request.getRemoteUser());

Access to Provider-Specific Operations

Method oauthProvider.getAuthorizedSocialApiObject() is useful for obtaining access to provider-specific operations. This method usually returns objects from a 3rd party library. Those objects are always initialized with access token of the current user and can be used to retrieve data from the related social network.

• Google - there are two supported types usable as arguments of this method:

  • com.google.api.services.plus.Plus - Google Plus API class, which can be used to call operations on Google Plus - see GoogleActivitiesPortlet and GoogleFriendsPortlet in our Social Portlets Quickstart.

  • com.google.api.services.oauth2.Oauth2 - Oauth2 class, which provides operations related to user, such as obtaining his Google user profile details or obtaining information about his access token - see GoogleUserInfoPortlet in our Social Portlets Quickstart.

• Twitter - there is only one supported type for Twitter: twitter4j.Twitter. An instance of this class can be used e.g. to retrieve user details, number of his tweets, number of his friends, his last tweets, etc. - see TwitterPortlet in our Social Portlets Quickstart.

• Facebook - there is no supported type for Facebook. In our Social Portlets Quickstart, we are using the 3rd party library RestFB directly to perform operations against Facebook.