# ContextLogRecord.java

    /*
    ** Module   : ContextLogRecord.java
    ** public abstract : Log record extending the original java class with FWD context.
    **
    ** Copyright (c) 2024, Golden Code Development Corporation.
    **
    ** -#- -I- --Date-- ----------------------------Description-----------------------------
    ** 001 GBB 20240725 Initial setup
    */
    /*
     ** 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.util.logging;

    import java.util.logging.*;

    /** Log record extending the original java class with FWD context. */
    public class ContextLogRecord extends LogRecord
    {
       /** The FWD context for the log record. */
       private LogContext logContext;

       /**
        * Public constructor matching the original java log record.
        *
        * @param    level
        *           The level of the log
        * @param    msg
        *           The message for the log.
        */
       public ContextLogRecord(Level level, String msg)
       {
          super(level, msg);
       }

       /**
        * Getter for {@link #logContext}.
        *
        * @return   See above.
        */
       public LogContext getLogContext()
       {
          return logContext;
       }

       /**
        * Setter for {@link #logContext}.
        *
        * @param    logContext
        *           The FWD context for the record.
        */
       public void setLogContext(LogContext logContext)
       {
          this.logContext = logContext;
       }

       /** The FWD context for the log record. */
       public static final class LogContext
       {
          /** The source process id. */
          private Long pid;

          /** The source thread name. */
          private String threadName;

          /** The source thread id. */
          private String threadId;

          /** The source FWD session id. */
          private String sessionId;

          /** The source FWD account. */
          private String fwdUser;

          /**
           * Getter for {@link #pid}.
           *
           * @return   See above.
           */
          public Long getPid()
          {
             return pid;
          }

          /**
           * Setter for {@link #pid}.
           *
           * @param    pid
           *           The source process id.
           */
          public void setPid(Long pid)
          {
             this.pid = pid;
          }

          /**
           * Getter for {@link #threadName}.
           *
           * @return   See above.
           */
          public String getThreadName()
          {
             return threadName;
          }

          /**
           * Setter for {@link #threadName}.
           *
           * @param    threadName
           *           The source thread name.
           */
          public void setThreadName(String threadName)
          {
             this.threadName = threadName;
          }

          /**
           * Getter for {@link #threadId}.
           *
           * @return   See above.
           */
          public String getThreadId()
          {
             return threadId;
          }

          /**
           * Setter for {@link #threadId}.
           *
           * @param    threadId
           *           The source thread ID.
           */
          public void setThreadId(String threadId)
          {
             this.threadId = threadId;
          }

          /**
           * Getter for {@link #sessionId}.
           *
           * @return   See above.
           */
          public String getSessionId()
          {
             return sessionId;
          }

          /**
           * Setter for {@link #sessionId}.
           *
           * @param    sessionId
           *           The source FWD session id.
           */
          public void setSessionId(String sessionId)
          {
             this.sessionId = sessionId;
          }

          /**
           * Getter for {@link #fwdUser}.
           *
           * @return   See above.
           */
          public String getFwdUser()
          {
             return fwdUser;
          }

          /**
           * Setter for {@link #fwdUser}.
           *
           * @param    fwdUser
           *           The source FWD account.
           */
          public void setFwdUser(String fwdUser)
          {
             this.fwdUser = fwdUser;
          }
       }
    }