Open Source Repository

Home /spring/spring-web-3.0.5 | Repository Home



org/springframework/web/context/request/FacesWebRequest.java
/*
 * Copyright 2002-2010 the original author or authors.
 *
 * 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.springframework.web.context.request;

import java.security.Principal;
import java.util.Iterator;
import java.util.Locale;
import java.util.Map;
import javax.faces.context.ExternalContext;
import javax.faces.context.FacesContext;

import org.springframework.util.StringUtils;

/**
 {@link WebRequest} adapter for a JSF {@link javax.faces.context.FacesContext}.
 *
 @author Juergen Hoeller
 @since 2.5.2
 */
public class FacesWebRequest extends FacesRequestAttributes implements NativeWebRequest {

  /**
   * Create a new FacesWebRequest adapter for the given FacesContext.
   @param facesContext the current FacesContext
   @see javax.faces.context.FacesContext#getCurrentInstance()
   */
  public FacesWebRequest(FacesContext facesContext) {
    super(facesContext);
  }


  public Object getNativeRequest() {
    return getExternalContext().getRequest();
  }

  public Object getNativeResponse() {
    return getExternalContext().getResponse();
  }

  @SuppressWarnings("unchecked")
  public <T> T getNativeRequest(Class<T> requiredType) {
    if (requiredType != null) {
      Object request = getExternalContext().getRequest();
      if (requiredType.isInstance(request)) {
        return (Trequest;
      }
    }
    return null;
  }

  @SuppressWarnings("unchecked")
  public <T> T getNativeResponse(Class<T> requiredType) {
    if (requiredType != null) {
      Object response = getExternalContext().getResponse();
      if (requiredType.isInstance(response)) {
        return (Tresponse;
      }
    }
    return null;
  }


  public String getHeader(String headerName) {
    return getExternalContext().getRequestHeaderMap().get(headerName);
  }

  public String[] getHeaderValues(String headerName) {
    return getExternalContext().getRequestHeaderValuesMap().get(headerName);
  }

  public Iterator<String> getHeaderNames() {
    return getExternalContext().getRequestHeaderMap().keySet().iterator();
  }

  public String getParameter(String paramName) {
    return getExternalContext().getRequestParameterMap().get(paramName);
  }

  public Iterator<String> getParameterNames() {
    return getExternalContext().getRequestParameterNames();
  }
  
  public String[] getParameterValues(String paramName) {
    return getExternalContext().getRequestParameterValuesMap().get(paramName);
  }

  public Map<String, String[]> getParameterMap() {
    return getExternalContext().getRequestParameterValuesMap();
  }

  public Locale getLocale() {
    return getFacesContext().getExternalContext().getRequestLocale();
  }

  public String getContextPath() {
    return getFacesContext().getExternalContext().getRequestContextPath();
  }

  public String getRemoteUser() {
    return getFacesContext().getExternalContext().getRemoteUser();
  }

  public Principal getUserPrincipal() {
    return getFacesContext().getExternalContext().getUserPrincipal();
  }

  public boolean isUserInRole(String role) {
    return getFacesContext().getExternalContext().isUserInRole(role);
  }

  public boolean isSecure() {
    return false;
  }

  public boolean checkNotModified(long lastModifiedTimestamp) {
    return false;
  }

  public String getDescription(boolean includeClientInfo) {
    ExternalContext externalContext = getExternalContext();
    StringBuilder sb = new StringBuilder();
    sb.append("context=").append(externalContext.getRequestContextPath());
    if (includeClientInfo) {
      Object session = externalContext.getSession(false);
      if (session != null) {
        sb.append(";session=").append(getSessionId());
      }
      String user = externalContext.getRemoteUser();
      if (StringUtils.hasLength(user)) {
        sb.append(";user=").append(user);
      }
    }
    return sb.toString();
  }


  @Override
  public String toString() {
    return "FacesWebRequest: " + getDescription(true);
  }

}