KickJava   Java API By Example, From Geeks To Geeks.

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


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 ActivationConfig matches the schema element activation-config
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 ActivationConfig extends com.sun.enterprise.tools.common.dd.SunBaseBean
40 {
41
42     static Vector comparators = new Vector();
43
44     static public final String JavaDoc DESCRIPTION = "Description"; // NOI18N
45
static public final String JavaDoc ACTIVATION_CONFIG_PROPERTY = "ActivationConfigProperty"; // NOI18N
46

47     public ActivationConfig() {
48         this(Common.USE_DEFAULT_VALUES);
49     }
50
51     public ActivationConfig(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("description", // NOI18N
56
DESCRIPTION,
57             Common.TYPE_0_1 | Common.TYPE_STRING | Common.TYPE_KEY,
58             String JavaDoc.class);
59         this.createProperty("activation-config-property", // NOI18N
60
ACTIVATION_CONFIG_PROPERTY,
61             Common.TYPE_1_N | Common.TYPE_BEAN | Common.TYPE_KEY,
62             ActivationConfigProperty.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 optional
73
public void setDescription(String JavaDoc value) {
74         this.setValue(DESCRIPTION, value);
75     }
76
77     //
78
public String JavaDoc getDescription() {
79         return (String JavaDoc)this.getValue(DESCRIPTION);
80     }
81
82     // This attribute is an array containing at least one element
83
public void setActivationConfigProperty(int index, ActivationConfigProperty value) {
84         this.setValue(ACTIVATION_CONFIG_PROPERTY, index, value);
85     }
86
87     //
88
public ActivationConfigProperty getActivationConfigProperty(int index) {
89         return (ActivationConfigProperty)this.getValue(ACTIVATION_CONFIG_PROPERTY, index);
90     }
91
92     // This attribute is an array containing at least one element
93
public void setActivationConfigProperty(ActivationConfigProperty[] value) {
94         this.setValue(ACTIVATION_CONFIG_PROPERTY, value);
95     }
96
97     //
98
public ActivationConfigProperty[] getActivationConfigProperty() {
99         return (ActivationConfigProperty[])this.getValues(ACTIVATION_CONFIG_PROPERTY);
100     }
101
102     // Return the number of properties
103
public int sizeActivationConfigProperty() {
104         return this.size(ACTIVATION_CONFIG_PROPERTY);
105     }
106
107     // Add a new element returning its index in the list
108
public int addActivationConfigProperty(com.sun.enterprise.tools.common.dd.ejb.ActivationConfigProperty value) {
109         return this.addValue(ACTIVATION_CONFIG_PROPERTY, value);
110     }
111
112     //
113
// Remove an element using its reference
114
// Returns the index the element had in the list
115
//
116
public int removeActivationConfigProperty(com.sun.enterprise.tools.common.dd.ejb.ActivationConfigProperty value) {
117         return this.removeValue(ACTIVATION_CONFIG_PROPERTY, value);
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 description
132
if (getDescription() != null) {
133         }
134         // Validating property activationConfigProperty
135
if (sizeActivationConfigProperty() == 0) {
136             throw new org.netbeans.modules.schema2beans.ValidateException("sizeActivationConfigProperty() == 0", "activationConfigProperty", this); // NOI18N
137
}
138         for (int _index = 0; _index < sizeActivationConfigProperty();
139             ++_index) {
140             com.sun.enterprise.tools.common.dd.ejb.ActivationConfigProperty element = getActivationConfigProperty(_index);
141             if (element != null) {
142                 element.validate();
143             }
144         }
145     }
146
147     // Dump the content of this bean returning it as a String
148
public void dump(StringBuffer JavaDoc str, String JavaDoc indent){
149         String JavaDoc s;
150         Object JavaDoc o;
151         org.netbeans.modules.schema2beans.BaseBean n;
152         str.append(indent);
153         str.append("Description"); // NOI18N
154
str.append(indent+"\t"); // NOI18N
155
str.append("<"); // NOI18N
156
s = this.getDescription();
157         str.append((s==null?"null":s.trim())); // NOI18N
158
str.append(">\n"); // NOI18N
159
this.dumpAttributes(DESCRIPTION, 0, str, indent);
160
161         str.append(indent);
162         str.append("ActivationConfigProperty["+this.sizeActivationConfigProperty()+"]"); // NOI18N
163
for(int i=0; i<this.sizeActivationConfigProperty(); i++)
164         {
165             str.append(indent+"\t");
166             str.append("#"+i+":");
167             n = (org.netbeans.modules.schema2beans.BaseBean) this.getActivationConfigProperty(i);
168             if (n != null)
169                 n.dump(str, indent + "\t"); // NOI18N
170
else
171                 str.append(indent+"\tnull"); // NOI18N
172
this.dumpAttributes(ACTIVATION_CONFIG_PROPERTY, i, str, indent);
173         }
174
175     }
176     public String JavaDoc dumpBeanNode(){
177         StringBuffer JavaDoc str = new StringBuffer JavaDoc();
178         str.append("ActivationConfig\n"); // NOI18N
179
this.dump(str, "\n "); // NOI18N
180
return str.toString();
181     }}
182
183 // END_NOI18N
184

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

1030
Popular Tags