MessagePart.java

/*
** Module   : MessagePart.java
** Abstract : Implementation of the builtin class.
**
** Copyright (c) 2019-2023, Golden Code Development Corporation.
**
** -#- -I- --Date-- ---------------------------------------Description---------------------------------------
** 001 CA  20190526 First version, stubs taken by converting the skeleton using FWD.
** 002 IAS 20190527 Added multipart support.
** 003 CA  20191024 Added method support levels and updated the class support level.
** 004 ME  20200413 Clean-up and fix toString legacy method.
**         20201125 Set header value 'fluent', use substitute for toString. 
** 005 CA  20210221 Fixed 'qualified', 'extent' and 'returns' annotations at the legacy signature.
**     OM  20210917 Code maintenance.
**     CA  20220120 Do not used TypeFactory.object when the OO reference must not be tracked or registered.
**                  Do not use TypeFactory.object for internal usages, use ObjectVar if the reference must 
**                  be tracked.
**                  All TypeFactory.object variable definitions must be done outside of the top-level block.
**     ME  20210929 Add body to string representation (if valid).
** 006 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;

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.lang.*;
import com.goldencode.p2j.oo.net.http.*;

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

/**
 * Business logic (converted to Java from the 4GL source code
 * in OpenEdge/Net/MessagePart.cls).
 */
