org.eclipse.jetty.websocket.api.UpgradeRequest Maven / Gradle / Ivy
//
// ========================================================================
// Copyright (c) 1995-2014 Mort Bay Consulting Pty. Ltd.
// ------------------------------------------------------------------------
// 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.api;
import java.net.HttpCookie;
import java.net.URI;
import java.security.Principal;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.TreeMap;
import org.eclipse.jetty.websocket.api.extensions.ExtensionConfig;
import org.eclipse.jetty.websocket.api.util.QuoteUtil;
public class UpgradeRequest
{
private URI requestURI;
private List subProtocols = new ArrayList<>(1);
private List extensions = new ArrayList<>(1);
private List cookies = new ArrayList<>(1);
private Map> headers = new TreeMap<>(String.CASE_INSENSITIVE_ORDER);
private Map> parameters = new HashMap<>(1);
private Object session;
private String httpVersion;
private String method;
private String host;
private boolean secure;
protected UpgradeRequest()
{
/* anonymous, no requestURI, upgrade request */
}
public UpgradeRequest(String requestURI)
{
this(URI.create(requestURI));
}
public UpgradeRequest(URI requestURI)
{
setRequestURI(requestURI);
}
public void addExtensions(ExtensionConfig... configs)
{
Collections.addAll(extensions, configs);
}
public void addExtensions(String... configs)
{
for (String config : configs)
{
extensions.add(ExtensionConfig.parse(config));
}
}
public void clearHeaders()
{
headers.clear();
}
public List getCookies()
{
return cookies;
}
public List getExtensions()
{
return extensions;
}
public String getHeader(String name)
{
List values = headers.get(name);
// no value list
if (values == null)
{
return null;
}
int size = values.size();
// empty value list
if (size <= 0)
{
return null;
}
// simple return
if (size == 1)
{
return values.get(0);
}
// join it with commas
boolean needsDelim = false;
StringBuilder ret = new StringBuilder();
for (String value : values)
{
if (needsDelim)
{
ret.append(", ");
}
QuoteUtil.quoteIfNeeded(ret,value,QuoteUtil.ABNF_REQUIRED_QUOTING);
needsDelim = true;
}
return ret.toString();
}
public int getHeaderInt(String name)
{
List values = headers.get(name);
// no value list
if (values == null)
{
return -1;
}
int size = values.size();
// empty value list
if (size <= 0)
{
return -1;
}
// simple return
if (size == 1)
{
return Integer.parseInt(values.get(0));
}
throw new NumberFormatException("Cannot convert multi-value header into int");
}
public Map> getHeaders()
{
return headers;
}
public List getHeaders(String name)
{
return headers.get(name);
}
public String getHost()
{
return host;
}
public String getHttpVersion()
{
return httpVersion;
}
public String getMethod()
{
return method;
}
public String getOrigin()
{
return getHeader("Origin");
}
/**
* Returns a map of the query parameters of the request.
*
* @return a unmodifiable map of query parameters of the request.
*/
public Map> getParameterMap()
{
return Collections.unmodifiableMap(parameters);
}
public String getProtocolVersion()
{
String version = getHeader("Sec-WebSocket-Version");
if (version == null)
{
return "13"; // Default
}
return version;
}
public String getQueryString()
{
return requestURI.getQuery();
}
public URI getRequestURI()
{
return requestURI;
}
/**
* Access the Servlet HTTP Session (if present)
*
* Note: Never present on a Client UpgradeRequest.
*
* @return the Servlet HTTPSession on server side UpgradeRequests
*/
public Object getSession()
{
return session;
}
public List getSubProtocols()
{
return subProtocols;
}
/**
* Get the User Principal for this request.
*
* Only applicable when using UpgradeRequest from server side.
*
* @return the user principal
*/
public Principal getUserPrincipal()
{
// Server side should override to implement
return null;
}
public boolean hasSubProtocol(String test)
{
for (String protocol : subProtocols)
{
if (protocol.equalsIgnoreCase(test))
{
return true;
}
}
return false;
}
public boolean isOrigin(String test)
{
return test.equalsIgnoreCase(getOrigin());
}
public boolean isSecure()
{
return secure;
}
public void setCookies(List cookies)
{
this.cookies.clear();
if (cookies != null && !cookies.isEmpty())
{
this.cookies.addAll(cookies);
}
}
public void setExtensions(List configs)
{
this.extensions.clear();
if (configs != null)
{
this.extensions.addAll(configs);
}
}
public void setHeader(String name, List values)
{
headers.put(name,values);
}
public void setHeader(String name, String value)
{
List values = new ArrayList<>();
values.add(value);
setHeader(name,values);
}
public void setHeaders(Map> headers)
{
clearHeaders();
for (Map.Entry> entry : headers.entrySet())
{
String name = entry.getKey();
List values = entry.getValue();
setHeader(name,values);
}
}
public void setHttpVersion(String httpVersion)
{
this.httpVersion = httpVersion;
}
public void setMethod(String method)
{
this.method = method;
}
protected void setParameterMap(Map> parameters)
{
this.parameters.clear();
this.parameters.putAll(parameters);
}
public void setRequestURI(URI uri)
{
this.requestURI = uri;
String scheme = uri.getScheme();
if ("ws".equalsIgnoreCase(scheme))
{
secure = false;
}
else if ("wss".equalsIgnoreCase(scheme))
{
secure = true;
}
else
{
throw new IllegalArgumentException("URI scheme must be 'ws' or 'wss'");
}
this.host = this.requestURI.getHost();
this.parameters.clear();
}
public void setSession(Object session)
{
this.session = session;
}
public void setSubProtocols(List subProtocols)
{
this.subProtocols.clear();
if (subProtocols != null)
{
this.subProtocols.addAll(subProtocols);
}
}
/**
* Set Sub Protocol request list.
*
* @param protocols
* the sub protocols desired
*/
public void setSubProtocols(String... protocols)
{
subProtocols.clear();
Collections.addAll(subProtocols, protocols);
}
}