KickJava   Java API By Example, From Geeks To Geeks.

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


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 Finder matches the schema element finder
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 Finder extends com.sun.enterprise.tools.common.dd.SunBaseBean
40 {
41
42     static Vector comparators = new Vector();
43
44     static public final String JavaDoc METHOD_NAME = "MethodName"; // NOI18N
45
static public final String JavaDoc QUERY_PARAMS = "QueryParams"; // NOI18N
46
static public final String JavaDoc QUERY_FILTER = "QueryFilter"; // NOI18N
47
static public final String JavaDoc QUERY_VARIABLES = "QueryVariables"; // NOI18N
48
static public final String JavaDoc QUERY_ORDERING = "QueryOrdering"; // NOI18N
49

50     public Finder() {
51         this(Common.USE_DEFAULT_VALUES);
52     }
53
54     public Finder(int options)
55     {
56         super(comparators, new org.netbeans.modules.schema2beans.Version(1, 2, 0));
57         // Properties (see root bean comments for the bean graph)
58
this.createProperty("method-name", // NOI18N
59
METHOD_NAME,
60             Common.TYPE_1 | Common.TYPE_STRING | Common.TYPE_KEY,
61             String JavaDoc.class);
62         this.createProperty("query-params", // NOI18N
63
QUERY_PARAMS,
64             Common.TYPE_0_1 | Common.TYPE_STRING | Common.TYPE_KEY,
65             String JavaDoc.class);
66         this.createProperty("query-filter", // NOI18N
67
QUERY_FILTER,
68             Common.TYPE_0_1 | Common.TYPE_STRING | Common.TYPE_KEY,
69             String JavaDoc.class);
70         this.createProperty("query-variables", // NOI18N
71
QUERY_VARIABLES,
72             Common.TYPE_0_1 | Common.TYPE_STRING | Common.TYPE_KEY,
73             String JavaDoc.class);
74         this.createProperty("query-ordering", // NOI18N
75
QUERY_ORDERING,
76             Common.TYPE_0_1 | Common.TYPE_STRING | Common.TYPE_KEY,
77             String JavaDoc.class);
78         this.initialize(options);
79     }
80
81     // Setting the default values of the properties
82
void initialize(int options)
83     {
84                     
85     }
86
87     // This attribute is mandatory
88
public void setMethodName(String JavaDoc value) {
89         this.setValue(METHOD_NAME, value);
90     }
91
92     //
93
public String JavaDoc getMethodName() {
94         return (String JavaDoc)this.getValue(METHOD_NAME);
95     }
96
97     // This attribute is optional
98
public void setQueryParams(String JavaDoc value) {
99         this.setValue(QUERY_PARAMS, value);
100     }
101
102     //
103
public String JavaDoc getQueryParams() {
104         return (String JavaDoc)this.getValue(QUERY_PARAMS);
105     }
106
107     // This attribute is optional
108
public void setQueryFilter(String JavaDoc value) {
109         this.setValue(QUERY_FILTER, value);
110     }
111
112     //
113
public String JavaDoc getQueryFilter() {
114         return (String JavaDoc)this.getValue(QUERY_FILTER);
115     }
116
117     // This attribute is optional
118
public void setQueryVariables(String JavaDoc value) {
119         this.setValue(QUERY_VARIABLES, value);
120     }
121
122     //
123
public String JavaDoc getQueryVariables() {
124         return (String JavaDoc)this.getValue(QUERY_VARIABLES);
125     }
126
127     // This attribute is optional
128
public void setQueryOrdering(String JavaDoc value) {
129         this.setValue(QUERY_ORDERING, value);
130     }
131
132     //
133
public String JavaDoc getQueryOrdering() {
134         return (String JavaDoc)this.getValue(QUERY_ORDERING);
135     }
136
137     //
138
public static void addComparator(org.netbeans.modules.schema2beans.BeanComparator c) {
139         comparators.add(c);
140     }
141
142     //
143
public static void removeComparator(org.netbeans.modules.schema2beans.BeanComparator c) {
144         comparators.remove(c);
145     }
146     public void validate() throws org.netbeans.modules.schema2beans.ValidateException {
147         boolean restrictionFailure = false;
148         // Validating property methodName
149
if (getMethodName() == null) {
150             throw new org.netbeans.modules.schema2beans.ValidateException("getMethodName() == null", "methodName", this); // NOI18N
151
}
152         // Validating property queryParams
153
if (getQueryParams() != null) {
154         }
155         // Validating property queryFilter
156
if (getQueryFilter() != null) {
157         }
158         // Validating property queryVariables
159
if (getQueryVariables() != null) {
160         }
161         // Validating property queryOrdering
162
if (getQueryOrdering() != null) {
163         }
164     }
165
166     // Dump the content of this bean returning it as a String
167
public void dump(StringBuffer JavaDoc str, String JavaDoc indent){
168         String JavaDoc s;
169         Object JavaDoc o;
170         org.netbeans.modules.schema2beans.BaseBean n;
171         str.append(indent);
172         str.append("MethodName"); // NOI18N
173
str.append(indent+"\t"); // NOI18N
174
str.append("<"); // NOI18N
175
s = this.getMethodName();
176         str.append((s==null?"null":s.trim())); // NOI18N
177
str.append(">\n"); // NOI18N
178
this.dumpAttributes(METHOD_NAME, 0, str, indent);
179
180         str.append(indent);
181         str.append("QueryParams"); // NOI18N
182
str.append(indent+"\t"); // NOI18N
183
str.append("<"); // NOI18N
184
s = this.getQueryParams();
185         str.append((s==null?"null":s.trim())); // NOI18N
186
str.append(">\n"); // NOI18N
187
this.dumpAttributes(QUERY_PARAMS, 0, str, indent);
188
189         str.append(indent);
190         str.append("QueryFilter"); // NOI18N
191
str.append(indent+"\t"); // NOI18N
192
str.append("<"); // NOI18N
193
s = this.getQueryFilter();
194         str.append((s==null?"null":s.trim())); // NOI18N
195
str.append(">\n"); // NOI18N
196
this.dumpAttributes(QUERY_FILTER, 0, str, indent);
197
198         str.append(indent);
199         str.append("QueryVariables"); // NOI18N
200
str.append(indent+"\t"); // NOI18N
201
str.append("<"); // NOI18N
202
s = this.getQueryVariables();
203         str.append((s==null?"null":s.trim())); // NOI18N
204
str.append(">\n"); // NOI18N
205
this.dumpAttributes(QUERY_VARIABLES, 0, str, indent);
206
207         str.append(indent);
208         str.append("QueryOrdering"); // NOI18N
209
str.append(indent+"\t"); // NOI18N
210
str.append("<"); // NOI18N
211
s = this.getQueryOrdering();
212         str.append((s==null?"null":s.trim())); // NOI18N
213
str.append(">\n"); // NOI18N
214
this.dumpAttributes(QUERY_ORDERING, 0, str, indent);
215
216     }
217     public String JavaDoc dumpBeanNode(){
218         StringBuffer JavaDoc str = new StringBuffer JavaDoc();
219         str.append("Finder\n"); // NOI18N
220
this.dump(str, "\n "); // NOI18N
221
return str.toString();
222     }}
223
224 // END_NOI18N
225

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

1071
Popular Tags