ContentTypeHeader.java
/*
** Module : ContentTypeHeader.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 20201127 Log info for invalid media types (no error).
** 20201204 Use internalProcedure block for error handling.
** 003 CA 20210221 Fixed 'qualified', 'extent' and 'returns' annotations at the legacy
** signature.
** VVT 20210917 Javadoc fixed.
** 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 java.util.Collections;
import java.util.HashSet;
import java.util.Set;
import static com.goldencode.p2j.report.ReportConstants.*;
import static com.goldencode.p2j.util.BlockManager.*;
import com.goldencode.p2j.oo.lang.AppError;
import com.goldencode.p2j.oo.logging.IlogWriter;
import com.goldencode.p2j.oo.logging.VoidLogger;
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.*;
/**
*
* Content-Type header
*
*/
@LegacyResource(resource = "OpenEdge.Net.HTTP.ContentTypeHeader")
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL| RT_LVL_FULL)
public class ContentTypeHeader extends HttpHeader
{
/** Valid Content-Type values */
private static final Set<String> VALID_TYPES = Collections.unmodifiableSet(
new HashSet<String>()
{{
add("application");
add("audio");
add("image");
// add("font");
// add("example");
add("message");
//add("model");
add("multipart");
add("text");
add("video");
}}
);
/** Header name. */
@LegacySignature(type = Type.PROPERTY, name = "Logger")
protected object<? extends IlogWriter> logger = TypeFactory.object(IlogWriter.class);
/**
* Execute method.
*/
@LegacySignature(type = Type.EXECUTE)
public void __net_http_ContentTypeHeader_execute__()
{
onBlockLevel(Condition.ERROR, Action.THROW);
}
/**
* Constructor.
* @param name header name.
*/
@LegacySignature(type = Type.CONSTRUCTOR, parameters = {
@LegacyParameter(name = "name", type = "CHARACTER", mode = "INPUT") })
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
public void __net_http_ContentTypeHeader_constructor__(final character name)
{
internalProcedure(ContentTypeHeader.class, this, "__net_http_ContentTypeHeader_constructor__", new Block((Body) () ->
{
__net_http_HttpHeader_constructor__(name);
this.paramDelimiter.assign(new character(";"));
}));
}
/**
* Constructor.
*
* @param name header name.
* @param val header value.
*/
@LegacySignature(type = Type.CONSTRUCTOR, parameters = {
@LegacyParameter(name = "name", type = "CHARACTER", mode = "INPUT"),
@LegacyParameter(name = "val", type = "CHARACTER", mode = "INPUT") })
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
public void __net_http_ContentTypeHeader_constructor__(final character name,
final character val)
{
internalProcedure(ContentTypeHeader.class, this, "__net_http_ContentTypeHeader_constructor__", new Block((Body) () ->
{
__net_http_HttpHeader_constructor__(name, val);
}));
}
/**
* Validates a header value
*
* @param val header value to be validated.
*/
@LegacySignature(type = Type.METHOD, name = "Validate", parameters = {
@LegacyParameter(name = "val", type = "CHARACTER", mode = "INPUT") })
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
@Override
protected void validate(final character val)
{
internalProcedure(ContentTypeHeader.class, this, "Validate", new Block((Body) () -> {
super.validate(val);
String sval = val.getValue();
if (sval != null && !sval.trim().isEmpty())
{
sval = TextOps.entries(sval, this.paramDelimiter.getValue())[0];
int sTypeIdx = sval.indexOf('/');
if (sTypeIdx == -1)
{
String msg = String.format(
"Header value must have at least 2 \"/\"-delimited parts: %s", sval);
undoThrow(AppError.newInstance(msg, 0));
}
String type = sval.substring(0, sTypeIdx);
if (!VALID_TYPES.contains(type.toLowerCase()))
{
getLogger().ref().info(TextOps
.substitute("Content-Type header has a non-standard type of &1", type));
}
}
}));
}
@LegacySignature(returns = "LOGICAL", type = Type.METHOD, name = "SetParameterValue", parameters = {
@LegacyParameter(name = "name", type = "CHARACTER", mode = "INPUT"),
@LegacyParameter(name = "val", type = "CHARACTER", mode = "INPUT") })
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
@Override
public logical setParameterValue(character name, character val)
{
// boundary value is unquoted (double quote only)
if ("boundary".equalsIgnoreCase(name.getValue()))
{
String sVal = val.getValue();
if (sVal.startsWith("\"") && sVal.endsWith("\""))
val.assign(sVal.substring(1, sVal.length() - 1));
}
return super.setParameterValue(name, val);
}
/**
* Get the logger.
*
* @return The logger.
*/
@LegacySignature(returns = "OBJECT", qualified = "OpenEdge.Logging.ILogWriter", type = Type.GETTER, name = "Logger")
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
public object<? extends IlogWriter> getLogger()
{
if (!this.logger._isValid())
this.logger.assign(ObjectOps.newInstance(VoidLogger.class));
return this.logger;
}
/**
* Set the logger.
*
* @param logger the logger instance
*/
@LegacySignature(type = Type.SETTER, name = "Logger", parameters = {
@LegacyParameter(qualified = "OpenEdge.Logging.ILogWriter", name = "logger", type = "OBJECT", mode = "INPUT") })
@LegacyResourceSupport(supportLvl = CVT_LVL_FULL | RT_LVL_FULL)
public void setLogger(object<? extends IlogWriter> logger)
{
this.logger.assign(logger);
}
}