net.nemerosa.ontrack.boot.ui.APIController Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of ontrack-ui Show documentation
Ontrack module: ontrack-ui
There is a newer version: 4.4.5
package net.nemerosa.ontrack.boot.ui;

import net.nemerosa.ontrack.boot.support.APIDescription;
import net.nemerosa.ontrack.boot.support.APIInfo;
import net.nemerosa.ontrack.boot.support.APIMethodInfo;
import net.nemerosa.ontrack.common.RunProfile;
import net.nemerosa.ontrack.model.exceptions.APIMethodInfoNotFoundException;
import net.nemerosa.ontrack.model.structure.NameDescription;
import net.nemerosa.ontrack.ui.controller.AbstractResourceController;
import net.nemerosa.ontrack.ui.resource.Resources;
import net.nemerosa.ontrack.ui.support.API;
import net.nemerosa.ontrack.ui.support.APIMethod;
import org.apache.commons.lang3.StringUtils;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.Profile;
import org.springframework.core.annotation.AnnotationUtils;
import org.springframework.stereotype.Controller;
import org.springframework.util.ReflectionUtils;
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.bind.annotation.RestController;
import org.springframework.web.method.HandlerMethod;
import org.springframework.web.servlet.HandlerExecutionChain;
import org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletRequestWrapper;
import java.lang.reflect.Method;
import java.util.*;
import java.util.stream.Collectors;

import static net.nemerosa.ontrack.model.structure.NameDescription.nd;
import static org.apache.commons.lang3.StringUtils.capitalize;
import static org.springframework.web.servlet.mvc.method.annotation.MvcUriComponentsBuilder.on;

@RestController
@RequestMapping("/api")
@Profile({RunProfile.DEV, RunProfile.ACC, RunProfile.PROD})
public class APIController extends AbstractResourceController {

    private final ApplicationContext applicationContext;
    private final RequestMappingHandlerMapping handlerMapping;

    @Autowired
    public APIController(
            ApplicationContext applicationContext,
            @Qualifier("requestMappingHandlerMapping")
                    RequestMappingHandlerMapping handlerMapping) {
        this.applicationContext = applicationContext;
        this.handlerMapping = handlerMapping;
    }

    @RequestMapping(value = "/describe", method = RequestMethod.GET)
    public APIDescription describe(HttpServletRequest request, @RequestParam String path) throws Exception {
        HandlerExecutionChain executionChain = handlerMapping.getHandler(
                new HttpServletRequestWrapper(request) {
                    @Override
                    public String getRequestURI() {
                        return path;
                    }

                    @Override
                    public String getServletPath() {
                        return path;
                    }
                }
        );
        // Gets the handler
        Object handler = executionChain.getHandler();
        if (handler instanceof HandlerMethod) {
            HandlerMethod handlerMethod = (HandlerMethod) handler;
            String type = handlerMethod.getBeanType().getName();
            String method = handlerMethod.getMethod().getName();
            // Gets all the infos
            List apiInfos = getApiInfos();
            // Looking for any GET mapping
            APIMethodInfo get = apiInfos.stream()
                    .flatMap(i -> i.getMethods().stream())
                    .filter(mi -> StringUtils.equals(type, mi.getApiInfo().getType())
                            && StringUtils.equals(method, mi.getMethod()))
                    .findFirst()
                    .orElseThrow(() -> new APIMethodInfoNotFoundException(path));
            // Gets all methods with the same path pattern
            List methods = apiInfos.stream()
                    .flatMap(i -> i.getMethods().stream())
                    .filter(mi -> StringUtils.equals(get.getPath(), mi.getPath()))
                    .collect(Collectors.toList());
            // OK
            return new APIDescription(
                    path,
                    methods
            );
        } else {
            throw new APIMethodInfoNotFoundException(path);
        }
    }

    @RequestMapping(value = "/list", method = RequestMethod.GET)
    public Resources list() {
        return Resources.of(
                getApiInfos(),
                uri(on(getClass()).list())
        );
    }

    private List getApiInfos() {
        List apiInfos = new ArrayList<>();
        Collection