EE10 :: Servlet 12.0.6 · org.eclipse.jetty.ee10.servlet.PushBuilderImpl

Modifier and Type	Field and Description
private final HttpFields.Mutable	_headers
private String	_method
private String	_path
private String	_query
private final ServletContextRequest	_request
private String	_sessionId

Access	Constructor and Description
public	PushBuilderImpl(ServletContextRequest request, HttpFields.Mutable headers, String sessionId)

Method Summary

Modifier and Type	Method and Description
public PushBuilder	addHeader(String The header name to add name, String The header value to add value) Implements jakarta.servlet.http.PushBuilder.addHeader. Add a request header to be used for the push.
public String	getHeader(String the name of the header name) Implements jakarta.servlet.http.PushBuilder.getHeader. Return the header of the given name to be used for the push.
public Set<String>	getHeaderNames() Implements jakarta.servlet.http.PushBuilder.getHeaderNames. Return the set of header to be used for the push.
public String	getMethod() Implements jakarta.servlet.http.PushBuilder.getMethod. Return the method to be used for the push.
public String	getPath() Implements jakarta.servlet.http.PushBuilder.getPath. Return the URI path to be used for the push.
public String	getQueryString() Implements jakarta.servlet.http.PushBuilder.getQueryString. Return the query string to be used for the push.
public String	getSessionId() Implements jakarta.servlet.http.PushBuilder.getSessionId. Return the SessionID to be used for the push.
public PushBuilder	method(String the method to be used for the push. method) Implements jakarta.servlet.http.PushBuilder.method. Set the method to be used for the push.
public PushBuilder	path(String the URI path to be used for the push, which may include a query string. path) Implements jakarta.servlet.http.PushBuilder.path. Set the URI path to be used for the push.
public void	push() Implements jakarta.servlet.http.PushBuilder.push. Push a resource given the current state of the builder, the method must be non-blocking.
public PushBuilder	queryString(String the query string to be used for the push. queryString) Implements jakarta.servlet.http.PushBuilder.queryString. Set the query string to be used for the push.
public PushBuilder	removeHeader(String The name of the header to remove name) Implements jakarta.servlet.http.PushBuilder.removeHeader. Remove the named request header.
public PushBuilder	sessionId(String the SessionID to be used for the push. sessionId) Implements jakarta.servlet.http.PushBuilder.sessionId. Set the SessionID to be used for the push.
public PushBuilder	setHeader(String The header name to set name, String The header value to set value) Implements jakarta.servlet.http.PushBuilder.setHeader. Set a request header to be used for the push.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

_headers	back to summary
private final HttpFields.Mutable _headers

_method	back to summary
private String _method

_path	back to summary
private String _path

_query	back to summary
private String _query

_request	back to summary
private final ServletContextRequest _request

_sessionId	back to summary
private String _sessionId

PushBuilderImpl	back to summary
public PushBuilderImpl(ServletContextRequest request, HttpFields.Mutable headers, String sessionId)

Method Detail

addHeader	back to summary
public PushBuilder addHeader(String name, String value) Implements jakarta.servlet.http.PushBuilder.addHeader. Doc from jakarta.servlet.http.PushBuilder.addHeader. Add a request header to be used for the push. Parameters name:String The header name to add value:String The header value to add Returns:PushBuilder this builder. Annotations @Override

addHeader

back to summary

public PushBuilder addHeader(String name, String value)

Implements jakarta.servlet.http.PushBuilder.addHeader.

Doc from jakarta.servlet.http.PushBuilder.addHeader.

Add a request header to be used for the push.

Parameters

name:String: The header name to add
value:String: The header value to add

Returns:PushBuilder

this builder.

Annotations

@Override

getHeader	back to summary
public String getHeader(String name) Implements jakarta.servlet.http.PushBuilder.getHeader. Doc from jakarta.servlet.http.PushBuilder.getHeader. Return the header of the given name to be used for the push. Parameters name:String the name of the header Returns:String the header of the given name to be used for the push. Annotations @Override

getHeader

back to summary

public String getHeader(String name)

Implements jakarta.servlet.http.PushBuilder.getHeader.

Doc from jakarta.servlet.http.PushBuilder.getHeader.

Return the header of the given name to be used for the push.

Parameters

name:String: the name of the header

Returns:String

the header of the given name to be used for the push.

Annotations

@Override

getHeaderNames back to summary

getHeaderNames	back to summary
public Set<String> getHeaderNames() Implements jakarta.servlet.http.PushBuilder.getHeaderNames. Doc from jakarta.servlet.http.PushBuilder.getHeaderNames. Return the set of header to be used for the push. The returned set is not backed by the `PushBuilder` object, so changes in the returned set are not reflected in the `PushBuilder` object, and vice-versa. Returns:Set<String> the set of header to be used for the push. Annotations @Override

