forked from apache/tomcat
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathHost.java
More file actions
252 lines (197 loc) · 7.62 KB
/
Host.java
File metadata and controls
252 lines (197 loc) · 7.62 KB
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
/*
* 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;
import java.io.File;
import java.util.concurrent.ExecutorService;
import java.util.regex.Pattern;
/**
* A <b>Host</b> is a Container that represents a virtual host in the
* Catalina servlet engine. It is useful in the following types of scenarios:
* <ul>
* <li>You wish to use Interceptors that see every single request processed
* by this particular virtual host.
* <li>You wish to run Catalina in with a standalone HTTP connector, but still
* want support for multiple virtual hosts.
* </ul>
* In general, you would not use a Host when deploying Catalina connected
* to a web server (such as Apache), because the Connector will have
* utilized the web server's facilities to determine which Context (or
* perhaps even which Wrapper) should be utilized to process this request.
* <p>
* The parent Container attached to a Host is generally an Engine, but may
* be some other implementation, or may be omitted if it is not necessary.
* <p>
* The child containers attached to a Host are generally implementations
* of Context (representing an individual servlet context).
*
* @author Craig R. McClanahan
*/
public interface Host extends Container {
// ----------------------------------------------------- Manifest Constants
/**
* The ContainerEvent event type sent when a new alias is added
* by <code>addAlias()</code>.
*/
public static final String ADD_ALIAS_EVENT = "addAlias";
/**
* The ContainerEvent event type sent when an old alias is removed
* by <code>removeAlias()</code>.
*/
public static final String REMOVE_ALIAS_EVENT = "removeAlias";
// ------------------------------------------------------------- Properties
/**
* Return the XML root for this Host. This can be an absolute
* pathname, a relative pathname, or a URL.
* If null, defaults to
* ${catalina.base}/conf/<engine name>/<host name> directory
*/
public String getXmlBase();
/**
* Set the Xml root for this Host. This can be an absolute
* pathname, a relative pathname, or a URL.
* If null, defaults to
* ${catalina.base}/conf/<engine name>/<host name> directory
* @param xmlBase The new XML root
*/
public void setXmlBase(String xmlBase);
/**
* Return a default configuration path of this Host. The file will be
* canonical if possible.
*/
public File getConfigBaseFile();
/**
* Return the application root for this Host. This can be an absolute
* pathname, a relative pathname, or a URL.
*/
public String getAppBase();
/**
* Return an absolute {@link File} for the appBase of this Host. The file
* will be canonical if possible. There is no guarantee that that the
* appBase exists.
*/
public File getAppBaseFile();
/**
* Set the application root for this Host. This can be an absolute
* pathname, a relative pathname, or a URL.
*
* @param appBase The new application root
*/
public void setAppBase(String appBase);
/**
* Return the value of the auto deploy flag. If true, it indicates that
* this host's child webapps should be discovered and automatically
* deployed dynamically.
*/
public boolean getAutoDeploy();
/**
* Set the auto deploy flag value for this host.
*
* @param autoDeploy The new auto deploy flag
*/
public void setAutoDeploy(boolean autoDeploy);
/**
* Return the Java class name of the context configuration class
* for new web applications.
*/
public String getConfigClass();
/**
* Set the Java class name of the context configuration class
* for new web applications.
*
* @param configClass The new context configuration class
*/
public void setConfigClass(String configClass);
/**
* Return the value of the deploy on startup flag. If true, it indicates
* that this host's child webapps should be discovered and automatically
* deployed.
*/
public boolean getDeployOnStartup();
/**
* Set the deploy on startup flag value for this host.
*
* @param deployOnStartup The new deploy on startup flag
*/
public void setDeployOnStartup(boolean deployOnStartup);
/**
* Return the regular expression that defines the files and directories in
* the host's appBase that will be ignored by the automatic deployment
* process.
*/
public String getDeployIgnore();
/**
* Return the compiled regular expression that defines the files and
* directories in the host's appBase that will be ignored by the automatic
* deployment process.
*/
public Pattern getDeployIgnorePattern();
/**
* Set the regular expression that defines the files and directories in
* the host's appBase that will be ignored by the automatic deployment
* process.
*/
public void setDeployIgnore(String deployIgnore);
/**
* Return the executor that is used for starting and stopping contexts. This
* is primarily for use by components deploying contexts that want to do
* this in a multi-threaded manner.
*/
public ExecutorService getStartStopExecutor();
/**
* Returns true if the Host will attempt to create directories for appBase and xmlBase
* unless they already exist.
* @return true if the Host will attempt to create directories
*/
public boolean getCreateDirs();
/**
* Should the Host attempt to create directories for xmlBase and appBase
* upon startup.
*
* @param createDirs The new value for this flag
*/
public void setCreateDirs(boolean createDirs);
/**
* Returns true of the Host is configured to automatically undeploy old
* versions of applications deployed using parallel deployment. This only
* takes effect is {@link #getAutoDeploy()} also returns true.
*/
public boolean getUndeployOldVersions();
/**
* Set to true if the Host should automatically undeploy old versions of
* applications deployed using parallel deployment. This only takes effect
* if {@link #getAutoDeploy()} returns true.
*/
public void setUndeployOldVersions(boolean undeployOldVersions);
// --------------------------------------------------------- Public Methods
/**
* Add an alias name that should be mapped to this same Host.
*
* @param alias The alias to be added
*/
public void addAlias(String alias);
/**
* Return the set of alias names for this Host. If none are defined,
* a zero length array is returned.
*/
public String[] findAliases();
/**
* Remove the specified alias name from the aliases for this Host.
*
* @param alias Alias name to be removed
*/
public void removeAlias(String alias);
}