com.liferay.portal.kernel.util.PropertiesParamUtil.java Source code

Introduction

Here is the source code for com.liferay.portal.kernel.util.PropertiesParamUtil.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.util;

import com.liferay.petra.string.StringPool;
import com.liferay.petra.string.StringUtil;
import com.liferay.portal.kernel.service.ServiceContext;

import java.io.Serializable;

import java.util.Locale;
import java.util.Map;
import java.util.Objects;
import java.util.Properties;

import javax.portlet.PortletRequest;

import javax.servlet.http.HttpServletRequest;

/**
 * @author Brian Wing Shun Chan
 */
public class PropertiesParamUtil {

    public static boolean getBoolean(Properties properties, HttpServletRequest httpServletRequest, String param) {

        return getBoolean(properties, httpServletRequest, param, GetterUtil.DEFAULT_BOOLEAN);
    }

    public static boolean getBoolean(Properties properties, HttpServletRequest httpServletRequest, String param,
            boolean defaultValue) {

        String propertiesValue = properties.getProperty(param, null);

        boolean getterUtilValue = GetterUtil.getBoolean(propertiesValue, defaultValue);

        return ParamUtil.get(httpServletRequest, param, getterUtilValue);
    }

    public static boolean getBoolean(Properties properties, PortletRequest portletRequest, String param) {

        return getBoolean(properties, portletRequest, param, GetterUtil.DEFAULT_BOOLEAN);
    }

    public static boolean getBoolean(Properties properties, PortletRequest portletRequest, String param,
            boolean defaultValue) {

        String propertiesValue = properties.getProperty(param, null);

        boolean getterUtilValue = GetterUtil.getBoolean(propertiesValue, defaultValue);

        return ParamUtil.get(portletRequest, param, getterUtilValue);
    }

    public static boolean getBoolean(UnicodeProperties properties, HttpServletRequest httpServletRequest,
            String param) {

        return getBoolean(properties, httpServletRequest, param, GetterUtil.DEFAULT_BOOLEAN);
    }

    public static boolean getBoolean(UnicodeProperties properties, HttpServletRequest httpServletRequest,
            String param, boolean defaultValue) {

        String propertiesValue = properties.getProperty(param, null);

        boolean getterUtilValue = GetterUtil.getBoolean(propertiesValue, defaultValue);

        return ParamUtil.get(httpServletRequest, param, getterUtilValue);
    }

    public static boolean getBoolean(UnicodeProperties properties, PortletRequest portletRequest, String param) {

        return getBoolean(properties, portletRequest, param, GetterUtil.DEFAULT_BOOLEAN);
    }

    public static boolean getBoolean(UnicodeProperties properties, PortletRequest portletRequest, String param,
            boolean defaultValue) {

        String propertiesValue = properties.getProperty(param, null);

        boolean getterUtilValue = GetterUtil.getBoolean(propertiesValue, defaultValue);

        return ParamUtil.get(portletRequest, param, getterUtilValue);
    }

    public static double getDouble(Properties properties, HttpServletRequest httpServletRequest, String param) {

        return getDouble(properties, httpServletRequest, param, GetterUtil.DEFAULT_DOUBLE);
    }

    public static double getDouble(Properties properties, HttpServletRequest httpServletRequest, String param,
            double defaultValue) {

        String propertiesValue = properties.getProperty(param, null);

        double getterUtilValue = GetterUtil.getDouble(propertiesValue, defaultValue);

        return ParamUtil.get(httpServletRequest, param, getterUtilValue);
    }

    public static double getDouble(Properties properties, HttpServletRequest httpServletRequest, String param,
            double defaultValue, Locale locale) {

        String propertiesValue = properties.getProperty(param, null);

        double getterUtilValue = GetterUtil.getDouble(propertiesValue, defaultValue);

        return ParamUtil.getDouble(httpServletRequest, param, getterUtilValue, locale);
    }

