BatchRequest.java

/*
   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.client;


import com.linkedin.data.template.RecordTemplate;
import com.linkedin.restli.common.ResourceMethod;
import com.linkedin.restli.common.ResourceSpec;
import com.linkedin.restli.common.RestConstants;
import com.linkedin.restli.internal.client.RestResponseDecoder;

import java.net.HttpCookie;
import java.util.Collection;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;


/**
 * A type-bound Batch Request for a resource.
 *
 * @param <T> response entity template class
 *
 * @author adubman
 */
public class BatchRequest<T> extends Request<T>
{
  BatchRequest(ResourceMethod method,
               RecordTemplate input,
               Map<String, String> headers,
               List<HttpCookie> cookies,
               RestResponseDecoder<T> decoder,
               ResourceSpec resourceSpec,
               Map<String, Object> queryParams,
               Map<String, Class<?>> queryParamClasses,
               String baseUriTemplate,
               Map<String, Object> pathKeys,
               RestliRequestOptions requestOptions,
               List<Object> streamingAttachments)
  {
    super(method, input, headers, cookies, decoder, resourceSpec, queryParams, queryParamClasses, null,
          baseUriTemplate, pathKeys, requestOptions, streamingAttachments);
  }

  /**
   * @return the IDs of the objects in this request. The IDs are the keys with their original types (non-coerced)
   */
  public Set<Object> getObjectIds()
  {
    @SuppressWarnings({"unchecked"})
    Collection<Object> ids = (Collection<Object>) getQueryParamsObjects().get(RestConstants.QUERY_BATCH_IDS_PARAM);
    if (ids == null || ids.isEmpty())
    {
      return Collections.emptySet();
    }
    return new HashSet<Object>(ids);
  }
}