IELegacyService.java

/*
** Module   : IELegacyService.java
** Abstract : Base class for defining a REST or SOAP service targeting an internal entry.
**
** Copyright (c) 2020-2022, Golden Code Development Corporation.
**
** -#- -I- --Date-- ---------------------------------------Description----------------------------------------
** 001 CA  20200514 First version.
** 002 CA  20220405 Added authentication and authorization for web requests.  When this is enabled, the target
**                  API call will be executed under the authenticated FWD context, and not the agent's context.
*/

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

import com.goldencode.p2j.util.*;

/**
 * Base class to invoke REST or SOAP services mapped to an internal entry (procedure, function). 
 */
public abstract class IELegacyService
extends ProgRestService
{
   /** The internal entry name. */
   protected final String iename;
   
   /** Flag identifying if we are invoking a function. */
   protected final boolean function;
   
   /** The annotation at the service resource (i.e. the converted Java class). */
   protected final LegacyService parent;
   
   /**
    * Initialize with the details for an internal entry invocation.
    * 
    * @param    ls
    *           The annotation at the Java class (defining the resource).
    * @param    pname
    *           The external program name.
    * @param    iels
    *           The annotation at the Java method (defining the operation).
    * @param    ie
    *           The target {@link InternalEntry} for this service.
    * @param    function
    *           Flag identifying if we are invoking a function.
    * @param    key
    *           The service key.
    * @param    timeout
    *           The invocation timeout.
    */
   public IELegacyService(LegacyService ls,
                          String        pname, 
                          LegacyService iels, 
                          InternalEntry ie, 
                          boolean       function,
                          ServiceKey    key,
                          int           timeout)
   {
      super(iels, pname, ie.getMethod(), key, timeout);

      this.parent = ls;
      this.iename = ie.getLegacyName();
      this.function = function;
   }
   
   /**
    * Invoke this service.
    * 
    * @param    helper
    *           The appserver helper used to execute the requests.
    * @param    token
    *           When not null, it represents the token of a FWD context created for an authenticated and 
    *           authorized web service call.  The API call will be performed in that context.
    * @param    args
    *           The arguments.
    *           
    * @return   The returned value.
    */
   @Override
   public abstract Object invoke(AppServerHelper helper, String token, Object[] args);
   
   /**
    * Get the execution mode for this service.
    * 
    * @return   See above.
    */
   @Override
   public String getExecutionMode()
   {
      return parent.executionMode();
   }

   /**
    * Get the {@link Parameter}s as they are defined at the internal entry.
    * 
    * @return   See above.
    */
   @Override
   protected List<Parameter> getParameters()
   {
      return SourceNameMapper.getParameters(pname, null, iename, function);
   }
}