javax.portlet.filter.ActionResponseWrapper Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of portlet-api Show documentation
The Java Portlet API version 3.0 developed by the Java Community Process JSR-362 Expert Group.
There is a newer version: 3.0.1
/*  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.
 */

/*
 * 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!
 */

package javax.portlet.filter;

import java.io.IOException;

import javax.portlet.ActionResponse;
import javax.portlet.MimeResponse.Copy;
import javax.portlet.RenderURL;

/**
 * The 
 * ActionResponseWrapper provides a convenient 
 * implementation of the ActionResponse interface 
 * that can be subclassed by developers.
 * 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 StateAwareResponseWrapper implements ActionResponse {

   /**
    * 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);
   }

   /**
    * Return the wrapped response object.
    * 
    * @return the wrapped response
    */
   public ActionResponse getResponse() {
      return (ActionResponse) 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) {
      super.setResponse(response);
   }

   /**
    * The default behavior of this method is to call 
    * sendRedirect(location) on the wrapped response object.
    */
   public void sendRedirect(String location) throws IOException {
      ((ActionResponse)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 {
      ((ActionResponse)response).sendRedirect(location, renderUrlParamName);
   }

   /**
    * call wrapped object.
    */
   public RenderURL createRedirectURL(Copy option) throws IllegalStateException {
      return ((ActionResponse)response).createRedirectURL(option);
   }

}