org.codice.ddf.ui.searchui.query.controller

Class AbstractEventController

java.lang.Object

org.codice.ddf.ui.searchui.query.controller.AbstractEventController

All Implemented Interfaces:

org.osgi.service.event.EventHandler

Direct Known Subclasses:

ActivityController, NotificationController

@Service
public abstract class AbstractEventController
extends Object
implements org.osgi.service.event.EventHandler

The AbstractEventController handles the processing and routing of events.

Field Summary

Fields

Modifier and Type	Field and Description
static String	EVENT_TOPIC_CANCEL

Constructor Summary

Constructors

Constructor and Description
AbstractEventController(PersistentStore persistentStore, org.osgi.framework.BundleContext bundleContext, org.osgi.service.event.EventAdmin eventAdmin) Establishes AbstractEventController as a listener to events published by the OSGi eventing framework on the event's root topic

Method Summary

Modifier and Type	Method and Description
void	adminCancelDownload(String userId, String downloadIdentifier) Called by ddf.catalog.event.retrievestatus.DownloadStatusInfoImpl.cancelDownload to fire a cancel event.
void	deregisterUserSession(org.cometd.bayeux.server.ServerSession serverSession, org.cometd.bayeux.server.ServerMessage serverMessage) Listens to the /meta/disconnect Channel for clients disconnecting and deregisters the user.
abstract String	getControllerRootTopic() Obtains the root topic of the controller that should be used when registering the eventhandler.
org.cometd.bayeux.server.ServerSession	getSessionById(String userId, String sessionId) Obtains the ServerSession associated with a given userId or sessionId.
org.cometd.bayeux.server.ServerSession	getSessionBySessionId(String sessionId) Obtains the ServerSession associated with a given sessionId.
org.cometd.bayeux.server.ServerSession	getSessionByUserId(String userId) Obtains the ServerSession associated with a given user id.
protected String	getUserId(org.cometd.bayeux.server.ServerSession serverSession, org.apache.shiro.subject.Subject subject)
protected void	queuePersistedMessages(org.cometd.bayeux.server.ServerSession serverSession, List<Map<String,Object>> messages, String topic)
void	registerUserSession(org.cometd.bayeux.server.ServerSession serverSession, org.cometd.bayeux.server.ServerMessage serverMessage) Enables private message delivery to a given user.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.osgi.service.event.EventHandler

handleEvent

Field Detail

EVENT_TOPIC_CANCEL

public static final String EVENT_TOPIC_CANCEL

See Also:

Constant Field Values

Constructor Detail

AbstractEventController

public AbstractEventController(PersistentStore persistentStore,
                               org.osgi.framework.BundleContext bundleContext,
                               org.osgi.service.event.EventAdmin eventAdmin)

Establishes AbstractEventController as a listener to events published by the OSGi eventing framework on the event's root topic

Parameters:

bundleContext -

Method Detail

getSessionByUserId

public org.cometd.bayeux.server.ServerSession getSessionByUserId(String userId)

Obtains the ServerSession associated with a given user id.

Parameters:

userId - The id of the user associated with the ServerSession to be retrieved.

Returns:

The ServerSession associated with the received userId or null if the user does not have an established ServerSession

getSessionBySessionId

public org.cometd.bayeux.server.ServerSession getSessionBySessionId(String sessionId)

Obtains the ServerSession associated with a given sessionId. Retrieval using getSessionByUserId(String) is the preferred method. This method is used when a userId is not available.

Parameters:

sessionId - The sessionId associated with the ServerSession to be retrieved.

Returns:

The ServerSession associated with the received sessionId or null if the session does not have an established ServerSession

getSessionById

public org.cometd.bayeux.server.ServerSession getSessionById(String userId,
                                                             String sessionId)

Obtains the ServerSession associated with a given userId or sessionId. It

Parameters:

sessionId - The sessionId associated with the ServerSession to be retrieved.

Returns:

The ServerSession associated with the received sessionId or null if the session does not have an established ServerSession

deregisterUserSession

@Listener(value="/meta/disconnect")
public void deregisterUserSession(org.cometd.bayeux.server.ServerSession serverSession,
                                                                      org.cometd.bayeux.server.ServerMessage serverMessage)

Listens to the /meta/disconnect Channel for clients disconnecting and deregisters the user. This should be invoked in order to remove AbstractEventController references to invalid ServerSessions.

Parameters:

serverSession - The ServerSession object associated with the client that is disconnecting

serverMessage - The ServerMessage that was sent from the client on the /meta/disconnect Channel

adminCancelDownload

public void adminCancelDownload(String userId,
                                String downloadIdentifier)

Called by ddf.catalog.event.retrievestatus.DownloadStatusInfoImpl.cancelDownload to fire a cancel event.

Parameters:

userId - The Id assigned to the user who is downloading.

downloadIdentifier - The randomly generated downloadId string assigned to the download at its start.

registerUserSession

public void registerUserSession(org.cometd.bayeux.server.ServerSession serverSession,
                                org.cometd.bayeux.server.ServerMessage serverMessage)
                         throws IllegalArgumentException

Enables private message delivery to a given user. As of CometD version 2.8.0, this must be called from the canHandshake method of a SecurityPolicy. See Obtaining user and session information for private message delivery for more information.

Parameters:

serverSession - The ServerSession on which to deliver messages to the user for the user.

serverMessage - The ServerMessage containing the userId property with which to associate the ServerSession.

Throws:

IllegalArgumentException - when the received ServerSession or the ServerSession's id is null.

queuePersistedMessages

protected void queuePersistedMessages(org.cometd.bayeux.server.ServerSession serverSession,
                                      List<Map<String,Object>> messages,
                                      String topic)

getUserId

protected String getUserId(org.cometd.bayeux.server.ServerSession serverSession,
                           org.apache.shiro.subject.Subject subject)

getControllerRootTopic

public abstract String getControllerRootTopic()

Obtains the root topic of the controller that should be used when registering the eventhandler.

Returns:

String representation of a root topic.