public Set<String> getHeaderNames()

Implements jakarta.servlet.http.PushBuilder.getHeaderNames.

Doc from jakarta.servlet.http.PushBuilder.getHeaderNames.

Return the set of header to be used for the push.

The returned set is not backed by the PushBuilder object, so changes in the returned set are not reflected in the PushBuilder object, and vice-versa.

Returns:Set<String>

the set of header to be used for the push.

Annotations

@Override

getMethod	back to summary
public String getMethod() Implements jakarta.servlet.http.PushBuilder.getMethod. Doc from jakarta.servlet.http.PushBuilder.getMethod. Return the method to be used for the push. Returns:String the method to be used for the push. Annotations @Override

getMethod

back to summary

public String getMethod()

Implements jakarta.servlet.http.PushBuilder.getMethod.

Doc from jakarta.servlet.http.PushBuilder.getMethod.

Return the method to be used for the push.

Returns:String

the method to be used for the push.

Annotations

@Override

getPath	back to summary
public String getPath() Implements jakarta.servlet.http.PushBuilder.getPath. Doc from jakarta.servlet.http.PushBuilder.getPath. Return the URI path to be used for the push. Returns:String the URI path to be used for the push. Annotations @Override

getPath

back to summary

public String getPath()

Implements jakarta.servlet.http.PushBuilder.getPath.

Doc from jakarta.servlet.http.PushBuilder.getPath.

Return the URI path to be used for the push.

Returns:String

the URI path to be used for the push.

Annotations

@Override

getQueryString	back to summary
public String getQueryString() Implements jakarta.servlet.http.PushBuilder.getQueryString. Doc from jakarta.servlet.http.PushBuilder.getQueryString. Return the query string to be used for the push. Returns:String the query string to be used for the push. Annotations @Override

getQueryString

back to summary

public String getQueryString()

Implements jakarta.servlet.http.PushBuilder.getQueryString.

Doc from jakarta.servlet.http.PushBuilder.getQueryString.

Return the query string to be used for the push.

Returns:String

the query string to be used for the push.

Annotations

@Override

getSessionId	back to summary
public String getSessionId() Implements jakarta.servlet.http.PushBuilder.getSessionId. Doc from jakarta.servlet.http.PushBuilder.getSessionId. Return the SessionID to be used for the push. Returns:String the SessionID to be used for the push. Annotations @Override

getSessionId

back to summary

public String getSessionId()

Implements jakarta.servlet.http.PushBuilder.getSessionId.

Doc from jakarta.servlet.http.PushBuilder.getSessionId.

Return the SessionID to be used for the push.

Returns:String

the SessionID to be used for the push.

Annotations

@Override

method	back to summary
public PushBuilder method(String method) Implements jakarta.servlet.http.PushBuilder.method. Doc from jakarta.servlet.http.PushBuilder.method. Set the method to be used for the push. Parameters method:String the method to be used for the push. Returns:PushBuilder this builder. Annotations @Override

method

back to summary

public PushBuilder method(String method)

Implements jakarta.servlet.http.PushBuilder.method.

Doc from jakarta.servlet.http.PushBuilder.method.

Set the method to be used for the push.

Parameters

method:String: the method to be used for the push.

Returns:PushBuilder

this builder.

Annotations

@Override

path back to summary

path	back to summary
public PushBuilder path(String path) Implements jakarta.servlet.http.PushBuilder.path. Doc from jakarta.servlet.http.PushBuilder.path. Set the URI path to be used for the push. The path may start with "/" in which case it is treated as an absolute path, otherwise it is relative to the context path of the associated request. There is no path default and `path(String)` must be called before every call to `push()`. If a query string is present in the argument `path`, its contents must be merged with the contents previously passed to `queryString`, preserving duplicates. Parameters path:String the URI path to be used for the push, which may include a query string. Returns:PushBuilder this builder. Annotations @Override

public PushBuilder path(String path)

Implements jakarta.servlet.http.PushBuilder.path.

Doc from jakarta.servlet.http.PushBuilder.path.

Set the URI path to be used for the push. The path may start with "/" in which case it is treated as an absolute path, otherwise it is relative to the context path of the associated request. There is no path default and path(String) must be called before every call to push(). If a query string is present in the argument path, its contents must be merged with the contents previously passed to queryString, preserving duplicates.

Parameters

path:String: the URI path to be used for the push, which may include a query string.

Returns:PushBuilder

this builder.

Annotations

@Override

