com.neocotic.bloggaer.common.Requests.java Source code

Introduction

Here is the source code for com.neocotic.bloggaer.common.Requests.java

Source

/* Copyright (C) 2012 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.bloggaer.common;

import javax.servlet.http.HttpServletRequest;

import org.apache.commons.lang3.StringUtils;

import com.neocotic.bloggaer.common.logging.Logger;

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

    /** The {@link Logger} instance for {@link Requests}. */
    private static final Logger logger = Logger.getLogger(Requests.class);

    /**
     * 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) {
        logger.entering(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];
        }

        logger.exiting(ipAddress);
        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) {
        logger.entering(request);

        String referrer = request.getHeader("Referer");

        logger.exiting(referrer);
        return referrer;
    }

    /**
     * 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) {
        logger.entering(request);

        String userAgent = request.getHeader("User-Agent");

        logger.exiting(userAgent);
        return userAgent;
    }
}