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
|
/*
* 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.loader;
import java.io.File;
import java.util.Arrays;
import java.util.LinkedHashSet;
import java.util.Locale;
import java.util.Set;
import java.util.StringTokenizer;
import org.apache.catalina.LifecycleException;
/**
* A WebappLoader that allows a customized classpath to be added
* through configuration in context xml. Any additional classpath entry will be
* added to the default webapp classpath, making easy to emulate a standard
* webapp without the need for assembly all the webapp dependencies as jars in
* WEB-INF/lib.
*
* <pre>
* <Context docBase="\webapps\mydocbase">
* <Loader className="org.apache.catalina.loader.VirtualWebappLoader"
* virtualClasspath="/dir/classes;/somedir/somejar.jar;
* /somedir/*.jar"/>
* </Context>
* </pre>
*
* <p>The <code>*.jar</code> suffix can be used to include all JAR files in a
* certain directory. If a file or a directory does not exist, it will be
* skipped.
* </p>
*
*
* @author Fabrizio Giustina
*/
public class VirtualWebappLoader extends WebappLoader {
private static final org.apache.juli.logging.Log log=
org.apache.juli.logging.LogFactory.getLog( VirtualWebappLoader.class );
/**
* <code>;</code> separated list of additional path elements.
*/
private String virtualClasspath = "";
/**
* Construct a new WebappLoader with no defined parent class loader (so that
* the actual parent will be the system class loader).
*/
public VirtualWebappLoader() {
super();
}
/**
* Construct a new WebappLoader with the specified class loader to be
* defined as the parent of the ClassLoader we ultimately create.
*
* @param parent The parent class loader
*/
public VirtualWebappLoader(ClassLoader parent) {
super(parent);
}
/**
* <code>virtualClasspath</code> attribute that will be automatically set
* from the <code>Context</code> <code>virtualClasspath</code> attribute
* from the context xml file.
* @param path <code>;</code> separated list of path elements.
*/
public void setVirtualClasspath(String path) {
virtualClasspath = path;
}
/**
* @return Returns searchVirtualFirst.
*/
public boolean getSearchVirtualFirst() {
return getSearchExternalFirst();
}
/**
* @param searchVirtualFirst Whether the virtual class path should be searched before the webapp
*/
public void setSearchVirtualFirst(boolean searchVirtualFirst) {
setSearchExternalFirst(searchVirtualFirst);
}
/**
* Implement the requirements
* of {@link org.apache.catalina.util.LifecycleBase#startInternal()}.
*
* @exception LifecycleException if this component detects a fatal error
* that prevents this component from being used
*/
@Override
protected void startInternal() throws LifecycleException {
// just add any jar/directory set in virtual classpath to the
// repositories list before calling start on the standard WebappLoader
StringTokenizer tkn = new StringTokenizer(virtualClasspath, ";");
Set<String> set = new LinkedHashSet<String>();
while (tkn.hasMoreTokens()) {
String token = tkn.nextToken().trim();
if (token.isEmpty()) {
continue;
}
if (log.isDebugEnabled())
log.debug(sm.getString("virtualWebappLoader.token", token));
if (token.endsWith("*.jar")) {
// glob
token = token.substring(0, token.length() - "*.jar".length());
File directory = new File(token);
if (!directory.isDirectory()) {
if (log.isDebugEnabled()) {
log.debug(sm.getString(
"virtualWebappLoader.token.notDirectory",
directory.getAbsolutePath()));
}
continue;
}
if (log.isDebugEnabled()) {
log.debug(sm.getString(
"virtualWebappLoader.token.glob.dir",
directory.getAbsolutePath()));
}
String filenames[] = directory.list();
Arrays.sort(filenames);
for (int j = 0; j < filenames.length; j++) {
String filename = filenames[j].toLowerCase(Locale.ENGLISH);
if (!filename.endsWith(".jar"))
continue;
File file = new File(directory, filenames[j]);
if (!file.isFile()) {
if (log.isDebugEnabled()) {
log.debug(sm.getString(
"virtualWebappLoader.token.notFile",
file.getAbsolutePath()));
}
continue;
}
if (log.isDebugEnabled()) {
log.debug(sm.getString(
"virtualWebappLoader.token.file",
file.getAbsolutePath()));
}
set.add(file.toURI().toString());
}
} else {
// single file or directory
File file = new File(token);
if (!file.exists()) {
if (log.isDebugEnabled()) {
log.debug(sm.getString(
"virtualWebappLoader.token.notExists",
file.getAbsolutePath()));
}
continue;
}
if (log.isDebugEnabled()) {
log.debug(sm.getString(
"virtualWebappLoader.token.file",
file.getAbsolutePath()));
}
set.add(file.toURI().toString());
}
}
for (String repository: set) {
addRepository(repository);
}
super.startInternal();
}
}
|
