org.jasig.portal.layout.dlm.remoting
Class SearchEntitiesController

java.lang.Object
  org.springframework.context.support.ApplicationObjectSupport
      org.springframework.web.context.support.WebApplicationObjectSupport
          org.springframework.web.servlet.support.WebContentGenerator
              org.springframework.web.servlet.mvc.AbstractController
                  org.jasig.portal.layout.dlm.remoting.SearchEntitiesController

All Implemented Interfaces:

ApplicationContextAware, ServletContextAware, Controller

public class SearchEntitiesController
extends AbstractController

A Spring controller that returns a JSON view of the desired user, group, or category. Request parameters:

• entityType (required): a string representing the desired entity to look for (category, group, or person). The user may supply multiple entityTypes and all will be queried.
• entityId (optional): the key or id of the single entity to be retrieved
• searchTerm (optional): a string representing a search term to use to retrieve a list of entities. Note that if the entityType is "category", search is not supported.

If neither an entityId nor a searchTerm is provided, the search will return the root category or group ("All Categories" or "Everyone", respectively).

Author:

Drew Mazurek

Field Summary

Fields inherited from class org.springframework.web.servlet.support.WebContentGenerator

METHOD_GET, METHOD_HEAD, METHOD_POST

Fields inherited from class org.springframework.context.support.ApplicationObjectSupport

logger

Constructor Summary

SearchEntitiesController()

Method Summary

ModelAndView	handleRequestInternal(HttpServletRequest request, HttpServletResponse response)
void	setGroupListHelper(IGroupListHelper groupListHelper) For injection of the group list helper.
void	setPersonManager(IPersonManager personManager) For injection of the person manager.

Methods inherited from class org.springframework.web.servlet.mvc.AbstractController

handleRequest, isSynchronizeOnSession, setSynchronizeOnSession

Methods inherited from class org.springframework.web.servlet.support.WebContentGenerator

applyCacheSeconds, applyCacheSeconds, cacheForSeconds, cacheForSeconds, checkAndPrepare, checkAndPrepare, getCacheSeconds, getSupportedMethods, isRequireSession, isUseCacheControlHeader, isUseCacheControlNoStore, isUseExpiresHeader, preventCaching, setCacheSeconds, setRequireSession, setSupportedMethods, setUseCacheControlHeader, setUseCacheControlNoStore, setUseExpiresHeader

Methods inherited from class org.springframework.web.context.support.WebApplicationObjectSupport

getServletContext, getTempDir, getWebApplicationContext, initApplicationContext, initServletContext, isContextRequired, setServletContext

Methods inherited from class org.springframework.context.support.ApplicationObjectSupport

getApplicationContext, getMessageSourceAccessor, initApplicationContext, requiredContextClass, setApplicationContext

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchEntitiesController

public SearchEntitiesController()

Method Detail

handleRequestInternal

public ModelAndView handleRequestInternal(HttpServletRequest request,
                                          HttpServletResponse response)
                                   throws Exception

Specified by:

handleRequestInternal in class AbstractController

Throws:

Exception

setGroupListHelper

public void setGroupListHelper(IGroupListHelper groupListHelper)

For injection of the group list helper.

Parameters:

groupListHelper - IGroupListHelper instance

setPersonManager

public void setPersonManager(IPersonManager personManager)

For injection of the person manager. Used for authorization.

Parameters:

personManager - IPersonManager instance