Dekoh platform API

dekoh.portal.syndication.aggregator
Class PortalAppsAggregatorInitializer

java.lang.Object
  extended by dekoh.portal.syndication.aggregator.managed.AggregatorInitializer
      extended by dekoh.portal.syndication.aggregator.PortalAppsAggregatorInitializer
All Implemented Interfaces:
DekohUserListener, EventListener, ServletContextListener

public class PortalAppsAggregatorInitializer
extends AggregatorInitializer

PortalAppsAggregatorInitializer should be extended by applications who desire to display some feeds in portal Aggregators like tray icon and desktop portal home page.

Subsclasses will override PortalAppsAggregatorInitializer.getSubscriptionItemsToShowInTrayIcon(com.pramati.bfly.das.api.DesktopUser) and PortalAppsAggregatorInitializer.getSubscriptionItemToShowInPortalPage(com.pramati.bfly.das.api.DesktopUser) . These Subscription items will be removed from portal aggregators when user logs out or the application is stopped

Since:
Nov 1, 2007

Field Summary
 
Fields inherited from class dekoh.portal.syndication.aggregator.managed.AggregatorInitializer
myAppContext
 
Constructor Summary
PortalAppsAggregatorInitializer()
           
 
Method Summary
protected  void addFeedsForDisplay(DesktopUser desktopUser)
          This method will be utilised to add feeds at various displays like , tray icon, protal home page etc
 Collection getAggregatorToShowInPortalPage(DesktopUser desktopUser)
          Apart from SubscriptionItesm applications can also add their aggregtors to portal's aggregator.
 Collection getAggregatorToShowInTrayIcon(DesktopUser desktopUser)
          Apart from SubscriptionItesm applications can also add their aggregtors to portal's tray aggregator.
 Collection getChannelProvidersToShowInPortalPage(DesktopUser desktopUser)
          Applications can also add their local ChannelProvider to portal's aggregator.
 Collection getChannelProvidersToShowInTrayIcon(DesktopUser desktopUser)
          Applications can also add their local ChannelProvider to portal's tray aggregator.
 Collection getSubscriptionItemsToShowInTrayIcon(DesktopUser desktopUser)
          Applications will override this method to supply SubscriptionItems which they wish to show in portal's tray icon.
 Collection getSubscriptionItemToShowInPortalPage(DesktopUser desktopUser)
          Applications will override this method to supply SubscriptionItems which they wish to show in portal's home page.
protected  void removeFeedsFromDisplay(DesktopUser desktopUser)
          Feeds added for display at various locations in AggregatorInitializer.addFeedsForDisplay(com.pramati.bfly.das.api.DesktopUser) } should be removed here
 
Methods inherited from class dekoh.portal.syndication.aggregator.managed.AggregatorInitializer
contextDestroyed, contextInitialized, createAggregator, createAndStartAggregators, deregisterChannelProviders, destroyActiveAggregators, getAggregatorConfigutations, getChannelProvidersToPublish, registerChannelProviders, startAggregator, userGoesOffline, userGoesOnline, userLogsIn, userLogsOut
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PortalAppsAggregatorInitializer

public PortalAppsAggregatorInitializer()
Method Detail

getSubscriptionItemsToShowInTrayIcon

public Collection getSubscriptionItemsToShowInTrayIcon(DesktopUser desktopUser)
Applications will override this method to supply SubscriptionItems which they wish to show in portal's tray icon.

Portal will call this method during login to add these items to tray and during logout to remove these items from tray.

This method at any point of time should give all the items that application has ever added to tray icon

Parameters:
desktopUser - loggedin DesktopUser
Returns:
Collection

getSubscriptionItemToShowInPortalPage

public Collection getSubscriptionItemToShowInPortalPage(DesktopUser desktopUser)
Applications will override this method to supply SubscriptionItems which they wish to show in portal's home page.

Portal will call this method during login to add these items to portal home and during logout to remove these items from portal.

This method at any point of time should give all the items that application has ever added to portal home

Parameters:
desktopUser - loggedin DesktopUser
Returns:
Collection

getAggregatorToShowInPortalPage

public Collection getAggregatorToShowInPortalPage(DesktopUser desktopUser)
Apart from SubscriptionItesm applications can also add their aggregtors to portal's aggregator. Portal will call this method during login to add these aggregators to portal home and during logout to remove these aggregators from portal.

This method at any point of time should give all aggregators that application has ever added to portal home

Parameters:
desktopUser - loggedin DesktopUser
Returns:
Collection Aggregators that application wish to be shown in portal home page

getAggregatorToShowInTrayIcon

public Collection getAggregatorToShowInTrayIcon(DesktopUser desktopUser)
Apart from SubscriptionItesm applications can also add their aggregtors to portal's tray aggregator. Portal will call this method during login to add these aggregators to portal home and during logout to remove these aggregators from portal.

This method at any point of time should give all aggregators that application has ever added to portal tray

Parameters:
desktopUser - loggedin DesktopUser
Returns:
Collection Aggregators that application wish to be shown in portal tray

getChannelProvidersToShowInTrayIcon

public Collection getChannelProvidersToShowInTrayIcon(DesktopUser desktopUser)
Applications can also add their local ChannelProvider to portal's tray aggregator. Portal will call this method during login to add these ChannelProviders to portal tray aggregator and during logout to remove them.

This method at any point of time should give all ChannelProviders that application has ever added to portal tray

Parameters:
desktopUser - loggedin DesktopUser
Returns:
Collection ChannelProviders that application wish to be shown in portal tray

getChannelProvidersToShowInPortalPage

public Collection getChannelProvidersToShowInPortalPage(DesktopUser desktopUser)
Applications can also add their local ChannelProvider to portal's aggregator. Portal will call this method during login to add these ChannelProviders to portal home and during logout to remove them from portal.

This method at any point of time should give all ChannelProviders that application has ever added to portal home page

Parameters:
desktopUser - loggedin DesktopUser
Returns:
Collection ChannelProviders that application wish to be shown in portal homem page

addFeedsForDisplay

protected void addFeedsForDisplay(DesktopUser desktopUser)
Description copied from class: AggregatorInitializer
This method will be utilised to add feeds at various displays like , tray icon, protal home page etc

Overrides:
addFeedsForDisplay in class AggregatorInitializer
Parameters:
desktopUser - loggedin desktopuser

removeFeedsFromDisplay

protected void removeFeedsFromDisplay(DesktopUser desktopUser)
Description copied from class: AggregatorInitializer
Feeds added for display at various locations in AggregatorInitializer.addFeedsForDisplay(com.pramati.bfly.das.api.DesktopUser) } should be removed here

Overrides:
removeFeedsFromDisplay in class AggregatorInitializer
Parameters:
desktopUser - loggedOut desktopuser

Dekoh platform API

© 2009 Pramati Technologies - Dekoh - Portal for Developers