AuthFilterEventHandlerWrapper.java

/*
** Module   : AuthFilterEventHandlerWrapper.java
** Abstract : Built-in class.
**
** Copyright (c) 2019-2023, Golden Code Development Corporation.
**
** -#- -I- --Date-- -------------------------------Description--------------------------------
** 001 ME  20200508 First version.
**         20201127 Fix error messages to avoid truncation of character (default format X8).
**         20201204 Use compare for lookup value to account for unknown internal entries (proxy procedures).
** 002 CA  20210221 Fixed 'qualified', 'extent' and 'returns' annotations at the legacy
**                  signature.
**     VVT 20221003 CommonHandle.getResourceType() method renamed to resourceType() to prevent conflicts
**                  with namesakes in DMO. See #6694.
** 003 CA  20231113 The 'execute' method must be annotated with LegacySignature Type.Execute, and also can be
**                  dropped if is a no-op.
*/

/*
** 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.oo.net.http.filter.auth;

import com.goldencode.p2j.util.*;
import com.goldencode.p2j.util.BlockManager.Action;
import com.goldencode.p2j.util.BlockManager.Condition;
import com.goldencode.p2j.oo.core.Assert;
import com.goldencode.p2j.oo.core.AssertionFailedError;
import com.goldencode.p2j.oo.lang.*;
import com.goldencode.p2j.oo.lang._BaseObject_;
import com.goldencode.p2j.oo.net.http.AuthenticationRequestEventArgs;

import static com.goldencode.p2j.report.ReportConstants.*;
import static com.goldencode.p2j.util.BlockManager.*;
import static com.goldencode.p2j.util.InternalEntry.Type;

/**
 * Business logic (converted to Java from the 4GL source code
 * in OpenEdge/Net/HTTP/Filter/Auth/AuthFilterEventHandlerWrapper.cls).
 */
@LegacyResource(resource = "OpenEdge.Net.HTTP.Filter.Auth.AuthFilterEventHandlerWrapper")
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
public class AuthFilterEventHandlerWrapper extends BaseObject implements IauthFilterEventHandler
{
   private static final String eventHandlerName = "AuthFilter_HttpCredentialRequestHandler";
   private static final String eventHandlerSig = "PROCEDURE,,INPUT poSender Progress.Lang.Object,INPUT poEventArgs OpenEdge.Net.HTTP.AuthenticationRequestEventArgs";
   private static final String eventHandlerInterface = "OpenEdge.Net.HTTP.Filter.Auth.IAuthFilterEventHandler";

   @LegacySignature(type = Type.PROPERTY, name = "Callback")
   private handle callback = TypeFactory.handle();

   @LegacySignature(type = Type.EXECUTE)
   public void __net_http_filter_auth_AuthFilterEventHandlerWrapper_execute__()
   {
      onBlockLevel(Condition.ERROR, Action.THROW);
   }

   @LegacySignature(returns = "HANDLE", type = Type.GETTER, name = "Callback")
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
   public handle getCallback()
   {
      return function(AuthFilterEventHandlerWrapper.class, this, "Callback", handle.class,
               new Block((Body) () ->
               {
                  returnNormal(callback);
               }));
   }

   @LegacySignature(type = Type.CONSTRUCTOR, parameters = {
            @LegacyParameter(name = "phCallbackProcedure", type = "HANDLE", mode = "INPUT") })
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
   public void __net_http_filter_auth_AuthFilterEventHandlerWrapper_constructor__(
            final handle _phCallbackProcedure)
   {
      handle phCallbackProcedure = TypeFactory.initInput(_phCallbackProcedure);

      internalProcedure(AuthFilterEventHandlerWrapper.class, this,
               "__net_http_filter_auth_AuthFilterEventHandlerWrapper_constructor__",
               new Block((Body) () ->
               {
                  __lang_BaseObject_constructor__();
                  Assert.notNull(phCallbackProcedure, new character("Callback"));

                  if (!phCallbackProcedure.isType(LegacyResource.PROCEDURE))
                     returnError(ObjectOps.newInstance(AssertionFailedError.class, "II",
                              "Callback is not a procedure handle (is of type )"
                                       + phCallbackProcedure.unwrapType().resourceType().getValue(),
                              0));

                  PersistentProcedure hProc = phCallbackProcedure.unwrapProcedure();

                  if (CompareOps._isEqual(TextOps.lookup(eventHandlerName, hProc.internalEntries()), 0))
                     returnError(AppError.newInstance(String.format(
                              "Unable to find event handle procedure \"%s\" in callback procedure %s",
                              eventHandlerName, hProc.getFileName().getValue()), 0));

                  if (!eventHandlerSig
                           .equalsIgnoreCase(hProc.getSignature(eventHandlerName).getValue()))
                     returnError(AppError.newInstance(String.format(
                              "The signature of %s in %s does not match the interface definition in %s",
                              eventHandlerName, hProc.getFileName().getValue(), eventHandlerInterface), 0));

                  callback.assign(phCallbackProcedure);
               }));
   }

   @LegacySignature(type = Type.METHOD, name = "AuthFilter_HttpCredentialRequestHandler", parameters = {
            @LegacyParameter(name = "poSender", type = "OBJECT", qualified = "progress.lang.object", mode = "INPUT"),
            @LegacyParameter(name = "poEventArgs", type = "OBJECT", qualified = "openedge.net.http.authenticationrequesteventargs", mode = "INPUT") })
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
   public void authFilterHttpCredentialRequestHandler(
            final object<? extends _BaseObject_> _poSender,
            final object<? extends AuthenticationRequestEventArgs> _poEventArgs)
   {
      object<? extends _BaseObject_> poSender = TypeFactory.initInput(_poSender);
      object<? extends AuthenticationRequestEventArgs> poEventArgs = TypeFactory
               .initInput(_poEventArgs);

      internalProcedure(AuthFilterEventHandlerWrapper.class, this,
               "AuthFilter_HttpCredentialRequestHandler", new Block((Body) () ->
               {
                  ControlFlowOps.invokeIn(eventHandlerName, callback, poSender, poEventArgs);
               }));
   }
}