KickJava   Java API By Example, From Geeks To Geeks.

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


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 PropertyElement matches the schema element property
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 PropertyElement extends com.sun.enterprise.tools.common.dd.SunBaseBean
40 {
41
42     static Vector comparators = new Vector();
43
44     static public final String JavaDoc NAME = "Name"; // NOI18N
45
static public final String JavaDoc VALUE = "Value"; // NOI18N
46

47     public PropertyElement() {
48         this(Common.USE_DEFAULT_VALUES);
49     }
50
51     public PropertyElement(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("name", // NOI18N
56
NAME,
57             Common.TYPE_1 | Common.TYPE_STRING | Common.TYPE_KEY,
58             String JavaDoc.class);
59         this.createProperty("value", // NOI18N
60
VALUE,
61             Common.TYPE_1 | Common.TYPE_STRING | Common.TYPE_KEY,
62             String JavaDoc.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 mandatory
73
public void setName(String JavaDoc value) {
74         this.setValue(NAME, value);
75     }
76
77     //
78
public String JavaDoc getName() {
79         return (String JavaDoc)this.getValue(NAME);
80     }
81
82     // This attribute is mandatory
83
public void setValue(String JavaDoc value) {
84         this.setValue(VALUE, value);
85     }
86
87     //
88
public String JavaDoc getValue() {
89         return (String JavaDoc)this.getValue(VALUE);
90     }
91
92     //
93
public static void addComparator(org.netbeans.modules.schema2beans.BeanComparator c) {
94         comparators.add(c);
95     }
96
97     //
98
public static void removeComparator(org.netbeans.modules.schema2beans.BeanComparator c) {
99         comparators.remove(c);
100     }
101     public void validate() throws org.netbeans.modules.schema2beans.ValidateException {
102         boolean restrictionFailure = false;
103         // Validating property name
104
if (getName() == null) {
105             throw new org.netbeans.modules.schema2beans.ValidateException("getName() == null", "name", this); // NOI18N
106
}
107         // Validating property value
108
if (getValue() == null) {
109             throw new org.netbeans.modules.schema2beans.ValidateException("getValue() == null", "value", this); // NOI18N
110
}
111     }
112
113     // Dump the content of this bean returning it as a String
114
public void dump(StringBuffer JavaDoc str, String JavaDoc indent){
115         String JavaDoc s;
116         Object JavaDoc o;
117         org.netbeans.modules.schema2beans.BaseBean n;
118         str.append(indent);
119         str.append("Name"); // NOI18N
120
str.append(indent+"\t"); // NOI18N
121
str.append("<"); // NOI18N
122
s = this.getName();
123         str.append((s==null?"null":s.trim())); // NOI18N
124
str.append(">\n"); // NOI18N
125
this.dumpAttributes(NAME, 0, str, indent);
126
127         str.append(indent);
128         str.append("Value"); // NOI18N
129
str.append(indent+"\t"); // NOI18N
130
str.append("<"); // NOI18N
131
s = this.getValue();
132         str.append((s==null?"null":s.trim())); // NOI18N
133
str.append(">\n"); // NOI18N
134
this.dumpAttributes(VALUE, 0, str, indent);
135
136     }
137     public String JavaDoc dumpBeanNode(){
138         StringBuffer JavaDoc str = new StringBuffer JavaDoc();
139         str.append("PropertyElement\n"); // NOI18N
140
this.dump(str, "\n "); // NOI18N
141
return str.toString();
142     }}
143
144 // END_NOI18N
145

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

991
Popular Tags