org.granite.gravity

Class AbstractChannel

java.lang.Object

org.granite.gravity.AbstractChannel

All Implemented Interfaces:

Channel

Direct Known Subclasses:

AbstractWebSocketChannel, AsyncChannel, ContinuationChannel, ContinuationChannel, GenericChannel, JBossWebChannel, TomcatChannel, WebLogicChannel

public abstract class AbstractChannel
extends java.lang.Object
implements Channel

Author:

Franck WOLFF

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	clientType
protected ChannelFactory<? extends Channel>	factory
protected GravityInternal	gravity
protected java.lang.String	id
protected java.util.LinkedList<AsyncPublishedMessage>	publishedQueue
protected java.util.concurrent.locks.Lock	publishedQueueLock
protected AsyncPublisher	publisher
protected java.util.LinkedList<AsyncMessage>	receivedQueue
protected java.util.concurrent.locks.Lock	receivedQueueLock
protected AsyncReceiver	receiver
protected java.lang.String	sessionId
protected java.util.concurrent.ConcurrentMap<java.lang.String,Subscription>	subscriptions
protected UdpReceiver	udpReceiver
protected java.security.Principal	userPrincipal

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractChannel(GravityInternal gravity, java.lang.String id, ChannelFactory<? extends Channel> factory, java.lang.String clientType)

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract AsyncHttpContext	acquireAsyncHttpContext()
Subscription	addSubscription(java.lang.String destination, java.lang.String subTopicId, java.lang.String subscriptionId, boolean noLocal)
protected void	createUdpReceiver(UdpReceiverFactory factory, AsyncHttpContext asyncHttpContext)
void	destroy()
void	destroy(boolean timeout)
boolean	equals(java.lang.Object obj)
java.lang.String	getClientType()
ChannelFactory<? extends Channel>	getFactory()
GravityInternal	getGravity()
java.lang.String	getId()
java.util.Collection<Subscription>	getSubscriptions()
java.security.Principal	getUserPrincipal()
protected abstract boolean	hasAsyncHttpContext()
int	hashCode()
boolean	hasPublishedMessage()
boolean	hasReceivedMessage()
boolean	isAuthenticated()
boolean	isConnected()
void	publish(AsyncPublishedMessage message)
protected boolean	queueReceiver()
void	receive(AsyncMessage message)
protected abstract void	releaseAsyncHttpContext(AsyncHttpContext context)
Subscription	removeSubscription(java.lang.String subscriptionId)
boolean	runPublish()
boolean	runReceive()
boolean	runReceived(AsyncHttpContext asyncHttpContext)
void	setUserPrincipal(java.security.Principal principal)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.granite.gravity.Channel

close

Field Detail

id

protected final java.lang.String id

sessionId

protected final java.lang.String sessionId

clientType

protected final java.lang.String clientType

gravity

protected final GravityInternal gravity

factory

protected final ChannelFactory<? extends Channel> factory

subscriptions

protected final java.util.concurrent.ConcurrentMap<java.lang.String,Subscription> subscriptions

userPrincipal

protected java.security.Principal userPrincipal

publishedQueue

protected java.util.LinkedList<AsyncPublishedMessage> publishedQueue

publishedQueueLock

protected final java.util.concurrent.locks.Lock publishedQueueLock

receivedQueue

protected java.util.LinkedList<AsyncMessage> receivedQueue

receivedQueueLock

protected final java.util.concurrent.locks.Lock receivedQueueLock

publisher

protected final AsyncPublisher publisher

receiver

protected final AsyncReceiver receiver

udpReceiver

protected UdpReceiver udpReceiver

Constructor Detail

AbstractChannel

protected AbstractChannel(GravityInternal gravity,
               java.lang.String id,
               ChannelFactory<? extends Channel> factory,
               java.lang.String clientType)

Method Detail

hasAsyncHttpContext

protected abstract boolean hasAsyncHttpContext()

acquireAsyncHttpContext

protected abstract AsyncHttpContext acquireAsyncHttpContext()

releaseAsyncHttpContext

protected abstract void releaseAsyncHttpContext(AsyncHttpContext context)

getId

public java.lang.String getId()

Specified by:

getId in interface Channel

getClientType

public java.lang.String getClientType()

Specified by:

getClientType in interface Channel

getFactory

public ChannelFactory<? extends Channel> getFactory()

Specified by:

getFactory in interface Channel

getGravity

public GravityInternal getGravity()

Specified by:

getGravity in interface Channel

addSubscription

public Subscription addSubscription(java.lang.String destination,
                           java.lang.String subTopicId,
                           java.lang.String subscriptionId,
                           boolean noLocal)

Specified by:

addSubscription in interface Channel

getSubscriptions

public java.util.Collection<Subscription> getSubscriptions()

Specified by:

getSubscriptions in interface Channel

removeSubscription

public Subscription removeSubscription(java.lang.String subscriptionId)

Specified by:

removeSubscription in interface Channel

isConnected

public boolean isConnected()

Specified by:

isConnected in interface Channel

isAuthenticated

public boolean isAuthenticated()

Specified by:

isAuthenticated in interface Channel

getUserPrincipal

public java.security.Principal getUserPrincipal()

Specified by:

getUserPrincipal in interface Channel

setUserPrincipal

public void setUserPrincipal(java.security.Principal principal)

Specified by:

setUserPrincipal in interface Channel

publish

public void publish(AsyncPublishedMessage message)
             throws MessagePublishingException

Specified by:

publish in interface Channel

Throws:

MessagePublishingException

hasPublishedMessage

public boolean hasPublishedMessage()

Specified by:

hasPublishedMessage in interface Channel

runPublish

public boolean runPublish()

Specified by:

runPublish in interface Channel

receive

public void receive(AsyncMessage message)
             throws MessageReceivingException

Specified by:

receive in interface Channel

Throws:

MessageReceivingException

hasReceivedMessage

public boolean hasReceivedMessage()

Specified by:

hasReceivedMessage in interface Channel

runReceive

public boolean runReceive()

Specified by:

runReceive in interface Channel

createUdpReceiver

protected void createUdpReceiver(UdpReceiverFactory factory,
                     AsyncHttpContext asyncHttpContext)

runReceived

public boolean runReceived(AsyncHttpContext asyncHttpContext)

Specified by:

runReceived in interface Channel

destroy

public final void destroy()

destroy

public void destroy(boolean timeout)

Specified by:

destroy in interface Channel

queueReceiver

protected boolean queueReceiver()

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object