ApplicationPushBuilder (Apache Tomcat 9.0.0.M9 API Documentation)

java.lang.Object
- org.apache.catalina.core.ApplicationPushBuilder

All Implemented Interfaces:: PushBuilder

public class ApplicationPushBuilder
extends Object
implements PushBuilder

Constructor Summary

Constructors
Constructor and Description

ApplicationPushBuilder(HttpServletRequest request)

Constructors
Constructor and Description
`ApplicationPushBuilder(HttpServletRequest request)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PushBuilder`	`addHeader(String name, String value)` Adds a HTTP header to the request.
`PushBuilder`	`conditional(boolean conditional)` Sets if the request will be conditional.
`PushBuilder`	`etag(String etag)` Sets the etag to be used for conditional push requests.
`String`	`getEtag()` Obtain the etag that will be used for the push request that will be generated by the next call to `push()`.
`String`	`getHeader(String name)` Obtain a value for the given HTTP header.
`Set<String>`	`getHeaderNames()`
`String`	`getLastModified()` Obtain the last modified that will be used for the push request that will be generated by the next call to `push()`.
`String`	`getMethod()` Obtain the name of the HTTP method that will be used for push requests generated by future calls to `push()`.
`String`	`getPath()` Obtain the path that will be used for the push request that will be generated by the next call to `push()`.
`String`	`getQueryString()` Obtain the query string that will be used for push requests generated by future calls to `push()`.
`String`	`getSessionId()` Obtain the session ID that will be used for push requests generated by future calls to `push()`.
`boolean`	`isConditional()` Will push requests generated by future calls to `push()` be conditional.
`PushBuilder`	`lastModified(String lastModified)` Sets the last modified to be used for conditional push requests.
`PushBuilder`	`method(String method)` Specify the HTTP method to use for the push request.
`PushBuilder`	`path(String path)` Sets the URI path to be used for the push request.
`boolean`	`push()` Generates the push request and sends it to the client unless pushes are not available for some reason.
`PushBuilder`	`queryString(String queryString)` Specifies the query string to use in subsequent push requests generated by a call to `PushBuilder.push()`.
`PushBuilder`	`removeHeader(String name)` Removes an HTTP header from the request.
`PushBuilder`	`sessionId(String sessionId)` Specifies the session ID to use in subsequent push requests generated by a call to `PushBuilder.push()`.
`PushBuilder`	`setHeader(String name, String value)` Sets a HTTP header on the request.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ApplicationPushBuilder
```
public ApplicationPushBuilder(HttpServletRequest request)
```
- Method Detail
  - path
```
public PushBuilder path(String path)
```
    Description copied from interface: javax.servlet.http.PushBuilder
    
    Sets the URI path to be used for the push request. This must be called before every call to PushBuilder.push(). If the path includes a query string, the query string will be appended to the existing query string (if any) and no de-duplication will occur.
    
    Specified by:
    
    path in interface PushBuilder
    
    Parameters:
    
    path - Paths beginning with '/' are treated as absolute paths. All other paths are treated as relative to the context path of the request used to create this builder instance. The path may include a query string.
    
    Returns:
    
    This builder instance
  - getPath
```
public String getPath()
```
    Description copied from interface: javax.servlet.http.PushBuilder
    
    Obtain the path that will be used for the push request that will be generated by the next call to push().
    
    Specified by:
    
    getPath in interface PushBuilder
    
    Returns:
    
    The path value that will be associated with the next push request
  - method
```
public PushBuilder method(String method)
```
    Description copied from interface: javax.servlet.http.PushBuilder
    
    Specify the HTTP method to use for the push request.
    
    Specified by:
    
    method in interface PushBuilder
    
    Parameters:
    
    method - The method to use for the push request
    
    Returns:
    
    This builder instance
  - getMethod
```
public String getMethod()
```
    Description copied from interface: javax.servlet.http.PushBuilder
    
    Obtain the name of the HTTP method that will be used for push requests generated by future calls to push().
    
    Specified by:
    
    getMethod in interface PushBuilder
    
    Returns:
    
    The HTTP method to be used for future push requests
  - etag
```
public PushBuilder etag(String etag)
```
    Description copied from interface: javax.servlet.http.PushBuilder
    
    Sets the etag to be used for conditional push requests. This will be set to null after a call to PushBuilder.push() so it must be explicitly set for every push request that requires it.
    
    Specified by:
    
    etag in interface PushBuilder
    
    Parameters:
    
    etag - The etag use for the push request
    
    Returns:
    
    This builder instance
  - getEtag
```
public String getEtag()
```
    Description copied from interface: javax.servlet.http.PushBuilder
    
    Obtain the etag that will be used for the push request that will be generated by the next call to push().
    
    Specified by:
    
    getEtag in interface PushBuilder
    
    Returns:
    
    The etag value that will be associated with the next push request
  - lastModified
```
public PushBuilder lastModified(String lastModified)
```
    Description copied from interface: javax.servlet.http.PushBuilder
    
    Sets the last modified to be used for conditional push requests. This will be set to null after a call to PushBuilder.push() so it must be explicitly set for every push request that requires it.
    
    Specified by:
    
    lastModified in interface PushBuilder
    
    Parameters:
    
    lastModified - The last modified value to use for the push request
    
    Returns:
    
    This builder instance
  - getLastModified
