All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.linkedin.restli.client.BatchPartialUpdateRequestBuilder Maven / Gradle / Ivy

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

/**
 * $Id: $
 */

package com.linkedin.restli.client;


import com.linkedin.data.DataMap;
import com.linkedin.data.template.RecordTemplate;
import com.linkedin.restli.common.CollectionRequest;
import com.linkedin.restli.common.KeyValueRecord;
import com.linkedin.restli.common.KeyValueRecordFactory;
import com.linkedin.restli.common.PatchRequest;
import com.linkedin.restli.common.ResourceSpec;
import com.linkedin.restli.common.TypeSpec;
import com.linkedin.restli.common.attachments.RestLiAttachmentDataSourceWriter;
import com.linkedin.restli.common.attachments.RestLiDataSourceIterator;

import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;


/**
 * @author Josh Walker
 * @version $Revision: $
 */
public class BatchPartialUpdateRequestBuilder extends
    BatchKVRequestBuilder>
{
  private final KeyValueRecordFactory> _keyValueRecordFactory;
  private final Map> _partialUpdateInputMap;
  private List _streamingAttachments; //We initialize only when we need to.

  @SuppressWarnings({"unchecked", "rawtypes"})
  public BatchPartialUpdateRequestBuilder(String baseUriTemplate,
                                          Class valueClass,
                                          ResourceSpec resourceSpec,
                                          RestliRequestOptions requestOptions)
  {
    super(baseUriTemplate, resourceSpec, requestOptions);
    _partialUpdateInputMap = new HashMap>();
    _keyValueRecordFactory = new KeyValueRecordFactory(_resourceSpec.getKeyType(),
                                    _resourceSpec.getComplexKeyType(),
                                    _resourceSpec.getKeyParts(),
                                    new TypeSpec(PatchRequest.class));
  }

  public BatchPartialUpdateRequestBuilder input(K id, PatchRequest patch)
  {
    _partialUpdateInputMap.put(id, patch);
    addKey(id);
    return this;
  }

  public BatchPartialUpdateRequestBuilder inputs(Map> patches)
  {
    addKeys(patches.keySet());
    for (Map.Entry> entry : patches.entrySet())
    {
      K key = entry.getKey();
      PatchRequest value = entry.getValue();
      _partialUpdateInputMap.put(key, value);
    }
    return this;
  }

  public BatchPartialUpdateRequestBuilder appendSingleAttachment(final RestLiAttachmentDataSourceWriter streamingAttachment)
  {
    if (_streamingAttachments == null)
    {
      _streamingAttachments = new ArrayList<>();
    }

    _streamingAttachments.add(streamingAttachment);
    return this;
  }

  public BatchPartialUpdateRequestBuilder appendMultipleAttachments(final RestLiDataSourceIterator dataSourceIterator)
  {
    if (_streamingAttachments == null)
    {
      _streamingAttachments = new ArrayList<>();
    }

    _streamingAttachments.add(dataSourceIterator);
    return this;
  }

  @Override
  public BatchPartialUpdateRequestBuilder setParam(String key, Object value)
  {
    super.setParam(key, value);
    return this;
  }

  @Override
  public BatchPartialUpdateRequestBuilder setReqParam(String key, Object value)
  {
    super.setReqParam(key, value);
    return this;
  }

  @Override
  public BatchPartialUpdateRequestBuilder addParam(String key, Object value)
  {
    super.addParam(key, value);
    return this;
  }

  @Override
  public BatchPartialUpdateRequestBuilder addReqParam(String key, Object value)
  {
    super.addReqParam(key, value);
    return this;
  }

  @Override
  public BatchPartialUpdateRequestBuilder setHeader(String key, String value)
  {
    super.setHeader(key, value);
    return this;
  }

  @Override
  public BatchPartialUpdateRequestBuilder setHeaders(Map headers)
  {
    super.setHeaders(headers);
    return this;
  }

  @Override
  public BatchPartialUpdateRequestBuilder addHeader(String name, String value)
  {
    super.addHeader(name, value);
    return this;
  }

  @Override
  public BatchPartialUpdateRequestBuilder pathKey(String name, Object value)
  {
    super.pathKey(name, value);
    return this;
  }

  @Override
  public BatchPartialUpdateRequest build()
  {
    ensureBatchKeys();

    return new BatchPartialUpdateRequest(buildReadOnlyHeaders(),
                                               buildReadOnlyCookies(),
                                               buildReadOnlyInput(),
                                               buildReadOnlyQueryParameters(),
                                               getQueryParamClasses(),
                                               _resourceSpec,
                                               getBaseUriTemplate(),
                                               buildReadOnlyPathKeys(),
                                               getRequestOptions(),
                                               _streamingAttachments == null ? null : Collections.unmodifiableList(_streamingAttachments));
  }

  private CollectionRequest>> buildReadOnlyInput()
  {
    try
    {
      DataMap map = new DataMap();
      @SuppressWarnings({ "unchecked", "rawtypes" })
      CollectionRequest>> input = new CollectionRequest(map, KeyValueRecord.class);

      for (Map.Entry> inputEntityEntry : _partialUpdateInputMap.entrySet())
      {
        K key = getReadOnlyOrCopyKey(inputEntityEntry.getKey());
        PatchRequest entity = getReadOnlyOrCopyDataTemplate(inputEntityEntry.getValue());
        KeyValueRecord> keyValueRecord = _keyValueRecordFactory.create(key, entity);
        keyValueRecord.data().setReadOnly();
        input.getElements().add(keyValueRecord);
      }

      map.setReadOnly();
      return input;
    }
    catch (CloneNotSupportedException cloneException)
    {
      throw new IllegalArgumentException("Entity cannot be copied.", cloneException);
    }
  }
}