org.graylog2.rest.resources.suggestions.EntitySuggestionResource Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of graylog2-server Show documentation
Graylog
There is a newer version: 6.1.4
/*
 * Copyright (C) 2020 Graylog, Inc.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the Server Side Public License, version 1,
 * as published by MongoDB, Inc.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * Server Side Public License for more details.
 *
 * You should have received a copy of the Server Side Public License
 * along with this program. If not, see
 * .
 */
package org.graylog2.rest.resources.suggestions;

import com.codahale.metrics.annotation.Timed;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;
import org.apache.shiro.authz.annotation.RequiresAuthentication;
import org.graylog2.database.suggestions.EntitySuggestionResponse;
import org.graylog2.database.suggestions.EntitySuggestionService;
import org.graylog2.shared.rest.resources.RestResource;

import javax.inject.Inject;
import javax.ws.rs.DefaultValue;
import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.Produces;
import javax.ws.rs.QueryParam;
import javax.ws.rs.core.MediaType;

import static org.graylog2.shared.rest.documentation.generator.Generator.CLOUD_VISIBLE;

@RequiresAuthentication
@Api(value = "EntitySuggestions", tags = {CLOUD_VISIBLE})
@Path("/entity_suggestions")
@Produces(MediaType.APPLICATION_JSON)
public class EntitySuggestionResource extends RestResource {

    private final EntitySuggestionService entitySuggestionService;

    @Inject
    public EntitySuggestionResource(final EntitySuggestionService entitySuggestionService) {
        this.entitySuggestionService = entitySuggestionService;
    }

    @GET
    @Timed
    @ApiOperation(value = "Get a paginated list of suggested entities")
    public EntitySuggestionResponse getPage(@ApiParam(name = "collection")
                                                @QueryParam("collection") String collection,
                                            @ApiParam(name = "column")
                                                @QueryParam("column") @DefaultValue("title") String column,
                                            @ApiParam(name = "page")
                                                @QueryParam("page") @DefaultValue("1") int page,
                                            @ApiParam(name = "per_page")
                                                @QueryParam("per_page") @DefaultValue("10") int perPage,
                                            @ApiParam(name = "query")
                                                @QueryParam("query") @DefaultValue("") String query) {

        return entitySuggestionService.suggest(collection, column, query, page, perPage, getSubject());
    }
}