com.liferay.portal.kernel.security.auth.AuthTokenUtil.java Source code

Introduction

Here is the source code for com.liferay.portal.kernel.security.auth.AuthTokenUtil.java

Source

/**
 * Copyright (c) 2000-present Liferay, Inc. All rights reserved.
 *
 * This library 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 library 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.
 */

package com.liferay.portal.kernel.security.auth;

import com.liferay.portal.kernel.model.Layout;
import com.liferay.portal.kernel.model.Portlet;
import com.liferay.portal.kernel.portlet.LiferayPortletURL;
import com.liferay.portal.kernel.util.ServiceProxyFactory;

import javax.servlet.http.HttpServletRequest;

/**
 * @author Amos Fong
 * @author Peter Fellwock
 * @author Raymond Aug
 */
public class AuthTokenUtil {

    public static void addCSRFToken(HttpServletRequest httpServletRequest, LiferayPortletURL liferayPortletURL) {

        AuthToken authToken = _authToken;

        if (authToken != null) {
            authToken.addCSRFToken(httpServletRequest, liferayPortletURL);
        }
    }

    public static void addPortletInvocationToken(HttpServletRequest httpServletRequest,
            LiferayPortletURL liferayPortletURL) {

        AuthToken authToken = _authToken;

        if (authToken != null) {
            authToken.addPortletInvocationToken(httpServletRequest, liferayPortletURL);
        }
    }

    public static void checkCSRFToken(HttpServletRequest httpServletRequest, String origin)
            throws PrincipalException {

        AuthToken authToken = _authToken;

        if (authToken != null) {
            authToken.checkCSRFToken(httpServletRequest, origin);
        }
    }

    public static String getToken(HttpServletRequest httpServletRequest) {
        AuthToken authToken = _authToken;

        if (authToken == null) {
            return null;
        }

        return authToken.getToken(httpServletRequest);
    }

    public static String getToken(HttpServletRequest httpServletRequest, long plid, String portletId) {

        AuthToken authToken = _authToken;

        if (authToken == null) {
            return null;
        }

        return authToken.getToken(httpServletRequest, plid, portletId);
    }

    public static boolean isValidPortletInvocationToken(HttpServletRequest httpServletRequest, Layout layout,
            Portlet portlet) {

        AuthToken authToken = _authToken;

        if (authToken == null) {
            return false;
        }

        return authToken.isValidPortletInvocationToken(httpServletRequest, layout, portlet);
    }

    private static volatile AuthToken _authToken = ServiceProxyFactory.newServiceTrackedInstance(AuthToken.class,
            AuthTokenUtil.class, "_authToken", false);

}