org.gatein.api.PortalRequest Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gatein-api
There is a newer version: 1.1.0.Final
/*
 * JBoss, Home of Professional Open Source.
 * Copyright 2012, Red Hat, Inc., and individual contributors
 * as indicated by the @author tags. See the copyright.txt file in the
 * distribution for a full listing of individual contributors.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */

package org.gatein.api;

import java.util.Locale;

import org.gatein.api.common.URIResolver;
import org.gatein.api.navigation.Navigation;
import org.gatein.api.navigation.Node;
import org.gatein.api.navigation.NodePath;
import org.gatein.api.page.Page;
import org.gatein.api.page.PageId;
import org.gatein.api.security.User;
import org.gatein.api.site.Site;
import org.gatein.api.site.SiteId;

/**
 * The PortalRequest object represents the current request of the portal. This object is available in the portal simply by
 * invoking the static {@link org.gatein.api.PortalRequest#getInstance()} method.
 * 
 * @author Nick Scavelli
 * @author Stian Thorgersen
 */
public abstract class PortalRequest {
    private Site site;
    private Navigation navigation;
    private Page page;
    private boolean pageLoaded;

    /**
     * The user of the request. If this request is for an unauthenticated user then {@link User#anonymous()} is returned.
     * 
     * @return the user of the current portal request. This should never be null.
     */
    public abstract User getUser();

    /**
     * The SiteId of the request.
     * 
     * @return the site id of the current portal request. This should never be null.
     */
    public abstract SiteId getSiteId();

    /**
     * The NodePath of the request.
     * 
     * @return the node path of the current portal request. This should never be null.
     */
    public abstract NodePath getNodePath();

    /**
     * The Locale of the request.
     * 
     * @return the locale of the current portal request.
     */
    public abstract Locale getLocale();

    /**
     * The site represented by the SiteId of the request.
     * 
     * @return the site of the current portal request
     */
    public Site getSite() {
        if (site == null) {
            site = getPortal().getSite(getSiteId());
        }

        return site;
    }

    /**
     * The page currently being accessed by the current portal request.
     * 
     * @return the page of the current portal request.
     */
    public Page getPage() {
        if (!pageLoaded) {
            Node node = getNavigation().getNode(getNodePath());
            PageId pageId = node != null ? node.getPageId() : null;
            page = (pageId == null) ? null : getPortal().getPage(pageId);
            pageLoaded = true;
        }

        return page;
    }

    /**
     * The navigation of the current portal request.
     * 
     * @return the navigation represented by the current portal request.
     */
    public Navigation getNavigation() {
        if (navigation == null) {
            navigation = getPortal().getNavigation(getSiteId());
        }

        return navigation;
    }

    /**
     * Access to the portal interface
     * 
     * @return the portal interface
     */
    public abstract Portal getPortal();

    /**
     * The resolver used to resolve the URI for Nodes. This is used by {@link Node#getURI()} which is the recommended way to
     * obtain the URI for a Node.
     * 
     * @return the URI resolver
     */
    public abstract URIResolver getURIResolver();

    /**
     * Obtain the current instance of a PortalRequest
     * 
     * @return the portal request
     */
    public static PortalRequest getInstance() {
        return instance.get();
    }

    protected static void setInstance(PortalRequest request) {
        if (request == null) {
            instance.remove();
        } else {
            instance.set(request);
        }
    }

    private static ThreadLocal instance = new ThreadLocal() {
        @Override
        protected PortalRequest initialValue() {
            return null;
        }
    };
}