KickJava   Java API By Example, From Geeks To Geeks.

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


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 TransportConfig matches the schema element transport-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 TransportConfig extends com.sun.enterprise.tools.common.dd.SunBaseBean
40 {
41
42     static Vector comparators = new Vector();
43
44     static public final String JavaDoc INTEGRITY = "Integrity"; // NOI18N
45
static public final String JavaDoc CONFIDENTIALITY = "Confidentiality"; // NOI18N
46
static public final String JavaDoc ESTABLISH_TRUST_IN_TARGET = "EstablishTrustInTarget"; // NOI18N
47
static public final String JavaDoc ESTABLISH_TRUST_IN_CLIENT = "EstablishTrustInClient"; // NOI18N
48

49     public TransportConfig() {
50         this(Common.USE_DEFAULT_VALUES);
51     }
52
53     public TransportConfig(int options)
54     {
55         super(comparators, new org.netbeans.modules.schema2beans.Version(1, 2, 0));
56         // Properties (see root bean comments for the bean graph)
57
this.createProperty("integrity", // NOI18N
58
INTEGRITY,
59             Common.TYPE_1 | Common.TYPE_STRING | Common.TYPE_KEY,
60             String JavaDoc.class);
61         this.createProperty("confidentiality", // NOI18N
62
CONFIDENTIALITY,
63             Common.TYPE_1 | Common.TYPE_STRING | Common.TYPE_KEY,
64             String JavaDoc.class);
65         this.createProperty("establish-trust-in-target", // NOI18N
66
ESTABLISH_TRUST_IN_TARGET,
67             Common.TYPE_1 | Common.TYPE_STRING | Common.TYPE_KEY,
68             String JavaDoc.class);
69         this.createProperty("establish-trust-in-client", // NOI18N
70
ESTABLISH_TRUST_IN_CLIENT,
71             Common.TYPE_1 | Common.TYPE_STRING | Common.TYPE_KEY,
72             String JavaDoc.class);
73         this.initialize(options);
74     }
75
76     // Setting the default values of the properties
77
void initialize(int options)
78     {
79                 
80     }
81
82     // This attribute is mandatory
83
public void setIntegrity(String JavaDoc value) {
84         this.setValue(INTEGRITY, value);
85     }
86
87     //
88
public String JavaDoc getIntegrity() {
89         return (String JavaDoc)this.getValue(INTEGRITY);
90     }
91
92     // This attribute is mandatory
93
public void setConfidentiality(String JavaDoc value) {
94         this.setValue(CONFIDENTIALITY, value);
95     }
96
97     //
98
public String JavaDoc getConfidentiality() {
99         return (String JavaDoc)this.getValue(CONFIDENTIALITY);
100     }
101
102     // This attribute is mandatory
103
public void setEstablishTrustInTarget(String JavaDoc value) {
104         this.setValue(ESTABLISH_TRUST_IN_TARGET, value);
105     }
106
107     //
108
public String JavaDoc getEstablishTrustInTarget() {
109         return (String JavaDoc)this.getValue(ESTABLISH_TRUST_IN_TARGET);
110     }
111
112     // This attribute is mandatory
113
public void setEstablishTrustInClient(String JavaDoc value) {
114         this.setValue(ESTABLISH_TRUST_IN_CLIENT, value);
115     }
116
117     //
118
public String JavaDoc getEstablishTrustInClient() {
119         return (String JavaDoc)this.getValue(ESTABLISH_TRUST_IN_CLIENT);
120     }
121
122     //
123
public static void addComparator(org.netbeans.modules.schema2beans.BeanComparator c) {
124         comparators.add(c);
125     }
126
127     //
128
public static void removeComparator(org.netbeans.modules.schema2beans.BeanComparator c) {
129         comparators.remove(c);
130     }
131     public void validate() throws org.netbeans.modules.schema2beans.ValidateException {
132         boolean restrictionFailure = false;
133         // Validating property integrity
134
if (getIntegrity() == null) {
135             throw new org.netbeans.modules.schema2beans.ValidateException("getIntegrity() == null", "integrity", this); // NOI18N
136
}
137         // Validating property confidentiality
138
if (getConfidentiality() == null) {
139             throw new org.netbeans.modules.schema2beans.ValidateException("getConfidentiality() == null", "confidentiality", this); // NOI18N
140
}
141         // Validating property establishTrustInTarget
142
if (getEstablishTrustInTarget() == null) {
143             throw new org.netbeans.modules.schema2beans.ValidateException("getEstablishTrustInTarget() == null", "establishTrustInTarget", this); // NOI18N
144
}
145         // Validating property establishTrustInClient
146
if (getEstablishTrustInClient() == null) {
147             throw new org.netbeans.modules.schema2beans.ValidateException("getEstablishTrustInClient() == null", "establishTrustInClient", this); // NOI18N
148
}
149     }
150
151     // Dump the content of this bean returning it as a String
152
public void dump(StringBuffer JavaDoc str, String JavaDoc indent){
153         String JavaDoc s;
154         Object JavaDoc o;
155         org.netbeans.modules.schema2beans.BaseBean n;
156         str.append(indent);
157         str.append("Integrity"); // NOI18N
158
str.append(indent+"\t"); // NOI18N
159
str.append("<"); // NOI18N
160
s = this.getIntegrity();
161         str.append((s==null?"null":s.trim())); // NOI18N
162
str.append(">\n"); // NOI18N
163
this.dumpAttributes(INTEGRITY, 0, str, indent);
164
165         str.append(indent);
166         str.append("Confidentiality"); // NOI18N
167
str.append(indent+"\t"); // NOI18N
168
str.append("<"); // NOI18N
169
s = this.getConfidentiality();
170         str.append((s==null?"null":s.trim())); // NOI18N
171
str.append(">\n"); // NOI18N
172
this.dumpAttributes(CONFIDENTIALITY, 0, str, indent);
173
174         str.append(indent);
175         str.append("EstablishTrustInTarget"); // NOI18N
176
str.append(indent+"\t"); // NOI18N
177
str.append("<"); // NOI18N
178
s = this.getEstablishTrustInTarget();
179         str.append((s==null?"null":s.trim())); // NOI18N
180
str.append(">\n"); // NOI18N
181
this.dumpAttributes(ESTABLISH_TRUST_IN_TARGET, 0, str, indent);
182
183         str.append(indent);
184         str.append("EstablishTrustInClient"); // NOI18N
185
str.append(indent+"\t"); // NOI18N
186
str.append("<"); // NOI18N
187
s = this.getEstablishTrustInClient();
188         str.append((s==null?"null":s.trim())); // NOI18N
189
str.append(">\n"); // NOI18N
190
this.dumpAttributes(ESTABLISH_TRUST_IN_CLIENT, 0, str, indent);
191
192     }
193     public String JavaDoc dumpBeanNode(){
194         StringBuffer JavaDoc str = new StringBuffer JavaDoc();
195         str.append("TransportConfig\n"); // NOI18N
196
this.dump(str, "\n "); // NOI18N
197
return str.toString();
198     }}
199
200 // END_NOI18N
201

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

1047
Popular Tags