HttpsRequestWrapper.java

/**
 * Licensed to The Apereo Foundation under one or more contributor license
 * agreements. See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 *
 * The Apereo Foundation licenses this file to you under the Educational
 * Community 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://opensource.org/licenses/ecl2.txt
 *
 * 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.opencastproject.kernel.filter.https;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletRequestWrapper;

/**
 * This wrapper is used to pretend the <code>HTTPS</code> scheme.
 */
public class HttpsRequestWrapper extends HttpServletRequestWrapper {

  /** The original URL */
  private String originalURL;

  /**
   * Wraps the request to enforce https as the request scheme.
   *
   * @param request
   *          the original request
   */
  public HttpsRequestWrapper(HttpServletRequest request) {
    super(request);
    StringBuffer url = super.getRequestURL();
    int protocolIndex = url.indexOf("://");
    originalURL = "https" + url.substring(protocolIndex);
  }

  /**
   * Overwrites the original request's scheme to return <code>https</code>.
   *
   * @return always returns <code>https</code>
   */
  public String getScheme() {
    return "https";
  }

  /**
   * Indicates that this is a secured request.
   *
   * @return always returns <code>true</code>
   */
  public boolean isSecure() {
    return true;
  }

  /**
   * Returns the request url with a "fixed" scheme of <code>https</code>.
   *
   * @return the original url featuring the <code>https</code> scheme
   */
  public StringBuffer getRequestURL() {
    return new StringBuffer(this.originalURL);
  }
}