javax.portlet.filter.StateAwareResponseWrapper Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of portlet-api Show documentation
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.
/* 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 javax.portlet.filter;
import java.io.Serializable;
import java.util.Map;
import javax.portlet.MutableRenderParameters;
import javax.portlet.PortletMode;
import javax.portlet.PortletModeException;
import javax.portlet.StateAwareResponse;
import javax.portlet.WindowState;
import javax.portlet.WindowStateException;
import javax.xml.namespace.QName;
/**
*
* The StateAwareResponseWrapper
provides a convenient
* implementation of the StateAwareResponse
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.
*
*/
public class StateAwareResponseWrapper extends PortletResponseWrapper implements StateAwareResponse {
/**
* @param response
*/
public StateAwareResponseWrapper(StateAwareResponse response) {
super(response);
}
/**
* Return the wrapped response object.
*
* @return the wrapped response
*/
public StateAwareResponse getResponse() {
return (StateAwareResponse) 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(StateAwareResponse response) {
super.setResponse(response);
}
/* (non-Javadoc)
* @see javax.portlet.MutableRenderState#getRenderParameters()
*/
public MutableRenderParameters getRenderParameters() {
return ((StateAwareResponse)response).getRenderParameters();
}
/* (non-Javadoc)
* @see javax.portlet.MutableRenderState#setWindowState(javax.portlet.WindowState)
*/
public void setWindowState(WindowState windowState)
throws WindowStateException {
((StateAwareResponse)response).setWindowState(windowState);
}
/* (non-Javadoc)
* @see javax.portlet.MutableRenderState#setPortletMode(javax.portlet.PortletMode)
*/
public void setPortletMode(PortletMode portletMode)
throws PortletModeException {
((StateAwareResponse)response).setPortletMode(portletMode);
}
/* (non-Javadoc)
* @see javax.portlet.RenderState#getPortletMode()
*/
public PortletMode getPortletMode() {
return ((StateAwareResponse)response).getPortletMode();
}
/* (non-Javadoc)
* @see javax.portlet.RenderState#getWindowState()
*/
public WindowState getWindowState() {
return ((StateAwareResponse)response).getWindowState();
}
/* (non-Javadoc)
* @see javax.portlet.StateAwareResponse#setRenderParameters(java.util.Map)
*/
@Deprecated
public void setRenderParameters(Map parameters) {
((StateAwareResponse)response).setRenderParameters(parameters);
}
/* (non-Javadoc)
* @see javax.portlet.StateAwareResponse#setRenderParameter(java.lang.String, java.lang.String)
*/
@Deprecated
public void setRenderParameter(String key, String value) {
((StateAwareResponse)response).setRenderParameter(key, value);
}
/* (non-Javadoc)
* @see javax.portlet.StateAwareResponse#setRenderParameter(java.lang.String, java.lang.String[])
*/
@Deprecated
public void setRenderParameter(String key, String... values) {
((StateAwareResponse)response).setRenderParameter(key, values);
}
/* (non-Javadoc)
* @see javax.portlet.StateAwareResponse#setEvent(javax.xml.namespace.QName, java.io.Serializable)
*/
public void setEvent(QName name, Serializable value) {
((StateAwareResponse)response).setEvent(name, value);
}
/* (non-Javadoc)
* @see javax.portlet.StateAwareResponse#setEvent(java.lang.String, java.io.Serializable)
*/
public void setEvent(String name, Serializable value) {
((StateAwareResponse)response).setEvent(name, value);
}
/* (non-Javadoc)
* @see javax.portlet.StateAwareResponse#getRenderParameterMap()
*/
@Deprecated
public Map getRenderParameterMap() {
return ((StateAwareResponse)response).getRenderParameterMap();
}
/* (non-Javadoc)
* @see javax.portlet.StateAwareResponse#removePublicRenderParameter(java.lang.String)
*/
@Deprecated
public void removePublicRenderParameter(String name) {
((StateAwareResponse)response).removePublicRenderParameter(name);
}
}