All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.finos.legend.sdlc.server.resources.VersionsResource Maven / Gradle / Ivy

// Copyright 2020 Goldman Sachs
//
// 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
//
//      http://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 org.finos.legend.sdlc.server.resources;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;
import org.finos.legend.sdlc.domain.model.version.Version;
import org.finos.legend.sdlc.server.application.version.CreateVersionCommand;
import org.finos.legend.sdlc.server.domain.api.version.VersionApi;
import org.finos.legend.sdlc.server.error.LegendSDLCServerException;

import javax.inject.Inject;
import javax.ws.rs.Consumes;
import javax.ws.rs.GET;
import javax.ws.rs.POST;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;
import javax.ws.rs.QueryParam;
import javax.ws.rs.core.MediaType;
import java.util.List;

@Path("/projects/{projectId}/versions")
@Api("Versions")
@Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON)
public class VersionsResource extends BaseResource
{
    private final VersionApi versionApi;

    @Inject
    public VersionsResource(VersionApi versionApi)
    {
        this.versionApi = versionApi;
    }

    @GET
    @ApiOperation("Get all versions for a project")
    public List getVersions(@PathParam("projectId") String projectId,
                                     @QueryParam("major")
                                     @ApiParam("Exact major version (trumps minimum or maximum)") Integer majorVersion,
                                     @QueryParam("minMajor")
                                     @ApiParam("Minimum major version (only used if exact major version is not supplied)") Integer minMajorVersion,
                                     @QueryParam("maxMajor")
                                     @ApiParam("Maximum major version (only used if exact major version is not supplied)") Integer maxMajorVersion,
                                     @QueryParam("minor")
                                     @ApiParam("Exact minor version (trumps minimum or maximum)") Integer minorVersion,
                                     @QueryParam("minMinor")
                                     @ApiParam("Minimum minor version (only used if exact minor version is not supplied)") Integer minMinorVersion,
                                     @QueryParam("maxMinor")
                                     @ApiParam("Maximum minor version (only used if exact minor version is not supplied)") Integer maxMinorVersion,
                                     @QueryParam("patch")
                                     @ApiParam("Exact patch version (trumps minimum or maximum)") Integer patchVersion,
                                     @QueryParam("minPatch")
                                     @ApiParam("Minimum patch version (only used if exact patch version is not supplied)") Integer minPatchVersion,
                                     @QueryParam("maxPatch")
                                     @ApiParam("Maximum patch version (only used if exact patch version is not supplied)") Integer maxPatchVersion)
    {
        return executeWithLogging(
                "getting versions for project " + projectId,
                () -> this.versionApi.getVersions(projectId,
                        (majorVersion == null) ? minMajorVersion : majorVersion,
                        (majorVersion == null) ? maxMajorVersion : majorVersion,
                        (minorVersion == null) ? minMinorVersion : minorVersion,
                        (minorVersion == null) ? maxMinorVersion : minorVersion,
                        (patchVersion == null) ? minPatchVersion : patchVersion,
                        (patchVersion == null) ? maxPatchVersion : patchVersion)
        );
    }

    @GET
    @Path("latest")
    @ApiOperation("Get the latest version of a project")
    public Version getLatestVersion(@PathParam("projectId") String projectId,
                                    @QueryParam("major")
                                    @ApiParam("Exact major version (trumps minimum or maximum)") Integer majorVersion,
                                    @QueryParam("minMajor")
                                    @ApiParam("Minimum major version (only used if exact major version is not supplied)") Integer minMajorVersion,
                                    @QueryParam("maxMajor")
                                    @ApiParam("Maximum major version (only used if exact major version is not supplied)") Integer maxMajorVersion,
                                    @QueryParam("minor")
                                    @ApiParam("Exact minor version (trumps minimum or maximum)") Integer minorVersion,
                                    @QueryParam("minMinor")
                                    @ApiParam("Minimum minor version (only used if exact minor version is not supplied)") Integer minMinorVersion,
                                    @QueryParam("maxMinor")
                                    @ApiParam("Maximum minor version (only used if exact minor version is not supplied)") Integer maxMinorVersion,
                                    @QueryParam("patch")
                                    @ApiParam("Exact patch version (trumps minimum or maximum)") Integer patchVersion,
                                    @QueryParam("minPatch")
                                    @ApiParam("Minimum patch version (only used if exact patch version is not supplied)") Integer minPatchVersion,
                                    @QueryParam("maxPatch")
                                    @ApiParam("Maximum patch version (only used if exact patch version is not supplied)") Integer maxPatchVersion)
    {
        return executeWithLogging(
                "getting the latest version of project " + projectId,
                () -> this.versionApi.getLatestVersion(projectId,
                        (majorVersion == null) ? minMajorVersion : majorVersion,
                        (majorVersion == null) ? maxMajorVersion : majorVersion,
                        (minorVersion == null) ? minMinorVersion : minorVersion,
                        (minorVersion == null) ? maxMinorVersion : minorVersion,
                        (patchVersion == null) ? minPatchVersion : patchVersion,
                        (patchVersion == null) ? maxPatchVersion : patchVersion)
        );
    }

    @GET
    @Path("{versionId}")
    @ApiOperation("Get a version of a project")
    public Version getVersion(@PathParam("projectId") String projectId, @PathParam("versionId") String versionId)
    {
        return executeWithLogging(
                "getting version " + versionId + " of project " + projectId,
                () -> this.versionApi.getVersion(projectId, versionId)
        );
    }

    @POST
    @ApiOperation("Create a new version of a project")
    public Version createVersion(@PathParam("projectId") String projectId, CreateVersionCommand command)
    {
        LegendSDLCServerException.validateNonNull(command, "Input required to create version");
        return executeWithLogging(
                "creating new " + command.getVersionType().name().toLowerCase() + " version",
                () -> this.versionApi.newVersion(projectId, command.getVersionType(), command.getRevisionId(), command.getNotes())
        );
    }
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy