target.classes.celerio.pack-javaee7-backend.src.main.java.context.LogContext.p.vm Maven / Gradle / Ivy
Show all versions of pack-javaee7-backend Show documentation
## Copyright 2015 JAXIO http://www.jaxio.com
##
## Licensed under the Apache License, Version 2.0 (the "License");
## you may not use this file except in compliance with the License.
## You may obtain a copy of the License at
##
## http://www.apache.org/licenses/LICENSE-2.0
##
## Unless required by applicable law or agreed to in writing, software
## distributed under the License is distributed on an "AS IS" BASIS,
## WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
## See the License for the specific language governing permissions and
## limitations under the License.
##
$output.java($Context, "LogContext")##
$output.require("org.slf4j.MDC")##
/**
* Used to store to use global info for logging purposes. This method prevents passing all the data you want to see in your logs in all the methods.
*
* Please configure logback with the data provided by this class where session_id and login are objects stored in the log context.
*
* Example:
*
* [%d{ISO8601}] [%-5level] [%X{session_id}] [%X{login}] [%C{3}.%M] %m%n
*
*/
public class $output.currentClass {
/**
* parameter name that holds logins
*/
public static final String LOGIN = "login";
/**
* parameter name that holds web session ids
*/
public static final String SESSION_ID = "session_id";
/**
* set the given login in the map
*/
public static void setLogin(String login) {
put(LOGIN, login);
}
/**
* set the given web session in the map
*/
public static void setSessionId(String sessionId) {
put(SESSION_ID, sessionId);
}
/**
* Get the context identified by the key parameter.
*/
public static Object get(String key) {
return MDC.get(key);
}
/**
* Put a context value (the o parameter) as identified with the key parameter into the current thread's context map.
*/
public static void put(String key, Object o) {
MDC.put(key, o.toString());
}
/**
* Remove the the context identified by the key parameter.
*/
public static void remove(String key) {
MDC.remove(key);
}
/**
* Remove all the object put in this thread context.
*/
public static void resetLogContext() {
MDC.clear();
}
}