001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements. See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache license, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License. You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the license for the specific language governing permissions and
015 * limitations under the license.
016 */
017package org.apache.logging.log4j.web;
018
019import java.util.Objects;
020
021import jakarta.servlet.ServletRequest;
022import jakarta.servlet.http.HttpServletRequest;
023
024import org.apache.logging.log4j.ThreadContext;
025
026public class ServletRequestThreadContext {
027
028    public static void put(final String key, final ServletRequest servletRequest) {
029        put(key, "RemoteAddr", servletRequest.getRemoteAddr());
030        put(key, "RemoteHost", servletRequest.getRemoteHost());
031        put(key, "RemotePort", servletRequest.getRemotePort());
032    }
033
034    public static void put(final String key, final String field, final Object value) {
035        put(key + "." + field, Objects.toString(value));
036    }
037
038    public static void put(final String key, final String value) {
039        ThreadContext.put(key, value);
040    }
041
042    public static void put(final String key, final HttpServletRequest servletRequest) {
043        put(key, (ServletRequest) servletRequest);
044    }
045}