com.neocotic.blingaer.common.RequestUtils.java Source code

Introduction

Here is the source code for com.neocotic.blingaer.common.RequestUtils.java

Source

/* Copyright (C) 2011 Alasdair Mercer, http://neocotic.com/
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
package com.neocotic.blingaer.common;

import javax.servlet.http.HttpServletRequest;

import org.apache.commons.lang3.StringUtils;

/**
 * Provides utility methods for extracting common data from
 * {@code HttpServletRequests}.
 * 
 * @author Alasdair Mercer
 */
// TODO: Test code
public class RequestUtils {

    /**
     * Returns the IP address that appears to be the source of the specified
     * {@code request}.
     * 
     * @param request
     *            the {@code HttpServletRequest} to check
     * @return the IP address
     */
    public static String getIpAddress(HttpServletRequest request) {
        String ipAddress = request.getHeader("X-Forwarded-For");

        if (ipAddress == null) {
            ipAddress = request.getRemoteAddr();
        } else {
            String[] ipAddresses = StringUtils.split(ipAddress, ",");

            if (ipAddresses.length > 0) {
                ipAddress = ipAddresses[0];
            }
        }

        return ipAddress;
    }

    /**
     * Returns the referrer of the specified {@code request}.
     * 
     * @param request
     *            the {@code HttpServletRequest} to check
     * @return the referrer
     */
    public static String getReferrer(HttpServletRequest request) {
        return request.getHeader("Referer");
    }

    /**
     * Returns the user agent of the specified {@code request}.
     * 
     * @param request
     *            the {@code HttpServletRequest} to check
     * @return the user agent
     */
    public static String getUserAgent(HttpServletRequest request) {
        return request.getHeader("User-Agent");
    }
}