/**
* Licensed to Apereo under one or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information regarding copyright ownership. Apereo
* licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use
* this file except in compliance with the License. You may obtain a copy of the License at the
* following location:
*
* <p>http://www.apache.org/licenses/LICENSE-2.0
*
* <p>Unless required by applicable law or agreed to in writing, software distributed under the
* License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apereo.portal.rest;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.apereo.portal.layout.dlm.remoting.IGroupListHelper;
import org.apereo.portal.layout.dlm.remoting.JsonEntityBean;
import org.apereo.portal.portlets.groupselector.EntityEnum;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.security.access.prepost.PreAuthorize;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.servlet.ModelAndView;
/**
* PrincipalsRESTController provides a REST endpoint for searching uPortal principals.
*
*/
@Controller
public class PrincipalsRESTController {
private IGroupListHelper listHelper;
@Autowired(required = true)
public void setGroupListHelper(IGroupListHelper groupListHelper) {
this.listHelper = groupListHelper;
}
/**
* Return a JSON view of the uPortal principals matching the supplied query string.
*
* @param query
* @param request
* @param response
* @return
* @throws Exception
*/
@PreAuthorize(
"hasPermission('string', 'REST', new org.apereo.portal.spring.security.evaluator.AuthorizableActivity('UP_PERMISSIONS', 'VIEW_PERMISSIONS'))")
@RequestMapping(value = "/permissions/principals.json", method = RequestMethod.GET)
public ModelAndView getPrincipals(
@RequestParam(value = "q") String query,
HttpServletRequest request,
HttpServletResponse response)
throws Exception {
/*
* Add groups and people matching the search query to the JSON model
*/
ModelAndView mv = new ModelAndView();
List<JsonEntityBean> groups = new ArrayList<JsonEntityBean>();
groups.addAll(listHelper.search(EntityEnum.GROUP.toString(), query));
Collections.sort(groups);
mv.addObject("groups", groups);
List<JsonEntityBean> people = new ArrayList<JsonEntityBean>();
people.addAll(listHelper.search(EntityEnum.PERSON.toString(), query));
Collections.sort(people);
mv.addObject("people", people);
mv.setViewName("json");
return mv;
}
}