org.eclipse.jetty.websocket.servlet.ServletUpgradeResponse Maven / Gradle / Ivy
//
// ========================================================================
// Copyright (c) 1995-2022 Mort Bay Consulting Pty Ltd and others.
// ------------------------------------------------------------------------
// All rights reserved. This program and the accompanying materials
// are made available under the terms of the Eclipse Public License v1.0
// and Apache License v2.0 which accompanies this distribution.
//
// The Eclipse Public License is available at
// http://www.eclipse.org/legal/epl-v10.html
//
// The Apache License v2.0 is available at
// http://www.opensource.org/licenses/apache2.0.php
//
// You may elect to redistribute this code under either of these licenses.
// ========================================================================
//
package org.eclipse.jetty.websocket.servlet;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.TreeMap;
import javax.servlet.http.HttpServletResponse;
import org.eclipse.jetty.websocket.api.UpgradeResponse;
import org.eclipse.jetty.websocket.api.WebSocketConstants;
import org.eclipse.jetty.websocket.api.extensions.ExtensionConfig;
/**
* Servlet Specific UpgradeResponse implementation.
*/
public class ServletUpgradeResponse implements UpgradeResponse
{
private HttpServletResponse response;
private boolean extensionsNegotiated = false;
private boolean subprotocolNegotiated = false;
private Map> headers = new TreeMap<>(String.CASE_INSENSITIVE_ORDER);
private List extensions = new ArrayList<>();
private boolean success = false;
private int status;
public ServletUpgradeResponse(HttpServletResponse response)
{
this.response = response;
}
@Override
public void addHeader(String name, String value)
{
if (value != null)
{
List values = headers.get(name);
if (values == null)
{
values = new ArrayList<>();
headers.put(name, values);
}
values.add(value);
}
}
@Override
public void setHeader(String name, String value)
{
// remove from the real response
if (response != null)
response.setHeader(name, null);
List values = headers.get(name);
if (values == null)
{
values = new ArrayList<>();
headers.put(name, values);
}
else
values.clear();
values.add(value);
}
public void complete()
{
if (response == null)
return;
// Take a copy of all the real response headers
Map> real = new TreeMap<>(String.CASE_INSENSITIVE_ORDER);
for (String name : response.getHeaderNames())
{
real.put(name, response.getHeaders(name));
}
// Transfer all headers to the real HTTP response
for (Map.Entry> entry : getHeaders().entrySet())
{
for (String value : entry.getValue())
{
response.addHeader(entry.getKey(), value);
}
}
// Prepend the real headers to the copy headers
for (Map.Entry> entry : real.entrySet())
{
String name = entry.getKey();
Collection prepend = entry.getValue();
List values = headers.getOrDefault(name, new ArrayList<>());
values.addAll(0, prepend);
headers.put(name, values);
}
status = response.getStatus();
response = null;
}
@Override
public String getAcceptedSubProtocol()
{
return getHeader(WebSocketConstants.SEC_WEBSOCKET_PROTOCOL);
}
@Override
public List getExtensions()
{
return extensions;
}
@Override
public String getHeader(String name)
{
if (response != null)
{
String value = response.getHeader(name);
if (value != null)
return value;
}
List values = headers.get(name);
if (values != null && !values.isEmpty())
return values.get(0);
return null;
}
@Override
public Set getHeaderNames()
{
if (response == null)
return headers.keySet();
Set h = new HashSet<>(response.getHeaderNames());
h.addAll(headers.keySet());
return h;
}
@Override
public Map> getHeaders()
{
return headers;
}
@Override
public List getHeaders(String name)
{
if (response == null)
return headers.get(name);
List values = new ArrayList<>(response.getHeaders(name));
values.addAll(headers.get(name));
return values.isEmpty() ? null : values;
}
@Override
public int getStatusCode()
{
if (response != null)
return response.getStatus();
return status;
}
@Override
public String getStatusReason()
{
throw new UnsupportedOperationException("Servlet's do not support Status Reason");
}
public boolean isCommitted()
{
if (response != null)
{
return response.isCommitted();
}
// True in all other cases
return true;
}
public boolean isExtensionsNegotiated()
{
return extensionsNegotiated;
}
public boolean isSubprotocolNegotiated()
{
return subprotocolNegotiated;
}
@Override
public boolean isSuccess()
{
return success;
}
public void sendError(int statusCode, String message) throws IOException
{
setSuccess(false);
HttpServletResponse r = response;
complete();
r.sendError(statusCode, message);
r.flushBuffer();
}
@Override
public void sendForbidden(String message) throws IOException
{
setSuccess(false);
HttpServletResponse r = response;
complete();
r.sendError(HttpServletResponse.SC_FORBIDDEN, message);
r.flushBuffer();
}
@Override
public void setAcceptedSubProtocol(String protocol)
{
response.setHeader(WebSocketConstants.SEC_WEBSOCKET_PROTOCOL, protocol);
subprotocolNegotiated = true;
}
@Override
public void setExtensions(List configs)
{
this.extensions.clear();
this.extensions.addAll(configs);
String value = ExtensionConfig.toHeaderValue(configs);
response.setHeader(WebSocketConstants.SEC_WEBSOCKET_EXTENSIONS, value);
extensionsNegotiated = true;
}
@Override
public void setStatusCode(int statusCode)
{
if (response != null)
response.setStatus(statusCode);
}
@Override
public void setStatusReason(String statusReason)
{
throw new UnsupportedOperationException("Servlet's do not support Status Reason");
}
@Override
public void setSuccess(boolean success)
{
this.success = success;
}
@Override
public String toString()
{
return String.format("r=%s s=%d h=%s", response, status, headers);
}
}