```
public String getLastModified()
```
    Description copied from interface: javax.servlet.http.PushBuilder
    
    Obtain the last modified that will be used for the push request that will be generated by the next call to push().
    
    Specified by:
    
    getLastModified in interface PushBuilder
    
    Returns:
    
    The last modified value that will be associated with the next push request
  - queryString
```
public PushBuilder queryString(String queryString)
```
    Description copied from interface: javax.servlet.http.PushBuilder
    
    Specifies the query string to use in subsequent push requests generated by a call to PushBuilder.push(). This will be appended to any query string specified in the call to PushBuilder.path(String).
    
    Specified by:
    
    queryString in interface PushBuilder
    
    Parameters:
    
    queryString - The query string to use to generate push requests
    
    Returns:
    
    This builder instance
  - getQueryString
```
public String getQueryString()
```
    Description copied from interface: javax.servlet.http.PushBuilder
    
    Obtain the query string that will be used for push requests generated by future calls to push().
    
    Specified by:
    
    getQueryString in interface PushBuilder
    
    Returns:
    
    The query string that will be appended to push requests.
  - sessionId
```
public PushBuilder sessionId(String sessionId)
```
    Description copied from interface: javax.servlet.http.PushBuilder
    Specifies the session ID to use in subsequent push requests generated by a call to PushBuilder.push(). The session ID will be presented the same way as it is on the original request (cookie or URL parameter). The default is determined in the following order:
    - the requested session ID for the originating request
    - the session ID generated in the originated request
    - null
    Specified by:
    
    sessionId in interface PushBuilder
    
    Parameters:
    
    sessionId - The session ID to use to generate push requests
    
    Returns:
    
    This builder instance
  - getSessionId
```
public String getSessionId()
```
    Description copied from interface: javax.servlet.http.PushBuilder
    
    Obtain the session ID that will be used for push requests generated by future calls to push().
    
    Specified by:
    
    getSessionId in interface PushBuilder
    
    Returns:
    
    The session that will be used for push requests.
  - conditional
```
public PushBuilder conditional(boolean conditional)
```
    Description copied from interface: javax.servlet.http.PushBuilder
    
    Sets if the request will be conditional. If true the values from PushBuilder.getEtag() and PushBuilder.getLastModified() will be used to construct appropriate headers.
    
    Specified by:
    
    conditional in interface PushBuilder
    
    Parameters:
    
    conditional - Should generated push requests be conditional
    
    Returns:
    
    This builder instance
  - isConditional
```
public boolean isConditional()
```
    Description copied from interface: javax.servlet.http.PushBuilder
    
    Will push requests generated by future calls to push() be conditional.
    
    Specified by:
    
    isConditional in interface PushBuilder
    
    Returns:
    
    true if push requests will be conditional
  - addHeader
```
public PushBuilder addHeader(String name,
                             String value)
```
    Description copied from interface: javax.servlet.http.PushBuilder
    
    Adds a HTTP header to the request.
    
    Specified by:
    
    addHeader in interface PushBuilder
    
    Parameters:
    
    name - The name of the header to add
    
    value - The value of the header to add
    
    Returns:
    
    This builder instance
  - setHeader
```
public PushBuilder setHeader(String name,
                             String value)
```
    Description copied from interface: javax.servlet.http.PushBuilder
    
    Sets a HTTP header on the request. Any existing headers of the same name are first remove.
    
    Specified by:
    
    setHeader in interface PushBuilder
    
    Parameters:
    
    name - The name of the header to set
    
    value - The value of the header to set
    
    Returns:
    
    This builder instance
  - removeHeader
```
public PushBuilder removeHeader(String name)
```
    Description copied from interface: javax.servlet.http.PushBuilder
    
    Removes an HTTP header from the request.
    
    Specified by:
    
    removeHeader in interface PushBuilder
    
    Parameters:
    
    name - The name of the header to remove
    
    Returns:
    
    This builder instance
  - getHeaderNames
```
public Set<String> getHeaderNames()
```
    Specified by:
    
    getHeaderNames in interface PushBuilder
    
    Returns:
    
    The current set of names of HTTP headers to be used the next time push() is called.
  - getHeader
```
public String getHeader(String name)
```
    Description copied from interface: javax.servlet.http.PushBuilder
    
    Obtain a value for the given HTTP header. TODO Servlet 4.0 Clarify the behaviour of this method
    
    Specified by:
    
    getHeader in interface PushBuilder
    
    Parameters:
    
    name - The name of the header whose value is to be returned
    
    Returns:
    
    The value of the given header. If multiple values are defined then any may be returned
  - push
```
public boolean push()
```
    Description copied from interface: javax.servlet.http.PushBuilder
    Generates the push request and sends it to the client unless pushes are not available for some reason. After calling this method the following fields are set to null:
    - path
    - etag
    - lastModified
    Specified by:
    
    push in interface PushBuilder
    
    Returns:
    
    true if the push request was sent to the client, otherwise false

Class ApplicationPushBuilder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ApplicationPushBuilder

Method Detail

path

getPath

method

getMethod

etag

getEtag

lastModified

getLastModified

queryString

getQueryString

sessionId

getSessionId

conditional

isConditional

addHeader

setHeader

removeHeader

getHeaderNames

getHeader

push