com.linkedin.restli.examples.greetings.server.AutomaticValidationDemoResource Maven / Gradle / Ivy

Go to download
/*
   Copyright (c) 2015 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.examples.greetings.server;


import com.linkedin.restli.common.HttpStatus;
import com.linkedin.restli.common.PatchRequest;
import com.linkedin.restli.common.validation.CreateOnly;
import com.linkedin.restli.common.validation.ReadOnly;
import com.linkedin.restli.examples.greetings.api.ValidationDemo;
import com.linkedin.restli.examples.greetings.api.myEnum;
import com.linkedin.restli.examples.greetings.api.myRecord;
import com.linkedin.restli.server.BatchCreateKVResult;
import com.linkedin.restli.server.BatchCreateRequest;
import com.linkedin.restli.server.BatchPatchRequest;
import com.linkedin.restli.server.BatchResult;
import com.linkedin.restli.server.BatchUpdateRequest;
import com.linkedin.restli.server.BatchUpdateResult;
import com.linkedin.restli.server.CreateKVResponse;
import com.linkedin.restli.server.RestLiServiceException;
import com.linkedin.restli.server.UpdateResponse;
import com.linkedin.restli.server.annotations.Finder;
import com.linkedin.restli.server.annotations.QueryParam;
import com.linkedin.restli.server.annotations.RestLiCollection;
import com.linkedin.restli.server.annotations.RestMethod;
import com.linkedin.restli.server.annotations.ReturnEntity;
import com.linkedin.restli.server.resources.KeyValueResource;

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

/**
 * Free-form resource for testing Rest.li data validation.
 * This class shows how to validate data automatically by using the validation filters.
 * Invalid incoming data or outgoing data are rejected, and an error response is returned to the client.
 *
 * @author Soojung Ha
 */
@RestLiCollection(name = "autoValidationDemos", namespace = "com.linkedin.restli.examples.greetings.client")
@ReadOnly({"stringA", "intA", "UnionFieldWithInlineRecord/com.linkedin.restli.examples.greetings.api.myRecord/foo1",
           "ArrayWithInlineRecord/*/bar1", "validationDemoNext/stringB", "validationDemoNext/UnionFieldWithInlineRecord"})
@CreateOnly({"stringB", "intB", "UnionFieldWithInlineRecord/com.linkedin.restli.examples.greetings.api.myRecord/foo2",
             "MapWithTyperefs/*/id"})
public class AutomaticValidationDemoResource implements KeyValueResource
{
  private static ValidationDemo _validReturnEntity;

  static
  {
    ValidationDemo.UnionFieldWithInlineRecord unionField = new ValidationDemo.UnionFieldWithInlineRecord();
    unionField.setMyEnum(myEnum.FOOFOO);
    _validReturnEntity = new ValidationDemo().setStringA("a").setStringB("b").setUnionFieldWithInlineRecord(unionField);
  }

  @RestMethod.Create
  @ReturnEntity
  public CreateKVResponse create(final ValidationDemo entity) throws CloneNotSupportedException
  {
    ValidationDemo returnedEntity;
    if (entity.getUnionFieldWithInlineRecord().isMyEnum()
        && entity.getUnionFieldWithInlineRecord().getMyEnum() == myEnum.BARBAR)
    {
      // Return invalid entity (missing stringA)
      returnedEntity = entity;
    }
    else
    {
      // Return valid entity
      returnedEntity = _validReturnEntity;
    }
    return new CreateKVResponse(1234, returnedEntity);
  }

  @RestMethod.BatchCreate
  @ReturnEntity
  public BatchCreateKVResult batchCreate(final BatchCreateRequest entities)
  {
    List> results = new ArrayList>();
    int id = 0;
    for (ValidationDemo entity : entities.getInput())
    {
      ValidationDemo returnEntity;
      if (entity.getStringB().equals("b1"))
      {
        // Missing union field.
        returnEntity = new ValidationDemo().setStringA("a").setStringB("b");
      }
      else if (entity.getStringB().equals("b2"))
      {
        // Missing foo1 in myRecord.
        ValidationDemo.UnionFieldWithInlineRecord unionField = new ValidationDemo.UnionFieldWithInlineRecord();
        unionField.setMyRecord(new myRecord().setFoo2(2));
        returnEntity = new ValidationDemo().setStringA("a").setStringB("b").setUnionFieldWithInlineRecord(unionField);
      }
      else
      {
        returnEntity = _validReturnEntity;
      }
      results.add(new CreateKVResponse(id, returnEntity));
      id++;
    }
    return new BatchCreateKVResult(results);
  }

