BaseRequestsParser.java

/*
** Module   : BaseRequestsParser.java
** Abstract : A super-class to allow implementation to load dataset, table, etc from various 
**            inputs.
**
** Copyright (c) 2020, Golden Code Development Corporation.
**
** -#- -I- --Date-- --------------------------------Description-----------------------------------
** 001 CA  20200427 Created initial version.
**     CA  20200514 Refactoring to allow common code for SOAP services support.
*/
/*
** This program is free software: you can redistribute it and/or modify
** it under the terms of the GNU Affero General Public License as
** published by the Free Software Foundation, either version 3 of the
** License, or (at your option) any later version.
**
** This program is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
** GNU Affero General Public License for more details.
**
** You may find a copy of the GNU Affero GPL version 3 at the following
** location: https://www.gnu.org/licenses/agpl-3.0.en.html
** 
** Additional terms under GNU Affero GPL version 3 section 7:
** 
**   Under Section 7 of the GNU Affero GPL version 3, the following additional
**   terms apply to the works covered under the License.  These additional terms
**   are non-permissive additional terms allowed under Section 7 of the GNU
**   Affero GPL version 3 and may not be removed by you.
** 
**   0. Attribution Requirement.
** 
**     You must preserve all legal notices or author attributions in the covered
**     work or Appropriate Legal Notices displayed by works containing the covered
**     work.  You may not remove from the covered work any author or developer
**     credit already included within the covered work.
** 
**   1. No License To Use Trademarks.
** 
**     This license does not grant any license or rights to use the trademarks
**     Golden Code, FWD, any Golden Code or FWD logo, or any other trademarks
**     of Golden Code Development Corporation. You are not authorized to use the
**     name Golden Code, FWD, or the names of any author or contributor, for
**     publicity purposes without written authorization.
** 
**   2. No Misrepresentation of Affiliation.
** 
**     You may not represent yourself as Golden Code Development Corporation or FWD.
** 
**     You may not represent yourself for publicity purposes as associated with
**     Golden Code Development Corporation, FWD, or any author or contributor to
**     the covered work, without written authorization.
** 
**   3. No Misrepresentation of Source or Origin.
** 
**     You may not represent the covered work as solely your work.  All modified
**     versions of the covered work must be marked in a reasonable way to make it
**     clear that the modified work is not originating from Golden Code Development
**     Corporation or FWD.  All modified versions must contain the notices of
**     attribution required in this license.
*/

package com.goldencode.p2j.rest;

import java.io.*;

import javax.servlet.http.*;

import com.goldencode.p2j.persist.*;

/**
 * Provides APIs to load a dataset or a table, and to parse arguments from various inputs.
 */
class BaseRequestsParser
extends RequestArguments
{
   /**
    * Parse the argument, by interpreting the request.
    * 
    * @param    body
    *           The request body.
    * @param    source
    *           The parameter's encoded source.
    * @param    request
    *           The request payload.
    *           
    * @return   The resolved argument.
    */
   @Override
   protected String parseArgumentInt(String body, String source, HttpServletRequest request)
   throws IOException
   {
      return super.parseArgumentInt(body, source, request);
   }
   
   /**
    * Load the specified dataset.
    * 
    * @param    content
    *           The dataset definition.
    * @return   A {@link DatasetWrapper} instance to be passed as argument to the remote call.
    */
   @Override
   protected DatasetWrapper loadDataSet(String content) throws IOException
   {
      return null;
   }
   
   /**
    * Load the specified table.
    * 
    * @param    content
    *           The table definition.
    * @return   A {@link TableWrapper} instance to be passed as argument to the remote call.
    */
   @Override
   protected TableWrapper loadTable(String content) throws IOException
   {
      return null;
   }
}