org.wso2.transport.http.netty.message

Class Http2PushPromise

java.lang.Object

org.wso2.transport.http.netty.message.Http2Frame

org.wso2.transport.http.netty.message.Http2PushPromise

public class Http2PushPromise
extends Http2Frame

Http2PushPromise represents a HTTP/2 PUSH_PROMISE frame.

This represents both HTTP/2 push promises received from a server as well as the push promises suppose to be delivered to a client. A PUSH_PROMISE should not be sent by a client.

Constructor Summary

Constructors

Constructor and Description
Http2PushPromise(io.netty.handler.codec.http.HttpRequest httpRequest) Constructor to create Http2PushPromise with initial HttpRequest.
Http2PushPromise(String method, String uri) Constructor to create a new Http2PushPromise with uri and http method.

Method Summary

Modifier and Type	Method and Description
void	addHeader(String name, String value) Adds a header to the push promise.
String	getHeader(String name) Gets a header value for a given header name.
String[]	getHeaders(String name) Gets all header values for a given header name.
io.netty.handler.codec.http.HttpRequest	getHttpRequest() Gets the associated HttpRequest of the push promise.
String	getMethod() Gets the http method associated with the push promise.
OutboundMsgHolder	getOutboundMsgHolder() Gets the OutboundMsgHolder associated with this Http2PushPromise.
String	getPath() Gets the path associated with the push promise.
int	getPromisedStreamId() Gets the promised stream id of the push promise.
boolean	isRejected() Checks whether push promise is rejected.
void	reject() Rejects the push promise.
void	removeAllHeaders() Removes all headers from the push promise.
void	removeHeader(String name) Remove all headers in for a given header name.
void	setHeader(String name, String value) Sets a header value for a given header name.
void	setOutboundMsgHolder(OutboundMsgHolder outboundMsgHolder) Sets the OutboundMsgHolder associated with Http2PushPromise.
void	setPromisedStreamId(int promisedStreamId) Sets the promised stream id of the push promise.

Methods inherited from class org.wso2.transport.http.netty.message.Http2Frame

getStreamId, isEndOfStream, setEndOfStream, setStreamId

Methods inherited from class java.lang.Object

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

Constructor Detail

Http2PushPromise

public Http2PushPromise(io.netty.handler.codec.http.HttpRequest httpRequest)

Constructor to create Http2PushPromise with initial HttpRequest.

Parameters:

httpRequest - the HttpRequest

Http2PushPromise

public Http2PushPromise(String method,
                        String uri)

Constructor to create a new Http2PushPromise with uri and http method.

Parameters:

method - the http method

uri - the uri

Method Detail

getHttpRequest

public io.netty.handler.codec.http.HttpRequest getHttpRequest()

Gets the associated HttpRequest of the push promise.

Returns:

the associated HttpRequest

getMethod

public String getMethod()

Gets the http method associated with the push promise.

Returns:

the http method

getPath

public String getPath()

Gets the path associated with the push promise.

Returns:

the path

addHeader

public void addHeader(String name,
                      String value)

Adds a header to the push promise. This will not replace the value of an already exists header.

Parameters:

name - the header name

value - value of the header

removeHeader

public void removeHeader(String name)

Remove all headers in for a given header name.

Parameters:

name - name of the header

getHeader

public String getHeader(String name)

Gets a header value for a given header name. In case if a given name has multiple headers, the first one is returned.

Parameters:

name - name of the header

Returns:

the value of the header

getHeaders

public String[] getHeaders(String name)

Gets all header values for a given header name.

Parameters:

name - name of the header

Returns:

array of header values

setHeader

public void setHeader(String name,
                      String value)

Sets a header value for a given header name. This replaces the value of an already existing header.

Parameters:

name - name of the header

value - value of the header

removeAllHeaders

public void removeAllHeaders()

Removes all headers from the push promise.

getPromisedStreamId

public int getPromisedStreamId()

Gets the promised stream id of the push promise.

Returns:

the promised stream id

setPromisedStreamId

public void setPromisedStreamId(int promisedStreamId)

Sets the promised stream id of the push promise.

Parameters:

promisedStreamId - promised stream id

isRejected

public boolean isRejected()

Checks whether push promise is rejected.

Returns:

whether push promise is rejected

reject

public void reject()

Rejects the push promise.

getOutboundMsgHolder

public OutboundMsgHolder getOutboundMsgHolder()

Gets the OutboundMsgHolder associated with this Http2PushPromise.

Returns:

the OutboundMsgHolder associated with this Http2PushPromise

setOutboundMsgHolder

public void setOutboundMsgHolder(OutboundMsgHolder outboundMsgHolder)

Sets the OutboundMsgHolder associated with Http2PushPromise.

Parameters:

outboundMsgHolder - the OutboundMsgHolder associated with this Http2PushPromise