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
|
/*******************************************************************************
* 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.internal;
import java.util.List;
import org.eclipse.core.resources.IProject;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.jst.j2ee.model.IModelProvider;
/**
* Abstract class to define web-xml editing interface. Users may use the
* WebXmlUpdater facade class for convenient web.xml editing.
*
* @author Debajit Adhikary
*
*/
public abstract class AbstractWebXmlUpdater
{
/**
* the web app object. JavaEE has own type and J2EE has another. They are not object compatible.
*/
protected final Object webAppObj;
/**
* the project
*/
protected final IProject project;
/**
* the model provider used to modify the model
*/
protected final IModelProvider provider;
/**
* the progress monitor
*/
protected final IProgressMonitor monitor;
/**
* @param webAppObj
* @param project
* @param provider
* @param monitor
*/
public AbstractWebXmlUpdater (final Object webAppObj,
final IProject project,
final IModelProvider provider,
final IProgressMonitor monitor)
{
this.webAppObj = webAppObj;
this.project = project;
this.provider = provider;
this.monitor = monitor;
}
/**
* @param servletName
* @param servletClass
* @param loadOnStartup
*/
public abstract void addServlet (final String servletName,
final String servletClass,
final String loadOnStartup);
/**
* @param servletName
* @param servletClass
* @param urlPattern
*/
public abstract void addServletMapping (final String servletName,
final String servletClass,
final String urlPattern);
/**
* Removes a servlet and its associated mappings from web.xml.
*
* @param servletClassName
* Fully qualified classname of servlet class to remove.
*/
public abstract void removeServlet (final String servletClassName);
/**
* @param filterName
* @param filterClass
*/
public abstract void addFilter (final String filterName,
final String filterClass);
/**
* Removes a filter and its associated mappings from web.xml.
*
* @param filterName
*/
public abstract void removeFilter (final String filterName);
/**
* @param filterName
* @param filterClass
* @param servletName
*/
public abstract void addFilterMapping (final String filterName,
final String filterClass,
final String servletName);
/**
* @param paramName
* Name of context param
* @return Value of given context param.
*/
public abstract String getContextParamValue (final String 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 abstract List<String> getContextParamValuesAsList (final String paramName,
final String 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 abstract void setContextParamValue (final String paramName,
final String paramValue);
/**
* @param paramName
* @param paramValue
* @param description
*/
public abstract void addContextParam (final String paramName,
final String paramValue,
final String description);
/**
* @param listenerClass
*/
public abstract void addListener (final String listenerClass);
/**
* @return The WebApp object associated with this updater
*/
public abstract Object getWebApp ();
}
|
