Module org.glassfish.grizzly.http.server

Package org.glassfish.grizzly.http.server.http2

Class PushEvent.PushEventBuilder

java.lang.Object

org.glassfish.grizzly.http.server.http2.PushEvent.PushEventBuilder

Enclosing class:

PushEvent

public static final class PushEvent.PushEventBuilder
extends Object

Construct a new PushEvent. Any missing required values will result in an exception when build() is invoked;

Method Summary

Modifier and Type	Method	Description
PushEvent	build()
PushEvent.PushEventBuilder	headers(org.glassfish.grizzly.http.util.MimeHeaders val)	The headers of the push request.
PushEvent.PushEventBuilder	httpRequest(org.glassfish.grizzly.http.HttpRequestPacket val)	The HttpRequestPacket of the original request.
PushEvent.PushEventBuilder	method(String val)	The push method.
PushEvent.PushEventBuilder	path(String val)	The path of the push request.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

method

public PushEvent.PushEventBuilder method(String val)

The push method. Defaults to Method.GET.

Returns:

this

Throws:

NullPointerException - if no value is provided.

IllegalArgumentException - if the argument is the empty String, or any non-cacheable or unsafe methods defined in RFC 7231, which are POST, PUT, DELETE, CONNECT, OPTIONS and TRACE.

headers

public PushEvent.PushEventBuilder headers(org.glassfish.grizzly.http.util.MimeHeaders val)

The headers of the push request.

Returns:

this

Throws:

NullPointerException - if no MimeHeaders is provided.

path

public PushEvent.PushEventBuilder path(String val)

The path of the push request.

Returns:

this

httpRequest

public PushEvent.PushEventBuilder httpRequest(org.glassfish.grizzly.http.HttpRequestPacket val)

The HttpRequestPacket of the original request. This is necessary in order to lookup the parent stream.

Returns:

this

Throws:

NullPointerException - if no HttpRequestPacket is provided.

build

public PushEvent build()

Returns:

a new PushEvent based on the provided values.

Throws:

IllegalArgumentException - if no value has been provided by invoking path(String), httpRequest(HttpRequestPacket), or headers(MimeHeaders).