com.google.api.server.spi.request.ParamReader Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of endpoints-framework Show documentation

A framework for building RESTful web APIs.

There is a newer version: 2.2.2

/*
 * Copyright 2016 Google Inc. All Rights Reserved.
 *
 * 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.google.api.server.spi.request;

import com.google.api.server.spi.response.BadRequestException;

/**
 * Reads a request and returns an array of parameter values.
 */
public interface ParamReader {

  /**
   * Reads parameters in JSON into an Object array to be used to invoke an Endpoint method.
   * @throws BadRequestException when reading of input stream failed, input JSON is invalid,
   * or cannot be mapped into parameter objects.
   */
  Object[] read() throws BadRequestException;
}