Package org.apache.pulsar.websocket

Class ConsumerHandler

java.lang.Object

org.eclipse.jetty.websocket.api.WebSocketAdapter

org.apache.pulsar.websocket.AbstractWebSocketHandler

org.apache.pulsar.websocket.ConsumerHandler

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, org.eclipse.jetty.websocket.api.WebSocketConnectionListener, org.eclipse.jetty.websocket.api.WebSocketListener

public class ConsumerHandler
extends AbstractWebSocketHandler

WebSocket end-point url handler to handle incoming receive and acknowledge requests.

receive: socket-proxy keeps pushing messages to client by writing into session. However, it dispatches N messages at any point and after that on acknowledgement from client it dispatches further messages.
acknowledge: it accepts acknowledgement for a given message from client and send it to broker. and for next action it notifies receive to dispatch further messages to client.

Field Summary

Fields inherited from class org.apache.pulsar.websocket.AbstractWebSocketHandler

queryParams, request, service, topic

Constructor Summary

Constructors

Constructor	Description
ConsumerHandler(WebSocketService service, javax.servlet.http.HttpServletRequest request, org.eclipse.jetty.websocket.servlet.ServletUpgradeResponse response)

Method Summary

Modifier and Type	Method	Description
void	close()
static java.lang.String	extractSubscription(javax.servlet.http.HttpServletRequest request)
long	getAndResetNumBytesDelivered()
long	getAndResetNumMsgsAcked()
long	getAndResetNumMsgsDelivered()
org.apache.pulsar.client.api.Consumer<byte[]>	getConsumer()
protected org.apache.pulsar.client.api.ConsumerBuilder<byte[]>	getConsumerConfiguration(org.apache.pulsar.client.api.PulsarClient client)
long	getMsgDeliveredCounter()
java.lang.String	getSubscription()
org.apache.pulsar.client.api.SubscriptionMode	getSubscriptionMode()
org.apache.pulsar.client.api.SubscriptionType	getSubscriptionType()
protected java.lang.Boolean	isAuthorized(java.lang.String authRole, org.apache.pulsar.broker.authentication.AuthenticationDataSource authenticationData)
void	onWebSocketConnect(org.eclipse.jetty.websocket.api.Session session)
void	onWebSocketText(java.lang.String message)
protected void	updateDeliverMsgStat(long msgSize)

Methods inherited from class org.apache.pulsar.websocket.AbstractWebSocketHandler

checkAuth, checkAuthentication, close, close, getErrorCode, getErrorMessage, getPingFuture, onWebSocketClose, onWebSocketError

Methods inherited from class org.eclipse.jetty.websocket.api.WebSocketAdapter

getRemote, getSession, isConnected, isNotConnected, onWebSocketBinary

Methods inherited from class java.lang.Object

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

Constructor Detail

ConsumerHandler

public ConsumerHandler(WebSocketService service,
                       javax.servlet.http.HttpServletRequest request,
                       org.eclipse.jetty.websocket.servlet.ServletUpgradeResponse response)

Method Detail

onWebSocketConnect

public void onWebSocketConnect(org.eclipse.jetty.websocket.api.Session session)

Specified by:

onWebSocketConnect in interface org.eclipse.jetty.websocket.api.WebSocketConnectionListener

Overrides:

onWebSocketConnect in class AbstractWebSocketHandler

onWebSocketText

public void onWebSocketText(java.lang.String message)

Specified by:

onWebSocketText in interface org.eclipse.jetty.websocket.api.WebSocketListener

Overrides:

onWebSocketText in class org.eclipse.jetty.websocket.api.WebSocketAdapter

close

public void close()
           throws java.io.IOException

Throws:

java.io.IOException

getConsumer

public org.apache.pulsar.client.api.Consumer<byte[]> getConsumer()

getSubscription

public java.lang.String getSubscription()

getSubscriptionType

public org.apache.pulsar.client.api.SubscriptionType getSubscriptionType()

getSubscriptionMode

public org.apache.pulsar.client.api.SubscriptionMode getSubscriptionMode()

getAndResetNumMsgsDelivered

public long getAndResetNumMsgsDelivered()

getAndResetNumBytesDelivered

public long getAndResetNumBytesDelivered()

getAndResetNumMsgsAcked

public long getAndResetNumMsgsAcked()

getMsgDeliveredCounter

public long getMsgDeliveredCounter()

updateDeliverMsgStat

protected void updateDeliverMsgStat(long msgSize)

getConsumerConfiguration

protected org.apache.pulsar.client.api.ConsumerBuilder<byte[]> getConsumerConfiguration(org.apache.pulsar.client.api.PulsarClient client)

isAuthorized

protected java.lang.Boolean isAuthorized(java.lang.String authRole,
                                         org.apache.pulsar.broker.authentication.AuthenticationDataSource authenticationData)
                                  throws java.lang.Exception

Specified by:

isAuthorized in class AbstractWebSocketHandler

Throws:

java.lang.Exception

extractSubscription

public static java.lang.String extractSubscription(javax.servlet.http.HttpServletRequest request)