KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > sun > enterprise > tools > common > dd > ejb > BeanPool


1 /*
2  * The contents of this file are subject to the terms
3  * of the Common Development and Distribution License
4  * (the License). You may not use this file except in
5  * compliance with the License.
6  *
7  * You can obtain a copy of the license at
8  * https://glassfish.dev.java.net/public/CDDLv1.0.html or
9  * glassfish/bootstrap/legal/CDDLv1.0.txt.
10  * See the License for the specific language governing
11  * permissions and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL
14  * Header Notice in each file and include the License file
15  * at glassfish/bootstrap/legal/CDDLv1.0.txt.
16  * If applicable, add the following below the CDDL Header,
17  * with the fields enclosed by brackets [] replaced by
18  * you own identifying information:
19  * "Portions Copyrighted [year] [name of copyright owner]"
20  *
21  * Copyright 2006 Sun Microsystems, Inc. All rights reserved.
22  */

23
24 /**
25  * This generated bean class BeanPool matches the schema element bean-pool
26  *
27  * Generated on Wed Aug 13 10:43:32 PDT 2003
28  */

29
30 package com.sun.enterprise.tools.common.dd.ejb;
31
32 import org.w3c.dom.*;
33 import org.netbeans.modules.schema2beans.*;
34 import java.beans.*;
35 import java.util.*;
36
37 // BEGIN_NOI18N
38

