javax.portlet.filter.ActionResponseWrapper 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.
 */
/*
 * NOTE: this source code is based on an early draft version of JSR 286 and not intended for product
 * implementations. This file may change or vanish in the final version of the JSR 286 specification.
 */
/*
 * This source code implements specifications defined by the Java
 * Community Process. In order to remain compliant with the specification
 * DO NOT add / change / or delete method signatures!
 */
/*
 * Copyright 2006 IBM Corporation.
 *
 */
package javax.portlet.filter;

import java.io.IOException;
import java.util.Map;

import javax.portlet.ActionResponse;
import javax.portlet.PortletMode;
import javax.portlet.PortletModeException;
import javax.portlet.WindowState;
import javax.portlet.WindowStateException;
import javax.xml.namespace.QName;

/**
 * The ActionResponseWrapper provides a convenient 
 * implementation of the ActionResponse interface 
 * that can be subclassed by developers wishing to adapt the response.
 * This class implements the Wrapper or Decorator pattern. 
 * Methods default to calling through to the wrapped response object.
 *
 * @since 2.0
 * @see ActionResponse
 */
public class ActionResponseWrapper extends PortletResponseWrapper implements ActionResponse {

   ActionResponse response;
    
    /**
     * Creates an ActionResponse adaptor 
     * wrapping the given response object.
     * 
     * @param response  the action response to wrap
     * @throws java.lang.IllegalArgumentException if the response is null
     */
    public ActionResponseWrapper(ActionResponse response) {
    	super(response);
    	this.response = response;
    }

    /**
     * The default behavior of this method is to call 
     * sendRedirect(location) on the wrapped response object.
     */
    public void sendRedirect(String location) throws IOException {
        response.sendRedirect(location);
    }

    /**
     * The default behavior of this method is to call 
     * sendRedirect(location, renderUrlParamName) on the wrapped response object.
     */
    public void sendRedirect(String location, String renderUrlParamName) throws IOException {
        response.sendRedirect(location, renderUrlParamName);
    }

    /**
     * The default behavior of this method is to call 
     * setEvent(name, value) on the wrapped response object.
     */
    public void setEvent(QName name, java.io.Serializable value) {
        response.setEvent(name, value);
    }

    /**
     * The default behavior of this method is to call 
     * setPortletMode(portletMode) on the wrapped response object.
     */
    public void setPortletMode(PortletMode portletMode)
            throws PortletModeException {
        response.setPortletMode(portletMode);
    }

    /**
     * The default behavior of this method is to call 
     * setRenderParameter(key, value) on the wrapped response object.
     */
    public void setRenderParameter(String key, String value) {
        response.setRenderParameter(key, value);
    }

    /**
     * The default behavior of this method is to call 
     * setRenderParameter(key, value) on the wrapped response object.
     */
    public void setRenderParameter(String key, String[] values) {
        response.setRenderParameter(key, values);
    }

    /**
     * The default behavior of this method is to call 
     * setRenderParameters(parameters) on the wrapped response object.
     */
    public void setRenderParameters(Map parameters) {
        response.setRenderParameters(parameters);
    }

    /**
     * The default behavior of this method is to call 
     * setWindowState(windowState) on the wrapped response object.
     */
    public void setWindowState(WindowState windowState)
            throws WindowStateException {
        response.setWindowState(windowState);
    }

     /**
     * Return the wrapped response object.
     * 
     * @return the wrapped response
     */
    public ActionResponse getResponse() {
        return response;
    }

    /**
     * Sets the response object being wrapped.
     * 
     * @param response the response to set
     * @throws java.lang.IllegalArgumentException   if the response is null.
     */
    public void setResponse(ActionResponse response) {
    	if ( response == null)
    		throw new java.lang.IllegalArgumentException("Response is null");

    	this.response = response;
    }

    /**
     * The default behavior of this method is to call 
     * getPortletMode() on the wrapped response object.
     */
    public PortletMode getPortletMode() {
        return response.getPortletMode();
    }

    /**
     * The default behavior of this method is to call 
     * getRenderParameterMap() on the wrapped response object.
     */
    public Map getRenderParameterMap() {
        return response.getRenderParameterMap();
    }

    /**
     * The default behavior of this method is to call 
     * getWindowState() on the wrapped response object.
     */
    public WindowState getWindowState() {
        return response.getWindowState();
    }

    /**
     *  The default behavior of this method is to call 
     * setEvent() on the wrapped response object.
     */
	public void setEvent(String name, java.io.Serializable value) {
		response.setEvent(name, value);
	}

    /**
     *  The default behavior of this method is to call 
     * removePublicRenderParameter() on the wrapped response object.
     */
	public void removePublicRenderParameter(String name) {
		response.removePublicRenderParameter(name);		
	}

}