org.mycore.common.log4j2.MCRSessionThreadContext Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of mycore-base Show documentation

There is a newer version: 2024.05

/*
 * This file is part of ***  M y C o R e  ***
 * See http://www.mycore.de/ for details.
 *
 * MyCoRe is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * MyCoRe 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with MyCoRe.  If not, see .
 */

package org.mycore.common.log4j2;

import org.apache.logging.log4j.ThreadContext;
import org.mycore.common.MCRSession;
import org.mycore.common.events.MCRSessionEvent;
import org.mycore.common.events.MCRSessionListener;

/**
 * Adds MCRSession information to the current {@link ThreadContext}.
 *
 * 
 * loginId
current user id
 * ipAddress
see {@link MCRSession#getCurrentIP()}
 * mcrSession
see {@link MCRSession#getID()}
 * language
see {@link MCRSession#getCurrentLanguage()}
 * 
 *
 * @author Thomas Scheffler (yagee)
 * @see ThreadContext description
 * @see ThreadContext
 */
public class MCRSessionThreadContext implements MCRSessionListener {

    @Override
    public void sessionEvent(MCRSessionEvent event) {
        switch (event.getType()) {
            case activated:
                ThreadContext.put("ipAddress", event.getSession().getCurrentIP());
                ThreadContext.put("loginId", event.getSession().getUserInformation().getUserID());
                ThreadContext.put("mcrSession", event.getSession().getID());
                ThreadContext.put("language", event.getSession().getCurrentLanguage());
                break;
            case passivated:
                ThreadContext.clearMap();
                break;

            default:
                break;
        }
    }

}