001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */
018package org.apache.hadoop.hbase.http.jersey;
019
020import java.io.IOException;
021import org.apache.yetus.audience.InterfaceAudience;
022
023import org.apache.hbase.thirdparty.com.google.common.collect.ImmutableMap;
024import org.apache.hbase.thirdparty.javax.ws.rs.container.ContainerRequestContext;
025import org.apache.hbase.thirdparty.javax.ws.rs.container.ContainerResponseContext;
026import org.apache.hbase.thirdparty.javax.ws.rs.container.ContainerResponseFilter;
027import org.apache.hbase.thirdparty.javax.ws.rs.core.Response.Status;
028
029/**
030 * Generate a uniform response wrapper around the Entity returned from the resource.
031 * @see <a href="https://jsonapi.org/format/#document-top-level">JSON API Document Structure</a>
032 * @see <a href="https://jsonapi.org/format/#error-objects">JSON API Error Objects</a>
033 */
034@InterfaceAudience.Private
035public class ResponseEntityMapper implements ContainerResponseFilter {
036
037  @Override
038  public void filter(ContainerRequestContext requestContext,
039    ContainerResponseContext responseContext) throws IOException {
040    /*
041     * Follows very loosely the top-level document specification described in by JSON API. Only
042     * handles 200 response codes; leaves room for errors and other response types.
043     */
044
045    final int statusCode = responseContext.getStatus();
046    if (Status.OK.getStatusCode() != statusCode) {
047      return;
048    }
049
050    responseContext.setEntity(ImmutableMap.of("data", responseContext.getEntity()));
051  }
052}