LocalUserSearchRestService.java

/*
 * Copyright (c) 2002-2020, City of Paris
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *  1. Redistributions of source code must retain the above copyright notice
 *     and the following disclaimer.
 *
 *  2. Redistributions in binary form must reproduce the above copyright notice
 *     and the following disclaimer in the documentation and/or other materials
 *     provided with the distribution.
 *
 *  3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
 *     contributors may be used to endorse or promote products derived from
 *     this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * License 1.0
 */
package fr.paris.lutece.plugins.mylutece.modules.users.rs;

import fr.paris.lutece.plugins.mylutece.modules.users.service.search.LocalUserSearchEngine;
import fr.paris.lutece.plugins.mylutece.modules.users.web.LocalUserJspBean;
import fr.paris.lutece.plugins.rest.service.RestConstants;
import fr.paris.lutece.portal.business.user.AdminUser;
import fr.paris.lutece.portal.service.admin.AdminUserService;
import fr.paris.lutece.util.json.ErrorJsonResponse;
import fr.paris.lutece.util.json.JsonResponse;
import fr.paris.lutece.util.json.JsonUtil;
import org.apache.commons.lang.StringUtils;
import org.apache.log4j.Logger;
import java.util.List;
import java.util.Map;

import javax.ws.rs.GET;
import javax.servlet.http.HttpServletRequest;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;
import javax.ws.rs.core.Context;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;

/**
 * SearchResultRest
 */
@Path( RestConstants.BASE_PATH + Constants.API_PATH )
public class LocalUserSearchRestService
{
    private final Logger _logger = Logger.getLogger( RestConstants.REST_LOGGER );
    private static final String BEAN_SEARCH_ENGINE = "mylutece-users.localUserSearchEngine";
    private static final String PARAMETER_KEYWORDS = "keywords";

    /**
     * Get SearchResult List
     * 
     * @param nVersion
     *            the API version
     * @return the SearchResult List
     */
    @GET
    @Path( StringUtils.EMPTY )
    @Produces( MediaType.APPLICATION_JSON )
    public Response getSearchResultList( @PathParam( Constants.VERSION ) Integer nVersion, @Context HttpServletRequest request )
    {
        AdminUser adminUser = AdminUserService.getAdminUser( request );
        String strKeywords = request.getParameter( PARAMETER_KEYWORDS );
        if ( adminUser != null && adminUser.checkRight( LocalUserJspBean.RIGHT_MYLUTECEUSERSMANAGEMENT ) && !strKeywords.isEmpty( ) )
        {
            return getSearchResultList( strKeywords, request );
        }
        else
        {
            _logger.error( Constants.ERROR_NOT_FOUND_VERSION );
            return Response.status( Response.Status.NOT_FOUND )
                    .entity( JsonUtil.buildJsonResponse( new ErrorJsonResponse( Response.Status.NOT_FOUND.name( ), Constants.ERROR_NOT_FOUND_VERSION ) ) )
                    .build( );
        }
    }

    /**
     * Get SearchResult List V1
     * 
     * @return the SearchResult List for the version 1
     */
    private Response getSearchResultList( String strQuery, HttpServletRequest request )
    {
        List<Map<String, String>> listResults = LocalUserSearchEngine.getSearchResults( strQuery, request );
        if ( listResults == null || listResults.isEmpty( ) )
        {
            return Response.status( Response.Status.NO_CONTENT ).entity( JsonUtil.buildJsonResponse( new JsonResponse( Constants.EMPTY_OBJECT ) ) ).build( );
        }
        return Response.status( Response.Status.OK ).entity( JsonUtil.buildJsonResponse( new JsonResponse( listResults ) ) ).build( );
    }
}