Skip to content

Commit

Permalink
Issue #5044 - move all setter methods on the UpgradeRequest interface…
Browse files Browse the repository at this point in the history 
… to ClientUpgradeRequest

Signed-off-by: Lachlan Roberts <lachlan@webtide.com>
  • Loading branch information
@lachlan-roberts
lachlan-roberts committed Jul 29, 2020
1 parent 5ff0ce4 commit 414a0f3
Show file tree
Hide file tree
Showing 5 changed files with 128 additions and 308 deletions.
90 changes: 0 additions & 90 deletions ...ket/websocket-jetty-api/src/main/java/org/eclipse/jetty/websocket/api/UpgradeRequest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,26 +31,6 @@
*/
public interface UpgradeRequest
{
/**
* Add WebSocket Extension Configuration(s) to Upgrade Request.
* <p>
* This is merely the list of requested Extensions to use, see {@link UpgradeResponse#getExtensions()} for what was
* negotiated
*
* @param configs the configuration(s) to add
*/
void addExtensions(ExtensionConfig... configs);

/**
* Add WebSocket Extension Configuration(s) to request
* <p>
* This is merely the list of requested Extensions to use, see {@link UpgradeResponse#getExtensions()} for what was
* negotiated
*
* @param configs the configuration(s) to add
*/
void addExtensions(String... configs);

/**
* Get the list of Cookies on the Upgrade request
*
Expand Down Expand Up @@ -207,74 +187,4 @@ public interface UpgradeRequest
* @return true if connection is secure.
*/
boolean isSecure();

/**
* Set the list of Cookies on the request
*
* @param cookies the cookies to use
*/
void setCookies(List<HttpCookie> cookies);

/**
* Set the list of WebSocket Extension configurations on the request.
*
* @param configs the list of extension configurations
*/
void setExtensions(List<ExtensionConfig> configs);

/**
* Set a specific header with multi-value field
* <p>
* Overrides any previous value for this named header
*
* @param name the name of the header
* @param values the multi-value field
*/
void setHeader(String name, List<String> values);

/**
* Set a specific header value
* <p>
* Overrides any previous value for this named header
*
* @param name the header to set
* @param value the value to set it to
*/
void setHeader(String name, String value);

/**
* Sets multiple headers on the request.
* <p>
* Only sets those headers provided, does not remove
* headers that exist on request and are not provided in the
* parameter for this method.
* <p>
* Convenience method vs calling {@link #setHeader(String, List)} multiple times.
*
* @param headers the headers to set
*/
void setHeaders(Map<String, List<String>> headers);

/**
* Set the Session associated with this request.
* <p>
* Typically used to associate the Servlet HttpSession object.
*
* @param session the session object to associate with this request
*/
void setSession(Object session);

/**
* Set the offered WebSocket Sub-Protocol list.
*
* @param protocols the offered sub-protocol list
*/
void setSubProtocols(List<String> protocols);

/**
* Set the offered WebSocket Sub-Protocol list.
*
* @param protocols the offered sub-protocol list
*/
void setSubProtocols(String... protocols);
}
170 changes: 107 additions & 63 deletions ...t-jetty-client/src/main/java/org/eclipse/jetty/websocket/client/ClientUpgradeRequest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@
import org.eclipse.jetty.http.HttpHeader;
import org.eclipse.jetty.http.HttpScheme;
import org.eclipse.jetty.websocket.api.UpgradeRequest;
import org.eclipse.jetty.websocket.api.UpgradeResponse;
import org.eclipse.jetty.websocket.api.extensions.ExtensionConfig;

