1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
|
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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.
*/
package org.apache.catalina.ha.session;
import java.io.Serial;
import org.apache.catalina.ha.ClusterMessageBase;
/**
* Session cluster message.
*/
public class SessionMessageImpl extends ClusterMessageBase implements SessionMessage {
@Serial
private static final long serialVersionUID = 2L;
/*
* Private serializable variables to keep the messages state
*/
private final int mEvtType;
private final byte[] mSession;
private final String mSessionID;
private final String mContextName;
private long serializationTimestamp;
private boolean timestampSet = false;
private String uniqueId;
private SessionMessageImpl(String contextName, int eventtype, byte[] session, String sessionID) {
mEvtType = eventtype;
mSession = session;
mSessionID = sessionID;
mContextName = contextName;
uniqueId = sessionID;
}
/**
* Creates a session message. Depending on what event type you want this message to represent, you populate the
* different parameters in the constructor<BR>
* The following rules apply dependent on what event type argument you use:<BR>
* <B>EVT_SESSION_CREATED</B><BR>
* The parameters: session, sessionID must be set.<BR>
* <B>EVT_SESSION_EXPIRED</B><BR>
* The parameters: sessionID must be set.<BR>
* <B>EVT_SESSION_ACCESSED</B><BR>
* The parameters: sessionID must be set.<BR>
* <B>EVT_GET_ALL_SESSIONS</B><BR>
* get all sessions from one of the nodes.<BR>
* <B>EVT_SESSION_DELTA</B><BR>
* Send attribute delta (add,update,remove attribute or principal, ...).<BR>
* <B>EVT_ALL_SESSION_DATA</B><BR>
* Send complete serializes session list<BR>
* <B>EVT_ALL_SESSION_TRANSFERCOMPLETE</B><BR>
* send that all session state information are transferred after GET_ALL_SESSION received from this sender.<BR>
* <B>EVT_CHANGE_SESSION_ID</B><BR>
* send original sessionID and new sessionID.<BR>
* <B>EVT_ALL_SESSION_NOCONTEXTMANAGER</B><BR>
* send that context manager does not exist after GET_ALL_SESSION received from this sender.<BR>
*
* @param contextName - the name of the context (application
* @param eventtype - one of the 8 event type defined in this class
* @param session - the serialized byte array of the session itself
* @param sessionID - the id that identifies this session
* @param uniqueID - the id that identifies this message
*/
public SessionMessageImpl(String contextName, int eventtype, byte[] session, String sessionID, String uniqueID) {
this(contextName, eventtype, session, sessionID);
uniqueId = uniqueID;
}
@Override
public int getEventType() {
return mEvtType;
}
@Override
public byte[] getSession() {
return mSession;
}
@Override
public String getSessionID() {
return mSessionID;
}
/**
* Set message send time but only the first setting works (one shot)
*
* @param time the timestamp
*/
@Override
public void setTimestamp(long time) {
if (!timestampSet) {
serializationTimestamp = time;
timestampSet = true;
}
}
@Override
public long getTimestamp() {
return serializationTimestamp;
}
@Override
public String getEventTypeString() {
return switch (mEvtType) {
case EVT_SESSION_CREATED -> "SESSION-MODIFIED";
case EVT_SESSION_EXPIRED -> "SESSION-EXPIRED";
case EVT_SESSION_ACCESSED -> "SESSION-ACCESSED";
case EVT_GET_ALL_SESSIONS -> "SESSION-GET-ALL";
case EVT_SESSION_DELTA -> "SESSION-DELTA";
case EVT_ALL_SESSION_DATA -> "ALL-SESSION-DATA";
case EVT_ALL_SESSION_TRANSFERCOMPLETE -> "SESSION-STATE-TRANSFERRED";
case EVT_CHANGE_SESSION_ID -> "SESSION-ID-CHANGED";
case EVT_ALL_SESSION_NOCONTEXTMANAGER -> "NO-CONTEXT-MANAGER";
default -> "UNKNOWN-EVENT-TYPE";
};
}
@Override
public String getContextName() {
return mContextName;
}
@Override
public String getUniqueId() {
return uniqueId;
}
@Override
public String toString() {
return getEventTypeString() + "#" + getContextName() + "#" + getSessionID();
}
}
|