@LegacyResource(resource = "OpenEdge.Net.MessagePart")
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
public class MessagePart
extends BaseObject
{
   /** Part body */
   private object<? extends _BaseObject_> body = TypeFactory.object(_BaseObject_.class);

   /** Part headers */
   private object<? extends HttpHeaderCollection> headers = 
         TypeFactory.object(HttpHeaderCollection.class);

   /**
    * Execute method
    */
   @LegacySignature(type = Type.EXECUTE)
   public void __net_MessagePart_execute__()
   {
      onBlockLevel(Condition.ERROR, Action.THROW);
   }

   /**
    * Get body
    * 
    * @return body
    */
   @LegacySignature(returns = "OBJECT", qualified = "Progress.Lang.Object", type = Type.GETTER, name = "Body")
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
   public object<? extends _BaseObject_> getBody()
   {
      return function(this, "Body", object.class, new Block((Body) () -> 
      {
         returnNormal(body);
      }));
   }

   /**
    * Set body
    * @param _var body
    */
   @LegacySignature(type = Type.SETTER, name = "Body", parameters = 
   {
      @LegacyParameter(qualified = "Progress.Lang.Object", name = "var", type = "OBJECT", mode = "INPUT")
   })
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
   public void setBody(final object<? extends _BaseObject_> _var)
   {
      object<? extends _BaseObject_> var = TypeFactory.initInput(_var);
      
      internalProcedure(this, "Body", new Block((Body) () -> 
      {
         if (var.isValid().booleanValue())
         {
            if (ObjectOps.typeOf(var, ISupportEncoding.class).booleanValue())
            {
               character encoding = ObjectOps.cast(var, ISupportEncoding.class).ref().
                     getEncoding();
               if (!encoding.isUnknown())
               {
                  headers.ref().get(new character("Content-Type")).ref().
                     setParameterValue(new character("charset"), encoding);
               }
            }
            if (ObjectOps.typeOf(var, ISupportMultipartEntity.class).booleanValue())
            {
               headers.ref().get(new character("Content-Type")).ref().
                  setParameterValue(new character("boundary"),
                        ObjectOps.cast(var, ISupportMultipartEntity.class).ref().getBoundary()
                  );
            }
         }
         body.assign(var);
      }));
   }

   /**
    * Get contentId
    * 
    * @return contentId
    */
   @LegacySignature(returns = "CHARACTER", type = Type.GETTER, name = "ContentId")
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
   public character getContentId()
   {
      return function(this, "ContentId", character.class, new Block((Body) () -> 
      {
         if (headers.ref().has(new character("Content-ID")).booleanValue())
         {
            returnNormal(headers.ref().get(new character("Content-ID")).ref().getBaseValue());
         }
         returnNormal(new character(""));
      }));
   }

   /**
    * Set contentId
    * 
    * @param _var contentId
    */
   @LegacySignature(type = Type.SETTER, name = "ContentId", parameters = 
   {
      @LegacyParameter(name = "var", type = "CHARACTER", mode = "INPUT")
   })
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
   public void setContentId(final character _var)
   {
      character var = TypeFactory.initInput(_var);
      object<? extends HttpHeader> hdr = TypeFactory.object(HttpHeader.class); 
      
      internalProcedure(this, "ContentId", new Block((Body) () -> 
      {
         character hdrn = new character("Content-ID");
         Assert.notNull(var, hdrn);
         if (headers.ref().has(hdrn).booleanValue())
         {
            hdr.assign(headers.ref().get(hdrn));
         }
         else 
         {
            hdr.assign(HttpHeaderBuilder.build(hdrn).ref().getHeader());
            headers.ref().put(hdr);
         }
         hdr.ref().setValue(var);
      }));
   }

   /**
    * Get ContentType
    * 
    * @return ContentType
    */
   @LegacySignature(returns = "CHARACTER", type = Type.GETTER, name = "ContentType")
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
   public character getContentType()
   {
      return function(this, "ContentType", character.class, new Block((Body) () -> 
      {
         if (headers.ref().has(new character("Content-Type")).booleanValue())
         {
            returnNormal(headers.ref().get(new character("Content-Type")).ref().getBaseValue());
         }
         returnNormal(new character(""));
      }));
   }

   /**
    * Set ContentType
    * 
    * @param _var ContentType
    */
   @LegacySignature(type = Type.SETTER, name = "ContentType", parameters = 
   {
      @LegacyParameter(name = "var", type = "CHARACTER", mode = "INPUT")
   })
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
   public void setContentType(final character _var)
   {
      character var = TypeFactory.initInput(_var);
      object<? extends HttpHeader> hdr = TypeFactory.object(HttpHeader.class); 
      
      internalProcedure(this, "ContentType", new Block((Body) () -> 
      {
         character hdrn = new character("Content-Type");
         Assert.notNull(var, hdrn);
         
         if (headers.ref().has(hdrn).booleanValue())
         {
            headers.ref().get(hdrn).ref().setValue(var);
         }
         else 
         {
            hdr.assign(HttpHeaderBuilder.build(hdrn).ref().value(var).ref().getHeader());
            headers.ref().put(hdr);
         }
      }));
   }

   /**
    * Get headers
    * 
    * @return headers
    */
   @LegacySignature(returns = "OBJECT", qualified = "OpenEdge.Net.HTTP.HttpHeaderCollection", type = Type.GETTER, name = "Headers")
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
   public object<? extends HttpHeaderCollection> getHeaders()
   {
      return function(this, "Headers", object.class, new Block((Body) () -> 
      {
         returnNormal(headers);
      }));
   }

   /**
    * Set headers
    * 
    * @param _var headers
    */
   @LegacySignature(type = Type.SETTER, name = "Headers", parameters = 
   {
      @LegacyParameter(qualified = "OpenEdge.Net.HTTP.HttpHeaderCollection", name = "var", type = "OBJECT", mode = "INPUT")
   })
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
   public void setHeaders(final object<? extends HttpHeaderCollection> _var)
   {
      object<? extends HttpHeaderCollection> var = TypeFactory.initInput(_var);
      
      internalProcedure(this, "Headers", new Block((Body) () -> 
      {
         headers.assign(var);
      }));
   }

   /**
    * Constructor.
    */
   @LegacySignature(type = Type.CONSTRUCTOR)
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
   public void __net_MessagePart_constructor__()
   {
      internalProcedure(this, "__net_MessagePart_constructor__", new Block((Body) () -> 
      {
         __net_MessagePart_constructor__(new character("text/plain"));
      }));
   }

   /**
    * Constructor
    * @param _contentType ContentType
    */
   @LegacySignature(type = Type.CONSTRUCTOR, parameters = 
   {
      @LegacyParameter(name = "contentType", type = "CHARACTER", mode = "INPUT")
   })
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
   public void __net_MessagePart_constructor__(final character _contentType)
   {
      character contentType = TypeFactory.initInput(_contentType);
      
      internalProcedure(this, "__net_MessagePart_constructor__", new Block((Body) () -> 
      {
         Assert.notNull(contentType, new character("Content type"));
         __lang_BaseObject_constructor__();
         this.headers.assign(ObjectOps.newInstance(HttpHeaderCollection.class));
         setContentType(contentType);
         
      }));
   }

   /**
    * Constructor.
    * 
    * @param _contentType ContentType
    * @param _body body
    */
   @LegacySignature(type = Type.CONSTRUCTOR, parameters = 
   {
      @LegacyParameter(name = "contentType", type = "CHARACTER", mode = "INPUT"),
      @LegacyParameter(name = "body", type = "OBJECT", 
            qualified = "progress.lang.object", mode = "INPUT")
   })
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
   public void __net_MessagePart_constructor__(final character _contentType, 
         final object<? extends _BaseObject_> _body)
   {
      character contentType = TypeFactory.initInput(_contentType);
      object<? extends _BaseObject_> body = TypeFactory.initInput(_body);
      
      internalProcedure(this, "__net_MessagePart_constructor__", new Block((Body) () -> 
      {
         __net_MessagePart_constructor__(contentType);
         Assert.notNull(body, new character("Part body"));
         setBody(body);
      }));
   }

   /**
    * Convert to string.
    *
    * @return string representation.
    */
   @LegacySignature(returns = "CHARACTER", type = Type.METHOD, name = "ToString")
   @Override
   @LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
   public character toLegacyString()
   {
      return function(this, "ToString", character.class, new Block((Body) () ->
      {
         returnNormal(TextOps.substitute("&1_&2", getContentType(), body._isValid() ? body.ref().toLegacyString() : handle.resourceId(ObjectOps.asResource(this))));
      }
      ));
   }
}