push	back to summary
public void push() Implements jakarta.servlet.http.PushBuilder.push. Doc from jakarta.servlet.http.PushBuilder.push. Push a resource given the current state of the builder, the method must be non-blocking. Push a resource based on the current state of the PushBuilder. Calling this method does not guarantee the resource will actually be pushed, since it is possible the client can decline acceptance of the pushed resource using the underlying HTTP/2 protocol. If the builder has a session ID, then the pushed request will include the session ID either as a Cookie or as a URI parameter as appropriate. The builders query string is merged with any passed query string. Before returning from this method, the builder has its path, conditional headers (defined in RFC 7232) nulled. All other fields are left as is for possible reuse in another push. Annotations @Override

push

back to summary

public void push()

Implements jakarta.servlet.http.PushBuilder.push.

Doc from jakarta.servlet.http.PushBuilder.push.

Push a resource given the current state of the builder, the method must be non-blocking.

Push a resource based on the current state of the PushBuilder. Calling this method does not guarantee the resource will actually be pushed, since it is possible the client can decline acceptance of the pushed resource using the underlying HTTP/2 protocol.

If the builder has a session ID, then the pushed request will include the session ID either as a Cookie or as a URI parameter as appropriate. The builders query string is merged with any passed query string.

Before returning from this method, the builder has its path, conditional headers (defined in RFC 7232) nulled. All other fields are left as is for possible reuse in another push.

Annotations

@Override

queryString back to summary

queryString	back to summary
public PushBuilder queryString(String queryString) Implements jakarta.servlet.http.PushBuilder.queryString. Doc from jakarta.servlet.http.PushBuilder.queryString. Set the query string to be used for the push. The query string will be appended to any query String included in a call to `path(String)`. Any duplicate parameters must be preserved. This method should be used instead of a query in `path(String)` when multiple `push()` calls are to be made with the same query string. Parameters queryString:String the query string to be used for the push. Returns:PushBuilder this builder. Annotations @Override

public PushBuilder queryString(String queryString)

Implements jakarta.servlet.http.PushBuilder.queryString.

Doc from jakarta.servlet.http.PushBuilder.queryString.

Set the query string to be used for the push. The query string will be appended to any query String included in a call to path(String). Any duplicate parameters must be preserved. This method should be used instead of a query in path(String) when multiple push() calls are to be made with the same query string.

Parameters

queryString:String: the query string to be used for the push.

Returns:PushBuilder

this builder.

Annotations

@Override

removeHeader	back to summary
public PushBuilder removeHeader(String name) Implements jakarta.servlet.http.PushBuilder.removeHeader. Doc from jakarta.servlet.http.PushBuilder.removeHeader. Remove the named request header. If the header does not exist, take no action. Parameters name:String The name of the header to remove Returns:PushBuilder this builder. Annotations @Override

removeHeader

back to summary

public PushBuilder removeHeader(String name)

Implements jakarta.servlet.http.PushBuilder.removeHeader.

Doc from jakarta.servlet.http.PushBuilder.removeHeader.

Remove the named request header. If the header does not exist, take no action.

Parameters

name:String: The name of the header to remove

Returns:PushBuilder

this builder.

Annotations

@Override

sessionId	back to summary
public PushBuilder sessionId(String sessionId) Implements jakarta.servlet.http.PushBuilder.sessionId. Doc from jakarta.servlet.http.PushBuilder.sessionId. Set the SessionID to be used for the push. The session ID will be set in the same way it was on the associated request (ie as a cookie if the associated request used a cookie, or as a url parameter if the associated request used a url parameter). Defaults to the requested session ID or any newly assigned session id from a newly created session. Parameters sessionId:String the SessionID to be used for the push. Returns:PushBuilder this builder. Annotations @Override

sessionId

back to summary

public PushBuilder sessionId(String sessionId)

Implements jakarta.servlet.http.PushBuilder.sessionId.

Doc from jakarta.servlet.http.PushBuilder.sessionId.

Set the SessionID to be used for the push. The session ID will be set in the same way it was on the associated request (ie as a cookie if the associated request used a cookie, or as a url parameter if the associated request used a url parameter). Defaults to the requested session ID or any newly assigned session id from a newly created session.

Parameters

sessionId:String: the SessionID to be used for the push.

Returns:PushBuilder

this builder.

Annotations

@Override

setHeader	back to summary
public PushBuilder setHeader(String name, String value) Implements jakarta.servlet.http.PushBuilder.setHeader. Doc from jakarta.servlet.http.PushBuilder.setHeader. Set a request header to be used for the push. If the builder has an existing header with the same name, its value is overwritten. Parameters name:String The header name to set value:String The header value to set Returns:PushBuilder this builder. Annotations @Override

setHeader

back to summary

public PushBuilder setHeader(String name, String value)

Implements jakarta.servlet.http.PushBuilder.setHeader.

Doc from jakarta.servlet.http.PushBuilder.setHeader.

Set a request header to be used for the push. If the builder has an existing header with the same name, its value is overwritten.

Parameters