RestParameterMappingRule.java

/*
** Module   : RestParameterMappingRule.java
** Abstract : Defines a rule for parameter mapping, from mapping.xml.
**
** Copyright (c) 2019-2024, Golden Code Development Corporation.
**
** -#- -I- --Date-- --------------------------------------Description---------------------------------------
** 001 CA  20190614 First version.
** 002 CA  20200427 String comparison is with equals(), not = operator.
** 003 GES 20200726 Added input-output mode support.
** 004 CA  20240830 Updated the finding of mapping rules for input-output parameters.
** 005 CA  20240925 Fixed regression in H004 - the target is used to match INPUT or INPUT-OUTPUT parameters 
**                  only if this rule was from an input mapping.
*/

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

/**
 * From the <code>mapping.xml</code> file, holds a pair of source and target values, defining
 * the mapping rule, as set in the 
 * <code>conditional:conditionalRuleSet/conditional:if/mapping:rule</code> XML node.
 */
class RestParameterMappingRule
{
   /** mapping.xml conditional:conditionalRuleSet/conditional:if/mapping:rule[source]. */
   final String source;
   
   /** mapping.xml conditional:conditionalRuleSet/conditional:if/mapping:rule[target]. */
   final String target;
   
   /**
    * Initialize this instance.
    * 
    * @param    source
    *           The mapping source.
    * @param    target
    *           The mapping target.
    */
   public RestParameterMappingRule(String source, String target)
   {
      this.source = source;
      this.target = target;
   }

   /**
    * Check if the parameter matches this rule - for this to match, the source (or target),
    * depending on parameter's mode, must have the <code>idl.param[legacy-name]</code>, 
    * where <code>legacy-name</code> is the argument's legacy name.
    * 
    * @param    param
    *           The parameter to check.
    * @param    forInput
    *           Flag indicating if the check is done for an input mapping, or output otherwise.
    *           
    * @return   <code>true</code> if the rule is for the specified parameter.
    */
   public boolean matches(RestLegacyParameter param, boolean forInput)
   {
      boolean input = forInput && (param.mode.equals("I") || param.mode.equals("U"));
      
      String check = (input ? target : source);
      
      return check.indexOf(String.format("idl.param['%s']", param.name)) >= 0 || 
             check.equalsIgnoreCase(param.name);
   }
}