org.apache.shale.application.faces.ShaleWebContext Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to you 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.apache.shale.application.faces;
import javax.faces.context.FacesContext;
import javax.servlet.ServletContext;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletRequestWrapper;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpServletResponseWrapper;
import org.apache.commons.chain.web.servlet.ServletWebContext;
import org.apache.shale.util.Messages;
/**
* Commons Chain Context implementation for Shale.
*
* $Id: ShaleWebContext.java 465067 2006-10-17 21:45:17Z rahul $
*/
public class ShaleWebContext extends ServletWebContext {
// ------------------------------------------------------------ Constructors
/**
* Serial version UID.
*/
private static final long serialVersionUID = -5177725738581183049L;
/**
* Construct a new context instance with the specified parameters.
*
* @param context ServletContext for this application
* @param request HttpServetRewquest for this request
* @param response HttpServletResponse for this request
*/
public ShaleWebContext(ServletContext context,
HttpServletRequest request,
HttpServletResponse response) {
super(context, request, response);
}
// ------------------------------------------------------ Instance Variables
/**
*
The FacesContext for the current request (if any).
*/
private FacesContext facesContext = null;
// -------------------------------------------------------- Static Variables
/**
* Message resources for this class.
*/
private static Messages messages =
new Messages("org.apache.shale.resources.Bundle",
ShaleWebContext.class.getClassLoader());
// -------------------------------------------------------------- Properties
/**
* Return the FacesContext for the current request, if any;
* otherwise, return null.
*/
public FacesContext getFacesContext() {
return this.facesContext;
}
/**
* Set the FacesContext for the current request. This
* method should only be called by the framework, once it is determined
* that this is actually a JSF request.
*
* @param facesContext The FacesContext for this request
*/
public void setFacesContext(FacesContext facesContext) {
this.facesContext = facesContext;
}
/**
* Set the HttpServletRequest that will be passed on to the
* remainder of the filter chain. If this is different from the request
* originally used to create this context, it must be an implementation of
* HttpServletRequestWrapper that wraps the original request.
*
* NOTE - Setting ths property is only useful if it
* occurs in the preprocessing portion of the chain, before the filter
* chain has been invoked.
*
* @param request The request or request wrapper to pass on
*/
public void setRequest(HttpServletRequest request) {
if (!(request instanceof HttpServletRequestWrapper)) {
throw new IllegalArgumentException
(messages.getMessage("context.requestWrapper"));
}
initialize(getContext(), request, getResponse());
}
/**
* Set the HttpServletResponse that will be passed on to the
* remainder of the filter chain. If this is different from the response
* originally used to create this context, it must be an implementation of
* HttpServletResponseWrapper that wraps the original request.
*
* NOTE - Setting ths property is only useful if it
* occurs in the preprocessing portion of the chain, before the filter
* chain has been invoked.
*
* @param response The response or response wrapper to pass on
*/
public void setResponse(HttpServletResponse response) {
if (!(response instanceof HttpServletResponseWrapper)) {
throw new IllegalArgumentException
(messages.getMessage("context.responseWrapper"));
}
initialize(getContext(), getRequest(), response);
}
}