1 /**
2  * Logback: the reliable, generic, fast and flexible logging framework.
3  * Copyright (C) 1999-2015, QOS.ch. All rights reserved.
4  *
5  * This program and the accompanying materials are dual-licensed under
6  * either the terms of the Eclipse Public License v1.0 as published by
7  * the Eclipse Foundation
8  *
9  *   or (per the licensee's choosing)
10  *
11  * under the terms of the GNU Lesser General Public License version 2.1
12  * as published by the Free Software Foundation.
13  */
14 package ch.qos.logback.classic.spi;
15
16 import java.io.Serializable;
17 import java.util.Map;
18
19 import ch.qos.logback.classic.LoggerContext;
20
21 /**
22  * LoggerContextVO offers a restricted view of LoggerContext intended to be
23  * exposed by LoggingEvent to remote systems. This restricted view is optimized
24  * for serialization.
25  * 
26  * <p>
27  * Some of the LoggerContext or Logger attributes MUST not survive
28  * serialization, e.g appenders, level values etc, as these attributes may have
29  * other values on the remote platform. LoggerContextVO class exposes the
30  * minimal and relevant attributes to the remote host, instead of having to deal
31  * with an incomplete LoggerContext with many null references.
32  * 
33  * @author Ceki G&uuml;lc&uuml;
34  * @author S&eacute;bastien Pennec
35  */
36 public class LoggerContextVO implements Serializable {
37
38     private static final long serialVersionUID = 5488023392483144387L;
39
40     final String name;
41     final Map<String, String> propertyMap;
42     final long birthTime;
43
44     public LoggerContextVO(LoggerContext lc) {
45         this.name = lc.getName();
46         this.propertyMap = lc.getCopyOfPropertyMap();
47         this.birthTime = lc.getBirthTime();
48     }
49
50     public LoggerContextVO(String name, Map<String, String> propertyMap, long birthTime) {
51         this.name = name;
52         this.propertyMap = propertyMap;
53         this.birthTime = birthTime;
54     }
55
56     public String getName() {
57         return name;
58     }
59
60     public Map<String, String> getPropertyMap() {
61         return propertyMap;
62     }
63
64     public long getBirthTime() {
65         return birthTime;
66     }
67
68     @Override
69     public String toString() {
70         return "LoggerContextVO{" + "name='" + name + '\'' + ", propertyMap=" + propertyMap + ", birthTime=" + birthTime + '}';
71     }
72
73     @Override
74     public boolean equals(Object o) {
75         if (this == o)
76             return true;
77         if (!(o instanceof LoggerContextVO))
78             return false;
79
80         LoggerContextVO that = (LoggerContextVO) o;
81
82         if (birthTime != that.birthTime)
83             return false;
84         if (name != null ? !name.equals(that.name) : that.name != null)
85             return false;
86         if (propertyMap != null ? !propertyMap.equals(that.propertyMap) : that.propertyMap != null)
87             return false;
88
89         return true;
90     }
91
92     @Override
93     public int hashCode() {
94         int result = name != null ? name.hashCode() : 0;
95         result = 31 * result + (propertyMap != null ? propertyMap.hashCode() : 0);
96         result = 31 * result + (int) (birthTime ^ (birthTime >>> 32));
97
98         return result;
99     }
100 }
101