org.wso2.transport.http.netty.contractimpl

Class DefaultHttpResponseFuture

java.lang.Object

org.wso2.transport.http.netty.contractimpl.DefaultHttpResponseFuture

All Implemented Interfaces:

HttpResponseFuture

public class DefaultHttpResponseFuture
extends Object
implements HttpResponseFuture

Implementation of the response returnError future.

Constructor Summary

Constructors

Constructor and Description
DefaultHttpResponseFuture()
DefaultHttpResponseFuture(OutboundMsgHolder outboundMsgHolder)

Method Summary

Modifier and Type	Method and Description
DefaultOperationStatus	getStatus() Reruns the status of the future.
void	notifyHttpListener(HttpCarbonMessage httpCarbonMessage) Notifies the http message listener when there is an event.
void	notifyHttpListener(Throwable throwable) Notifies the listener when there is an event.
void	notifyPromiseAvailability() Notifies the promise listener when there is an event.
void	notifyPushPromise() Notifies the push promise listener when there is an event.
void	notifyPushResponse(int streamId, HttpCarbonMessage pushResponse) Notifies push response listener when there is a push response.
void	notifyPushResponse(int streamId, Throwable throwable) Notifies the Push Response Listener when there is an error.
void	notifyResponseHandle(ResponseHandle responseHandle) Notifies the response handle listener when there is an event.
void	notifyResponseHandle(Throwable throwable) Notifies the response handle listener when there is an error.
void	removeHttpListener() Removes the message listener set to the future.
void	removePromiseAvailabilityListener() Removes the promise availability listener.
void	removePushPromiseListener() Removes the push promise listener set to the future.
void	removePushResponseListener(int promisedId) Removes the Push Response listener.
void	removeResponseHandleListener() Removes the handle listener set to the future.
void	resetStatus() Reset the states associated with the future.
void	setBackPressureHandler(BackPressureHandler backPressureHandler) Sets back pressure handler.
void	setHttpConnectorListener(HttpConnectorListener connectorListener) Sets listener for the connector future.
void	setPromiseAvailabilityListener(HttpClientConnectorListener promiseAvailabilityListener) Sets the listener for the promise availability future.
void	setPushPromiseListener(HttpConnectorListener pushPromiseListener) Sets listener for the push promise future.
void	setPushResponseListener(HttpConnectorListener pushResponseListener, int promiseId) Sets the Push Response listener.
void	setResponseHandleListener(HttpClientConnectorListener responseHandleListener) Sets response handle listener.
HttpResponseFuture	sync() Makes the async operation sync.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultHttpResponseFuture

public DefaultHttpResponseFuture(OutboundMsgHolder outboundMsgHolder)

DefaultHttpResponseFuture

public DefaultHttpResponseFuture()

Method Detail

setHttpConnectorListener

public void setHttpConnectorListener(HttpConnectorListener connectorListener)

Description copied from interface: HttpResponseFuture

Sets listener for the connector future.

Specified by:

setHttpConnectorListener in interface HttpResponseFuture

Parameters:

connectorListener - the listener that receive http message events related to the connector

removeHttpListener

public void removeHttpListener()

Description copied from interface: HttpResponseFuture

Removes the message listener set to the future.

Specified by:

removeHttpListener in interface HttpResponseFuture

notifyHttpListener

public void notifyHttpListener(HttpCarbonMessage httpCarbonMessage)

Description copied from interface: HttpResponseFuture

Notifies the http message listener when there is an event.

Specified by:

notifyHttpListener in interface HttpResponseFuture

Parameters:

httpCarbonMessage - the entity which contains the data related to the event

notifyHttpListener

public void notifyHttpListener(Throwable throwable)

Description copied from interface: HttpResponseFuture

Notifies the listener when there is an event.

Specified by:

notifyHttpListener in interface HttpResponseFuture

Parameters:

throwable - the entity which contains the data related to the error

sync

public HttpResponseFuture sync()
                        throws InterruptedException

Description copied from interface: HttpResponseFuture

Makes the async operation sync.

Specified by:

sync in interface HttpResponseFuture

Returns:

Status future

Throws:

InterruptedException - if the connection is interrupted

getStatus

public DefaultOperationStatus getStatus()

Description copied from interface: HttpResponseFuture

Reruns the status of the future.

Specified by:

getStatus in interface HttpResponseFuture

Returns:

the status of the HttpResponseFuture

resetStatus

public void resetStatus()

Description copied from interface: HttpResponseFuture