    public static double getDouble(Properties properties, HttpServletRequest httpServletRequest, String param,
            Locale locale) {

        return getDouble(properties, httpServletRequest, param, GetterUtil.DEFAULT_DOUBLE, locale);
    }

    public static double getDouble(Properties properties, PortletRequest portletRequest, String param) {

        return getDouble(properties, portletRequest, param, GetterUtil.DEFAULT_DOUBLE);
    }

    public static double getDouble(Properties properties, PortletRequest portletRequest, String param,
            double defaultValue) {

        String propertiesValue = properties.getProperty(param, null);

        double getterUtilValue = GetterUtil.getDouble(propertiesValue, defaultValue);

        return ParamUtil.get(portletRequest, param, getterUtilValue);
    }

    public static double getDouble(Properties properties, PortletRequest portletRequest, String param,
            double defaultValue, Locale locale) {

        String propertiesValue = properties.getProperty(param, null);

        double getterUtilValue = GetterUtil.getDouble(propertiesValue, defaultValue);

        return ParamUtil.getDouble(portletRequest, param, getterUtilValue, locale);
    }

    public static double getDouble(Properties properties, PortletRequest portletRequest, String param,
            Locale locale) {

        return getDouble(properties, portletRequest, param, GetterUtil.DEFAULT_DOUBLE, locale);
    }

    public static double getDouble(UnicodeProperties properties, HttpServletRequest httpServletRequest,
            String param) {

        return getDouble(properties, httpServletRequest, param, GetterUtil.DEFAULT_DOUBLE);
    }

    public static double getDouble(UnicodeProperties properties, HttpServletRequest httpServletRequest,
            String param, double defaultValue) {

        String propertiesValue = properties.getProperty(param, null);

        double getterUtilValue = GetterUtil.getDouble(propertiesValue, defaultValue);

        return ParamUtil.get(httpServletRequest, param, getterUtilValue);
    }

    public static double getDouble(UnicodeProperties properties, HttpServletRequest httpServletRequest,
            String param, double defaultValue, Locale locale) {

        String propertiesValue = properties.getProperty(param, null);

        double getterUtilValue = GetterUtil.getDouble(propertiesValue, defaultValue);

        return ParamUtil.getDouble(httpServletRequest, param, getterUtilValue, locale);
    }

    public static double getDouble(UnicodeProperties properties, HttpServletRequest httpServletRequest,
            String param, Locale locale) {

        return getDouble(properties, httpServletRequest, param, GetterUtil.DEFAULT_DOUBLE, locale);
    }

    public static double getDouble(UnicodeProperties properties, PortletRequest portletRequest, String param) {

        return getDouble(properties, portletRequest, param, GetterUtil.DEFAULT_DOUBLE);
    }

    public static double getDouble(UnicodeProperties properties, PortletRequest portletRequest, String param,
            double defaultValue) {

        String propertiesValue = properties.getProperty(param, null);

        double getterUtilValue = GetterUtil.getDouble(propertiesValue, defaultValue);

        return ParamUtil.get(portletRequest, param, getterUtilValue);
    }

    public static double getDouble(UnicodeProperties properties, PortletRequest portletRequest, String param,
            double defaultValue, Locale locale) {

        String propertiesValue = properties.getProperty(param, null);

        double getterUtilValue = GetterUtil.getDouble(propertiesValue, defaultValue);

        return ParamUtil.getDouble(portletRequest, param, getterUtilValue, locale);
    }

    public static double getDouble(UnicodeProperties properties, PortletRequest portletRequest, String param,
            Locale locale) {

        return getDouble(properties, portletRequest, param, GetterUtil.DEFAULT_DOUBLE, locale);
    }

    public static int getInteger(Properties properties, HttpServletRequest httpServletRequest, String param) {

        return getInteger(properties, httpServletRequest, param, GetterUtil.DEFAULT_INTEGER);
    }