  @RestMethod.Update
  public UpdateResponse update(final Integer key, final ValidationDemo entity)
  {
    return new UpdateResponse(HttpStatus.S_204_NO_CONTENT);
  }

  @RestMethod.BatchUpdate
  public BatchUpdateResult batchUpdate(final BatchUpdateRequest entities)
  {
    Map results = new HashMap();
    Map errors = new HashMap();
    for (Map.Entry entry : entities.getData().entrySet())
    {
      Integer key = entry.getKey();
      ValidationDemo entity = entry.getValue();
      results.put(key, new UpdateResponse(HttpStatus.S_204_NO_CONTENT));
    }
    return new BatchUpdateResult(results, errors);
  }

  @RestMethod.PartialUpdate
  public UpdateResponse update(final Integer key, final PatchRequest patch)
  {
    return new UpdateResponse(HttpStatus.S_204_NO_CONTENT);
  }

  @RestMethod.BatchPartialUpdate
  public BatchUpdateResult batchUpdate(final BatchPatchRequest entityUpdates)
  {
    Map results = new HashMap();
    Map errors = new HashMap();
    for (Map.Entry> entry : entityUpdates.getData().entrySet())
    {
      Integer key = entry.getKey();
      PatchRequest patch = entry.getValue();
      results.put(key, new UpdateResponse(HttpStatus.S_204_NO_CONTENT));
    }
    return new BatchUpdateResult(results, errors);
  }

  @RestMethod.Get
  public ValidationDemo get(final Integer key)
  {
    if (key == 0)
    {
      throw new RestLiServiceException(HttpStatus.S_400_BAD_REQUEST);
    }
    // Generate an entity that does not conform to the data schema
    ValidationDemo.UnionFieldWithInlineRecord union = new ValidationDemo.UnionFieldWithInlineRecord();
    union.setMyEnum(myEnum.BARBAR);
    ValidationDemo validationDemo = new ValidationDemo().setStringA("stringA is readOnly").setUnionFieldWithInlineRecord(union);
    return validationDemo;
  }

  @RestMethod.BatchGet
  public BatchResult batchGet(Set ids)
  {
    Map resultMap = new HashMap();
    Map errorMap = new HashMap();
    // Generate entities that are missing a required field
    for (Integer id : ids)
    {
      if (id == 0)
      {
        errorMap.put(id, new RestLiServiceException(HttpStatus.S_400_BAD_REQUEST));
      }
      else if (id == 1)
      {
        ValidationDemo.UnionFieldWithInlineRecord union = new ValidationDemo.UnionFieldWithInlineRecord();
        union.setMyRecord(new myRecord().setFoo1(100).setFoo2(200));
        resultMap.put(id, new ValidationDemo().setStringA("a").setStringB("b").setUnionFieldWithInlineRecord(union));
      }
      else
      {
        ValidationDemo.UnionFieldWithInlineRecord union = new ValidationDemo.UnionFieldWithInlineRecord();
        union.setMyRecord(new myRecord());
        ValidationDemo validationDemo = new ValidationDemo().setStringA("a").setStringB("b").setUnionFieldWithInlineRecord(union);
        resultMap.put(id, validationDemo);
      }
    };
    return new BatchResult(resultMap, errorMap);
  }

  @RestMethod.GetAll
  public List getAll()
  {
    List validationDemos = new ArrayList();
    // Generate entities with stringA fields that are too long
    for (int i = 0; i < 4; i++)
    {
      ValidationDemo.UnionFieldWithInlineRecord union = new ValidationDemo.UnionFieldWithInlineRecord();
      union.setMyEnum(myEnum.FOOFOO);
      validationDemos.add(new ValidationDemo().setStringA("This string is too long to pass validation.")
                              .setStringB("stringB").setUnionFieldWithInlineRecord(union));
    }
    return validationDemos;
  }

  @Finder("search")
  public List search(@QueryParam("intA") Integer intA)
  {
    if (intA == 0)
    {
      throw new RestLiServiceException(HttpStatus.S_400_BAD_REQUEST);
    }
    List validationDemos = new ArrayList();
    // Generate entities that are missing stringB fields
    for (int i = 0; i < 3; i++)
    {
      ValidationDemo.UnionFieldWithInlineRecord union = new ValidationDemo.UnionFieldWithInlineRecord();
      union.setMyEnum(myEnum.FOOFOO);
      validationDemos.add(new ValidationDemo().setStringA("valueA").setIntA(intA).setUnionFieldWithInlineRecord(union));
    }
    return validationDemos;
  }
}