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
|
/*******************************************************************************
* Copyright (c) 2001, 2008 Oracle Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Oracle Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.jst.jsf.common.webxml;
import java.util.List;
import org.eclipse.core.resources.IProject;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.jst.j2ee.model.IModelProvider;
import org.eclipse.jst.j2ee.model.ModelProviderManager;
import org.eclipse.jst.javaee.web.WebApp;
import org.eclipse.jst.jsf.common.webxml.internal.AbstractWebXmlUpdater;
import org.eclipse.jst.jsf.common.webxml.internal.WebXmlUpdaterForJ2EE;
import org.eclipse.jst.jsf.common.webxml.internal.WebXmlUpdaterForJavaEE;
/**
* Facade for web.xml updater classes WebXmlUpdaterForJavaEE,
* WebXmlUpdaterForJ2EE, and AbstractWebXmlUpdater. Utility class to make
* editing web.xml easy.
*
* @author Debajit Adhikary
*
*/
public class WebXmlUpdater
{
private final IProject project;
private final IProgressMonitor monitor;
private final AbstractWebXmlUpdater updater;
private final IModelProvider provider;
/**
* @param project
* @param monitor
*/
public WebXmlUpdater (final IProject project,
final IProgressMonitor monitor)
{
this.project = project;
this.monitor = monitor;
this.provider = ModelProviderManager.getModelProvider(project);
this.updater = initUpdater();
}
/**
* @return WebApp object associated with this WebXmlUpdater object
*/
public WebApp getWebAppForJavaEE ()
{
return (WebApp) updater.getWebApp();
}
/**
* @return WebApp object associated with this WebXmlUpdater object
*/
public org.eclipse.jst.j2ee.webapplication.WebApp getWebAppForJ2EE ()
{
return (org.eclipse.jst.j2ee.webapplication.WebApp) updater.getWebApp();
}
/**
* @return Provider object for the webapp this WebXmlUpdater is associated
* with. This may be used by clients to perform additional complex
* updates to web.xml using getProvider.modify(new Runnable(), ...)
*/
public IModelProvider getProvider()
{
return provider;
}
/**
* @return True if this webapp is a Java EE app.
*/
public boolean isJavaEEWebapp ()
{
return updater instanceof WebXmlUpdaterForJavaEE;
}
/**
* @return True if this webapp is a J2EE app
*/
public boolean isJ2EEWebapp ()
{
return updater instanceof WebXmlUpdaterForJ2EE;
}
/**
* @param servletName
* @param servletClass
* @param loadOnStartup
*/
public void addServlet (final String servletName,
final String servletClass,
final String loadOnStartup)
{
updater.addServlet(servletName, servletClass, loadOnStartup);
}
/**
* @param servletClassName
*/
public void removeServlet (final String servletClassName)
{
updater.removeServlet(servletClassName);
}
/**
* @param servletName
* @param servletClass
* @param urlPattern
*/
public void addServletMapping (final String servletName,
final String servletClass,
final String urlPattern)
{
updater.addServletMapping(servletName, servletClass, urlPattern);
}
/**
* @param filterName
* @param filterClass
*/
public void addFilter (final String filterName,
final String filterClass)
{
updater.addFilter(filterName, filterClass);
}
/**
* @param filterName
*/
public void removeFilter (final String filterName)
{
updater.removeFilter(filterName);
}
/**
* @param filterName
* @param filterClass
* @param servletName
*/
public void addFilterMapping (final String filterName,
final String filterClass,
final String servletName)
{
updater.addFilterMapping(filterName, filterClass, servletName);
}
/**
* @param paramName
* Name of context param
* @return Value of given context param.
*/
public String getContextParamValue (final String paramName)
{
return updater.getContextParamValue(paramName);
}
/**
* @param paramName
* Name of context param
* @param valuesDelimiterRegex
* Delimiter string for values
* @return Values of given context param as a list. This is useful when the
* multiple values are demarcated by a delimiter string.
*
*/
public List<String> getContextParamValuesAsList (final String paramName,
final String valuesDelimiterRegex)
{
return updater.getContextParamValuesAsList(paramName, valuesDelimiterRegex);
}
/**
* Sets the value of the given context param name to the given value. If
* paramName is not found, a new context-param is created with the given
* paramName and paramValue.
*
* @param paramName
* @param paramValue
*/
public void setContextParamValue (final String paramName,
final String paramValue)
{
updater.setContextParamValue(paramName, paramValue);
}
/**
* @param paramName
* @param paramValue
* @param description
*/
public void addContextParam (final String paramName,
final String paramValue,
final String description)
{
updater.addContextParam(paramName, paramValue, description);
}
/**
* @param listenerClass
*/
public void addListener (final String listenerClass)
{
updater.addListener(listenerClass);
}
private AbstractWebXmlUpdater initUpdater()
{
final Object webAppObj = ModelProviderManager.getModelProvider(project).getModelObject();
if (webAppObj != null)
{
if (webAppObj instanceof WebApp) // Java EE
return new WebXmlUpdaterForJavaEE(webAppObj, project, getProvider(), monitor);
else if (webAppObj instanceof org.eclipse.jst.j2ee.webapplication.WebApp) // J2EE
return new WebXmlUpdaterForJ2EE(webAppObj, project, getProvider(), monitor);
}
// Control should never come here
throw new IllegalArgumentException("Unable to resolve WebApp object for updating web.xml"); //$NON-NLS-1$
}
}
|
