KickJava   Java API By Example, From Geeks To Geeks.

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


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 Session matches the schema element session
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 Session extends com.sun.enterprise.tools.common.dd.SunBaseBean
40 {
41
42     static Vector comparators = new Vector();
43
44     static public final String JavaDoc CHECKPOINT_LOCATION = "CheckpointLocation"; // NOI18N
45
static public final String JavaDoc QUICK_CHECKPOINT = "QuickCheckpoint"; // NOI18N
46
static public final String JavaDoc CHECKPOINTED_METHODS = "CheckpointedMethods"; // NOI18N
47

48     public Session() {
49         this(Common.USE_DEFAULT_VALUES);
50     }
51
52     public Session(int options)
53     {
54         super(comparators, new org.netbeans.modules.schema2beans.Version(1, 2, 0));
55         // Properties (see root bean comments for the bean graph)
56
this.createProperty("checkpoint-location", // NOI18N
57
CHECKPOINT_LOCATION,
58             Common.TYPE_0_1 | Common.TYPE_STRING | Common.TYPE_KEY,
59             String JavaDoc.class);
60         this.createProperty("quick-checkpoint", // NOI18N
61
QUICK_CHECKPOINT,
62             Common.TYPE_0_1 | Common.TYPE_STRING | Common.TYPE_KEY,
63             String JavaDoc.class);
64         this.createProperty("checkpointed-methods", // NOI18N
65
CHECKPOINTED_METHODS,
66             Common.TYPE_0_1 | Common.TYPE_BEAN | Common.TYPE_KEY,
67             CheckpointedMethods.class);
68         this.initialize(options);
69     }
70
71     // Setting the default values of the properties
72
void initialize(int options)
73     {
74         
75     }
76
77     // This attribute is optional
78
public void setCheckpointLocation(String JavaDoc value) {
79         this.setValue(CHECKPOINT_LOCATION, value);
80     }
81
82     //
83
public String JavaDoc getCheckpointLocation() {
84         return (String JavaDoc)this.getValue(CHECKPOINT_LOCATION);
85     }
86
87     // This attribute is optional
88
public void setQuickCheckpoint(String JavaDoc value) {
89         this.setValue(QUICK_CHECKPOINT, value);
90     }
91
92     //
93
public String JavaDoc getQuickCheckpoint() {
94         return (String JavaDoc)this.getValue(QUICK_CHECKPOINT);
95     }
96
97     // This attribute is optional
98
public void setCheckpointedMethods(CheckpointedMethods value) {
99         this.setValue(CHECKPOINTED_METHODS, value);
100     }
101
102     //
103
public CheckpointedMethods getCheckpointedMethods() {
104         return (CheckpointedMethods)this.getValue(CHECKPOINTED_METHODS);
105     }
106
107     //
108
public static void addComparator(org.netbeans.modules.schema2beans.BeanComparator c) {
109         comparators.add(c);
110     }
111
112     //
113
public static void removeComparator(org.netbeans.modules.schema2beans.BeanComparator c) {
114         comparators.remove(c);
115     }
116     public void validate() throws org.netbeans.modules.schema2beans.ValidateException {
117         boolean restrictionFailure = false;
118         // Validating property checkpointLocation
119
if (getCheckpointLocation() != null) {
120         }
121         // Validating property quickCheckpoint
122
if (getQuickCheckpoint() != null) {
123         }
124         // Validating property checkpointedMethods
125
if (getCheckpointedMethods() != null) {
126             getCheckpointedMethods().validate();
127         }
128     }
129
130     // Dump the content of this bean returning it as a String
131
public void dump(StringBuffer JavaDoc str, String JavaDoc indent){
132         String JavaDoc s;
133         Object JavaDoc o;
134         org.netbeans.modules.schema2beans.BaseBean n;
135         str.append(indent);
136         str.append("CheckpointLocation"); // NOI18N
137
str.append(indent+"\t"); // NOI18N
138
str.append("<"); // NOI18N
139
s = this.getCheckpointLocation();
140         str.append((s==null?"null":s.trim())); // NOI18N
141
str.append(">\n"); // NOI18N
142
this.dumpAttributes(CHECKPOINT_LOCATION, 0, str, indent);
143
144         str.append(indent);
145         str.append("QuickCheckpoint"); // NOI18N
146
str.append(indent+"\t"); // NOI18N
147
str.append("<"); // NOI18N
148
s = this.getQuickCheckpoint();
149         str.append((s==null?"null":s.trim())); // NOI18N
150
str.append(">\n"); // NOI18N
151
this.dumpAttributes(QUICK_CHECKPOINT, 0, str, indent);
152
153         str.append(indent);
154         str.append("CheckpointedMethods"); // NOI18N
155
n = (org.netbeans.modules.schema2beans.BaseBean) this.getCheckpointedMethods();
156         if (n != null)
157             n.dump(str, indent + "\t"); // NOI18N
158
else
159             str.append(indent+"\tnull"); // NOI18N
160
this.dumpAttributes(CHECKPOINTED_METHODS, 0, str, indent);
161
162     }
163     public String JavaDoc dumpBeanNode(){
164         StringBuffer JavaDoc str = new StringBuffer JavaDoc();
165         str.append("Session\n"); // NOI18N
166
this.dump(str, "\n "); // NOI18N
167
return str.toString();
168     }}
169
170 // END_NOI18N
171

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

1017
Popular Tags