ServletTools.java

/*
 * Copyright (c) 2001-2007, Inversoft Inc., All Rights Reserved
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
 * either express or implied. See the License for the specific
 * language governing permissions and limitations under the License.
 *
 */
package org.primeframework.mvc.servlet;

import javax.servlet.ServletRequest;
import javax.servlet.http.HttpServletRequest;
import java.net.MalformedURLException;
import java.net.URL;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Toolkit for Servlet related tasks
 *
 * @author James Humphrey
 */
public class ServletTools {
  private static final Logger logger = LoggerFactory.getLogger(ServletTools.class);

  /**
   * Returns the base url in the following format:
   * <p/>
   * protocol://host[:port]/
   * <p/>
   * The protocol, host and port are extracted from the ServletRequest using the following methods:
   * <p/>
   * protocol = ServletRequest.getScheme() host = ServletRequest.getServerName() port = ServletRequest.getServerPost()
   * <p/>
   * Below are some examples of base URLs that can be returned:
   * <p/>
   * <strong>http://www.Inversoft Inc./</strong> <strong>https://www.Inversoft Inc.:8080/</strong>
   *
   * @param request the ServletRequest
   * @return a URL in the format of protocol://host[:port]/
   */
  public static URL getBaseUrl(ServletRequest request) {
    String scheme = request.getScheme();
    String serverName = request.getServerName();
    int serverPort = request.getServerPort();

    URL baseUrl = null;
    try {
      if (serverPort > 0) {
        baseUrl = new URL(scheme, serverName, serverPort, "/");
      } else {
        baseUrl = new URL(scheme, serverName, "/");
      }
    } catch (MalformedURLException e) {
      logger.error(e.getMessage(), e);
    }

    return baseUrl;
  }

  /**
   * The request URI without the context path.
   *
   * @param request The request.
   * @return The uri minus the context path.
   */
  public static String getRequestURI(HttpServletRequest request) {
    String uri = request.getRequestURI();
    int semicolon = uri.indexOf(';');
    if (semicolon >= 0) {
      uri = uri.substring(0, semicolon);
    }

    String context = request.getContextPath();
    if (context.length() > 0) {
      return uri.substring(context.length());
    }

    return uri;
  }

  /**
   * Returns the jsessionid part of the URI if it exists.
   *
   * @param request The request.
   * @return The jsessionid part or empty string.
   */
  public static String getSessionId(HttpServletRequest request) {
    String uri = request.getRequestURI();
    int semicolon = uri.indexOf(';');
    if (semicolon >= 0) {
      return uri.substring(semicolon);
    }

    return "";
  }
}