    public static int getInteger(Properties properties, HttpServletRequest httpServletRequest, String param,
            int defaultValue) {

        String propertiesValue = properties.getProperty(param, null);

        int getterUtilValue = GetterUtil.getInteger(propertiesValue, defaultValue);

        return ParamUtil.get(httpServletRequest, param, getterUtilValue);
    }

    public static int getInteger(Properties properties, PortletRequest portletRequest, String param) {

        return getInteger(properties, portletRequest, param, GetterUtil.DEFAULT_INTEGER);
    }

    public static int getInteger(Properties properties, PortletRequest portletRequest, String param,
            int defaultValue) {

        String propertiesValue = properties.getProperty(param, null);

        int getterUtilValue = GetterUtil.getInteger(propertiesValue, defaultValue);

        return ParamUtil.get(portletRequest, param, getterUtilValue);
    }

    public static int getInteger(UnicodeProperties properties, HttpServletRequest httpServletRequest,
            String param) {

        return getInteger(properties, httpServletRequest, param, GetterUtil.DEFAULT_INTEGER);
    }

    public static int getInteger(UnicodeProperties properties, HttpServletRequest httpServletRequest, String param,
            int defaultValue) {

        String propertiesValue = properties.getProperty(param, null);

        int getterUtilValue = GetterUtil.getInteger(propertiesValue, defaultValue);

        return ParamUtil.get(httpServletRequest, param, getterUtilValue);
    }

    public static int getInteger(UnicodeProperties properties, PortletRequest portletRequest, String param) {

        return getInteger(properties, portletRequest, param, GetterUtil.DEFAULT_INTEGER);
    }

    public static int getInteger(UnicodeProperties properties, PortletRequest portletRequest, String param,
            int defaultValue) {

        String propertiesValue = properties.getProperty(param, null);

        int getterUtilValue = GetterUtil.getInteger(propertiesValue, defaultValue);

        return ParamUtil.get(portletRequest, param, getterUtilValue);
    }

    public static long getLong(Properties properties, HttpServletRequest httpServletRequest, String param) {

        return getLong(properties, httpServletRequest, param, GetterUtil.DEFAULT_LONG);
    }

    public static long getLong(Properties properties, HttpServletRequest httpServletRequest, String param,
            long defaultValue) {

        String propertiesValue = properties.getProperty(param, null);

        long getterUtilValue = GetterUtil.getLong(propertiesValue, defaultValue);

        return ParamUtil.get(httpServletRequest, param, getterUtilValue);
    }

    public static long getLong(Properties properties, PortletRequest portletRequest, String param) {

        return getLong(properties, portletRequest, param, GetterUtil.DEFAULT_LONG);
    }

    public static long getLong(Properties properties, PortletRequest portletRequest, String param,
            long defaultValue) {

        String propertiesValue = properties.getProperty(param, null);

        long getterUtilValue = GetterUtil.getLong(propertiesValue, defaultValue);

        return ParamUtil.get(portletRequest, param, getterUtilValue);
    }

    public static long getLong(UnicodeProperties properties, HttpServletRequest httpServletRequest, String param) {

        return getLong(properties, httpServletRequest, param, GetterUtil.DEFAULT_LONG);
    }

    public static long getLong(UnicodeProperties properties, HttpServletRequest httpServletRequest, String param,
            long defaultValue) {

        String propertiesValue = properties.getProperty(param, null);

        long getterUtilValue = GetterUtil.getLong(propertiesValue, defaultValue);

        return ParamUtil.get(httpServletRequest, param, getterUtilValue);
    }

    public static long getLong(UnicodeProperties properties, PortletRequest portletRequest, String param) {

        return getLong(properties, portletRequest, param, GetterUtil.DEFAULT_LONG);
    }

    public static long getLong(UnicodeProperties properties, PortletRequest portletRequest, String param,
            long defaultValue) {

        String propertiesValue = properties.getProperty(param, null);

        long getterUtilValue = GetterUtil.getLong(propertiesValue, defaultValue);

        return ParamUtil.get(portletRequest, param, getterUtilValue);
    }

