View Javadoc

1   /*
2    *
3    * Licensed to the Apache Software Foundation (ASF) under one
4    * or more contributor license agreements.  See the NOTICE file
5    * distributed with this work for additional information
6    * regarding copyright ownership.  The ASF licenses this file
7    * to you under the Apache License, Version 2.0 (the
8    * "License"); you may not use this file except in compliance
9    * with the License.  You may obtain a copy of the License at
10   *
11   *     http://www.apache.org/licenses/LICENSE-2.0
12   *
13   * Unless required by applicable law or agreed to in writing, software
14   * distributed under the License is distributed on an "AS IS" BASIS,
15   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16   * See the License for the specific language governing permissions and
17   * limitations under the License.
18   */
19  
20  package org.apache.hadoop.hbase.rest;
21  
22  import java.io.IOException;
23  
24  import javax.servlet.ServletContext;
25  import javax.ws.rs.GET;
26  import javax.ws.rs.Path;
27  import javax.ws.rs.Produces;
28  import javax.ws.rs.core.CacheControl;
29  import javax.ws.rs.core.Context;
30  import javax.ws.rs.core.Response;
31  import javax.ws.rs.core.UriInfo;
32  import javax.ws.rs.core.Response.ResponseBuilder;
33  
34  import org.apache.commons.logging.Log;
35  import org.apache.commons.logging.LogFactory;
36  
37  import org.apache.hadoop.hbase.classification.InterfaceAudience;
38  import org.apache.hadoop.hbase.rest.model.VersionModel;
39  
40  /**
41   * Implements REST software version reporting
42   * <p>
43   * <tt>/version/rest</tt>
44   * <p>
45   * <tt>/version</tt> (alias for <tt>/version/rest</tt>)
46   */
47  @InterfaceAudience.Private
48  public class VersionResource extends ResourceBase {
49  
50    private static final Log LOG = LogFactory.getLog(VersionResource.class);
51  
52    static CacheControl cacheControl;
53    static {
54      cacheControl = new CacheControl();
55      cacheControl.setNoCache(true);
56      cacheControl.setNoTransform(false);
57    }
58  
59    /**
60     * Constructor
61     * @throws IOException
62     */
63    public VersionResource() throws IOException {
64      super();
65    }
66  
67    /**
68     * Build a response for a version request.
69     * @param context servlet context
70     * @param uriInfo (JAX-RS context variable) request URL
71     * @return a response for a version request 
72     */
73    @GET
74    @Produces({MIMETYPE_TEXT, MIMETYPE_XML, MIMETYPE_JSON, MIMETYPE_PROTOBUF,
75      MIMETYPE_PROTOBUF_IETF})
76    public Response get(final @Context ServletContext context, 
77        final @Context UriInfo uriInfo) {
78      if (LOG.isDebugEnabled()) {
79        LOG.debug("GET " + uriInfo.getAbsolutePath());
80      }
81      servlet.getMetrics().incrementRequests(1);
82      ResponseBuilder response = Response.ok(new VersionModel(context));
83      response.cacheControl(cacheControl);
84      servlet.getMetrics().incrementSucessfulGetRequests(1);
85      return response.build();
86    }
87  
88    /**
89     * Dispatch to StorageClusterVersionResource
90     */
91    @Path("cluster")
92    public StorageClusterVersionResource getClusterVersionResource() 
93        throws IOException {
94      return new StorageClusterVersionResource();
95    }
96  
97    /**
98     * Dispatch <tt>/version/rest</tt> to self.
99     */
100   @Path("rest")
101   public VersionResource getVersionResource() {
102     return this;
103   }
104 }