javax.portlet.filter.PortletResponseWrapper 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 javax.portlet.PortletResponse;
import javax.servlet.http.Cookie;

/**
 * The PortletResponseWrapper provides a convenient 
 * implementation of the PortletResponse interface 
 * and is extended by other response wrappers.
 * This class implements the Wrapper or Decorator pattern. 
 * Methods default to calling through to the wrapped response object.
 *
 * @since 2.0
 * @see PortletResponse
 */
public class PortletResponseWrapper implements PortletResponse {

		PortletResponse response;
	    
	    /** 
	     * Require having a response for constructing
	     * the wrapper.
	     *
	     */
	    private PortletResponseWrapper() {
	    }
	    
	    /**
	     * 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 PortletResponseWrapper(PortletResponse response) {
	    	if ( response == null)
	    		throw new java.lang.IllegalArgumentException("Response is null");

	        this.response = response;
	    }

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

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

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

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

	    /**
	     * Return the wrapped response object.
	     * 
	     * @return the wrapped response
	     */
	    public PortletResponse 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(PortletResponse response) {
	    	if ( response == null)
	    		throw new java.lang.IllegalArgumentException("Response is null");

	        this.response = response;
	    }

	    /**
	     *  The default behavior of this method is to call 
	     * addProperty() on the wrapped response object.
	     */
	    public void addProperty(String key, org.w3c.dom.Element element) {
	        response.addProperty(key, element);
	    }

	    /**
	     *  The default behavior of this method is to call 
	     * createElement() on the wrapped response object.
	     */
	    public org.w3c.dom.Element createElement(String tagName) {
	        return response.createElement(tagName);
	    }

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

}