Package org.cometd.server
Class ServerSessionImpl
java.lang.Object
org.cometd.server.ServerSessionImpl
- All Implemented Interfaces:
ServerSession,org.cometd.bayeux.Session,org.eclipse.jetty.util.component.Dumpable
public class ServerSessionImpl extends java.lang.Object implements ServerSession, org.eclipse.jetty.util.component.Dumpable
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Dumpable
org.eclipse.jetty.util.component.Dumpable.DumpableContainerNested classes/interfaces inherited from interface org.cometd.bayeux.server.ServerSession
ServerSession.AddedListener, ServerSession.DeQueueListener, ServerSession.Extension, ServerSession.HeartBeatListener, ServerSession.MessageListener, ServerSession.QueueListener, ServerSession.QueueMaxedListener, ServerSession.RemovedListener, ServerSession.ServerSessionListener -
Field Summary
Fields inherited from interface org.eclipse.jetty.util.component.Dumpable
KEY -
Constructor Summary
Constructors Constructor Description ServerSessionImpl(BayeuxServerImpl bayeux)ServerSessionImpl(BayeuxServerImpl bayeux, LocalSessionImpl localSession, java.lang.String idHint) -
Method Summary
Modifier and Type Method Description voidaddExtension(ServerSession.Extension extension)voidaddListener(ServerSession.ServerSessionListener listener)protected voidaddMessage(ServerMessage message)voidbatch(java.lang.Runnable batch)longcalculateInterval(long defaultInterval)longcalculateTimeout(long defaultTimeout)voidcancelExpiration(boolean metaConnect)protected booleanconnected()voiddeliver(org.cometd.bayeux.Session sender, java.lang.String channelId, java.lang.Object data, org.cometd.bayeux.Promise<java.lang.Boolean> promise)voiddeliver(org.cometd.bayeux.Session sender, ServerMessage.Mutable message, org.cometd.bayeux.Promise<java.lang.Boolean> promise)protected voiddeliver1(ServerSession sender, ServerMessage.Mutable mutable, org.cometd.bayeux.Promise<java.lang.Boolean> promise)voiddestroyScheduler()voiddisconnect()voiddump(java.lang.Appendable out, java.lang.String indent)booleanendBatch()protected voidextendIncoming(ServerMessage.Mutable message, org.cometd.bayeux.Promise<java.lang.Boolean> promise)protected voidextendOutgoing(ServerSession sender, ServerMessage.Mutable message, org.cometd.bayeux.Promise<ServerMessage.Mutable> promise)voidflush()java.lang.ObjectgetAttribute(java.lang.String name)java.util.Set<java.lang.String>getAttributeNames()BayeuxServerImplgetBayeuxServer()java.lang.StringgetBrowserId()java.util.List<ServerSession.Extension>getExtensions()java.lang.StringgetId()longgetInterval()java.util.List<ServerSession.ServerSessionListener>getListeners()LocalSessiongetLocalSession()java.util.concurrent.locks.LockgetLock()longgetMaxInterval()java.util.Queue<ServerMessage>getQueue()ServerTransportgetServerTransport()java.util.Set<ServerChannel>getSubscriptions()longgetTimeout()java.lang.StringgetUserAgent()protected booleanhandshake(ServerMessage.Mutable message)booleanhasNonLazyMessages()booleanisAllowMessageDeliveryDuringHandshake()booleanisBroadcastToPublisher()booleanisConnected()booleanisDisconnected()booleanisHandshook()booleanisLocalSession()booleanisMetaConnectDeliveryOnly()booleanisTerminated()voidnotifyResumed(ServerMessage message, boolean timeout)voidnotifySuspended(ServerMessage message, long timeout)voidreAdvise()java.lang.ObjectremoveAttribute(java.lang.String name)protected booleanremoved(ServerMessage message, boolean timeout)voidremoveExtension(ServerSession.Extension extension)voidremoveListener(ServerSession.ServerSessionListener listener)voidscheduleExpiration(long defaultInterval, long defaultMaxInterval, long metaConnectCycle)voidsetAllowMessageDeliveryDuringHandshake(boolean allow)voidsetAttribute(java.lang.String name, java.lang.Object value)voidsetBroadcastToPublisher(boolean value)voidsetBrowserId(java.lang.String browserId)Sets a remote client identifier, typically a browser.voidsetInterval(long intervalMS)voidsetMaxInterval(long maxInterval)voidsetMetaConnectDeliveryOnly(boolean meta)voidsetScheduler(AbstractServerTransport.Scheduler newScheduler)voidsetServerTransport(ServerTransport transport)voidsetTimeout(long timeoutMS)voidsetUserAgent(java.lang.String userAgent)booleanshouldSchedule()voidstartBatch()protected booleansubscribe(ServerChannelImpl channel)protected voidsweep(long now)java.util.Map<java.lang.String,java.lang.Object>takeAdvice(ServerTransport transport)java.util.List<ServerMessage>takeQueue(java.util.List<ServerMessage.Mutable> replies)java.lang.StringtoString()protected voidunsubscribedFrom(ServerChannelImpl channel)voidupdateTransientInterval(long interval)Updates the transient interval with the given value.voidupdateTransientTimeout(long timeout)Updates the transient timeout with the given value.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface org.eclipse.jetty.util.component.Dumpable
dump, dumpSelf
-
Constructor Details
-
ServerSessionImpl
-
ServerSessionImpl
public ServerSessionImpl(BayeuxServerImpl bayeux, LocalSessionImpl localSession, java.lang.String idHint)
-
-
Method Details
-
getBayeuxServer
-
getUserAgent
public java.lang.String getUserAgent()- Specified by:
getUserAgentin interfaceServerSession- Returns:
- the remote user agent
-
setUserAgent
public void setUserAgent(java.lang.String userAgent)- Parameters:
userAgent- the remote user agent
-
getBrowserId
public java.lang.String getBrowserId()- Returns:
- the remote client identifier
-
setBrowserId
public void setBrowserId(java.lang.String browserId)Sets a remote client identifier, typically a browser.
- Parameters:
browserId- the remote client identifier
-
sweep
protected void sweep(long now) -
getSubscriptions
- Specified by:
getSubscriptionsin interfaceServerSession
-
addExtension
- Specified by:
addExtensionin interfaceServerSession
-
removeExtension
- Specified by:
removeExtensionin interfaceServerSession
-
getExtensions
- Specified by:
getExtensionsin interfaceServerSession
-
batch
public void batch(java.lang.Runnable batch)- Specified by:
batchin interfaceorg.cometd.bayeux.Session
-
deliver
public void deliver(org.cometd.bayeux.Session sender, ServerMessage.Mutable message, org.cometd.bayeux.Promise<java.lang.Boolean> promise)- Specified by:
deliverin interfaceServerSession
-
deliver
public void deliver(org.cometd.bayeux.Session sender, java.lang.String channelId, java.lang.Object data, org.cometd.bayeux.Promise<java.lang.Boolean> promise)- Specified by:
deliverin interfaceServerSession
-
deliver1
protected void deliver1(ServerSession sender, ServerMessage.Mutable mutable, org.cometd.bayeux.Promise<java.lang.Boolean> promise) -
extendOutgoing
protected void extendOutgoing(ServerSession sender, ServerMessage.Mutable message, org.cometd.bayeux.Promise<ServerMessage.Mutable> promise) -
handshake
-
connected
protected boolean connected() -
disconnect
public void disconnect()- Specified by:
disconnectin interfaceorg.cometd.bayeux.Session
-
startBatch
public void startBatch()- Specified by:
startBatchin interfaceorg.cometd.bayeux.Session
-
endBatch
public boolean endBatch()- Specified by:
endBatchin interfaceorg.cometd.bayeux.Session
-
getLocalSession
- Specified by:
getLocalSessionin interfaceServerSession
-
isLocalSession
public boolean isLocalSession()- Specified by:
isLocalSessionin interfaceServerSession
-
addListener
- Specified by:
addListenerin interfaceServerSession
-
getId
public java.lang.String getId()- Specified by:
getIdin interfaceorg.cometd.bayeux.Session
-
getLock
public java.util.concurrent.locks.Lock getLock() -
getQueue
-
hasNonLazyMessages
public boolean hasNonLazyMessages() -
addMessage
-
takeQueue
-
notifySuspended
-
notifyResumed
-
removeListener
- Specified by:
removeListenerin interfaceServerSession
-
getListeners
-
setScheduler
-
shouldSchedule
public boolean shouldSchedule() -
flush
public void flush() -
destroyScheduler
public void destroyScheduler() -
cancelExpiration
public void cancelExpiration(boolean metaConnect) -
scheduleExpiration
public void scheduleExpiration(long defaultInterval, long defaultMaxInterval, long metaConnectCycle) -
getMaxInterval
public long getMaxInterval()- Specified by:
getMaxIntervalin interfaceServerSession
-
setMaxInterval
public void setMaxInterval(long maxInterval)- Specified by:
setMaxIntervalin interfaceServerSession
-
getAttribute
public java.lang.Object getAttribute(java.lang.String name)- Specified by:
getAttributein interfaceorg.cometd.bayeux.Session
-
getAttributeNames
public java.util.Set<java.lang.String> getAttributeNames()- Specified by:
getAttributeNamesin interfaceorg.cometd.bayeux.Session
-
removeAttribute
public java.lang.Object removeAttribute(java.lang.String name)- Specified by:
removeAttributein interfaceorg.cometd.bayeux.Session
-
setAttribute
public void setAttribute(java.lang.String name, java.lang.Object value)- Specified by:
setAttributein interfaceorg.cometd.bayeux.Session
-
isHandshook
public boolean isHandshook()- Specified by:
isHandshookin interfaceorg.cometd.bayeux.Session
-
isConnected
public boolean isConnected()- Specified by:
isConnectedin interfaceorg.cometd.bayeux.Session
-
isDisconnected
public boolean isDisconnected() -
isTerminated
public boolean isTerminated() -
extendIncoming
protected void extendIncoming(ServerMessage.Mutable message, org.cometd.bayeux.Promise<java.lang.Boolean> promise) -
reAdvise
public void reAdvise() -
takeAdvice
-
getServerTransport
- Specified by:
getServerTransportin interfaceServerSession
-
setServerTransport
-
getTimeout
public long getTimeout()- Specified by:
getTimeoutin interfaceServerSession
-
getInterval
public long getInterval()- Specified by:
getIntervalin interfaceServerSession
-
setTimeout
public void setTimeout(long timeoutMS)- Specified by:
setTimeoutin interfaceServerSession
-
setInterval
public void setInterval(long intervalMS)- Specified by:
setIntervalin interfaceServerSession
-
isBroadcastToPublisher
public boolean isBroadcastToPublisher()- Specified by:
isBroadcastToPublisherin interfaceServerSession
-
setBroadcastToPublisher
public void setBroadcastToPublisher(boolean value)- Specified by:
setBroadcastToPublisherin interfaceServerSession
-
removed
- Parameters:
message- the message that caused the removal, or nulltimeout- whether the session has been removed due a timeout- Returns:
- True if the session was connected.
-
setMetaConnectDeliveryOnly
public void setMetaConnectDeliveryOnly(boolean meta)- Specified by:
setMetaConnectDeliveryOnlyin interfaceServerSession
-
isMetaConnectDeliveryOnly
public boolean isMetaConnectDeliveryOnly()- Specified by:
isMetaConnectDeliveryOnlyin interfaceServerSession
-
isAllowMessageDeliveryDuringHandshake
public boolean isAllowMessageDeliveryDuringHandshake() -
setAllowMessageDeliveryDuringHandshake
public void setAllowMessageDeliveryDuringHandshake(boolean allow) -
subscribe
-
unsubscribedFrom
-
calculateTimeout
public long calculateTimeout(long defaultTimeout) -
calculateInterval
public long calculateInterval(long defaultInterval) -
updateTransientTimeout
public void updateTransientTimeout(long timeout)Updates the transient timeout with the given value. The transient timeout is the one sent by the client, that should temporarily override the session/transport timeout, for example when the client sends {timeout:0}- Parameters:
timeout- the value to update the timeout to- See Also:
updateTransientInterval(long)
-
updateTransientInterval
public void updateTransientInterval(long interval)Updates the transient interval with the given value. The transient interval is the one sent by the client, that should temporarily override the session/transport interval, for example when the client sends {timeout:0,interval:60000}- Parameters:
interval- the value to update the interval to- See Also:
updateTransientTimeout(long)
-
dump
public void dump(java.lang.Appendable out, java.lang.String indent) throws java.io.IOException- Specified by:
dumpin interfaceorg.eclipse.jetty.util.component.Dumpable- Throws:
java.io.IOException
-
toString
public java.lang.String toString()- Overrides:
toStringin classjava.lang.Object
-