com.smoketurner.notification.application.resources.VersionResource Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of notification-application Show documentation

There is a newer version: 2.0.0

Show newest version

/**
 * Copyright 2016 Smoke Turner, LLC.
 *
 * 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 com.smoketurner.notification.application.resources;

import java.util.Objects;
import javax.annotation.Nonnull;
import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;
import com.google.common.annotations.VisibleForTesting;
import io.dropwizard.jersey.caching.CacheControl;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiResponse;
import io.swagger.annotations.ApiResponses;

@Path("/version")
@Api("version")
public class VersionResource {

    private final String version;

    /**
     * Constructor
     */
    public VersionResource() {
        version = getClass().getPackage().getImplementationVersion();
    }

    /**
     * Constructor
     *
     * @param version
     *            Version to expose in the endpoint
     */
    @VisibleForTesting
    public VersionResource(@Nonnull final String version) {
        this.version = Objects.requireNonNull(version);
    }

    @GET
    @CacheControl(mustRevalidate = true, noCache = true, noStore = true)
    @ApiOperation(value = "Get Version", notes = "Returns the service version")
    @ApiResponses(value = {
            @ApiResponse(code = 200, message = "Service Version") })
    public Response getVersion() {
        return Response.ok(version).type(MediaType.TEXT_PLAIN).build();
    }
}