/
Holder.java
296 lines (257 loc) · 7.9 KB
/
Holder.java
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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
//
// ========================================================================
// Copyright (c) 1995-2021 Mort Bay Consulting Pty Ltd and others.
// ------------------------------------------------------------------------
// All rights reserved. This program and the accompanying materials
// are made available under the terms of the Eclipse Public License v1.0
// and Apache License v2.0 which accompanies this distribution.
//
// The Eclipse Public License is available at
// http://www.eclipse.org/legal/epl-v10.html
//
// The Apache License v2.0 is available at
// http://www.opensource.org/licenses/apache2.0.php
//
// You may elect to redistribute this code under either of these licenses.
// ========================================================================
//
package org.eclipse.jetty.servlet;
import java.util.Collections;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;
import javax.servlet.Registration;
import javax.servlet.ServletContext;
import org.eclipse.jetty.util.annotation.ManagedAttribute;
import org.eclipse.jetty.util.annotation.ManagedObject;
import org.eclipse.jetty.util.log.Log;
import org.eclipse.jetty.util.log.Logger;
/**
* Holder
*
* Specialization of AbstractHolder for servlet-related classes that
* have init-params etc
*
* @param <T> the type of holder
*/
@ManagedObject("Holder - a container for servlets and the like")
public abstract class Holder<T> extends BaseHolder<T>
{
private static final Logger LOG = Log.getLogger(Holder.class);
private final Map<String, String> _initParams = new HashMap<String, String>(3);
private String _displayName;
private boolean _asyncSupported;
private String _name;
protected Holder(Source source)
{
super(source);
switch (getSource().getOrigin())
{
case JAVAX_API:
case DESCRIPTOR:
case ANNOTATION:
_asyncSupported = false;
break;
default:
_asyncSupported = true;
}
}
@ManagedAttribute(value = "Display Name", readonly = true)
public String getDisplayName()
{
return _displayName;
}
public String getInitParameter(String param)
{
if (_initParams == null)
return null;
return _initParams.get(param);
}
public Enumeration<String> getInitParameterNames()
{
if (_initParams == null)
return Collections.enumeration(Collections.EMPTY_LIST);
return Collections.enumeration(_initParams.keySet());
}
@ManagedAttribute(value = "Initial Parameters", readonly = true)
public Map<String, String> getInitParameters()
{
return _initParams;
}
@ManagedAttribute(value = "Name", readonly = true)
public String getName()
{
return _name;
}
@Override
protected synchronized void setInstance(T instance)
{
super.setInstance(instance);
if (getName() == null)
setName(String.format("%s@%x", instance.getClass().getName(), instance.hashCode()));
}
public void destroyInstance(Object instance)
throws Exception
{
}
/**
* @param className The className to set.
*/
@Override
public void setClassName(String className)
{
super.setClassName(className);
if (_name == null)
_name = className + "-" + Integer.toHexString(this.hashCode());
}
/**
* @param held The class to hold
*/
@Override
public void setHeldClass(Class<? extends T> held)
{
super.setHeldClass(held);
if (held != null)
{
if (_name == null)
_name = held.getName() + "-" + Integer.toHexString(this.hashCode());
}
}
public void setDisplayName(String name)
{
_displayName = name;
}
public void setInitParameter(String param, String value)
{
_initParams.put(param, value);
}
public void setInitParameters(Map<String, String> map)
{
_initParams.clear();
_initParams.putAll(map);
}
/**
* The name is a primary key for the held object.
* Ensure that the name is set BEFORE adding a Holder
* (eg ServletHolder or FilterHolder) to a ServletHandler.
*
* @param name The name to set.
*/
public void setName(String name)
{
_name = name;
}
public void setAsyncSupported(boolean suspendable)
{
_asyncSupported = suspendable;
}
public boolean isAsyncSupported()
{
return _asyncSupported;
}
@Override
public String dump()
{
return super.dump();
}
@Override
public String toString()
{
return String.format("%s@%x==%s", _name, hashCode(), getClassName());
}
protected class HolderConfig
{
public ServletContext getServletContext()
{
return getServletHandler().getServletContext();
}
public String getInitParameter(String param)
{
return Holder.this.getInitParameter(param);
}
public Enumeration<String> getInitParameterNames()
{
return Holder.this.getInitParameterNames();
}
}
protected class HolderRegistration implements Registration.Dynamic
{
@Override
public void setAsyncSupported(boolean isAsyncSupported)
{
illegalStateIfContextStarted();
Holder.this.setAsyncSupported(isAsyncSupported);
}
public void setDescription(String description)
{
if (LOG.isDebugEnabled())
LOG.debug(this + " is " + description);
}
@Override
public String getClassName()
{
return Holder.this.getClassName();
}
@Override
public String getInitParameter(String name)
{
return Holder.this.getInitParameter(name);
}
@Override
public Map<String, String> getInitParameters()
{
return Holder.this.getInitParameters();
}
@Override
public String getName()
{
return Holder.this.getName();
}
@Override
public boolean setInitParameter(String name, String value)
{
illegalStateIfContextStarted();
if (name == null)
{
throw new IllegalArgumentException("init parameter name required");
}
if (value == null)
{
throw new IllegalArgumentException("non-null value required for init parameter " + name);
}
if (Holder.this.getInitParameter(name) != null)
return false;
Holder.this.setInitParameter(name, value);
return true;
}
@Override
public Set<String> setInitParameters(Map<String, String> initParameters)
{
illegalStateIfContextStarted();
Set<String> clash = null;
for (Map.Entry<String, String> entry : initParameters.entrySet())
{
if (entry.getKey() == null)
{
throw new IllegalArgumentException("init parameter name required");
}
if (entry.getValue() == null)
{
throw new IllegalArgumentException("non-null value required for init parameter " + entry.getKey());
}
if (Holder.this.getInitParameter(entry.getKey()) != null)
{
if (clash == null)
clash = new HashSet<String>();
clash.add(entry.getKey());
}
}
if (clash != null)
return clash;
Holder.this.getInitParameters().putAll(initParameters);
return Collections.emptySet();
}
}
}