/*
* $Id: PortletTilesRequestContext.java 709140 2008-10-30 11:07:50Z apetrelli $
*
* 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.tiles.portlet.context;
import java.io.IOException;
import java.util.Collections;
import java.util.Locale;
import java.util.Map;
import javax.portlet.PortletContext;
import javax.portlet.PortletException;
import javax.portlet.PortletRequest;
import javax.portlet.PortletRequestDispatcher;
import javax.portlet.PortletResponse;
import javax.portlet.RenderRequest;
import javax.portlet.RenderResponse;
import org.apache.tiles.TilesApplicationContext;
import org.apache.tiles.context.TilesApplicationContextWrapper;
import org.apache.tiles.context.TilesRequestContext;
import org.apache.tiles.util.TilesIOException;
/**
* Portlet-based TilesApplicationContext implementation.
*
* @version $Rev: 709140 $ $Date: 2008-10-30 12:07:50 +0100 (Thu, 30 Oct 2008) $
*/
public class PortletTilesRequestContext extends TilesApplicationContextWrapper
implements TilesRequestContext {
/**
* <p>The lazily instantiated <code>Map</code> of header name-value
* combinations (immutable).</p>
*/
private Map<String, String> header = null;
/**
* <p>The lazily instantitated <code>Map</code> of header name-values
* combinations (immutable).</p>
*/
private Map<String, String[]> headerValues = null;
/**
* The <code>PortletContext</code> for this application.
*/
private PortletContext context = null;
/**
* <p>The <code>PortletRequest</code> for this request.</p>
*/
protected PortletRequest request = null;
/**
* <p>The lazily instantiated <code>Map</code> of request scope
* attributes.</p>
*/
private Map<String, Object> requestScope = null;
/**
* <p>The <code>PortletResponse</code> for this request.</p>
*/
protected PortletResponse response = null;
/**
* <p>The lazily instantiated <code>Map</code> of session scope
* attributes.</p>
*/
private Map<String, Object> sessionScope = null;
/**
* <p>Indicates whether the request is an ActionRequest or RenderRequest.
*/
private boolean isRenderRequest;
/**
* <p>The lazily instantiated <code>Map</code> of request
* parameter name-value.</p>
*/
protected Map<String, String> param = null;
/**
* <p>The lazily instantiated <code>Map</code> of request
* parameter name-values.</p>
*/
protected Map<String, String[]> paramValues = null;
/**
* Creates a new instance of PortletTilesRequestContext.
*
* @param applicationContext The Tiles application context.
* @param context The portlet context to use.
* @param request The request object to use.
* @param response The response object to use.
* @since 2.1.1
*/
public PortletTilesRequestContext(
TilesApplicationContext applicationContext, PortletContext context,
PortletRequest request, PortletResponse response) {
super(applicationContext);
this.context = context;
initialize(request, response);
}
/**
* Creates a new instance of PortletTilesRequestContext.
*
* @param context The portlet context to use.
* @param request The request object to use.
* @param response The response object to use.
* @deprecated Use
* {@link #PortletTilesRequestContext(TilesApplicationContext, PortletContext, PortletRequest, PortletResponse)}
* .
*/
@Deprecated
public PortletTilesRequestContext(PortletContext context, PortletRequest request,
PortletResponse response) {
super(new PortletTilesApplicationContext(context));
this.context = context;
initialize(request, response);
}
/**
* <p>Initialize (or reinitialize) this {@link PortletTilesRequestContext} instance
* for the specified Portlet API objects.</p>
*
* @param request The <code>PortletRequest</code> for this request
* @param response The <code>PortletResponse</code> for this request
*/
public void initialize(PortletRequest request,
PortletResponse response) {
// Save the specified Portlet API object references
this.request = request;
this.response = response;
// Perform other setup as needed
this.isRenderRequest = false;
if (request != null) {
if (request instanceof RenderRequest) {
isRenderRequest = true;
}
}
}
/**
* <p>Release references to allocated resources acquired in
* <code>initialize()</code> of via subsequent processing. After this
* method is called, subsequent calls to any other method than
* <code>initialize()</code> will return undefined results.</p>
*/
public void release() {
// Release references to allocated collections
header = null;
headerValues = null;
param = null;
paramValues = null;
requestScope = null;
sessionScope = null;
// Release references to Portlet API objects
context = null;
request = null;
response = null;
}
/**
* <p>Return the {@link PortletRequest} for this context.</p>
*
* @return The used portlet request.
*/
public PortletRequest getRequest() {
return (this.request);
}
/**
* <p>Return the {@link PortletResponse} for this context.</p>
*
* @return The used portlet response.
*/
public PortletResponse getResponse() {
return (this.response);
}
/** {@inheritDoc} */
@SuppressWarnings("unchecked")
public Map<String, String> getHeader() {
if ((header == null) && (request != null)) {
header = Collections.EMPTY_MAP;
}
return (header);
}
/** {@inheritDoc} */
@SuppressWarnings("unchecked")
public Map<String, String[]> getHeaderValues() {
if ((headerValues == null) && (request != null)) {
headerValues = Collections.EMPTY_MAP;
}
return (headerValues);
}
/** {@inheritDoc} */
public Map<String, String> getParam() {
if ((param == null) && (request != null)) {
param = new PortletParamMap(request);
}
return (param);
}
/** {@inheritDoc} */
public Map<String, String[]> getParamValues() {
if ((paramValues == null) && (request != null)) {
paramValues = new PortletParamValuesMap(request);
}
return (paramValues);
}
/** {@inheritDoc} */
public Map<String, Object> getRequestScope() {
if ((requestScope == null) && (request != null)) {
requestScope = new PortletRequestScopeMap(request);
}
return (requestScope);
}
/** {@inheritDoc} */
public Map<String, Object> getSessionScope() {
if ((sessionScope == null) && (request != null)) {
sessionScope =
new PortletSessionScopeMap(request.getPortletSession());
}
return (sessionScope);
}
/** {@inheritDoc} */
public TilesApplicationContext getApplicationContext() {
return getWrappedApplicationContext();
}
/** {@inheritDoc} */
public void dispatch(String path) throws IOException {
include(path);
}
/** {@inheritDoc} */
public void include(String path) throws IOException {
if (isRenderRequest) {
try {
PortletRequestDispatcher rd = context.getRequestDispatcher(path);
if (rd == null) {
throw new IOException(
"No portlet request dispatcher returned for path '"
+ path + "'");
}
rd.include((RenderRequest) request,
(RenderResponse) response);
} catch (PortletException e) {
throw new TilesIOException(
"PortletException while including path '" + path + "'.",
e);
}
}
}
/** {@inheritDoc} */
public Locale getRequestLocale() {
if (request != null) {
return request.getLocale();
} else {
return null;
}
}
/** {@inheritDoc} */
public boolean isUserInRole(String role) {
return request.isUserInRole(role);
}
}