Reset the states associated with the future. Status need to be reset if we are to reuse the future for more than once with sync operation.

Specified by:

resetStatus in interface HttpResponseFuture

setBackPressureHandler

public void setBackPressureHandler(BackPressureHandler backPressureHandler)

Description copied from interface: HttpResponseFuture

Sets back pressure handler.

Specified by:

setBackPressureHandler in interface HttpResponseFuture

Parameters:

backPressureHandler - which handles backpressure

setResponseHandleListener

public void setResponseHandleListener(HttpClientConnectorListener responseHandleListener)

Description copied from interface: HttpResponseFuture

Sets response handle listener.

Specified by:

setResponseHandleListener in interface HttpResponseFuture

Parameters:

responseHandleListener - the listener that receives events related to the handle

removeResponseHandleListener

public void removeResponseHandleListener()

Description copied from interface: HttpResponseFuture

Removes the handle listener set to the future.

Specified by:

removeResponseHandleListener in interface HttpResponseFuture

notifyResponseHandle

public void notifyResponseHandle(ResponseHandle responseHandle)

Description copied from interface: HttpResponseFuture

Notifies the response handle listener when there is an event.

Specified by:

notifyResponseHandle in interface HttpResponseFuture

Parameters:

responseHandle - the entity which contains the data related to the event

notifyResponseHandle

public void notifyResponseHandle(Throwable throwable)

Description copied from interface: HttpResponseFuture

Notifies the response handle listener when there is an error.

Specified by:

notifyResponseHandle in interface HttpResponseFuture

Parameters:

throwable - the error related to the error

setPromiseAvailabilityListener

public void setPromiseAvailabilityListener(HttpClientConnectorListener promiseAvailabilityListener)

Description copied from interface: HttpResponseFuture

Sets the listener for the promise availability future.

Specified by:

setPromiseAvailabilityListener in interface HttpResponseFuture

Parameters:

promiseAvailabilityListener - the listener that receives events related to the promise availability.

removePromiseAvailabilityListener

public void removePromiseAvailabilityListener()

Description copied from interface: HttpResponseFuture

Removes the promise availability listener.

Specified by:

removePromiseAvailabilityListener in interface HttpResponseFuture

notifyPromiseAvailability

public void notifyPromiseAvailability()

Description copied from interface: HttpResponseFuture

Notifies the promise listener when there is an event.

Specified by:

notifyPromiseAvailability in interface HttpResponseFuture

setPushPromiseListener

public void setPushPromiseListener(HttpConnectorListener pushPromiseListener)

Description copied from interface: HttpResponseFuture

Sets listener for the push promise future.

Specified by:

setPushPromiseListener in interface HttpResponseFuture

Parameters:

pushPromiseListener - the listener that receives events related to the connector

removePushPromiseListener

public void removePushPromiseListener()

Description copied from interface: HttpResponseFuture

Removes the push promise listener set to the future.

Specified by:

removePushPromiseListener in interface HttpResponseFuture

notifyPushPromise

public void notifyPushPromise()

Description copied from interface: HttpResponseFuture

Notifies the push promise listener when there is an event.

Specified by:

notifyPushPromise in interface HttpResponseFuture

setPushResponseListener

public void setPushResponseListener(HttpConnectorListener pushResponseListener,
                                    int promiseId)

Description copied from interface: HttpResponseFuture

Sets the Push Response listener.

Specified by:

setPushResponseListener in interface HttpResponseFuture

Parameters:

pushResponseListener - the push response listener

promiseId - the promised stream id which the push response is suppose to arrive

removePushResponseListener

public void removePushResponseListener(int promisedId)

Description copied from interface: HttpResponseFuture

Removes the Push Response listener.

Specified by:

removePushResponseListener in interface HttpResponseFuture

Parameters:

promisedId - the promised stream id which the push response is suppose to arrive

notifyPushResponse

public void notifyPushResponse(int streamId,
                               HttpCarbonMessage pushResponse)

Description copied from interface: HttpResponseFuture

Notifies push response listener when there is a push response.

Specified by:

notifyPushResponse in interface HttpResponseFuture

Parameters:

streamId - stream id of the received push response

pushResponse - push response message

notifyPushResponse

public void notifyPushResponse(int streamId,
                               Throwable throwable)

Description copied from interface: HttpResponseFuture

Notifies the Push Response Listener when there is an error.

Specified by:

notifyPushResponse in interface HttpResponseFuture

Parameters:

streamId - stream id of the received or to be received push response

throwable - data related to the error