org.sakaiproject.hybrid.tool
Class SitesServlet

java.lang.Object
  javax.servlet.GenericServlet
      javax.servlet.http.HttpServlet
          org.sakaiproject.hybrid.tool.SitesServlet

All Implemented Interfaces:

Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

public class SitesServlet
extends javax.servlet.http.HttpServlet

Based on https://source.caret.cam.ac.uk/camtools/trunk/camtools/sdata/tool/sakai -sdata-impl/src/main/java/org/sakaiproject/sdata/services/mcp/ MyCoursesAndProjectsBean.java

No required get parameters. Runs in the context of the current user. Returns all sites that the user has access to visit.

See Also:

Serialized Form

Nested Class Summary

protected static class

SitesServlet.PortalSiteNavUserPreferences Wraps Sakai2 portal functionality around number of sites to display.

Field Summary

static String	CATEGORIZED Optional GET parameter which categorizes the JSON by site term and type.
protected org.sakaiproject.component.api.ComponentManager	componentManager
static String	LOCALE Optional GET parameter which specifies locale.
protected org.sakaiproject.hybrid.tool.MoreSiteViewImpl	moreSiteViewImpl
protected org.sakaiproject.user.api.PreferencesService	preferencesService
protected org.sakaiproject.component.api.ServerConfigurationService	serverConfigurationService
protected org.sakaiproject.tool.api.SessionManager	sessionManager
protected org.sakaiproject.site.api.SiteService	siteService
protected org.sakaiproject.api.app.messageforums.SynopticMsgcntrManager	synopticMsgcntrManager
static String	UNREAD Optional GET parameter which will include Messages and Forums unread counts.

Constructor Summary

SitesServlet()

Method Summary

protected void	doGet(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
void	init(javax.servlet.ServletConfig config)
protected void	setupTestCase(org.sakaiproject.component.api.ComponentManager componentManager) Only used for unit testing setup.

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doHead, doOptions, doPost, doPut, doTrace, getLastModified, service, service

Methods inherited from class javax.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

Methods inherited from class java.lang.Object

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

Field Detail

CATEGORIZED

public static final String CATEGORIZED

Optional GET parameter which categorizes the JSON by site term and type.

See Also:

Constant Field Values

UNREAD

public static final String UNREAD

Optional GET parameter which will include Messages and Forums unread counts.

See Also:

Constant Field Values

LOCALE

public static final String LOCALE

Optional GET parameter which specifies locale. For example: en_US.

See Also:

Locale, Constant Field Values

sessionManager

protected transient org.sakaiproject.tool.api.SessionManager sessionManager

siteService

protected transient org.sakaiproject.site.api.SiteService siteService

serverConfigurationService

protected transient org.sakaiproject.component.api.ServerConfigurationService serverConfigurationService

componentManager

protected transient org.sakaiproject.component.api.ComponentManager componentManager

synopticMsgcntrManager

protected transient org.sakaiproject.api.app.messageforums.SynopticMsgcntrManager synopticMsgcntrManager

preferencesService

protected transient org.sakaiproject.user.api.PreferencesService preferencesService

moreSiteViewImpl

protected transient org.sakaiproject.hybrid.tool.MoreSiteViewImpl moreSiteViewImpl

Constructor Detail

SitesServlet

public SitesServlet()

Method Detail

doGet

protected void doGet(javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response)
              throws javax.servlet.ServletException,
                     IOException

Overrides:

doGet in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

IOException

init

public void init(javax.servlet.ServletConfig config)
          throws javax.servlet.ServletException

Specified by:

init in interface javax.servlet.Servlet

Overrides:

init in class javax.servlet.GenericServlet

Throws:

javax.servlet.ServletException

setupTestCase

protected void setupTestCase(org.sakaiproject.component.api.ComponentManager componentManager)

Only used for unit testing setup.

Parameters:

componentManager -