# RestOperation.java

    /*
    ** Module   : RestOperation.java
    ** Abstract : Defines a REST operation, from the resourceModel.xml file.
    **
    ** Copyright (c) 2019, Golden Code Development Corporation.
    **
    ** -#- -I- --Date-- -------------------------------Description--------------------------------
    ** 001 CA  20190614 First version.
    ** 002 EAB 20240827 Updated the finding of mapping rules for input-output parameters.
    */

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

    import java.util.*;

    /**
     * Holds the definition of a REST operation, as it appears in the resourceModel.xml file.
     * <p>
     * This instance is the source for creating the {@link com.goldencode.p2j.util.LegacyService}
     * annotations.
     */
    public class RestOperation
    {
       /** resourceModel.xml prgs:resource/prgs:operation[name] */
       final String name;

       /** resourceModel.xml prgs:resource/prgs:operation[verb] */
       final String verb;

       /** resourceModel.xml prgs:resource/prgs:operation[consumes] */
       final String consumes;

       /** resourceModel.xml prgs:resource/prgs:operation[produces] */
       final String produces;

       /** resourceModel.xml prgs:resource/prgs:operation/prgs:param */
       final Map<String, RestParameter> parameters = new HashMap<>();

       /** Back-reference to the <code>prgs:resource</code> where this operation appears. */
       RestResource rest;

       /** The mappings (to the request/response) for this operation's legacy parameters. */
       final List<RestParameterMapping> mappings = new ArrayList<>();

       /** .restoe wsad:Operation - wsad:ProcPath/wsad:Name.wsad:Proc */
       String source;

       boolean isClass = false;

       /** The name of the target method (in case of class). */
       String methodName;

       /** wsad:ProcDetail/wsad:ReturnValue */
       RestLegacyParameter retVal = null;

       /** wsad:ProcDetail/wsad:Parameter */
       List<RestLegacyParameter> legacyParams;

       public RestOperation(String name, String verb, String consumes, String produces)
       {
          this.name = name;
          this.verb = verb;
          this.consumes = consumes;
          this.produces = produces;
       }

       /**
        * Find a mapping rule for the specified legacy parameter.
        * <p>
        * This rule will be used to identify what to use as the source (for INPUT) and what to
        * use as the target (for OUTPUT).
        *
        * @param    param
        *           The legacy parameter to match.
        */
       public RestParameterMappingRule findParameterMapping(RestLegacyParameter param)
       {
          String ruleSource = null;
          String ruleTarget = null;

          for (RestParameterMapping mapping : mappings)
          {
             for (RestParameterMappingRule rule : mapping.rules)
             {
                if (rule.matches(param, mapping.input))
                {
                   if (mapping.input)
                   {
                      if (ruleSource != null)
                      {
                         ruleSource = rule.source;
                      }
                      else
                      {
                         ruleSource = rule.source;
                         ruleTarget = rule.target;
                      }
                   }
                   else
                   {
                      if (ruleSource != null)
                      {
                         ruleTarget = rule.target;
                      }
                      else
                      {
                         ruleSource = rule.source;
                         ruleTarget = rule.target;
                      }
                   }
                }
             }
          }
          return ruleSource != null ? new RestParameterMappingRule(ruleSource, ruleTarget) : null;
       }
    }