39 public class BeanPool extends com.sun.enterprise.tools.common.dd.SunBaseBean
40 {
41
42     static Vector comparators = new Vector();
43
44     static public final String JavaDoc STEADY_POOL_SIZE = "SteadyPoolSize"; // NOI18N
45
static public final String JavaDoc RESIZE_QUANTITY = "ResizeQuantity"; // NOI18N
46
static public final String JavaDoc MAX_POOL_SIZE = "MaxPoolSize"; // NOI18N
47
static public final String JavaDoc POOL_IDLE_TIMEOUT_IN_SECONDS = "PoolIdleTimeoutInSeconds"; // NOI18N
48
static public final String JavaDoc MAX_WAIT_TIME_IN_MILLIS = "MaxWaitTimeInMillis"; // NOI18N
49

50     public BeanPool() {
51         this(Common.USE_DEFAULT_VALUES);
52     }
53
54     public BeanPool(int options)
55     {
56         super(comparators, new org.netbeans.modules.schema2beans.Version(1, 2, 0));
57         // Properties (see root bean comments for the bean graph)
58
this.createProperty("steady-pool-size", // NOI18N
59
STEADY_POOL_SIZE,
60             Common.TYPE_0_1 | Common.TYPE_STRING | Common.TYPE_KEY,
61             String JavaDoc.class);
62         this.createProperty("resize-quantity", // NOI18N
63
RESIZE_QUANTITY,
64             Common.TYPE_0_1 | Common.TYPE_STRING | Common.TYPE_KEY,
65             String JavaDoc.class);
66         this.createProperty("max-pool-size", // NOI18N
67
MAX_POOL_SIZE,
68             Common.TYPE_0_1 | Common.TYPE_STRING | Common.TYPE_KEY,
69             String JavaDoc.class);
70         this.createProperty("pool-idle-timeout-in-seconds", // NOI18N
71
POOL_IDLE_TIMEOUT_IN_SECONDS,
72             Common.TYPE_0_1 | Common.TYPE_STRING | Common.TYPE_KEY,
73             String JavaDoc.class);
74         this.createProperty("max-wait-time-in-millis", // NOI18N
75
MAX_WAIT_TIME_IN_MILLIS,
76             Common.TYPE_0_1 | Common.TYPE_STRING | Common.TYPE_KEY,
77             String JavaDoc.class);
78         this.initialize(options);
79     }
80
81     // Setting the default values of the properties
82
void initialize(int options)
83     {
84                     
85     }
86
87     // This attribute is optional
88
public void setSteadyPoolSize(String JavaDoc value) {
89         this.setValue(STEADY_POOL_SIZE, value);
90     }
91
92     //
93
public String JavaDoc getSteadyPoolSize() {
94         return (String JavaDoc)this.getValue(STEADY_POOL_SIZE);
95     }
96
97     // This attribute is optional
98
public void setResizeQuantity(String JavaDoc value) {
99         this.setValue(RESIZE_QUANTITY, value);
100     }
101
102     //
103
public String JavaDoc getResizeQuantity() {
104         return (String JavaDoc)this.getValue(RESIZE_QUANTITY);
105     }
106
107     // This attribute is optional
108
public void setMaxPoolSize(String JavaDoc value) {
109         this.setValue(MAX_POOL_SIZE, value);
110     }
111
112     //
113
public String JavaDoc getMaxPoolSize() {
114         return (String JavaDoc)this.getValue(MAX_POOL_SIZE);
115     }
116
117     // This attribute is optional
118
public void setPoolIdleTimeoutInSeconds(String JavaDoc value) {
119         this.setValue(POOL_IDLE_TIMEOUT_IN_SECONDS, value);
120     }
121
122     //
123
public String JavaDoc getPoolIdleTimeoutInSeconds() {
124         return (String JavaDoc)this.getValue(POOL_IDLE_TIMEOUT_IN_SECONDS);
125     }
126
127     // This attribute is optional
128
public void setMaxWaitTimeInMillis(String JavaDoc value) {
129         this.setValue(MAX_WAIT_TIME_IN_MILLIS, value);
130     }
131
132     //
133
public String JavaDoc getMaxWaitTimeInMillis() {
134         return (String JavaDoc)this.getValue(MAX_WAIT_TIME_IN_MILLIS);
135     }
136
137     //
138
public static void addComparator(org.netbeans.modules.schema2beans.BeanComparator c) {
139         comparators.add(c);
140     }
141
142     //
143
public static void removeComparator(org.netbeans.modules.schema2beans.BeanComparator c) {
144         comparators.remove(c);
145     }
146     public void validate() throws org.netbeans.modules.schema2beans.ValidateException {
147         boolean restrictionFailure = false;
148         // Validating property steadyPoolSize
149
if (getSteadyPoolSize() != null) {
150         }
151         // Validating property resizeQuantity
152
if (getResizeQuantity() != null) {
153         }
154         // Validating property maxPoolSize
155
if (getMaxPoolSize() != null) {
156         }
157         // Validating property poolIdleTimeoutInSeconds
158
if (getPoolIdleTimeoutInSeconds() != null) {
159         }
160         // Validating property maxWaitTimeInMillis
161
if (getMaxWaitTimeInMillis() != null) {
162         }
163     }
164
165     // Dump the content of this bean returning it as a String
166
public void dump(StringBuffer JavaDoc str, String JavaDoc indent){
167         String JavaDoc s;
168         Object JavaDoc o;
169         org.netbeans.modules.schema2beans.BaseBean n;
170         str.append(indent);
171         str.append("SteadyPoolSize"); // NOI18N
172
str.append(indent+"\t"); // NOI18N
173
str.append("<"); // NOI18N
174
s = this.getSteadyPoolSize();
175         str.append((s==null?"null":s.trim())); // NOI18N
176
str.append(">\n"); // NOI18N
177
this.dumpAttributes(STEADY_POOL_SIZE, 0, str, indent);
178
179         str.append(indent);
180         str.append("ResizeQuantity"); // NOI18N
181
str.append(indent+"\t"); // NOI18N
182
str.append("<"); // NOI18N
183
s = this.getResizeQuantity();
184         str.append((s==null?"null":s.trim())); // NOI18N
185
str.append(">\n"); // NOI18N
186
this.dumpAttributes(RESIZE_QUANTITY, 0, str, indent);
187
188         str.append(indent);
189         str.append("MaxPoolSize"); // NOI18N
190
str.append(indent+"\t"); // NOI18N
191
str.append("<"); // NOI18N
192
s = this.getMaxPoolSize();
193         str.append((s==null?"null":s.trim())); // NOI18N
194
str.append(">\n"); // NOI18N
195
this.dumpAttributes(MAX_POOL_SIZE, 0, str, indent);
196
197         str.append(indent);
198         str.append("PoolIdleTimeoutInSeconds"); // NOI18N
199
str.append(indent+"\t"); // NOI18N
200
str.append("<"); // NOI18N
201
s = this.getPoolIdleTimeoutInSeconds();
202         str.append((s==null?"null":s.trim())); // NOI18N
203
str.append(">\n"); // NOI18N
204
this.dumpAttributes(POOL_IDLE_TIMEOUT_IN_SECONDS, 0, str, indent);
205
206         str.append(indent);
207         str.append("MaxWaitTimeInMillis"); // NOI18N
208
str.append(indent+"\t"); // NOI18N
209
str.append("<"); // NOI18N
210
s = this.getMaxWaitTimeInMillis();
211         str.append((s==null?"null":s.trim())); // NOI18N
212
str.append(">\n"); // NOI18N
213
this.dumpAttributes(MAX_WAIT_TIME_IN_MILLIS, 0, str, indent);
214
215     }
216     public String JavaDoc dumpBeanNode(){
217         StringBuffer JavaDoc str = new StringBuffer JavaDoc();
218         str.append("BeanPool\n"); // NOI18N
219
this.dump(str, "\n "); // NOI18N
220
return str.toString();
221     }}
222
223 // END_NOI18N
224