    public static UnicodeProperties getProperties(HttpServletRequest httpServletRequest, String prefix) {

        UnicodeProperties properties = new UnicodeProperties(true);

        Map<String, String[]> parameterMap = httpServletRequest.getParameterMap();

        for (String param : parameterMap.keySet()) {
            if (param.startsWith(prefix)) {
                String key = param.substring(prefix.length(), param.length() - 2);

                String value = httpServletRequest.getParameter(param);

                properties.setProperty(key, value);
            }
        }

        return properties;
    }

    public static UnicodeProperties getProperties(PortletRequest portletRequest, String prefix) {

        UnicodeProperties properties = new UnicodeProperties(true);

        Map<String, String[]> parameterMap = portletRequest.getParameterMap();

        for (String param : parameterMap.keySet()) {
            if (param.startsWith(prefix)) {
                String key = param.substring(prefix.length(), param.length() - 2);

                String[] values = portletRequest.getParameterValues(param);

                // Portlets that opt-in to Portlet 3.0 functionality might have
                // null values in the array. Make the array compatible with the
                // call to StringUtil.merge(String[]) below by replacing each
                // null value with the empty string.

                properties.setProperty(key,
                        StringUtil.merge(values, s -> Objects.toString(s, StringPool.BLANK), StringPool.COMMA));
            }
        }

        return properties;
    }

    public static UnicodeProperties getProperties(ServiceContext serviceContext, String prefix) {

        UnicodeProperties properties = new UnicodeProperties(true);

        Map<String, Serializable> attributes = serviceContext.getAttributes();

        for (String param : attributes.keySet()) {
            if (param.startsWith(prefix)) {
                String key = param.substring(prefix.length(), param.length() - 2);

                String value = ParamUtil.getString(serviceContext, param);

                properties.setProperty(key, value);
            }
        }

        return properties;
    }

    public static String getString(Properties properties, HttpServletRequest httpServletRequest, String param) {

        return getString(properties, httpServletRequest, param, GetterUtil.DEFAULT_STRING);
    }

    public static String getString(Properties properties, HttpServletRequest httpServletRequest, String param,
            String defaultValue) {

        String propertiesValue = properties.getProperty(param, null);

        String getterUtilValue = GetterUtil.getString(propertiesValue, defaultValue);

        return ParamUtil.get(httpServletRequest, param, getterUtilValue);
    }

    public static String getString(Properties properties, PortletRequest portletRequest, String param) {

        return getString(properties, portletRequest, param, GetterUtil.DEFAULT_STRING);
    }

    public static String getString(Properties properties, PortletRequest portletRequest, String param,
            String defaultValue) {

        String propertiesValue = properties.getProperty(param, null);

        String getterUtilValue = GetterUtil.getString(propertiesValue, defaultValue);

        return ParamUtil.get(portletRequest, param, getterUtilValue);
    }

    public static String getString(UnicodeProperties properties, HttpServletRequest httpServletRequest,
            String param) {

        return getString(properties, httpServletRequest, param, GetterUtil.DEFAULT_STRING);
    }

    public static String getString(UnicodeProperties properties, HttpServletRequest httpServletRequest,
            String param, String defaultValue) {

        String propertiesValue = properties.getProperty(param, null);

        String getterUtilValue = GetterUtil.getString(propertiesValue, defaultValue);

        return ParamUtil.get(httpServletRequest, param, getterUtilValue);
    }

    public static String getString(UnicodeProperties properties, PortletRequest portletRequest, String param) {

        return getString(properties, portletRequest, param, GetterUtil.DEFAULT_STRING);
    }

    public static String getString(UnicodeProperties properties, PortletRequest portletRequest, String param,
            String defaultValue) {

        String propertiesValue = properties.getProperty(param, null);

        String getterUtilValue = GetterUtil.getString(propertiesValue, defaultValue);

        return ParamUtil.get(portletRequest, param, getterUtilValue);
    }

}