001/*
002 * jPOS Project [http://jpos.org]
003 * Copyright (C) 2000-2026 jPOS Software SRL
004 *
005 * This program is free software: you can redistribute it and/or modify
006 * it under the terms of the GNU Affero General Public License as
007 * published by the Free Software Foundation, either version 3 of the
008 * License, or (at your option) any later version.
009 *
010 * This program is distributed in the hope that it will be useful,
011 * but WITHOUT ANY WARRANTY; without even the implied warranty of
012 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
013 * GNU Affero General Public License for more details.
014 *
015 * You should have received a copy of the GNU Affero General Public License
016 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
017 */
018
019package org.jpos.log.evt;
020
021import com.fasterxml.jackson.annotation.JsonInclude;
022import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlProperty;
023import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlText;
024
025/**
026 * Record representing the output of a process, encapsulating the process name,
027 * standard output, and optionally standard error.
028 *
029 * <p>This record makes use of Jackson annotations to control the serialization
030 * and deserialization process. The {@code name} field is serialized as an
031 * attribute with the local name "name". The {@code stdout} field is serialized
032 * as XML text. The {@code stderr} field is included in the JSON output only if
033 * it is non-null.
034 *
035 * @param name   the name of the process, serialized as an XML attribute with the local name "name"
036 * @param stdout the standard output of the process, serialized as XML text
037 * @param stderr the standard error of the process, included in JSON output only if non-null
038 */
039public record ProcessOutput(
040  @JacksonXmlProperty(isAttribute = true, localName = "name") String name,
041  @JacksonXmlText String stdout,
042  @JsonInclude(JsonInclude.Include.NON_NULL) String stderr)
043{ }