Top Fields Constructors Methods
org.glassfish.grizzly.websockets

public abstract Class HandShake

extends Object
Class Inheritance
Known Direct Subclasses
org.glassfish.grizzly.websockets.rfc6455.RFC6455HandShake
Imports
java.io.IOException, java.net.URI, java.util.ArrayList, .Arrays, .Collections, .List, .Locale, .Set, .TreeSet, org.glassfish.grizzly.filterchain.FilterChainContext, org.glassfish.grizzly.http.HttpContent, .HttpHeader, .HttpRequestPacket, .HttpResponsePacket, .Method, .Protocol, org.glassfish.grizzly.http.util.DataChunk, .Header, .HttpStatus, .MimeHeaders
Author
Justin Lee

Field Summary

Modifier and TypeField and Description
private HttpRequestPacket.Builder
builder

private List<Extension>
extensions

private String
location

private String
origin

private int
port

private String
resourcePath

private boolean
secure

private String
serverHostName

private List<String>
subProtocol

Constructor Summary

AccessConstructor and Description
public
HandShake(URI url)

public
HandShake(HttpRequestPacket request)

Method Summary

Modifier and TypeMethod and Description
private StringBuilder
appendPort(StringBuilder builder)

protected final void
buildLocation()

private void
checkForHeader(HttpHeader headers, String header, String validValue)

private void
checkForSubProtocol(final HttpResponsePacket headers)

public HttpContent
composeHeaders()

private void
determineHostAndPort(MimeHeaders headers)

public List<Extension>
getExtensions()

public String
getLocation()

public String
getOrigin()

public int
getPort()

public String
getResourcePath()

private String
getScheme()

public String
getServerHostName()

public List<String>
getSubProtocol()

protected abstract int
getVersion()

public void
initiate(FilterChainContext ctx)

protected List<Extension>
intersection(List<Extension> requested, List<Extension> supported)

public boolean
isSecure()

protected String
join(List<String> values)

protected final String
joinExtensions(List<Extension> extensions)

protected final List<Extension>
parseExtensionsHeader(final String headerValue)

protected final void
parseParameters(String parameterString, List<Extension.Parameter> parameters)

private String
readHeader(MimeHeaders headers, final String name)

Reads the header value using UTF-8 encoding

public void
respond(final FilterChainContext ctx, final WebSocketApplication application, final HttpResponsePacket response)

private void
sanitize(List<String> strings)

public void
setExtensions(List<Extension> extensions)

protected abstract void
setHeaders(HttpResponsePacket response)

public void
setSubProtocol(List<String> subProtocol)

protected final List<String>
split(final String header)

private void
validate(final String header, final String validValue, final String value)

public void
validateServerResponse(HttpResponsePacket headers)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

builderback to summary
private HttpRequestPacket.Builder builder
extensionsback to summary
private List<Extension> extensions
locationback to summary
private String location
originback to summary
private String origin
portback to summary
private int port
resourcePathback to summary
private String resourcePath
secureback to summary
private boolean secure
serverHostNameback to summary
private String serverHostName
subProtocolback to summary
private List<String> subProtocol

Constructor Detail

HandShakeback to summary
public HandShake(URI url)
HandShakeback to summary
public HandShake(HttpRequestPacket request)

Method Detail

appendPortback to summary
private StringBuilder appendPort(StringBuilder builder)
buildLocationback to summary
protected final void buildLocation()
checkForHeaderback to summary
private void checkForHeader(HttpHeader headers, String header, String validValue)
checkForSubProtocolback to summary
private void checkForSubProtocol(final HttpResponsePacket headers)
composeHeadersback to summary
public HttpContent composeHeaders()
determineHostAndPortback to summary
private void determineHostAndPort(MimeHeaders headers)
getExtensionsback to summary
public List<Extension> getExtensions()
getLocationback to summary
public String getLocation()
getOriginback to summary
public String getOrigin()
getPortback to summary
public int getPort()
getResourcePathback to summary
public String getResourcePath()
getSchemeback to summary
private String getScheme()
getServerHostNameback to summary
public String getServerHostName()
getSubProtocolback to summary
public List<String> getSubProtocol()
getVersionback to summary
protected abstract int getVersion()
initiateback to summary
public void initiate(FilterChainContext ctx) throws IOException
intersectionback to summary
protected List<Extension> intersection(List<Extension> requested, List<Extension> supported)
isSecureback to summary
public boolean isSecure()
joinback to summary
protected String join(List<String> values)
joinExtensionsback to summary
protected final String joinExtensions(List<Extension> extensions)
parseExtensionsHeaderback to summary
protected final List<Extension> parseExtensionsHeader(final String headerValue)
parseParametersback to summary
protected final void parseParameters(String parameterString, List<Extension.Parameter> parameters)
readHeaderback to summary
private String readHeader(MimeHeaders headers, final String name)

Reads the header value using UTF-8 encoding

respondback to summary
public void respond(final FilterChainContext ctx, final WebSocketApplication application, final HttpResponsePacket response)
sanitizeback to summary
private void sanitize(List<String> strings)
setExtensionsback to summary
public void setExtensions(List<Extension> extensions)
setHeadersback to summary
protected abstract void setHeaders(HttpResponsePacket response)
setSubProtocolback to summary
public void setSubProtocol(List<String> subProtocol)
splitback to summary
protected final List<String> split(final String header)
validateback to summary
private void validate(final String header, final String validValue, final String value)
validateServerResponseback to summary
public void validateServerResponse(HttpResponsePacket headers)