org.atmosphere.gwt.server.impl.GwtResponseWriterImpl Maven / Gradle / Ivy
/*
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 2007-2008 Sun Microsystems, Inc. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can obtain
* a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
* or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
* Sun designates this particular file as subject to the "Classpath" exception
* as provided by Sun in the GPL Version 2 section of the License file that
* accompanied this code. If applicable, add the following below the License
* Header, with the fields enclosed by brackets [] replaced by your own
* identifying information: "Portions Copyrighted [year]
* [name of copyright owner]"
*
* Contributor(s):
*
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*
*/
/*
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 2007-2008 Sun Microsystems, Inc. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can obtain
* a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
* or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
* Sun designates this particular file as subject to the "Classpath" exception
* as provided by Sun in the GPL Version 2 section of the License file that
* accompanied this code. If applicable, add the following below the License
* Header, with the fields enclosed by brackets [] replaced by your own
* identifying information: "Portions Copyrighted [year]
* [name of copyright owner]"
*
* Contributor(s):
*
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*
*/
package org.atmosphere.gwt.server.impl;
import com.google.gwt.rpc.server.ClientOracle;
import com.google.gwt.user.client.rpc.SerializationException;
import com.google.gwt.rpc.server.RPC;
import com.google.gwt.user.server.rpc.SerializationPolicy;
import com.google.gwt.user.server.rpc.impl.ServerSerializationStreamWriter;
import org.atmosphere.gwt.server.GwtResponseWriter;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.NotSerializableException;
import java.io.OutputStream;
import java.io.OutputStreamWriter;
import java.io.Serializable;
import java.io.UnsupportedEncodingException;
import java.io.Writer;
import java.util.Collections;
import java.util.List;
import java.util.concurrent.ScheduledFuture;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;
import org.atmosphere.gwt.server.deflate.DeflaterOutputStream;
import java.util.Date;
import java.util.concurrent.atomic.AtomicInteger;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
*
* @author p.havelaar
*/
public abstract class GwtResponseWriterImpl implements GwtResponseWriter {
protected Writer writer;
protected final GwtAtmosphereResourceImpl resource;
protected final int connectionID;
protected final Logger logger = LoggerFactory.getLogger(getClass());
protected GwtResponseWriterImpl(GwtAtmosphereResourceImpl resource, SerializationPolicy serializationPolicy, ClientOracle clientOracle) {
this.resource = resource;
this.serializationPolicy = serializationPolicy;
this.clientOracle = clientOracle;
this.connectionID = connectionIDs.getAndIncrement();
}
@Override
public synchronized boolean isTerminated() {
return terminated;
}
protected boolean isDeRPC() {
return clientOracle != null;
}
public HttpServletRequest getRequest() {
return resource.getAtmosphereResource().getRequest();
}
public HttpServletResponse getResponse() {
return resource.getAtmosphereResource().getResponse();
}
synchronized void scheduleHeartbeat() {
if (logger.isTraceEnabled()) {
logger.trace("Schedule heartbeat for ["+connectionID+"]");
logger.trace("Last write for ["+connectionID+"] was " + new Date(lastWriteTime).toString());
}
lastWriteTime = System.currentTimeMillis();
if (heartbeatFuture != null) {
heartbeatFuture.cancel(false);
}
heartbeatFuture = resource.scheduleHeartbeat();
}
@Override
public void sendError(int statusCode) throws IOException {
sendError(statusCode, null);
}
@Override
public synchronized void sendError(int statusCode, String message) throws IOException {
try {
if (writer == null) {
getResponse().reset();
getResponse().setHeader("Cache-Control", "no-cache");
getResponse().setCharacterEncoding("UTF-8");
writer = new OutputStreamWriter(getResponse().getOutputStream(), "UTF-8");
}
doSendError(statusCode, message);
}
catch (IllegalStateException e) {
logger.error("Error resetting response to send error: " + e.getMessage());
}
catch (IOException e) {
logger.debug("Failed to send error to client", e);
}
finally {
setTerminated(true);
}
}
protected OutputStream getOutputStream(OutputStream outputStream) {
return outputStream;
}
public synchronized void initiate() throws IOException {
getResponse().setHeader("Cache-Control", "no-cache");
getResponse().setCharacterEncoding("UTF-8");
OutputStream outputStream = getResponse().getOutputStream();
outputStream = getOutputStream(outputStream);
String acceptEncoding = getRequest().getHeader("Accept-Encoding");
if (acceptEncoding != null && acceptEncoding.contains("deflate")) {
getResponse().setHeader("Content-Encoding", "deflate");
outputStream = new DeflaterOutputStream(outputStream);
}
writer = new OutputStreamWriter(outputStream, "UTF-8");
if (logger.isTraceEnabled()) {
logger.trace("Initiated ["+connectionID+"]");
}
getRequest().setAttribute("connectionID", connectionID);
scheduleHeartbeat();
}
public void suspend() throws IOException {
try {
synchronized (this) {
if (terminated) {
return;
}
if (logger.isTraceEnabled()) {
logger.trace("Suspending ["+connectionID+"]");
}
doSuspend();
flush();
}
}
catch (IOException e) {
logger.error("Error suspending response", e);
synchronized (this) {
setTerminated(false);
}
throw e;
}
}
@Override
public synchronized void terminate() throws IOException {
if (!terminated) {
try {
doTerminate();
flush();
}
finally {
setTerminated(true);
}
}
}
void tryTerminate() {
try {
terminate();
}
catch (IOException e) {
logger.error("Error terminating response", e);
}
}
@Override
public void write(Serializable message) throws IOException {
write(Collections.singletonList(message), true);
}
@Override
public void write(Serializable message, boolean flush) throws IOException {
write(Collections.singletonList(message), flush);
}
@Override
public void write(List messages) throws IOException {
write(messages, true);
}
@Override
public synchronized void write(List messages, boolean flush) throws IOException {
if (terminated) {
throw new IOException("CometServletResponse terminated");
}
try {
if (messages.size() == 1 && messages.get(0) instanceof Heartbeat) {
heartbeat();
} else {
if (logger.isTraceEnabled()) {
logger.trace("Writing #" + messages.size() + " messages to ["+connectionID+"]");
}
doWrite(messages);
if (flush) {
flush();
}
scheduleHeartbeat();
}
}
catch (IOException e) {
resource.resumeAfterDeath();
setTerminated(false);
throw e;
}
}
@Override
public synchronized void heartbeat() throws IOException {
if (!terminated) {
try {
logger.trace("Sending heartbeat ["+connectionID+"]");
doHeartbeat();
flush();
scheduleHeartbeat();
}
catch (IOException e) {
logger.debug("Failed to send heartbeat", e);
setTerminated(false);
throw e;
}
}
}
synchronized void flush() throws IOException {
writer.flush();
}
synchronized void setTerminated(boolean serverInitiated) {
if (!terminated) {
terminated = true;
if (logger.isTraceEnabled()) {
logger.trace("Terminating ["+connectionID+"]");
}
if (heartbeatFuture != null) {
heartbeatFuture.cancel(false);
heartbeatFuture = null;
}
if (serverInitiated) {
try {
if (writer != null) {
writer.close();
}
}
catch (IOException e) {
logger.error("Error closing connection", e);
}
resource.terminate(serverInitiated);
}
}
}
@Override
public long getLastWriteTime() {
return lastWriteTime;
}
protected abstract void doSendError(int statusCode, String message) throws IOException;
protected abstract void doSuspend() throws IOException;
protected abstract void doWrite(List messages) throws IOException;
protected abstract void doHeartbeat() throws IOException;
protected abstract void doTerminate() throws IOException;
protected boolean hasSession() {
HttpSession session = resource.getSession(false);
return session != null;
}
protected String serialize(Serializable message) throws NotSerializableException, UnsupportedEncodingException {
try {
if (clientOracle == null) {
ServerSerializationStreamWriter streamWriter = new ServerSerializationStreamWriter(serializationPolicy);
streamWriter.prepareToWrite();
streamWriter.writeObject(message);
return streamWriter.toString();
}
else {
ByteArrayOutputStream result = new ByteArrayOutputStream();
RPC.streamResponseForSuccess(clientOracle, result, message);
return new String(result.toByteArray(), "UTF-8");
}
}
catch (SerializationException e) {
throw new NotSerializableException("Unable to serialize object, message: " + e.getMessage());
}
}
private final SerializationPolicy serializationPolicy;
private final ClientOracle clientOracle;
private boolean terminated;
private volatile long lastWriteTime;
private ScheduledFuture heartbeatFuture;
private static AtomicInteger connectionIDs = new AtomicInteger(1);
}© 2015 - 2025 Weber Informatics LLC | Privacy Policy