KickJava   Java API By Example, From Geeks To Geeks.

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


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 PmDescriptors matches the schema element pm-descriptors
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 PmDescriptors extends com.sun.enterprise.tools.common.dd.SunBaseBean
40 {
41
42     static Vector comparators = new Vector();
43
44     static public final String JavaDoc PM_DESCRIPTOR = "PmDescriptor"; // NOI18N
45
static public final String JavaDoc PM_INUSE = "PmInuse"; // NOI18N
46

47     public PmDescriptors() {
48         this(Common.USE_DEFAULT_VALUES);
49     }
50
51     public PmDescriptors(int options)
52     {
53         super(comparators, new org.netbeans.modules.schema2beans.Version(1, 2, 0));
54         // Properties (see root bean comments for the bean graph)
55
this.createProperty("pm-descriptor", // NOI18N
56
PM_DESCRIPTOR,
57             Common.TYPE_1_N | Common.TYPE_BEAN | Common.TYPE_KEY,
58             PmDescriptor.class);
59         this.createProperty("pm-inuse", // NOI18N
60
PM_INUSE,
61             Common.TYPE_1 | Common.TYPE_BEAN | Common.TYPE_KEY,
62             PmInuse.class);
63         this.initialize(options);
64     }
65
66     // Setting the default values of the properties
67
void initialize(int options)
68     {
69
70     }
71
72     // This attribute is an array containing at least one element
73
public void setPmDescriptor(int index, PmDescriptor value) {
74         this.setValue(PM_DESCRIPTOR, index, value);
75     }
76
77     //
78
public PmDescriptor getPmDescriptor(int index) {
79         return (PmDescriptor)this.getValue(PM_DESCRIPTOR, index);
80     }
81
82     // This attribute is an array containing at least one element
83
public void setPmDescriptor(PmDescriptor[] value) {
84         this.setValue(PM_DESCRIPTOR, value);
85     }
86
87     //
88
public PmDescriptor[] getPmDescriptor() {
89         return (PmDescriptor[])this.getValues(PM_DESCRIPTOR);
90     }
91
92     // Return the number of properties
93
public int sizePmDescriptor() {
94         return this.size(PM_DESCRIPTOR);
95     }
96
97     // Add a new element returning its index in the list
98
public int addPmDescriptor(com.sun.enterprise.tools.common.dd.ejb.PmDescriptor value) {
99         return this.addValue(PM_DESCRIPTOR, value);
100     }
101
102     //
103
// Remove an element using its reference
104
// Returns the index the element had in the list
105
//
106
public int removePmDescriptor(com.sun.enterprise.tools.common.dd.ejb.PmDescriptor value) {
107         return this.removeValue(PM_DESCRIPTOR, value);
108     }
109
110     // This attribute is mandatory
111
public void setPmInuse(PmInuse value) {
112         this.setValue(PM_INUSE, value);
113     }
114
115     //
116
public PmInuse getPmInuse() {
117         return (PmInuse)this.getValue(PM_INUSE);
118     }
119
120     //
121
public static void addComparator(org.netbeans.modules.schema2beans.BeanComparator c) {
122         comparators.add(c);
123     }
124
125     //
126
public static void removeComparator(org.netbeans.modules.schema2beans.BeanComparator c) {
127         comparators.remove(c);
128     }
129     public void validate() throws org.netbeans.modules.schema2beans.ValidateException {
130         boolean restrictionFailure = false;
131         // Validating property pmDescriptor
132
if (sizePmDescriptor() == 0) {
133             throw new org.netbeans.modules.schema2beans.ValidateException("sizePmDescriptor() == 0", "pmDescriptor", this); // NOI18N
134
}
135         for (int _index = 0; _index < sizePmDescriptor(); ++_index) {
136             com.sun.enterprise.tools.common.dd.ejb.PmDescriptor element = getPmDescriptor(_index);
137             if (element != null) {
138                 element.validate();
139             }
140         }
141         // Validating property pmInuse
142
if (getPmInuse() == null) {
143             throw new org.netbeans.modules.schema2beans.ValidateException("getPmInuse() == null", "pmInuse", this); // NOI18N
144
}
145         getPmInuse().validate();
146     }
147
148     // Dump the content of this bean returning it as a String
149
public void dump(StringBuffer JavaDoc str, String JavaDoc indent){
150         String JavaDoc s;
151         Object JavaDoc o;
152         org.netbeans.modules.schema2beans.BaseBean n;
153         str.append(indent);
154         str.append("PmDescriptor["+this.sizePmDescriptor()+"]"); // NOI18N
155
for(int i=0; i<this.sizePmDescriptor(); i++)
156         {
157             str.append(indent+"\t");
158             str.append("#"+i+":");
159             n = (org.netbeans.modules.schema2beans.BaseBean) this.getPmDescriptor(i);
160             if (n != null)
161                 n.dump(str, indent + "\t"); // NOI18N
162
else
163                 str.append(indent+"\tnull"); // NOI18N
164
this.dumpAttributes(PM_DESCRIPTOR, i, str, indent);
165         }
166
167         str.append(indent);
168         str.append("PmInuse"); // NOI18N
169
n = (org.netbeans.modules.schema2beans.BaseBean) this.getPmInuse();
170         if (n != null)
171             n.dump(str, indent + "\t"); // NOI18N
172
else
173             str.append(indent+"\tnull"); // NOI18N
174
this.dumpAttributes(PM_INUSE, 0, str, indent);
175
176     }
177     public String JavaDoc dumpBeanNode(){
178         StringBuffer JavaDoc str = new StringBuffer JavaDoc();
179         str.append("PmDescriptors\n"); // NOI18N
180
this.dump(str, "\n "); // NOI18N
181
return str.toString();
182     }}
183
184 // END_NOI18N
185

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

1031
Popular Tags