/**
Expand Down Expand Up @@ -63,53 +64,18 @@ public ClientUpgradeRequest(URI uri)
this.host = this.requestURI.getHost();
}

@Override
public void addExtensions(ExtensionConfig... configs)
{
Collections.addAll(extensions, configs);
}

@Override
public void addExtensions(String... configs)
{
for (String config : configs)
{
extensions.add(ExtensionConfig.parse(config));
}
}

@Override
public List<HttpCookie> getCookies()
{
return cookies;
}

@Override
public void setCookies(List<HttpCookie> cookies)
{
this.cookies.clear();
if (cookies != null && !cookies.isEmpty())
{
this.cookies.addAll(cookies);
}
}

@Override
public List<ExtensionConfig> getExtensions()
{
return extensions;
}

@Override
public void setExtensions(List<ExtensionConfig> configs)
{
this.extensions.clear();
if (configs != null)
{
this.extensions.addAll(configs);
}
}

@Override
public String getHeader(String name)
{
Expand Down Expand Up @@ -219,28 +185,6 @@ public Principal getUserPrincipal()
throw new UnsupportedOperationException("User Principal not available on Client request");
}

/**
* Set Sub Protocol request list.
*
* @param protocols the sub protocols desired
*/
@Override
public void setSubProtocols(String... protocols)
{
subProtocols.clear();
Collections.addAll(subProtocols, protocols);
}

@Override
public void setSubProtocols(List<String> subProtocols)
{
this.subProtocols.clear();
if (subProtocols != null)
{
this.subProtocols.addAll(subProtocols);
}
}

@Override
public boolean hasSubProtocol(String test)
{
Expand All @@ -260,21 +204,102 @@ public boolean isSecure()
throw new UnsupportedOperationException("Request.isSecure not available on Client request");
}

@Override
/**
* Add WebSocket Extension Configuration(s) to Upgrade Request.
* <p>
* This is merely the list of requested Extensions to use, see {@link UpgradeResponse#getExtensions()} for what was
* negotiated
*
* @param configs the configuration(s) to add
*/
public void addExtensions(ExtensionConfig... configs)
{
Collections.addAll(extensions, configs);
}

/**
* Add WebSocket Extension Configuration(s) to request
* <p>
* This is merely the list of requested Extensions to use, see {@link UpgradeResponse#getExtensions()} for what was
* negotiated
*
* @param configs the configuration(s) to add
*/
public void addExtensions(String... configs)
{
for (String config : configs)
{
extensions.add(ExtensionConfig.parse(config));
}
}

/**
* Set the list of Cookies on the request
*
* @param cookies the cookies to use
*/
public void setCookies(List<HttpCookie> cookies)
{
this.cookies.clear();
if (cookies != null && !cookies.isEmpty())
{
this.cookies.addAll(cookies);
}
}

/**
* Set the list of WebSocket Extension configurations on the request.
*
* @param configs the list of extension configurations
*/
public void setExtensions(List<ExtensionConfig> configs)
{
this.extensions.clear();
if (configs != null)
{
this.extensions.addAll(configs);
}
}

/**
* Set a specific header with multi-value field
* <p>
* Overrides any previous value for this named header
*
* @param name the name of the header
* @param values the multi-value field
*/
public void setHeader(String name, List<String> values)
{
headers.put(name, values);
}

@Override
/**
* Set a specific header value
* <p>
* Overrides any previous value for this named header
*
* @param name the header to set
* @param value the value to set it to
*/
public void setHeader(String name, String value)
{
List<String> values = new ArrayList<>();
values.add(value);
setHeader(name, values);
}

@Override
/**
* Sets multiple headers on the request.
* <p>
* Only sets those headers provided, does not remove
* headers that exist on request and are not provided in the
* parameter for this method.
* <p>
* Convenience method vs calling {@link #setHeader(String, List)} multiple times.
*
* @param headers the headers to set
*/
public void setHeaders(Map<String, List<String>> headers)
{
this.headers.clear();
Expand All @@ -286,10 +311,29 @@ public void setHeaders(Map<String, List<String>> headers)
}
}

@Override
public void setSession(Object session)
/**
* Set the offered WebSocket Sub-Protocol list.
*
* @param protocols the offered sub-protocol list
*/
public void setSubProtocols(List<String> protocols)
{
throw new UnsupportedOperationException("HttpSession not available on Client request");
this.subProtocols.clear();
if (protocols != null)
{
this.subProtocols.addAll(protocols);
}
}

/**
* Set the offered WebSocket Sub-Protocol list.
*
* @param protocols the offered sub-protocol list
*/
public void setSubProtocols(String... protocols)
{
subProtocols.clear();
Collections.addAll(subProtocols, protocols);
}

/**
Expand Down
Loading

0 comments on commit 414a0f3

Please sign in to comment.