Class Seti
- All Implemented Interfaces:
org.eclipse.jetty.util.component.Dumpable,org.eclipse.jetty.util.component.LifeCycle
The component that Searches for Extra Terrestrial Intelligence or, in this case, just searches for a user logged onto a comet in an Oort cloud.
Seti allows an application to maintain a mapping from userId (any application
identifier such as user names or database IDs that represent users) to
server sessions using the associate(String, ServerSession) and
disassociate(String, ServerSession) methods.
A typical example of usage of associate(String, ServerSession) is
in a SecurityPolicy after a successful handshake (where authentication
information can be linked with the server session), or in CometD services
where the association is established upon receiving a message on a particular channel
processed by the service itself.
Each comet in the cluster keeps its own mapping for clients connected to it.
The sendMessage(Collection, String, Object) and
sendMessage(String, String, Object) methods may be
used to send messages to user(s) anywhere in the Oort cluster
and Seti organizes the search in order to locate the user(s).
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprotected classA Location that represent a user connected to a local comet.protected static interfaceThe representation of where a user is.static interfaceListener interface that gets notified of remote Seti presence events.protected classA Location that represent a user connected to a remote comet.Nested classes/interfaces inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle
org.eclipse.jetty.util.component.AbstractLifeCycle.AbstractLifeCycleListener, org.eclipse.jetty.util.component.AbstractLifeCycle.StopExceptionNested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Dumpable
org.eclipse.jetty.util.component.Dumpable.DumpableContainerNested classes/interfaces inherited from interface org.eclipse.jetty.util.component.LifeCycle
org.eclipse.jetty.util.component.LifeCycle.Listener -
Field Summary
FieldsFields inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle
FAILED, STARTED, STARTING, STOPPED, STOPPINGFields inherited from interface org.eclipse.jetty.util.component.Dumpable
KEY -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidaddPresenceListener(Seti.PresenceListener listener) booleanAssociates the given userId to the given session.protected booleanassociate(String userId, Seti.Location location) Set<org.cometd.bayeux.server.ServerSession>disassociate(String userId) Disassociates the given userId from all sessions.booleandisassociate(String userId, org.cometd.bayeux.server.ServerSession session) Disassociates the given userId from the given session.protected booleandisassociate(String userId, Seti.Location location) protected voiddoStart()protected voiddoStop()voiddump(Appendable out, String indent) protected StringgenerateSetiChannel(String setiId) protected StringgenerateSetiId(String oortURL) intgetAssociationCount(String userId) getId()getOort()intgetPresenceCount(String userId) booleanisAssociated(String userId) booleanprotected voidprotectSetiChannels(org.cometd.bayeux.server.BayeuxServer bayeux) protected voidreceiveBroadcast(org.cometd.bayeux.Message message) Receives messages broadcast by other Setis in the cloud.protected voidreceiveDirect(org.cometd.bayeux.Message message) Receives messages directly from other Setis in the cloud, containing messages to be delivered to sessions connected to this comet.protected voidreceiveLocalPresence(Map<String, Object> presence) protected voidreceiveMessage(Map<String, Object> message) Receives a seti message.protected voidreceivePresence(Map<String, Object> presence) Receives a presence message.protected voidreceiveRemotePresence(Map<String, Object> presence) protected voidvoidremovePresenceListener(Seti.PresenceListener listener) voidprotected voidremovePresences(String oortURL) voidsendMessage(String toUserId, String toChannel, Object data) Sends a message to the given userId in the Oort cloud.voidsendMessage(Collection<String> toUserIds, String toChannel, Object data) Sends a message to multiple userIds in the Oort cloud.toString()protected voidunprotectSetiChannels(org.cometd.bayeux.server.BayeuxServer bayeux) Methods inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle
addEventListener, getEventListeners, getState, getState, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeEventListener, setEventListeners, start, stopMethods 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
-
Field Details
-
SETI_ATTRIBUTE
-
-
Constructor Details
-
Seti
-
-
Method Details
-
getOort
-
getId
-
doStart
protected void doStart()- Overrides:
doStartin classorg.eclipse.jetty.util.component.AbstractLifeCycle
-
doStop
protected void doStop()- Overrides:
doStopin classorg.eclipse.jetty.util.component.AbstractLifeCycle
-
protectSetiChannels
protected void protectSetiChannels(org.cometd.bayeux.server.BayeuxServer bayeux) -
unprotectSetiChannels
protected void unprotectSetiChannels(org.cometd.bayeux.server.BayeuxServer bayeux) -
generateSetiId
-
generateSetiChannel
-
associate
Associates the given userId to the given session.
If it is the first association for this userId, broadcasts this information on the Oort cloud, so that other comets will know that the given userId is on this comet.
- Parameters:
userId- the user identifier to associatesession- the session to map the userId to- Returns:
- true if the session has been associated, false if it was already associated
- See Also:
-
associate
-
isAssociated
@ManagedOperation(value="Whether the given userId is associated locally", impact="INFO") public boolean isAssociated(@Name(value="userId",description="The userId to test for local association") String userId) - Parameters:
userId- the user identifier to test for association- Returns:
- whether the given userId has been associated via
associate(String, ServerSession) - See Also:
-
getAssociationCount
@ManagedOperation(value="The number of local associations for the given userId", impact="INFO") public int getAssociationCount(@Name(value="userId",description="The userId to test for local association count") String userId) - Parameters:
userId- the user identifier to test for association count- Returns:
- the number of local associations
- See Also:
-
isPresent
@ManagedOperation(value="Whether the given userId is present in the cloud", impact="INFO") public boolean isPresent(@Name(value="userId",description="The userId to test for presence in the cloud") String userId) - Parameters:
userId- the user identifier to test for presence- Returns:
- whether the given userId is present on the cloud (and therefore has been associated either locally or remotely)
- See Also:
-
getPresenceCount
@ManagedOperation(value="The number of local and remote associations for the given userId", impact="INFO") public int getPresenceCount(@Name(value="userId",description="The userId to test for presence count") String userId) - Parameters:
userId- the user identifier to test for presence count- Returns:
- the number of associations (local or remote) on the cloud
- See Also:
-
disassociate
Disassociates the given userId from the given session.
If this is the last disassociation for this userId, broadcasts this information on the Oort cloud, so that other comets will know that the given userId no longer is on this comet.
- Parameters:
userId- the user identifier to disassociatesession- the session mapped to the userId- Returns:
- true if the session has been disassociated, false if it was not associated
- See Also:
-
disassociate
Disassociates the given userId from all sessions.
If this user had sessions on this comet, broadcast this information on the Oort cloud, so that other comets will know that the given userId no longer is on this comet.
- Parameters:
userId- the user identifier to disassociate- Returns:
- set of sessions that were disassociated
- See Also:
-
disassociate
-
removeAssociationsAndPresences
protected void removeAssociationsAndPresences() -
removePresences
-
getUserIds
@ManagedAttribute(value="The set of userIds known to this Seti", readonly=true) public Set<String> getUserIds()- Returns:
- the set of
userIds known to this Seti, both local and remote
-
getAssociatedUserIds
- Returns:
- the set of
userIds associated viaassociate(String, ServerSession)
-
sendMessage
Sends a message to the given userId in the Oort cloud.
- Parameters:
toUserId- the userId to send the message totoChannel- the channel to send the message todata- the content of the message- See Also:
-
sendMessage
Sends a message to multiple userIds in the Oort cloud.
- Parameters:
toUserIds- the userIds to send the message totoChannel- the channel to send the message todata- the content of the message
-
receiveDirect
protected void receiveDirect(org.cometd.bayeux.Message message) Receives messages directly from other Setis in the cloud, containing messages to be delivered to sessions connected to this comet.
- Parameters:
message- the message to deliver to a session connected to this comet
-
receiveBroadcast
protected void receiveBroadcast(org.cometd.bayeux.Message message) Receives messages broadcast by other Setis in the cloud.
Broadcast messages may be presence messages, where another Seti advertises an association, or fallback messages. Fallback messages are messages that were sent to a particular Seti because the sender thought the target userId was there, but the receiving Seti does not know that userId anymore (for example, it just disconnected); in this case, the receiving Seti broadcasts the message to the whole cloud, in the hope that the user can be found in some other comet of the cloud.
- Parameters:
message- the message to possibly deliver to a session connected to this comet
-
receivePresence
Receives a presence message.
- Parameters:
presence- the presence message received
-
receiveLocalPresence
-
receiveRemotePresence
-
addPresenceListener
-
removePresenceListener
-
removePresenceListeners
public void removePresenceListeners() -
receiveMessage
Receives a seti message.
- Parameters:
message- the seti message received
-
dump
- Specified by:
dumpin interfaceorg.eclipse.jetty.util.component.Dumpable- Throws:
IOException
-
toString
- Overrides:
toStringin classorg.eclipse.jetty.util.component.AbstractLifeCycle
-