RootApiRequest.java

/*
 * Copyright 2000-2011 JetBrains s.r.o.
 *
 * 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 jetbrains.buildServer.server.rest.request;

import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;
import javax.ws.rs.core.Context;
import jetbrains.buildServer.server.rest.ApiUrlBuilder;
import jetbrains.buildServer.server.rest.data.DataProvider;
import jetbrains.buildServer.server.rest.model.plugin.PluginInfo;
import jetbrains.buildServer.serverSide.SBuild;
import jetbrains.buildServer.serverSide.SBuildType;
import jetbrains.buildServer.serverSide.SProject;

/**
 * @author Yegor.Yarko
 *         Date: 22.07.2009
 */
@Path(Constants.API_URL)
public class RootApiRequest {
  @Context
  private DataProvider myDataProvider;
  @Context
  private ApiUrlBuilder myApiUrlBuilder;

  @GET
  @Produces("text/plain")
  public String serveRoot() {
    return "This is a root page of REST API. Try '" + myApiUrlBuilder.getGlobalWadlHref() +
           "'. See also documentation on the usage at " + myDataProvider.getHelpLink("REST API", null);
  }

  @GET
  @Path("/version")
  @Produces("text/plain")
  public String serveApiVersion() {
    return myDataProvider.getPluginInfo().getPluginXml().getInfo().getVersion();
  }

  @GET
  @Path("/info")
  @Produces("application/xml")
  public PluginInfo servePluginInfo() {
    return new PluginInfo(myDataProvider.getPluginInfo());
  }

  @GET
  @Path("/{projectLocator}/{btLocator}/{buildLocator}/{field}")
  @Produces("text/plain")
  public String serveBuildFieldShort(@PathParam("projectLocator") String projectLocator,
                                     @PathParam("btLocator") String buildTypeLocator,
                                     @PathParam("buildLocator") String buildLocator,
                                     @PathParam("field") String field) {
    SProject project = myDataProvider.getProject(projectLocator);
    SBuildType buildType = myDataProvider.getBuildType(project, buildTypeLocator);
    SBuild build = myDataProvider.getBuild(buildType, buildLocator);

    return myDataProvider.getFieldValue(build, field);
  }
}