/*
* Copyright 2000-2016 Vaadin Ltd.
*
* Licensed 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 com.vaadin.server;
import java.io.IOException;
import java.io.OutputStream;
import java.io.PrintWriter;
import java.text.DateFormat;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.Locale;
import java.util.TimeZone;
import javax.portlet.MimeResponse;
import javax.portlet.PortletResponse;
import javax.portlet.ResourceResponse;
import javax.servlet.http.Cookie;
/**
* Wrapper for {@link PortletResponse} and its subclasses.
*
* @author Vaadin Ltd.
* @since 7.0
*
* @see VaadinResponse
* @see VaadinPortletRequest
*/
public class VaadinPortletResponse implements VaadinResponse {
static final DateFormat HTTP_DATE_FORMAT = new SimpleDateFormat(
"EEE, dd MMM yyyy HH:mm:ss zzz", Locale.ENGLISH);
static {
HTTP_DATE_FORMAT.setTimeZone(TimeZone.getTimeZone("GMT"));
}
private final PortletResponse response;
private final VaadinPortletService vaadinService;
/**
* Wraps a portlet response and an associated vaadin service
*
* @param response
* the portlet response to wrap
* @param vaadinService
* the associated vaadin service
*/
public VaadinPortletResponse(PortletResponse response,
VaadinPortletService vaadinService) {
this.response = response;
this.vaadinService = vaadinService;
}
@Override
public OutputStream getOutputStream() throws IOException {
if (response instanceof MimeResponse) {
return ((MimeResponse) response).getPortletOutputStream();
} else {
throw new IOException(
"Output stream not available for response of type "
+ response.getClass().getName());
}
}
/**
* Gets the original, unwrapped portlet response.
*
* @return the unwrapped portlet response
*/
public PortletResponse getPortletResponse() {
return response;
}
@Override
public void setContentType(String type) {
if (response instanceof MimeResponse) {
((MimeResponse) response).setContentType(type);
} else {
throw new RuntimeException(
"Content type cannot be set for response of type "
+ response.getClass().getName());
}
}
@Override
public void setContentLength(int len) {
if (response instanceof ResourceResponse) {
((ResourceResponse) response).setContentLength(len);
}
}
@Override
public PrintWriter getWriter() throws IOException {
if (response instanceof MimeResponse) {
return ((MimeResponse) response).getWriter();
} else {
throw new IOException("Writer not available for response of type "
+ response.getClass().getName());
}
}
@Override
public void setStatus(int responseStatus) {
response.setProperty(ResourceResponse.HTTP_STATUS_CODE,
Integer.toString(responseStatus));
}
@Override
public void setHeader(String name, String value) {
response.setProperty(name, value);
}
@Override
public void setDateHeader(String name, long timestamp) {
response.setProperty(name,
HTTP_DATE_FORMAT.format(new Date(timestamp)));
}
@Override
public void setCacheTime(long milliseconds) {
VaadinServletResponse.doSetCacheTime(this, milliseconds);
}
@Override
public void sendError(int errorCode, String message) throws IOException {
setStatus(errorCode);
if (message != null) {
message = escapeHtml(message);
}
getWriter().write(message);
}
/**
* Perform minimal HTML escaping similar to Guava HtmlEscapers.
*
* @param input
* string to escape
* @return minimally escaped HTML safe string
*/
private static String escapeHtml(String input) {
StringBuilder sb = new StringBuilder();
for (int i = 0; i < input.length(); i++) {
char c = input.charAt(i);
switch (c) {
case '"':
sb.append(""");
break;
case '\'':
sb.append("'");
break;
case '&':
sb.append("&");
break;
case '<':
sb.append("<");
break;
case '>':
sb.append(">");
break;
default:
sb.append(c);
}
}
return sb.toString();
}
@Override
public VaadinPortletService getService() {
return vaadinService;
}
@Override
public void addCookie(Cookie cookie) {
response.addProperty(cookie);
}
}