225
226 /*
227         The following schema file has been used for generation:
228
229 <!--
230   XML DTD for Sun ONE Application Server specific EJB jar module
231   deployment descriptor. This is a companion DTD for ejb-jar_2_1.xsd
232
233   $Revision: 1.3 $
234 -->
235
236 <!--
237 This is the root element of the ejb module descriptor document.
238 -->
239 <!ELEMENT sun-ejb-jar (security-role-mapping*, enterprise-beans) >
240
241 <!--
242 System unique object id. Automatically generated and updated at deployment/redeployment
243 -->
244 <!ELEMENT unique-id (#PCDATA)>
245
246 <!--
247 This is the root element describing all the runtime of an ejb-jar in the application.
248 -->
249 <!ELEMENT enterprise-beans (name?, unique-id?, ejb*, pm-descriptors?, cmp-resource?,
250     message-destination*, webservice-description*)>
251
252 <!--
253 This is the element describing runtime bindings for a single ejb.
254
255 Properties applicable to all types of beans:
256      ejb-name, ejb-ref*, jndi-name, resource-ref*, resource-env-ref*, pass-by-reference?,
257      ior-security-config?, gen-classes?, service-ref*
258
259 Additional properties applicable to a stateless session bean:
260     bean-pool, webservice-endpoint
261
262 Additional properties applicable to a stateful session bean:
263     bean-cache, webservice-endpoint
264
265 Additional properties applicable to an entity bean:
266    is-read-only-bean?, refresh-period-in-seconds?, cmp?, commit-option?, bean-cache?, bean-pool?
267
268 Additional properties applicable to a message-driven bean:
269    mdb-resource-adapter?, mdb-connection-factory?, jms-durable-subscription-name?,
270    jms-max-messages-load?, bean-pool?
271    ( In case of MDB, jndi-name is the jndi name of the associated jms destination )
272 -->
273
274 <!ELEMENT ejb (ejb-name, jndi-name?, ejb-ref*, resource-ref*, resource-env-ref*, service-ref*, pass-by-reference?,
275                cmp?, principal?, mdb-connection-factory?, jms-durable-subscription-name?,
276                jms-max-messages-load?, ior-security-config?, is-read-only-bean?,
277                refresh-period-in-seconds?, commit-option?, cmt-timeout-in-seconds?, gen-classes?,
278                bean-pool?, bean-cache?, mdb-resource-adapter?, webservice-endpoint*, session?)>
279 <!--
280 The text in this element matches the ejb-name of the ejb to which it refers in ejb-jar.xml.
281 -->
282 <!ELEMENT ejb-name (#PCDATA)>
283
284 <!--
285 The text in this element is a true/false flag for read only beans.
286 -->
287 <!ELEMENT is-read-only-bean (#PCDATA)>
288
289 <!--
290 This is the root element which binds an ejb reference to a jndi name.
291 -->
292 <!ELEMENT ejb-ref (ejb-ref-name, jndi-name)>
293
294 <!--
295 The ejb ref name locates the name of the ejb reference in the application.
296 -->
297 <!ELEMENT ejb-ref-name (#PCDATA)>
298
299 <!--
300 This element describes runtime information for a CMP EntityBean object for
301 EJB1.1 and EJB2.0 beans.
302 -->
303 <!ELEMENT cmp (mapping-properties?, is-one-one-cmp?, one-one-finders?)>
304
305 <!--
306 This contains the location of the persistence vendor specific O/R mapping file
307 -->
308 <!ELEMENT mapping-properties (#PCDATA)>
309
310 <!--
311 This element in deprecated. It has been left in the DTD for validation purposes.
312 Any value will be ignored by the runtime.
313 -->
314 <!ELEMENT is-one-one-cmp (#PCDATA)>
315
316 <!--
317 This root element contains the finders for CMP 1.1.
318 -->
319 <!ELEMENT one-one-finders (finder+ )>
320
321 <!--
322 This root element contains the finder for CMP 1.1 with a method-name and query parameters
323 -->
324 <!ELEMENT finder (method-name, query-params?, query-filter?, query-variables?, query-ordering?)>
325
326 <!--
327 This contains the query parameters for CMP 1.1 finder
328 -->
329 <!ELEMENT query-params (#PCDATA)>
330
331 <!--
332 This optional element contains the query filter for CMP 1.1 finder
333 -->
334 <!ELEMENT query-filter (#PCDATA)>
335
336 <!--
337 This optional element contains variables in query expression for CMP 1.1 finder
338 -->
339 <!ELEMENT query-variables (#PCDATA)>
340
341 <!--
342 This optional element contains the ordering specification for CMP 1.1 finder.
343 -->
344
345 <!ELEMENT query-ordering (#PCDATA)>
346
347 <!--
348 This element identifies the database and the policy for processing CMP beans
349 storage. The jndi-name element identifies either the persistence-manager-
350 factory-resource or the jdbc-resource as defined in the server configuration.
351 -->
352 <!ELEMENT cmp-resource (jndi-name, default-resource-principal?, property*,
353         create-tables-at-deploy?, drop-tables-at-undeploy?,
354         database-vendor-name?, schema-generator-properties?)>
355
356 <!--
357 This element contains the override properties for the schema generation
358 from CMP beans in this module.
359 -->
360 <!ELEMENT schema-generator-properties (property*) >
361
362 <!--
363 This element specifies whether automatic creation of tables for the CMP beans
364 is done at module deployment. Acceptable values are true or false
365 -->
366 <!ELEMENT create-tables-at-deploy ( #PCDATA )>
367
368 <!--
369 This element specifies whether automatic dropping of tables for the CMP beans
370 is done at module undeployment. Acceptabel values are true of false
371 -->
372 <!ELEMENT drop-tables-at-undeploy ( #PCDATA )>
373
374 <!--
375 This element specifies the database vendor name for ddl files generated at
376 module deployment. Default is SQL92.
377 -->
378 <!ELEMENT database-vendor-name ( #PCDATA )>
379
380 <!--
381 This element specifies the connection factory associated with a message-driven bean.
382 -->
383 <!ELEMENT mdb-connection-factory (jndi-name, default-resource-principal?)>
384
385 <!--
386 This node holds information about a logical message destination
387 -->
388 <!ELEMENT message-destination (message-destination-name, jndi-name)>
389
390 <!--
391 This node holds the name of a logical message destination
392 -->
393 <!ELEMENT message-destination-name (#PCDATA)>
394
395 <!--
396 Specifies the name of a durable subscription associated with a message-driven bean's
397 destination. Required for a Topic destination, if subscription-durability is set to
398 Durable (in ejb-jar.xml)
399 -->
400 <!ELEMENT jms-durable-subscription-name (#PCDATA)>
401
402 <!--
403 A string value specifies the maximum number of messages to load into a JMS session
404 at one time for a message-driven bean to serve. If not specified, the default is 1.
405 -->
406 <!ELEMENT jms-max-messages-load (#PCDATA)>
407
408 <!--
409 This element contains all the generated class names for a bean.
410 -->
411 <!ELEMENT gen-classes ( remote-impl?, local-impl?, remote-home-impl?, local-home-impl? )>
412
413 <!--
414 This contains the fully qualified class name of the generated EJBObject impl class.
415 -->
416 <!ELEMENT remote-impl (#PCDATA)>
417
418 <!--
419 This contains the fully qualified class name of the generated EJBLocalObject impl class.
420 -->
421 <!ELEMENT local-impl (#PCDATA)>
422
423 <!--
424 This contains the fully qualified class name of the generated EJBHome impl class.
425 -->
426 <!ELEMENT remote-home-impl (#PCDATA)>
427
428 <!--
429 This contains the fully qualified class name of the generated EJBLocalHome impl class.
430 -->
431 <!ELEMENT local-home-impl (#PCDATA)>
432
433 <!--
434 This contains the bean cache properties. Used only for entity beans and stateful session beans
435 -->
436 <!ELEMENT bean-cache (max-cache-size?, resize-quantity?, is-cache-overflow-allowed?, cache-idle-timeout-in-seconds?, removal-timeout-in-seconds?, victim-selection-policy?)>
437
438 <!--
439 max-cache-size defines the maximum number of beans in the cache. Should be greater than 1.
440 Default is 512.
441 -->
442 <!ELEMENT max-cache-size (#PCDATA)>
443
444 <!--
445 is-cache-overflow-allowed is a boolean which indicates if the cache size is a hard limit or not.
446 Default is true i.e there is no hard limit. max-cache-size is a hint to the cache implementation.
447 -->
448 <!ELEMENT is-cache-overflow-allowed (#PCDATA)>
449
450 <!--
451 cache-idle-timeout-in-seconds specifies the maximum time that a stateful session bean or
452 entity bean is allowed to be idle in the cache. After this time, the bean is passivated
453 to backup store. This is a hint to server. Default value for cache-idle-timeout-in-seconds
454 is 600 seconds.
455 -->
456 <!ELEMENT cache-idle-timeout-in-seconds (#PCDATA)>
457
458
459 <!--
460 The amount of time that the bean remains passivated (i.e. idle in the backup store) is
461 controlled by removal-timeout-in-seconds parameter. Note that if a bean was not accessed beyond
462 removal-timeout-in-seconds, then it will be removed from the backup store and hence will not
463 be accessible to the client. The Default value for removal-timeout-in-seconds is 60min.
464 -->
465 <!ELEMENT removal-timeout-in-seconds (#PCDATA)>
466
467 <!--
468 victim-selection-policy specifies the algorithm to use to pick victims.
469 Possible values are FIFO | LRU | NRU. Default is NRU, which is actually
470 pseudo-random selection policy.
471 -->
472 <!ELEMENT victim-selection-policy (#PCDATA)>
473
474 <!--
475 bean-pool is a root element containing the bean pool properties. Used only for stateless session
476 bean and message-driven bean pools.
477 -->
478 <!ELEMENT bean-pool (steady-pool-size?, resize-quantity?, max-pool-size?, pool-idle-timeout-in-seconds?, max-wait-time-in-millis?)>
479
480 <!--
481 steady-pool-size specified the initial and minimum number of beans that must be maintained in the pool.
482 Valid values are from 0 to MAX_INTEGER.
483 -->
484 <!ELEMENT steady-pool-size (#PCDATA)>
485
486 <!--
487 resize-quantity specifies the number of beans to be created or deleted when the pool
488 or cache is being serviced by the server. Valid values are from 0 to MAX_INTEGER and
489 subject to maximum size limit). Default is 16.
490 -->
491 <!ELEMENT resize-quantity (#PCDATA)>
492
493 <!--
494 max-pool-size speifies the maximum pool size. Valid values are from 0 to MAX_INTEGER.
495 Default is 64.
496 -->
497 <!ELEMENT max-pool-size (#PCDATA)>
498
499 <!--
500 pool-idle-timeout-in-seconds specifies the maximum time that a stateless session bean or
501 message-driven bean is allowed to be idle in the pool. After this time, the bean is
502 passivated to backup store. This is a hint to server. Default value for
503 pool-idle-timeout-in-seconds is 600 seconds.
504 -->
505 <!ELEMENT pool-idle-timeout-in-seconds (#PCDATA)>
506
507 <!--
508 A string field whose valid values are either "B", or "C". Default is "B"
509 -->
510 <!ELEMENT commit-option (#PCDATA)>
511
512 <!--
513 Specifies the timeout for transactions started by the container. This value must be greater than zero, else it will be ignored by the container.
514 -->
515 <!ELEMENT cmt-timeout-in-seconds (#PCDATA)>
516
517 <!--
518 Specifies the maximum time that the caller is willing to wait to get a bean from the pool.
519 Wait time is infinite, if the value specified is 0. Deprecated.
520 -->
521 <!ELEMENT max-wait-time-in-millis (#PCDATA)>
522
523 <!--
524 refresh-period-in-seconds specifies the rate at which the read-only-bean must be refreshed
525 from the data source. 0 (never refreshed) and positive (refreshed at specified intervals).
526 Specified value is a hint to the container. Default is 600 seconds.
527 -->
528 <!ELEMENT refresh-period-in-seconds (#PCDATA)>
529
530 <!--
531 Specifies the jndi name string.
532 -->
533 <!ELEMENT jndi-name (#PCDATA)>
534
535 <!--
536 This text nodes holds a name string.
537 -->
538 <!ELEMENT name (#PCDATA)>
539
540 <!--
541 This element holds password text.
542 -->
543 <!ELEMENT password (#PCDATA)>
544
545 <!--
546 This node describes a username on the platform.
547 -->
548 <!ELEMENT principal (name)>
549
550 <!--
551 security-role-mapping element maps the user principal or group
552 to a different principal on the server.
553 -->
554 <!ELEMENT security-role-mapping (role-name, (principal-name | group-name)+)>
555
556 <!--
557 role-name specifies an accepted role
558 -->
559 <!ELEMENT role-name (#PCDATA)>
560
561 <!--
562 principal-name specifies a valid principal
563 -->
564 <!ELEMENT principal-name (#PCDATA)>
565
566 <!--
567 group-name specifies a valid group name
568 -->
569 <!ELEMENT group-name (#PCDATA)>
570
571 <!--
572 The name of a resource reference.
573 -->
574 <!ELEMENT res-ref-name (#PCDATA)>
575
576 <!--
577 resource-env-ref holds all the runtime bindings of a resource env reference.
578 -->
579 <!ELEMENT resource-env-ref ( resource-env-ref-name, jndi-name )>
580
581 <!--
582 name of a resource env reference.
583 -->
584 <!ELEMENT resource-env-ref-name (#PCDATA)>
585
586 <!--
587 resource-ref node holds all the runtime bindings of a resource reference.
588 -->
589 <!ELEMENT resource-ref (res-ref-name, jndi-name, default-resource-principal?)>
590
591 <!--
592 user name and password to be used when none are specified while accesing a resource
593 -->
594 <!ELEMENT default-resource-principal ( name, password)>
595
596 <!--
597 ior-security-config element describes the security configuration information for the IOR.
598 -->
599 <!ELEMENT ior-security-config ( transport-config? , as-context?, sas-context? )>
600
601 <!--
602 transport-config is the root element for security between the end points
603 -->
604 <!ELEMENT transport-config ( integrity, confidentiality, establish-trust-in-target, establish-trust-in-client )>
605
606 <!--
607 integrity element indicates if the server (target) supports integrity protected messages.
608 The valid values are NONE, SUPPORTED or REQUIRED
609 -->
610 <!ELEMENT integrity ( #PCDATA)>
611
612 <!--
613 confidentiality element indicates if the server (target) supports privacy protected
614 messages. The values are NONE, SUPPORTED or REQUIRED
615 -->
616 <!ELEMENT confidentiality ( #PCDATA)>
617
618 <!--
619 establish-trust-in-target element indicates if the target is capable of authenticating to a client.
620 The values are NONE or SUPPORTED.
621 -->
622 <!ELEMENT establish-trust-in-target ( #PCDATA)>
623
624 <!--
625 establish-trust-in-client element indicates if the target is capable of authenticating a client. The
626 values are NONE, SUPPORTED or REQUIRED.
627 -->
628 <!ELEMENT establish-trust-in-client ( #PCDATA)>
629
630 <!--
631 as-context (CSIv2 authentication service) is the element describing the authentication
632 mechanism that will be used to authenticate the client. If specified it will be the
633 username-password mechanism.
634 -->
635 <!ELEMENT as-context ( auth-method, realm, required )>
636
637 <!--
638 required element specifies if the authentication method specified is required
639 to be used for client authentication. If so the EstablishTrustInClient bit
640 will be set in the target_requires field of the AS_Context. The element value
641 is either true or false.
642 -->
643 <!ELEMENT required ( #PCDATA )>
644
645 <!--
646 auth-method element describes the authentication method. The only supported value
647 is USERNAME_PASSWORD
648 -->
649 <!ELEMENT auth-method ( #PCDATA )>
650
651 <!--
652 realm element describes the realm in which the user is authenticated. Must be
653 a valid realm that is registered in server configuration.
654 -->
655 <!ELEMENT realm ( #PCDATA )>
656
657 <!--
658 sas-context (related to CSIv2 security attribute service) element describes
659 the sas-context fields.
660 -->
661 <!ELEMENT sas-context ( caller-propagation )>
662
663 <!--
664 caller-propagation element indicates if the target will accept propagated caller identities
665 The values are NONE or SUPPORTED.
666 -->
667 <!ELEMENT caller-propagation ( #PCDATA) >
668
669 <!--
670 pass-by-reference elements controls use of Pass by Reference semantics.
671 EJB spec requires pass by value, which will be the default mode of operation.
672 This can be set to true for non-compliant operation and possibly higher
673 performance. For a stand-alone server, this can be used. By setting a similarly
674 named element at sun-application.xml, it can apply to all the enclosed ejb
675 modules. Allowed values are true and false. Default will be false.
676  -->
677 <!ELEMENT pass-by-reference (#PCDATA)>
678
679 <!--
680 PM descriptors contain one or more pm descriptors, but only one of them must
681 be in use at any given time. If not specified, the Sun ONE CMP is used.
682 -->
683 <!ELEMENT pm-descriptors ( pm-descriptor+, pm-inuse)>
684
685 <!--
686 pm-descriptor describes the pluggable vendor implementation for the CMP
687 support of the CMP entity beans in this module.
688 -->
689 <!ELEMENT pm-descriptor ( pm-identifier, pm-version, pm-config?, pm-class-generator, pm-mapping-factory?)>
690
691 <!--
692 pm-identifier element identifies the vendor who provides the CMP implementation
693 -->
694 <!ELEMENT pm-identifier (#PCDATA)>
695
696 <!--
697 pm-version further specifies which version of PM vendor product to be used
698 -->
699 <!ELEMENT pm-version (#PCDATA)>
700
701 <!--
702 pm-config specifies the vendor specific config file to be used
703 -->
704 <!ELEMENT pm-config (#PCDATA)>
705
706 <!--
707 pm-class-generator specifies the vendor specific class generator to be used
708 at the module deploymant time. This is the name of the class specific to this
709 vendor.
710 -->
711 <!ELEMENT pm-class-generator (#PCDATA)>
712
713 <!--
714 pm-mapping-factory specifies the vendor specific mapping factory
715 This is the name of the class specific to a vendor.
716 -->
717 <!ELEMENT pm-mapping-factory (#PCDATA)>
718
719 <!--
720 pm-inuse specifies which CMP vendor is used.
721 -->
722 <!ELEMENT pm-inuse (pm-identifier, pm-version)>
723
724
725 <!--
726 This holds the runtime configuration properties of the message-driven bean
727 in its operation environment. For example, this may include information
728 about the name of a physical JMS destination etc.
729 Defined this way to match the activation-config on the standard
730 deployment descriptor for message-driven bean.
731 -->
732 <!ELEMENT activation-config ( description?, activation-config-property+ ) >
733
734 <!--
735 provide an element description
736 -->
737 <!ELEMENT description (#PCDATA)>
738
739 <!--
740 This hold a particular activation config propery name-value pair
741 -->
742 <!ELEMENT activation-config-property (
743   activation-config-property-name, activation-config-property-value ) >
744
745 <!--
746 This holds the name of a runtime activation-config property
747 -->
748 <!ELEMENT activation-config-property-name ( #PCDATA ) >
749
750 <!--
751 This holds the value of a runtime activation-config property
752 -->
753 <!ELEMENT activation-config-property-value ( #PCDATA ) >
754
755 <!--
756 This node holds the module ID of the resource adapter that
757 is responsible for delivering messages to the message-driven
758 bean, as well as the runtime configuration information for
759 the mdb.
760 -->
761 <!ELEMENT mdb-resource-adapter ( resource-adapter-mid, activation-config? )>
762
763 <!--
764 This node holds the module ID of the resource adapter that is responsible
765 for delivering messages to the message-driven bean.
766 -->
767 <!ELEMENT resource-adapter-mid ( #PCDATA ) >
768
769 <!--
770 Generic name-value pairs property
771 -->
772 <!ELEMENT property ( name, value ) >
773
774 <!--
775 This text nodes holds a value string.
776 -->
777 <!ELEMENT value (#PCDATA)>
778
779
780
781 <!--
782             W E B S E R V I C E S
783 -->
784 <!--
785 Information about a web service endpoint.
786 -->
787 <!ELEMENT webservice-endpoint ( port-component-name, endpoint-address-uri?, login-config?, transport-guarantee?, service-qname?, tie-class?, servlet-impl-class? )>
788
789 <!--
790 Unique name of a port component within a module
791 -->
792 <!ELEMENT port-component-name ( #PCDATA )>
793
794 <!--
795 Relative path combined with web server root to form fully qualified
796 endpoint address for a web service endpoint. For servlet endpoints, this
797 value is relative to the servlet's web application context root. In
798 all cases, this value must be a fixed pattern(i.e. no "*" allowed).
799 If the web service endpoint is a servlet that only implements a single
800 endpoint has only one url-pattern, it is not necessary to set
801 this value since the container can derive it from web.xml.
802 -->
803 <!ELEMENT endpoint-address-uri ( #PCDATA )>
804
805 <!--
806 The name of tie implementation class for a port-component. This is
807 not specified by the deployer. It is derived during deployment.
808 -->
809 <!ELEMENT tie-class (#PCDATA)>
810
811 <!--
812 The service-qname element declares the specific WSDL service
813 element that is being refered to. It is not set by the deployer.
814 It is derived during deployment.
815 -->
816 <!ELEMENT service-qname (namespaceURI, localpart)>
817
818 <!--
819 The localpart element indicates the local part of a QNAME.
820 -->
821 <!ELEMENT localpart (#PCDATA)>
822
823 <!--
824 The namespaceURI element indicates a URI.
825 -->
826 <!ELEMENT namespaceURI (#PCDATA)>
827
828 <!--
829 Optional authentication configuration for an EJB web service endpoint.
830 Not needed for servet web service endpoints. Their security configuration
831 is contained in the standard web application descriptor.
832 -->
833 <!ELEMENT login-config ( auth-method )>
834
835 <!--
836 Name of application-written servlet impl class contained in deployed war.
837 This is not set by the deployer. It is derived by the container
838 during deployment.
839 -->
840 <!ELEMENT servlet-impl-class (#PCDATA)>
841
842 <!--
843 Runtime settings for a web service reference. In the simplest case,
844 there is no runtime information required for a service ref. Runtime info
845 is only needed in the following cases :
846  * to define the port that should be used to resolve a container-managed port
847  * to define default Stub/Call property settings for Stub objects
848  * to define the URL of a final WSDL document to be used instead of
849 the one packaged with a service-ref
850 -->
851 <!ELEMENT service-ref ( service-ref-name, port-info*, call-property*, wsdl-override?, service-impl-class?, service-qname? )>
852
853 <!--
854 Coded name (relative to java:comp/env) for a service-reference
855 -->
856 <!ELEMENT service-ref-name ( #PCDATA )>
857
858 <!--
859 Name of generated service implementation class. This is not set by the
860 deployer. It is derived during deployment.
861 -->
862 <!ELEMENT service-impl-class ( #PCDATA )>
863
864 <!--
865 Information for a port within a service-reference.
866
867 Either service-endpoint-interface or wsdl-port or both
868 (service-endpoint-interface and wsdl-port) should be specified.
869
870 If both are specified, wsdl-port represents the
871 port the container should choose for container-managed port selection.
872
873 The same wsdl-port value must not appear in
874 more than one port-info entry within the same service-ref.
875
876 If a particular service-endpoint-interface is using container-managed port
877 selection, it must not appear in more than one port-info entry
878 within the same service-ref.
879
880 -->
881 <!ELEMENT port-info ( service-endpoint-interface?, wsdl-port?, stub-property*, call-property* )>
882
883 <!--
884 Fully qualified name of service endpoint interface
885 -->
886 <!ELEMENT service-endpoint-interface ( #PCDATA )>
887
888 <!--
889 Specifies that the communication between client and server should
890 be NONE, INTEGRAL, or CONFIDENTIAL. NONE means that the application
891 does not require any transport guarantees. A value of INTEGRAL means
892 that the application requires that the data sent between the client
893 and server be sent in such a way that it can't be changed in transit.
894 CONFIDENTIAL means that the application requires that the data be
895 transmitted in a fashion that prevents other entities from observing
896 the contents of the transmission. In most cases, the presence of the
897 INTEGRAL or CONFIDENTIAL flag will indicate that the use of SSL is
898 required.
899 -->
900 <!ELEMENT transport-guarantee ( #PCDATA )>
901
902
903 <!--
904 Port used in port-info.
905 -->
906 <!ELEMENT wsdl-port ( namespaceURI, localpart )>
907
908 <!--
909 JAXRPC property values that should be set on a stub before it's returned to
910 to the web service client. The property names can be any properties supported
911 by the JAXRPC Stub implementation. See javadoc for javax.xml.rpc.Stub
912 -->
913 <!ELEMENT stub-property ( name, value )>
914
915 <!--
916 JAXRPC property values that should be set on a Call object before it's
917 returned to the web service client. The property names can be any
918 properties supported by the JAXRPC Call implementation. See javadoc
919 for javax.xml.rpc.Call
920 -->
921 <!ELEMENT call-property ( name, value )>
922
923 <!--
924 Runtime information about a web service.
925
926 wsdl-publish-location is optionally used to specify
927 where the final wsdl and any dependent files should be stored. This location
928 resides on the file system from which deployment is initiated.
929
930 -->
931 <!ELEMENT webservice-description ( webservice-description-name, wsdl-publish-location? )>
932
933 <!--
934 Unique name of a webservice within a module
935 -->
936 <!ELEMENT webservice-description-name ( #PCDATA )>
937
938 <!--
939 This is a valid URL pointing to a final WSDL document. It is optional.
940 If specified, the WSDL document at this URL will be used during
941 deployment instead of the WSDL document associated with the
942 service-ref in the standard deployment descriptor.
943
944 Examples :
945
946   // available via HTTP
947   <wsdl-override>http://localhost:8000/myservice/myport?WSDL</wsdl-override>
948
949   // in a file
950   <wsdl-override>file:/home/user1/myfinalwsdl.wsdl</wsdl-override>
951
952 -->
953 <!ELEMENT wsdl-override ( #PCDATA )>
954
955 <!--
956 file: URL of a directory to which a web-service-description's wsdl should be
957 published during deployment. Any required files will be published to this
958 directory, preserving their location relative to the module-specific
959 wsdl directory(META-INF/wsdl or WEB-INF/wsdl).
960
961 Example :
962
963   For an ejb.jar whose webservices.xml wsdl-file element contains
964     META-INF/wsdl/a/Foo.wsdl
965
966   <wsdl-publish-location>file:/home/user1/publish
967   </wsdl-publish-location>
968
969   The final wsdl will be stored in /home/user1/publish/a/Foo.wsdl
970
971 -->
972 <!ELEMENT wsdl-publish-location ( #PCDATA )>
973
974
975 <!--
976             S E / E E V e r s i o n r e l a t e d f i e l d s
977 -->
978 <!--
979 The session element specifies a Stateful enterprise bean's check pointing mechanism properties
980 Used in: ejb
981 -->
982 <!ELEMENT session ( checkpoint-location?, quick-checkpoint?, checkpointed-methods? )>
983
984 <!--
985 The checkpoint-location element specifies a Stateful enterprise bean's check pointing mechanism type. The checkpoint-location element must be one of the following:
986 <checkpoint-location>end-of-transaction</checkpoint-location>
987 <checkpoint-location>end-of-method</checkpoint-location>
988 <checkpoint-location>end-of-transaction-or-method</checkpoint-location>
989 Default value: end-of-transaction
990 Used in: session
991 -->
992 <!ELEMENT checkpoint-location (#PCDATA)>
993
994
995 <!--
996 The quick-checkpoint element specifies an enterprise bean's if ejbPassivate/ejbActivate must be called or not during check pointing.
997 The checkpointing-type element must be one of the two following:
998         <quick-checkpoint>true</quick-checkpoint>
999         <quick-checkpoint>false</quick-checkpoint>
1000Dafault: true
1001Used in: session
1002-->
1003<!ELEMENT quick-checkpoint (#PCDATA)>
1004
1005<!--
1006This element specifies which methods require checkpointing. The methods specified in here, will be checkpointed, when the checkpoint-location is set to end-of-method.
1007
1008Default: none or all methods if failover is enabled at application or cluster/instance levels
1009Used in: session
1010-->
1011<!ELEMENT checkpointed-methods (description?, method+)>
1012
1013<!--
1014
1015Method as defined in the standard deployment descriptors.
1016
1017Used in : checkpointed-methods
1018-->
1019<!ELEMENT method (description?, method-intf?, method-name,
1020method-params?)>
1021
1022<!--
1023
1024The method-intf element allows a method element to differentiate
1025between the methods with the same name and signature that are multiply
1026defined across the component and home interfaces (e.g, in both an
1027enterprise bean's remote and local interfaces; in both an enterprise bean's
1028home and remote interfaces, etc.)
1029
1030The method-intf element must be one of the following:
1031
1032    <method-intf>Home</method-intf>
1033    <method-intf>Remote</method-intf>
1034    <method-intf>LocalHome</method-intf>
1035    <method-intf>Local</method-intf>
1036
1037Used in: method
1038-->
1039<!ELEMENT method-intf (#PCDATA)>
1040
1041<!--
1042The method-name element contains a name of an enterprise bean method
1043or the asterisk (*) character. The asterisk is used when the element
1044denotes all the methods of an enterprise bean's component and home
1045interfaces.
1046
1047Used in: method, query-method
1048-->
1049<!ELEMENT method-name (#PCDATA)>
1050
1051<!--
1052The method-param element contains the fully-qualified Java type name
1053of a method parameter.
1054
1055Used in: method-params
1056-->
1057<!ELEMENT method-param (#PCDATA)>
1058
1059<!--
1060The method-params element contains a list of the fully-qualified Java
1061type names of the method parameters.
1062
1063Used in: method, query-method
1064-->
1065<!ELEMENT method-params (method-param*)>
1066
1067
1068
1069*/

1070
Popular Tags