CookieJarDecorator.java
/*
** Module : CookieJarDecorator.java
** Abstract : Implementation of the builtin class.
**
** Copyright (c) 2019-2023, Golden Code Development Corporation.
**
** -#- -I- --Date-- -------------------------------Description--------------------------------
** 001 MP 20200603 Added stubs taken by converting the skeleton using FWD
** 002 ME 20201028 Implement as per OE12.2.
** 003 CA 20210221 Fixed 'qualified', 'extent' and 'returns' annotations at the legacy
** signature.
** CA 20210609 Updated INPUT/INPUT-OUTPUT parameters to the new approach, where they are explicitly
** initialized at the method's execution, and not at the caller's arguments.
** 004 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 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 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/CookieJarDecorator.cls).
*/
@LegacyResource(resource = "OpenEdge.Net.HTTP.CookieJarDecorator")
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
public abstract class CookieJarDecorator
extends BaseObject
implements com.goldencode.p2j.oo.net.http.ICookieJar
{
@LegacySignature(type = Type.PROPERTY, name = "DecoratedCookieJar")
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
private object<? extends com.goldencode.p2j.oo.net.http.ICookieJar> decoratedCookieJar =
TypeFactory.object(com.goldencode.p2j.oo.net.http.ICookieJar.class);
@LegacySignature(type = Type.EXECUTE)
public void __net_http_CookieJarDecorator_execute__()
{
onBlockLevel(Condition.ERROR, Action.THROW);
}
@LegacySignature(returns = "OBJECT", qualified = "OpenEdge.Net.HTTP.ICookieJar", type = Type.GETTER, name = "DecoratedCookieJar")
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
protected object<? extends com.goldencode.p2j.oo.net.http.ICookieJar> getDecoratedCookieJar()
{
return function(CookieJarDecorator.class, this, "DecoratedCookieJar", object.class, new Block((Body) () ->
{
returnNormal(decoratedCookieJar);
}));
}
@LegacySignature(returns = "CHARACTER", type = Type.GETTER, name = "CookieJarPath")
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
public character getCookieJarPath()
{
return function(CookieJarDecorator.class, this, "CookieJarPath", character.class, new Block((Body) () ->
{
returnNormal(decoratedCookieJar.ref().getCookieJarPath());
}));
}
@LegacySignature(type = Type.SETTER, name = "CookieJarPath", parameters =
{
@LegacyParameter(name = "var", type = "CHARACTER", mode = "INPUT")
})
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
public void setCookieJarPath(final character _var)
{
internalProcedure(CookieJarDecorator.class, this, "CookieJarPath", new Block((Body) () ->
{
decoratedCookieJar.ref().setCookieJarPath(_var);
}));
}
@LegacySignature(type = Type.CONSTRUCTOR, parameters =
{
@LegacyParameter(name = "poCookieJar", type = "OBJECT", qualified = "openedge.net.http.icookiejar", mode = "INPUT")
})
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
public void __net_http_CookieJarDecorator_constructor__(final object<? extends com.goldencode.p2j.oo.net.http.ICookieJar> _poCookieJar)
{
object<? extends com.goldencode.p2j.oo.net.http.ICookieJar> poCookieJar = TypeFactory.initInput(_poCookieJar);
internalProcedure(CookieJarDecorator.class, this, "__net_http_CookieJarDecorator_constructor__", new Block(
(Body) () ->
{
__lang_BaseObject_constructor__();
Assert.notNull(poCookieJar, new character("Cookie Jar"));
this.decoratedCookieJar.assign(poCookieJar);
}));
}
@LegacySignature(returns = "INTEGER", type = Type.METHOD, name = "GetCookies", parameters =
{
@LegacyParameter(name = "poUri", type = "OBJECT", qualified = "openedge.net.uri", mode = "INPUT"),
@LegacyParameter(name = "poCookies", type = "OBJECT", extent = -1, qualified = "openedge.net.http.cookie", mode = "OUTPUT")
})
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
public integer getCookies(
final object<? extends com.goldencode.p2j.oo.net.Uri> _poUri,
final OutputExtentParameter<object<? extends com.goldencode.p2j.oo.net.http.Cookie>> _extpoCookies)
{
object[][] extpoCookies = { TypeFactory.initOutput(_extpoCookies) };
return function(CookieJarDecorator.class, this, "GetCookies", integer.class, new Block((Body) () ->
{
returnNormal(decoratedCookieJar.ref().getCookies(_poUri, new OutputExtentParameter<object<? extends com.goldencode.p2j.oo.net.http.Cookie>>()
{
@Override
public object<? extends com.goldencode.p2j.oo.net.http.Cookie>[] getVariable()
{
return extpoCookies[0];
}
@Override
public void setVariable(object<? extends com.goldencode.p2j.oo.net.http.Cookie>[] reference)
{
extpoCookies[0] = reference;
}
}));
}));
}
@LegacySignature(type = Type.METHOD, name = "AddCookie", parameters =
{
@LegacyParameter(name = "poCookie", type = "OBJECT", qualified = "openedge.net.http.cookie", mode = "INPUT")
})
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
public void addCookie(final object<? extends com.goldencode.p2j.oo.net.http.Cookie> _poCookie)
{
object<? extends com.goldencode.p2j.oo.net.http.Cookie> poCookie = TypeFactory.initInput(_poCookie);
internalProcedure(CookieJarDecorator.class, this, "AddCookie", new Block((Body) () ->
{
// for whatever reason this is not a straight pass-through
Assert.notNull(poCookie, new character("Cookie"));
addCookie(poCookie.ref().getDomain(), poCookie.ref().getPath(), poCookie);
}));
}
@LegacySignature(type = Type.METHOD, name = "AddCookie", parameters =
{
@LegacyParameter(name = "pcDomain", type = "CHARACTER", mode = "INPUT"),
@LegacyParameter(name = "pcPath", type = "CHARACTER", mode = "INPUT"),
@LegacyParameter(name = "poCookie", type = "OBJECT", qualified = "openedge.net.http.cookie", mode = "INPUT")
})
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
public void addCookie(
final character _pcDomain,
final character _pcPath,
final object<? extends com.goldencode.p2j.oo.net.http.Cookie> _poCookie)
{
internalProcedure(CookieJarDecorator.class, this, "AddCookie", new Block((Body) () ->
{
decoratedCookieJar.ref().addCookie(_pcDomain, _pcPath, _poCookie);
}));
}
@LegacySignature(returns = "LOGICAL", type = Type.METHOD, name = "RemoveCookie", parameters =
{
@LegacyParameter(name = "poCookie", type = "OBJECT", qualified = "openedge.net.http.cookie", mode = "INPUT")
})
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
public logical removeCookie(final object<? extends com.goldencode.p2j.oo.net.http.Cookie> _poCookie)
{
return function(CookieJarDecorator.class, this, "RemoveCookie", logical.class, new Block((Body) () ->
{
returnNormal(decoratedCookieJar.ref().removeCookie(_poCookie));
}));
}
@LegacySignature(type = Type.METHOD, name = "AddCookies", parameters =
{
@LegacyParameter(name = "poCookies", type = "OBJECT", extent = -1, qualified = "openedge.net.http.cookie", mode = "INPUT")
})
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
public void addCookies(final object<? extends com.goldencode.p2j.oo.net.http.Cookie>[] _poCookies)
{
internalProcedure(CookieJarDecorator.class, this, "AddCookies", new Block((Body) () ->
{
// in 4GL this goes in a loop, probably calls itself instead of method from decorated jar
decoratedCookieJar.ref().addCookies(_poCookies);
}));
}
@LegacySignature(type = Type.METHOD, name = "ClearSessionCookies")
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
public void clearSessionCookies()
{
internalProcedure(CookieJarDecorator.class, this, "ClearSessionCookies", new Block((Body) () ->
{
decoratedCookieJar.ref().clearSessionCookies();;
}));
}
@LegacySignature(type = Type.METHOD, name = "ClearPersistentCookies")
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL|RT_LVL_FULL)
public void clearPersistentCookies()
{
internalProcedure(CookieJarDecorator.class, this, "ClearPersistentCookies", new Block((Body) () ->
{
decoratedCookieJar.ref().clearPersistentCookies();
}));
}
}