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
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
|
/*******************************************************************************
* Copyright (c) 2007 IBM 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:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.jst.javaee.ejb;
import java.util.List;
import org.eclipse.jst.javaee.core.JavaEEObject;
/**
* <!-- begin-user-doc -->
* A representation of the model object '<em><b>Interceptor Binding Type</b></em>'.
* <!-- end-user-doc -->
*
* <!-- begin-model-doc -->
*
*
* The interceptor-bindingType element describes the binding of
* interceptor classes to beans within the ejb-jar.
* It consists of :
*
* - An optional description.
* - The name of an ejb within the ejb-jar or the wildcard value "*",
* which is used to define interceptors that are bound to all
* beans in the ejb-jar.
* - A list of interceptor classes that are bound to the contents of
* the ejb-name element or a specification of the total ordering
* over the interceptors defined for the given level and above.
* - An optional exclude-default-interceptors element. If set to true,
* specifies that default interceptors are not to be applied to
* a bean-class and/or business method.
* - An optional exclude-class-interceptors element. If set to true,
* specifies that class interceptors are not to be applied to
* a business method.
* - An optional set of method elements for describing the name/params
* of a method-level interceptor.
*
* Interceptors bound to all classes using the wildcard syntax
* "*" are default interceptors for the components in the ejb-jar.
* In addition, interceptors may be bound at the level of the bean
* class (class-level interceptors) or business methods (method-level
* interceptors ).
*
* The binding of interceptors to classes is additive. If interceptors
* are bound at the class-level and/or default-level as well as the
* method-level, both class-level and/or default-level as well as
* method-level will apply.
*
* There are four possible styles of the interceptor element syntax :
*
* 1.
* <interceptor-binding xmlns="http://www.w3.org/2001/XMLSchema">
* <ejb-name>*</ejb-name>
* <interceptor-class>INTERCEPTOR</interceptor-class>
* </interceptor-binding>
*
* Specifying the ejb-name as the wildcard value "*" designates
* default interceptors (interceptors that apply to all session and
* message-driven beans contained in the ejb-jar).
*
* 2.
* <interceptor-binding xmlns="http://www.w3.org/2001/XMLSchema">
* <ejb-name>EJBNAME</ejb-name>
* <interceptor-class>INTERCEPTOR</interceptor-class>
* </interceptor-binding>
*
* This style is used to refer to interceptors associated with the
* specified enterprise bean(class-level interceptors).
*
* 3.
* <interceptor-binding xmlns="http://www.w3.org/2001/XMLSchema">
* <ejb-name>EJBNAME</ejb-name>
* <interceptor-class>INTERCEPTOR</interceptor-class>
* <method>
* <method-name>METHOD</method-name>
* </method>
* </interceptor-binding>
*
* This style is used to associate a method-level interceptor with
* the specified enterprise bean. If there are multiple methods
* with the same overloaded name, the element of this style refers
* to all the methods with the overloaded name. Method-level
* interceptors can only be associated with business methods of the
* bean class. Note that the wildcard value "*" cannot be used
* to specify method-level interceptors.
*
* 4.
* <interceptor-binding xmlns="http://www.w3.org/2001/XMLSchema">
* <ejb-name>EJBNAME</ejb-name>
* <interceptor-class>INTERCEPTOR</interceptor-class>
* <method>
* <method-name>METHOD</method-name>
* <method-params>
* <method-param>PARAM-1</method-param>
* <method-param>PARAM-2</method-param>
* ...
* <method-param>PARAM-N</method-param>
* </method-params>
* </method>
* </interceptor-binding>
*
* This style is used to associate a method-level interceptor with
* the specified method of the specified enterprise bean. This
* style is used to refer to a single method within a set of methods
* with an overloaded name. The values PARAM-1 through PARAM-N
* are the fully-qualified Java types of the method's input parameters
* (if the method has no input arguments, the method-params element
* contains no method-param elements). Arrays are specified by the
* array element's type, followed by one or more pair of square
* brackets (e.g. int[][]).
*
*
* <!-- end-model-doc -->
*
* <p>
* The following features are supported:
* <ul>
* <li>{@link org.eclipse.jst.javaee.ejb.InterceptorBindingType#getDescriptions <em>Descriptions</em>}</li>
* <li>{@link org.eclipse.jst.javaee.ejb.InterceptorBindingType#getEjbName <em>Ejb Name</em>}</li>
* <li>{@link org.eclipse.jst.javaee.ejb.InterceptorBindingType#getInterceptorClasses <em>Interceptor Classes</em>}</li>
* <li>{@link org.eclipse.jst.javaee.ejb.InterceptorBindingType#getInterceptorOrder <em>Interceptor Order</em>}</li>
* <li>{@link org.eclipse.jst.javaee.ejb.InterceptorBindingType#isExcludeDefaultInterceptors <em>Exclude Default Interceptors</em>}</li>
* <li>{@link org.eclipse.jst.javaee.ejb.InterceptorBindingType#isExcludeClassInterceptors <em>Exclude Class Interceptors</em>}</li>
* <li>{@link org.eclipse.jst.javaee.ejb.InterceptorBindingType#getMethod <em>Method</em>}</li>
* <li>{@link org.eclipse.jst.javaee.ejb.InterceptorBindingType#getId <em>Id</em>}</li>
* </ul>
* </p>
*
* @see org.eclipse.jst.javaee.ejb.internal.metadata.EjbPackage#getInterceptorBindingType()
* @extends JavaEEObject
* @generated
*/
public interface InterceptorBindingType extends JavaEEObject {
/**
* Returns the value of the '<em><b>Descriptions</b></em>' containment reference list.
* The list contents are of type {@link org.eclipse.jst.javaee.core.Description}.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Descriptions</em>' containment reference list isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Descriptions</em>' containment reference list.
* @see org.eclipse.jst.javaee.ejb.internal.metadata.EjbPackage#getInterceptorBindingType_Descriptions()
* @generated
*/
List getDescriptions();
/**
* Returns the value of the '<em><b>Ejb Name</b></em>' attribute.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Ejb Name</em>' attribute isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Ejb Name</em>' attribute.
* @see #setEjbName(String)
* @see org.eclipse.jst.javaee.ejb.internal.metadata.EjbPackage#getInterceptorBindingType_EjbName()
* @generated
*/
String getEjbName();
/**
* Sets the value of the '{@link org.eclipse.jst.javaee.ejb.InterceptorBindingType#getEjbName <em>Ejb Name</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Ejb Name</em>' attribute.
* @see #getEjbName()
* @generated
*/
void setEjbName(String value);
/**
* Returns the value of the '<em><b>Interceptor Classes</b></em>' attribute list.
* The list contents are of type {@link java.lang.String}.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Interceptor Classes</em>' attribute list isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Interceptor Classes</em>' attribute list.
* @see org.eclipse.jst.javaee.ejb.internal.metadata.EjbPackage#getInterceptorBindingType_InterceptorClasses()
* @generated
*/
List getInterceptorClasses();
/**
* Returns the value of the '<em><b>Interceptor Order</b></em>' containment reference.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Interceptor Order</em>' containment reference isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Interceptor Order</em>' containment reference.
* @see #setInterceptorOrder(InterceptorOrderType)
* @see org.eclipse.jst.javaee.ejb.internal.metadata.EjbPackage#getInterceptorBindingType_InterceptorOrder()
* @generated
*/
InterceptorOrderType getInterceptorOrder();
/**
* Sets the value of the '{@link org.eclipse.jst.javaee.ejb.InterceptorBindingType#getInterceptorOrder <em>Interceptor Order</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Interceptor Order</em>' containment reference.
* @see #getInterceptorOrder()
* @generated
*/
void setInterceptorOrder(InterceptorOrderType value);
/**
* Returns the value of the '<em><b>Exclude Default Interceptors</b></em>' attribute.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Exclude Default Interceptors</em>' attribute isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Exclude Default Interceptors</em>' attribute.
* @see #isSetExcludeDefaultInterceptors()
* @see #unsetExcludeDefaultInterceptors()
* @see #setExcludeDefaultInterceptors(boolean)
* @see org.eclipse.jst.javaee.ejb.internal.metadata.EjbPackage#getInterceptorBindingType_ExcludeDefaultInterceptors()
* @generated
*/
boolean isExcludeDefaultInterceptors();
/**
* Sets the value of the '{@link org.eclipse.jst.javaee.ejb.InterceptorBindingType#isExcludeDefaultInterceptors <em>Exclude Default Interceptors</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Exclude Default Interceptors</em>' attribute.
* @see #isSetExcludeDefaultInterceptors()
* @see #unsetExcludeDefaultInterceptors()
* @see #isExcludeDefaultInterceptors()
* @generated
*/
void setExcludeDefaultInterceptors(boolean value);
/**
* Unsets the value of the '{@link org.eclipse.jst.javaee.ejb.InterceptorBindingType#isExcludeDefaultInterceptors <em>Exclude Default Interceptors</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @see #isSetExcludeDefaultInterceptors()
* @see #isExcludeDefaultInterceptors()
* @see #setExcludeDefaultInterceptors(boolean)
* @generated
*/
void unsetExcludeDefaultInterceptors();
/**
* Returns whether the value of the '{@link org.eclipse.jst.javaee.ejb.InterceptorBindingType#isExcludeDefaultInterceptors <em>Exclude Default Interceptors</em>}' attribute is set.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @return whether the value of the '<em>Exclude Default Interceptors</em>' attribute is set.
* @see #unsetExcludeDefaultInterceptors()
* @see #isExcludeDefaultInterceptors()
* @see #setExcludeDefaultInterceptors(boolean)
* @generated
*/
boolean isSetExcludeDefaultInterceptors();
/**
* Returns the value of the '<em><b>Exclude Class Interceptors</b></em>' attribute.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Exclude Class Interceptors</em>' attribute isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Exclude Class Interceptors</em>' attribute.
* @see #isSetExcludeClassInterceptors()
* @see #unsetExcludeClassInterceptors()
* @see #setExcludeClassInterceptors(boolean)
* @see org.eclipse.jst.javaee.ejb.internal.metadata.EjbPackage#getInterceptorBindingType_ExcludeClassInterceptors()
* @generated
*/
boolean isExcludeClassInterceptors();
/**
* Sets the value of the '{@link org.eclipse.jst.javaee.ejb.InterceptorBindingType#isExcludeClassInterceptors <em>Exclude Class Interceptors</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Exclude Class Interceptors</em>' attribute.
* @see #isSetExcludeClassInterceptors()
* @see #unsetExcludeClassInterceptors()
* @see #isExcludeClassInterceptors()
* @generated
*/
void setExcludeClassInterceptors(boolean value);
/**
* Unsets the value of the '{@link org.eclipse.jst.javaee.ejb.InterceptorBindingType#isExcludeClassInterceptors <em>Exclude Class Interceptors</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @see #isSetExcludeClassInterceptors()
* @see #isExcludeClassInterceptors()
* @see #setExcludeClassInterceptors(boolean)
* @generated
*/
void unsetExcludeClassInterceptors();
/**
* Returns whether the value of the '{@link org.eclipse.jst.javaee.ejb.InterceptorBindingType#isExcludeClassInterceptors <em>Exclude Class Interceptors</em>}' attribute is set.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @return whether the value of the '<em>Exclude Class Interceptors</em>' attribute is set.
* @see #unsetExcludeClassInterceptors()
* @see #isExcludeClassInterceptors()
* @see #setExcludeClassInterceptors(boolean)
* @generated
*/
boolean isSetExcludeClassInterceptors();
/**
* Returns the value of the '<em><b>Method</b></em>' containment reference.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Method</em>' containment reference isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Method</em>' containment reference.
* @see #setMethod(NamedMethodType)
* @see org.eclipse.jst.javaee.ejb.internal.metadata.EjbPackage#getInterceptorBindingType_Method()
* @generated
*/
NamedMethodType getMethod();
/**
* Sets the value of the '{@link org.eclipse.jst.javaee.ejb.InterceptorBindingType#getMethod <em>Method</em>}' containment reference.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Method</em>' containment reference.
* @see #getMethod()
* @generated
*/
void setMethod(NamedMethodType value);
/**
* Returns the value of the '<em><b>Id</b></em>' attribute.
* <!-- begin-user-doc -->
* <p>
* If the meaning of the '<em>Id</em>' attribute isn't clear,
* there really should be more of a description here...
* </p>
* <!-- end-user-doc -->
* @return the value of the '<em>Id</em>' attribute.
* @see #setId(String)
* @see org.eclipse.jst.javaee.ejb.internal.metadata.EjbPackage#getInterceptorBindingType_Id()
* @generated
*/
String getId();
/**
* Sets the value of the '{@link org.eclipse.jst.javaee.ejb.InterceptorBindingType#getId <em>Id</em>}' attribute.
* <!-- begin-user-doc -->
* <!-- end-user-doc -->
* @param value the new value of the '<em>Id</em>' attribute.
* @see #getId()
* @generated
*/
void setId(String value);
} // InterceptorBindingType
|
