org.sakaiproject.portal.service
Class SiteNeighbourhoodServiceImpl

java.lang.Object
  org.sakaiproject.portal.service.SiteNeighbourhoodServiceImpl

All Implemented Interfaces:

SiteNeighbourhoodService

public class SiteNeighbourhoodServiceImpl
extends Object
implements SiteNeighbourhoodService

Author:

ieb

Constructor Summary

SiteNeighbourhoodServiceImpl()

Method Summary

void	destroy()
List<org.sakaiproject.site.api.Site>	getAllSites(javax.servlet.http.HttpServletRequest req, org.sakaiproject.tool.api.Session session, boolean includeMyWorkspace) Get All Sites for the current user.
org.sakaiproject.user.api.PreferencesService	getPreferencesService()
org.sakaiproject.component.api.ServerConfigurationService	getServerConfigurationService()
List<org.sakaiproject.site.api.Site>	getSitesAtNode(javax.servlet.http.HttpServletRequest request, org.sakaiproject.tool.api.Session session, boolean includeMyWorkspace)
org.sakaiproject.site.api.SiteService	getSiteService()
org.sakaiproject.site.api.Site	getSiteVisit(String siteId) Do the getSiteVisit, but if not found and the id is a user site, try translating from user EID to ID.
org.sakaiproject.user.api.UserDirectoryService	getUserDirectoryService()
void	init()
boolean	isUseAliasPrefix()
String	lookupSiteAlias(String id, String context)
String	parseSiteAlias(String url)
void	setAliasService(org.sakaiproject.alias.api.AliasService aliasService)
void	setPreferencesService(org.sakaiproject.user.api.PreferencesService preferencesService)
void	setServerConfigurationService(org.sakaiproject.component.api.ServerConfigurationService serverConfigurationService)
void	setSiteService(org.sakaiproject.site.api.SiteService siteService)
void	setUseAliasPrefix(boolean useAliasPrefix)
void	setUserDirectoryService(org.sakaiproject.user.api.UserDirectoryService userDirectoryService)

Methods inherited from class java.lang.Object

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

Constructor Detail

SiteNeighbourhoodServiceImpl

public SiteNeighbourhoodServiceImpl()

Method Detail

init

public void init()

destroy

public void destroy()

getSitesAtNode

public List<org.sakaiproject.site.api.Site> getSitesAtNode(javax.servlet.http.HttpServletRequest request,
                                                           org.sakaiproject.tool.api.Session session,
                                                           boolean includeMyWorkspace)

Specified by:

getSitesAtNode in interface SiteNeighbourhoodService

getAllSites

public List<org.sakaiproject.site.api.Site> getAllSites(javax.servlet.http.HttpServletRequest req,
                                                        org.sakaiproject.tool.api.Session session,
                                                        boolean includeMyWorkspace)

Get All Sites for the current user. If the user is not logged in we return the list of publically viewable gateway sites.

Parameters:

includeMyWorkspace - When this is true - include the user's My Workspace as the first parameter. If false, do not include the MyWorkspace anywhere in the list. Some uses - such as the portlet styled portal or the rss styled portal simply want all of the sites with the MyWorkspace first. Other portals like the basic tabbed portal treats My Workspace separately from all of the rest of the workspaces.

See Also:

org.sakaiproject.portal.api.PortalSiteHelper#getAllSites(javax.servlet.http.HttpServletRequest, org.sakaiproject.tool.api.Session, boolean)

getSiteVisit

public org.sakaiproject.site.api.Site getSiteVisit(String siteId)
                                            throws org.sakaiproject.exception.PermissionException,
                                                   org.sakaiproject.exception.IdUnusedException

Do the getSiteVisit, but if not found and the id is a user site, try translating from user EID to ID.

Parameters:

siteId - The Site Id.

Returns:

The Site.

Throws:

org.sakaiproject.exception.PermissionException - If not allowed.

org.sakaiproject.exception.IdUnusedException - If not found.

getPreferencesService

public org.sakaiproject.user.api.PreferencesService getPreferencesService()

Returns:

the preferencesService

setPreferencesService

public void setPreferencesService(org.sakaiproject.user.api.PreferencesService preferencesService)

Parameters:

preferencesService - the preferencesService to set

getServerConfigurationService

public org.sakaiproject.component.api.ServerConfigurationService getServerConfigurationService()

Returns:

the serverConfigurationService

setServerConfigurationService

public void setServerConfigurationService(org.sakaiproject.component.api.ServerConfigurationService serverConfigurationService)

Parameters:

serverConfigurationService - the serverConfigurationService to set

getSiteService

public org.sakaiproject.site.api.SiteService getSiteService()

Returns:

the siteService

setSiteService

public void setSiteService(org.sakaiproject.site.api.SiteService siteService)

Parameters:

siteService - the siteService to set

getUserDirectoryService

public org.sakaiproject.user.api.UserDirectoryService getUserDirectoryService()

Returns:

the userDirectoryService

setUserDirectoryService

public void setUserDirectoryService(org.sakaiproject.user.api.UserDirectoryService userDirectoryService)

Parameters:

userDirectoryService - the userDirectoryService to set

lookupSiteAlias

public String lookupSiteAlias(String id,
                              String context)

Specified by:

lookupSiteAlias in interface SiteNeighbourhoodService

parseSiteAlias

public String parseSiteAlias(String url)

Specified by:

parseSiteAlias in interface SiteNeighbourhoodService

setAliasService

public void setAliasService(org.sakaiproject.alias.api.AliasService aliasService)

isUseAliasPrefix

public boolean isUseAliasPrefix()

setUseAliasPrefix

public void setUseAliasPrefix(boolean useAliasPrefix)