net.n2oapp.security.admin.rest.api.ApplicationSystemRestService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of security-admin-rest-api Show documentation
There is a newer version: 8.0.1
Show newest version
/*
 * Copyright 2017-2020 the original author or authors.
 *
 * Licensed 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
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * 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 net.n2oapp.security.admin.rest.api;

import io.swagger.annotations.*;
import net.n2oapp.security.admin.api.model.AppSystem;
import net.n2oapp.security.admin.api.model.AppSystemForm;
import net.n2oapp.security.admin.api.model.Application;
import net.n2oapp.security.admin.rest.api.criteria.RestApplicationCriteria;
import net.n2oapp.security.admin.rest.api.criteria.RestSystemCriteria;
import org.springframework.data.domain.Page;

import javax.ws.rs.*;
import javax.ws.rs.core.MediaType;

/**
 * REST сервис управления приложениями и системами
 */
@Path("/")
@Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON)
@Api(value = "Приложения и Системы", authorizations = @Authorization(value = "oauth2"))
public interface ApplicationSystemRestService {

    String SYSTEM_PATH = "/systems";
    String APPLICATION_PATH = "/applications";

    @GET
    @Path(APPLICATION_PATH)
    @ApiOperation("Найти приложение по критериям поиска")
    @ApiResponse(code = 200, message = "Страница приложений")
    Page findAllApplications(@BeanParam RestApplicationCriteria criteria);

    @GET
    @Path(APPLICATION_PATH + "/{id}")
    @ApiOperation("Получить приложение по идентификатору")
    @ApiResponse(code = 200, message = "Приложения")
    Application getApplication(@ApiParam(value = "Код приложения") @PathParam("id") String code);

    @POST
    @Path(APPLICATION_PATH)
    @ApiOperation("Создать приложение")
    @ApiResponses({
            @ApiResponse(code = 200, message = "Созданное приложение"),
            @ApiResponse(code = 400, message = "Некорректный запрос")
    })
    Application createApplication(@ApiParam(value = "Приложение") Application serviceForm);

    @PUT
    @Path(APPLICATION_PATH)
    @ApiOperation("Изменить приложение")
    @ApiResponse(code = 200, message = "Измененное приложение")
    Application updateApplication(@ApiParam(value = "Приложение") Application serviceForm);

    @DELETE
    @Path(APPLICATION_PATH + "/{code}")
    @ApiOperation("Удалить приложение")
    @ApiResponses({
            @ApiResponse(code = 200, message = "Приложение удалено"),
            @ApiResponse(code = 400, message = "Некорректный запрос")
    })
    void deleteApplication(@ApiParam(value = "Код приложения") @PathParam("code") String code);

    @GET
    @Path(SYSTEM_PATH)
    @ApiOperation("Найти систему по критериям поиска")
    @ApiResponse(code = 200, message = "Страница систем")
    Page findAllSystems(@BeanParam RestSystemCriteria criteria);

    @GET
    @Path(SYSTEM_PATH + "/{id}")
    @ApiOperation("Получить систему по идентификатору")
    @ApiResponse(code = 200, message = "Системы")
    AppSystem getSystem(@ApiParam(value = "Код") @PathParam("id") String code);

    @POST
    @Path(SYSTEM_PATH)
    @ApiOperation("Создать систему")
    @ApiResponse(code = 200, message = "Созданная система")
    AppSystem createSystem(@ApiParam(value = "Система") AppSystemForm systemForm);

    @PUT
    @Path(SYSTEM_PATH)
    @ApiOperation("Изменить систему")
    @ApiResponse(code = 200, message = "Измененная система")
    AppSystem updateSystem(@ApiParam(value = "Система") AppSystemForm systemForm);

    @DELETE
    @Path(SYSTEM_PATH + "/{code}")
    @ApiOperation("Удалить систему")
    @ApiResponse(code = 200, message = "Система удалена")
    void deleteSystem(@ApiParam(value = "Код системы") @PathParam("code") String code);
}