CookieJarBuilder.java
/*
** Module : CookieJarBuilder.java
** Abstract : Implementation of the builtin class.
**
** Copyright (c) 2019-2023, Golden Code Development Corporation.
**
** -#- -I- --Date-- ---------------------------------------Description----------------------------------------
** 001 IAS 20190923 First version.
** 002 ME 20200410 Added missing build method and getCookieJar abstract.
** 003 MP 20200611 Added missing methods as stubs taken by converting the skeleton using FWD.
** 004 ME 20201028 Implement missing methods as of OE12.2.
** 005 CA 20210221 Fixed 'qualified', 'extent' and 'returns' annotations at the legacy signature.
** 006 ME 20210519 Fix registry lazy loading.
** ME 20210929 Fix function block for getRegistry.
** 007 CA 20230817 Removed ObjectOps.register, as this registration is handled by runtime.
** 008 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;
import static com.goldencode.p2j.util.BlockManager.externalProcedure;
import static com.goldencode.p2j.util.BlockManager.function;
import static com.goldencode.p2j.report.ReportConstants.*;
import static com.goldencode.p2j.util.BlockManager.internalProcedure;
import static com.goldencode.p2j.util.BlockManager.onBlockLevel;
import static com.goldencode.p2j.util.BlockManager.returnNormal;
import com.goldencode.p2j.oo.core.Assert;
import com.goldencode.p2j.oo.core.ISupportInitialize;
import com.goldencode.p2j.oo.lang.LegacyClass;
import com.goldencode.p2j.oo.lang._BaseObject_;
import com.goldencode.p2j.security.*;
import com.goldencode.p2j.util.*;
import com.goldencode.p2j.util.BlockManager.Action;
import com.goldencode.p2j.util.BlockManager.Condition;
import com.goldencode.p2j.util.InternalEntry.*;
/**
*
* Allows the construction of a working CookieJar via a fluent interface.
*
*/
@LegacyResource(resource = "OpenEdge.Net.HTTP.CookieJarBuilder")
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
public abstract class CookieJarBuilder
extends com.goldencode.p2j.oo.net.http.ConfigBuilder
{
protected static final String OPTION_PERSIST_TO = "cookieJarPath";
/** Registry */
@LegacySignature(type = Type.PROPERTY, name = "Registry")
private static ContextLocal<object<? extends BuilderRegistry>> registry = new ContextLocal<object<? extends BuilderRegistry>>()
{
/**
* Initial value
*/
@Override
protected object<? extends BuilderRegistry> initialValue()
{
object<? extends BuilderRegistry> registry = TypeFactory.object(BuilderRegistry.class);
return registry;
}
};
/**
* Get registry
*
* @return registry
*/
@LegacySignature(returns = "OBJECT", qualified = "OpenEdge.Net.HTTP.BuilderRegistry", type = Type.GETTER, name = "Registry")
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
public static object<? extends BuilderRegistry> getRegistry()
{
return function(CookieJarBuilder.class, "Registry", object.class, new Block((Body) () ->
{
if(!registry.get()._isValid())
{
registry.get().assign(ObjectOps.newInstance(BuilderRegistry.class));
registry.get().ref().put(new character(ObjectOps.getLegacyName(CookieJarBuilder.class)),
ObjectOps.getLegacyClass(DefaultCookieJarBuilder.class));
registry.get().ref().put(new character(ObjectOps.getLegacyName(ICookieJar.class)),
ObjectOps.getLegacyClass(CookieJar.class));
}
returnNormal(registry.get());
}));
}
/**
* Return a configured client
*
* @return a configured client.
*/
@LegacySignature(returns = "OBJECT", qualified = "OpenEdge.Net.HTTP.ICookieJar", type = Type.GETTER, name = "CookieJar")
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
public abstract object<? extends ICookieJar> getCookieJar();
/**
* Builder director method.
*
* @return A builder for the requested type.
*/
@LegacySignature(returns = "OBJECT", type = Type.METHOD, name = "Build", qualified = "OpenEdge.Net.HTTP.CookieJarBuilder")
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
public static object<? extends com.goldencode.p2j.oo.net.http.CookieJarBuilder> build()
{
object<? extends CookieJarBuilder> oCJB = TypeFactory.object(CookieJarBuilder.class);
return function(CookieJarBuilder.class, "Build", object.class, new Block((Body)() ->
{
object<? extends LegacyClass> oBuilderType = getRegistry().ref()
.get(new character(ObjectOps.getLegacyName(CookieJarBuilder.class)));
Assert.isType(oBuilderType, ObjectOps.getLegacyClass(CookieJarBuilder.class));
oCJB.assign(ObjectOps.newInstance(oBuilderType.ref().getType()));
if (oCJB._isValid() && oCJB.ref() instanceof ISupportInitialize)
((ISupportInitialize) oCJB.ref()).initialize();
returnNormal(oCJB);
}));
}
/**
* Execute method
*/
@LegacySignature(type = Type.EXECUTE)
public void __net_http_CookieJarBuilder_execute__()
{
onBlockLevel(Condition.ERROR, Action.THROW);
}
@LegacySignature(type = Type.CONSTRUCTOR)
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
public void __net_http_CookieJarBuilder_constructor__()
{
internalProcedure(CookieJarBuilder.class, this, "__net_http_CookieJarBuilder_constructor__", new Block((Body) () ->
{
super.__net_http_ConfigBuilder_constructor__();
}));
}
@LegacySignature(type = Type.CONSTRUCTOR)
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
public static void __net_http_CookieJarBuilder_constructor__static__()
{
externalProcedure(CookieJarBuilder.class, new Block((Body) () -> {
onBlockLevel(Condition.ERROR, Action.THROW);
}));
}
@LegacySignature(returns = "OBJECT", type = Type.METHOD, name = "PersistTo", qualified = "openedge.net.http.cookiejarbuilder", parameters =
{
@LegacyParameter(name = "pcCookieJarPath", type = "CHARACTER", mode = "INPUT")
})
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
public object<? extends CookieJarBuilder> persistTo(final character _pcCookieJarPath)
{
character pcCookieJarPath = TypeFactory.initInput(_pcCookieJarPath);
return function(CookieJarBuilder.class, this, "PersistTo", object.class, new Block((Body)() ->
{
Assert.notNullOrEmpty(pcCookieJarPath, new character("Cookie Jar Persistence Path"));
setOption(new character(OPTION_PERSIST_TO), pcCookieJarPath);
returnNormal(new object(this));
}));
}
@LegacySignature(returns = "OBJECT", type = Type.METHOD, name = "DecorateCookieJar", qualified = "openedge.net.http.icookiejar", parameters =
{
@LegacyParameter(name = "poDecorationType", type = "OBJECT", qualified = "progress.lang.class", mode = "INPUT"),
@LegacyParameter(name = "poDecoratedClient", type = "OBJECT", qualified = "openedge.net.http.icookiejar", mode = "INPUT")
})
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
public static object<? extends com.goldencode.p2j.oo.net.http.ICookieJar> decorateCookieJar(final object<? extends com.goldencode.p2j.oo.lang.LegacyClass> _poDecorationType, final object<? extends com.goldencode.p2j.oo.net.http.ICookieJar> _poDecoratedClient)
{
object<? extends com.goldencode.p2j.oo.lang.LegacyClass> poDecorationType = TypeFactory.initInput(_poDecorationType);
object<? extends com.goldencode.p2j.oo.net.http.ICookieJar> poDecoratedClient = TypeFactory.initInput(_poDecoratedClient);
object<? extends com.goldencode.p2j.oo.net.http.ICookieJar> decoratedClient = TypeFactory.object(ICookieJar.class);
return function(CookieJarBuilder.class, "DecorateCookieJar", object.class, new Block((Body)() ->
{
object<? extends LegacyClass> oType = getRegistry().ref()
.get(poDecorationType.ref().getTypeName());
if (!oType._isValid())
returnNormal(poDecoratedClient);
Assert.isType(oType, ObjectOps.getLegacyClass(CookieJarDecorator.class));
decoratedClient.assign(ObjectOps.newInstance(oType.ref().getType(), "I", poDecoratedClient));
if (decoratedClient._isValid() && decoratedClient.ref() instanceof ISupportInitialize)
((ISupportInitialize) decoratedClient.ref()).initialize();
returnNormal(decoratedClient);
}));
}
}