com.linkedin.restli.internal.server.methods.response.CollectionResponseBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of restli-server Show documentation
Pegasus is a framework for building robust, scalable service architectures using dynamic discovery and simple asychronous type-checked REST + JSON APIs.
There is a newer version: 27.7.18
Show newest version
/*
   Copyright (c) 2012 LinkedIn Corp.

   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.linkedin.restli.internal.server.methods.response;

import java.io.IOException;
import java.util.List;
import java.util.Map;

import com.linkedin.data.DataList;
import com.linkedin.data.DataMap;
import com.linkedin.data.collections.CheckedUtil;
import com.linkedin.data.template.RecordTemplate;
import com.linkedin.r2.message.rest.RestRequest;
import com.linkedin.restli.common.CollectionMetadata;
import com.linkedin.restli.common.CollectionResponse;
import com.linkedin.restli.common.RestConstants;
import com.linkedin.restli.internal.server.RoutingResult;
import com.linkedin.restli.internal.server.methods.AnyRecord;
import com.linkedin.restli.internal.server.util.RestUtils;
import com.linkedin.restli.server.CollectionResult;
import com.linkedin.restli.server.CollectionResult.PageIncrement;

public class CollectionResponseBuilder implements RestLiResponseBuilder
{

  @Override
  public PartialRestResponse buildResponse(final RestRequest request,
                                           final RoutingResult routingResult,
                                           final Object object,
                                           final Map headers)
      throws IOException
  {
    if (object instanceof List)
    {
      @SuppressWarnings({"unchecked"})
      /** constrained by {@link com.linkedin.restli.internal.server.model.RestLiAnnotationReader#validateFinderMethod(com.linkedin.restli.internal.server.model.ResourceMethodDescriptor, com.linkedin.restli.internal.server.model.ResourceModel)} */
      List result = (List)object;

      return buildResponseImpl(request,
                               routingResult,
                               result,
                               PageIncrement.RELATIVE,
                               null,
                               null,
                               headers);
    }
    else
    {
      @SuppressWarnings({"unchecked"})
      /** constrained by {@link com.linkedin.restli.internal.server.model.RestLiAnnotationReader#validateFinderMethod(com.linkedin.restli.internal.server.model.ResourceMethodDescriptor, com.linkedin.restli.internal.server.model.ResourceModel)} */
      CollectionResult collectionResult =
          (CollectionResult) object;

      return buildResponseImpl(request,
                               routingResult,
                               collectionResult.getElements(),
                               collectionResult.getPageIncrement(),
                               collectionResult.getMetadata(),
                               collectionResult.getTotal(),
                               headers);
    }
  }

  private static PartialRestResponse buildResponseImpl(final RestRequest request,
                                                       final RoutingResult routingResult,
                                                       final List elements,
                                                       final PageIncrement pageIncrement,
                                                       final RecordTemplate customMetadata,
                                                       final Integer totalResults,
                                                       final Map headers)
      throws IOException
  {

    Class valueClass =
        routingResult.getResourceMethod().getResourceModel().getValueClass();
    CollectionResponse collectionResponse =
        new CollectionResponse(AnyRecord.class);


    CollectionMetadata pagingMetadata =
        RestUtils.buildMetadata(request.getURI(),
                                routingResult.getContext(),
                                routingResult.getResourceMethod(),
                                elements,
                                pageIncrement,
                                totalResults);
    collectionResponse.setPaging(pagingMetadata);

    DataList elementsMap =
        (DataList) collectionResponse.data().get(CollectionResponse.ELEMENTS);
    for (RecordTemplate entry : elements)
    {
      DataMap data = RestUtils.projectFields(entry.data(), routingResult.getContext());

      CheckedUtil.addWithoutChecking(elementsMap, data);
    }

    if (customMetadata != null)
    {
      collectionResponse.setMetadataRaw(customMetadata.data());
    }

    return new PartialRestResponse(collectionResponse);
  }


}