/** * Licensed to Apereo under one or more contributor license agreements. See the NOTICE file * distributed with this work for additional information regarding copyright ownership. Apereo * 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 the * following location: * * <p>http://www.apache.org/licenses/LICENSE-2.0 * * <p>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.apereo.portal.portlet.container; import java.io.IOException; import java.io.OutputStream; import java.io.PrintWriter; import java.util.Locale; import javax.portlet.CacheControl; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; import org.apache.commons.lang.Validate; import org.apache.pluto.container.PortletContainer; import org.apache.pluto.container.PortletMimeResponseContext; import org.apache.pluto.container.PortletURLProvider; import org.apache.pluto.container.PortletURLProvider.TYPE; import org.apereo.portal.portlet.container.properties.IRequestPropertiesManager; import org.apereo.portal.portlet.container.services.IPortletCookieService; import org.apereo.portal.portlet.om.IPortletWindow; import org.apereo.portal.portlet.om.IPortletWindowId; import org.apereo.portal.portlet.rendering.IPortletRenderer; import org.apereo.portal.portlet.rendering.PortletOutputHandler; import org.apereo.portal.portlet.url.PortletURLProviderImpl; import org.apereo.portal.url.IPortalUrlBuilder; import org.apereo.portal.url.IPortalUrlProvider; import org.apereo.portal.url.IPortletUrlBuilder; import org.apereo.portal.url.UrlType; /** */ public abstract class PortletMimeResponseContextImpl extends PortletResponseContextImpl implements PortletMimeResponseContext { private final IPortalUrlProvider portalUrlProvider; private final PortletOutputHandler portletOutputHandler; private final CacheControl cacheControl; public PortletMimeResponseContextImpl( PortletContainer portletContainer, IPortletWindow portletWindow, HttpServletRequest containerRequest, HttpServletResponse containerResponse, IRequestPropertiesManager requestPropertiesManager, IPortalUrlProvider portalUrlProvider, IPortletCookieService portletCookieService) { super( portletContainer, portletWindow, containerRequest, containerResponse, requestPropertiesManager, portletCookieService); Validate.notNull(portalUrlProvider, "portalUrlProvider can not be null"); this.portalUrlProvider = portalUrlProvider; this.portletOutputHandler = (PortletOutputHandler) containerRequest.getAttribute( IPortletRenderer.ATTRIBUTE__PORTLET_OUTPUT_HANDLER); Validate.notNull( portletOutputHandler, "No " + IPortletRenderer.ATTRIBUTE__PORTLET_OUTPUT_HANDLER + " attribute found in request"); this.cacheControl = (CacheControl) containerRequest.getAttribute( IPortletRenderer.ATTRIBUTE__PORTLET_CACHE_CONTROL); Validate.notNull( cacheControl, "No " + IPortletRenderer.ATTRIBUTE__PORTLET_OUTPUT_HANDLER + " attribute found in request"); } protected final PortletOutputHandler getPortletOutputHandler() { return portletOutputHandler; } /* (non-Javadoc) * @see org.apache.pluto.container.PortletMimeResponseContext#getCacheControl() */ @Override public CacheControl getCacheControl() { this.checkContextStatus(); return this.cacheControl; } /* (non-Javadoc) * @see org.apache.pluto.container.PortletMimeResponseContext#flushBuffer() */ @Override public void flushBuffer() throws IOException { this.checkContextStatus(); this.portletOutputHandler.flushBuffer(); } /* (non-Javadoc) * @see org.apache.pluto.container.PortletMimeResponseContext#getBufferSize() */ @Override public int getBufferSize() { return this.portletOutputHandler.getBufferSize(); } /* (non-Javadoc) * @see org.apache.pluto.container.PortletMimeResponseContext#getCharacterEncoding() */ @Override public String getCharacterEncoding() { this.checkContextStatus(); return this.servletResponse.getCharacterEncoding(); } /* (non-Javadoc) * @see org.apache.pluto.container.PortletMimeResponseContext#getContentType() */ @Override public String getContentType() { this.checkContextStatus(); return this.servletResponse.getContentType(); } /* (non-Javadoc) * @see org.apache.pluto.container.PortletMimeResponseContext#getLocale() */ @Override public Locale getLocale() { this.checkContextStatus(); return this.servletResponse.getLocale(); } /* (non-Javadoc) * @see org.apache.pluto.container.PortletMimeResponseContext#getOutputStream() */ @Override public OutputStream getOutputStream() throws IOException, IllegalStateException { this.checkContextStatus(); return this.portletOutputHandler.getOutputStream(); } /* (non-Javadoc) * @see org.apache.pluto.container.PortletMimeResponseContext#getPortletURLProvider(org.apache.pluto.container.PortletURLProvider.TYPE) */ @Override public PortletURLProvider getPortletURLProvider(TYPE type) { final IPortletWindowId portletWindowId = this.portletWindow.getPortletWindowId(); final UrlType urlType = UrlType.fromPortletUrlType(type); final IPortalUrlBuilder portalUrlBuilder = this.portalUrlProvider.getPortalUrlBuilderByPortletWindow( containerRequest, portletWindowId, urlType); final IPortletUrlBuilder portletUrlBuilder = portalUrlBuilder.getPortletUrlBuilder(portletWindowId); return new PortletURLProviderImpl(portletUrlBuilder); } /* (non-Javadoc) * @see org.apache.pluto.container.PortletMimeResponseContext#getWriter() */ @Override public PrintWriter getWriter() throws IOException, IllegalStateException { this.checkContextStatus(); return this.portletOutputHandler.getPrintWriter(); } /* (non-Javadoc) * @see org.apache.pluto.container.PortletMimeResponseContext#isCommitted() */ @Override public boolean isCommitted() { return this.portletOutputHandler.isCommitted(); } /* (non-Javadoc) * @see org.apache.pluto.container.PortletMimeResponseContext#reset() */ @Override public void reset() { this.checkContextStatus(); this.portletOutputHandler.reset(); } /* (non-Javadoc) * @see org.apache.pluto.container.PortletMimeResponseContext#resetBuffer() */ @Override public void resetBuffer() { this.checkContextStatus(); this.portletOutputHandler.resetBuffer(); } /* (non-Javadoc) * @see org.apache.pluto.container.PortletMimeResponseContext#setBufferSize(int) */ @Override public void setBufferSize(int size) { this.checkContextStatus(); this.portletOutputHandler.setBufferSize(size); } /* (non-Javadoc) * @see org.apache.pluto.container.PortletMimeResponseContext#setContentType(java.lang.String) */ @Override public void setContentType(String contentType) { this.checkContextStatus(); this.portletOutputHandler.setContentType(contentType); } }