KickJava   Java API By Example, From Geeks To Geeks.

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


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 CmpResource matches the schema element cmp-resource
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 import com.sun.enterprise.tools.common.dd.DefaultResourcePrincipal;
37
38 // BEGIN_NOI18N
39

40 public class CmpResource extends com.sun.enterprise.tools.common.dd.SunBaseBean
41 {
42
43     static Vector comparators = new Vector();
44
45     static public final String JavaDoc JNDI_NAME = "JndiName"; // NOI18N
46
static public final String JavaDoc DEFAULT_RESOURCE_PRINCIPAL = "DefaultResourcePrincipal"; // NOI18N
47
static public final String JavaDoc PROPERTY = "PropertyElement"; // NOI18N
48
static public final String JavaDoc CREATE_TABLES_AT_DEPLOY = "CreateTablesAtDeploy"; // NOI18N
49
static public final String JavaDoc DROP_TABLES_AT_UNDEPLOY = "DropTablesAtUndeploy"; // NOI18N
50
static public final String JavaDoc DATABASE_VENDOR_NAME = "DatabaseVendorName"; // NOI18N
51
static public final String JavaDoc SCHEMA_GENERATOR_PROPERTIES = "SchemaGeneratorProperties"; // NOI18N
52

53     public CmpResource() {
54         this(Common.USE_DEFAULT_VALUES);
55     }
56
57     public CmpResource(int options)
58     {
59         super(comparators, new org.netbeans.modules.schema2beans.Version(1, 2, 0));
60         // Properties (see root bean comments for the bean graph)
61
this.createProperty("jndi-name", // NOI18N
62
JNDI_NAME,
63             Common.TYPE_1 | Common.TYPE_STRING | Common.TYPE_KEY,
64             String JavaDoc.class);
65         this.createProperty("default-resource-principal", // NOI18N
66
DEFAULT_RESOURCE_PRINCIPAL,
67             Common.TYPE_0_1 | Common.TYPE_BEAN | Common.TYPE_KEY,
68             DefaultResourcePrincipal.class);
69         this.createProperty("property", // NOI18N
70
PROPERTY,
71             Common.TYPE_0_N | Common.TYPE_BEAN | Common.TYPE_KEY,
72             PropertyElement.class);
73         this.createProperty("create-tables-at-deploy", // NOI18N
74
CREATE_TABLES_AT_DEPLOY,
75             Common.TYPE_0_1 | Common.TYPE_STRING | Common.TYPE_KEY,
76             String JavaDoc.class);
77         this.createProperty("drop-tables-at-undeploy", // NOI18N
78
DROP_TABLES_AT_UNDEPLOY,
79             Common.TYPE_0_1 | Common.TYPE_STRING | Common.TYPE_KEY,
80             String JavaDoc.class);
81         this.createProperty("database-vendor-name", // NOI18N
82
DATABASE_VENDOR_NAME,
83             Common.TYPE_0_1 | Common.TYPE_STRING | Common.TYPE_KEY,
84             String JavaDoc.class);
85         this.createProperty("schema-generator-properties", // NOI18N
86
SCHEMA_GENERATOR_PROPERTIES,
87             Common.TYPE_0_1 | Common.TYPE_BEAN | Common.TYPE_KEY,
88             SchemaGeneratorProperties.class);
89         this.initialize(options);
90     }
91
92     // Setting the default values of the properties
93
void initialize(int options)
94     {
95                 
96     }
97
98     // This attribute is mandatory
99
public void setJndiName(String JavaDoc value) {
100         this.setValue(JNDI_NAME, value);
101     }
102
103     //
104
public String JavaDoc getJndiName() {
105         return (String JavaDoc)this.getValue(JNDI_NAME);
106     }
107
108     // This attribute is optional
109
public void setDefaultResourcePrincipal(DefaultResourcePrincipal value) {
110         this.setValue(DEFAULT_RESOURCE_PRINCIPAL, value);
111     }
112
113     //
114
public DefaultResourcePrincipal getDefaultResourcePrincipal() {
115         return (DefaultResourcePrincipal)this.getValue(DEFAULT_RESOURCE_PRINCIPAL);
116     }
117
118     // This attribute is an array, possibly empty
119
public void setPropertyElement(int index, PropertyElement value) {
120         this.setValue(PROPERTY, index, value);
121     }
122
123     //
124
public PropertyElement getPropertyElement(int index) {
125         return (PropertyElement)this.getValue(PROPERTY, index);
126     }
127
128     // This attribute is an array, possibly empty
129
public void setPropertyElement(PropertyElement[] value) {
130         this.setValue(PROPERTY, value);
131     }
132
133     //
134
public PropertyElement[] getPropertyElement() {
135         return (PropertyElement[])this.getValues(PROPERTY);
136     }
137
138     // Return the number of properties
139
public int sizePropertyElement() {
140         return this.size(PROPERTY);
141     }
142
143     // Add a new element returning its index in the list
144
public int addPropertyElement(com.sun.enterprise.tools.common.dd.ejb.PropertyElement value) {
145         return this.addValue(PROPERTY, value);
146     }
147
148     //
149
// Remove an element using its reference
150
// Returns the index the element had in the list
151
//
152
public int removePropertyElement(com.sun.enterprise.tools.common.dd.ejb.PropertyElement value) {
153         return this.removeValue(PROPERTY, value);
154     }
155
156     // This attribute is optional
157
public void setCreateTablesAtDeploy(String JavaDoc value) {
158         this.setValue(CREATE_TABLES_AT_DEPLOY, value);
159     }
160
161     //
162
public String JavaDoc getCreateTablesAtDeploy() {
163         return (String JavaDoc)this.getValue(CREATE_TABLES_AT_DEPLOY);
164     }
165
166     // This attribute is optional
167
public void setDropTablesAtUndeploy(String JavaDoc value) {
168         this.setValue(DROP_TABLES_AT_UNDEPLOY, value);
169     }
170
171     //
172
public String JavaDoc getDropTablesAtUndeploy() {
173         return (String JavaDoc)this.getValue(DROP_TABLES_AT_UNDEPLOY);
174     }
175
176     // This attribute is optional
177
public void setDatabaseVendorName(String JavaDoc value) {
178         this.setValue(DATABASE_VENDOR_NAME, value);
179     }
180
181     //
182
public String JavaDoc getDatabaseVendorName() {
183         return (String JavaDoc)this.getValue(DATABASE_VENDOR_NAME);
184     }
185
186     // This attribute is optional
187
public void setSchemaGeneratorProperties(SchemaGeneratorProperties value) {
188         this.setValue(SCHEMA_GENERATOR_PROPERTIES, value);
189     }
190
191     //
192
public SchemaGeneratorProperties getSchemaGeneratorProperties() {
193         return (SchemaGeneratorProperties)this.getValue(SCHEMA_GENERATOR_PROPERTIES);
194     }
195
196     //
197
public static void addComparator(org.netbeans.modules.schema2beans.BeanComparator c) {
198         comparators.add(c);
199     }
200
201     //
202
public static void removeComparator(org.netbeans.modules.schema2beans.BeanComparator c) {
203         comparators.remove(c);
204     }
205     public void validate() throws org.netbeans.modules.schema2beans.ValidateException {
206         boolean restrictionFailure = false;
207         // Validating property jndiName
208
if (getJndiName() == null) {
209             throw new org.netbeans.modules.schema2beans.ValidateException("getJndiName() == null", "jndiName", this); // NOI18N
210
}
211         // Validating property defaultResourcePrincipal
212
if (getDefaultResourcePrincipal() != null) {
213             getDefaultResourcePrincipal().validate();
214         }
215         // Validating property propertyElement
216
for (int _index = 0; _index < sizePropertyElement(); ++_index) {
217             com.sun.enterprise.tools.common.dd.ejb.PropertyElement element = getPropertyElement(_index);
218             if (element != null) {
219                 element.validate();
220             }
221         }
222         // Validating property createTablesAtDeploy
223
if (getCreateTablesAtDeploy() != null) {
224         }
225         // Validating property dropTablesAtUndeploy
226
if (getDropTablesAtUndeploy() != null) {
227         }
228         // Validating property databaseVendorName
229
if (getDatabaseVendorName() != null) {
230         }
231         // Validating property schemaGeneratorProperties
232
if (getSchemaGeneratorProperties() != null) {
233             getSchemaGeneratorProperties().validate();
234         }
235     }
236
237     // Dump the content of this bean returning it as a String
238
public void dump(StringBuffer JavaDoc str, String JavaDoc indent){
239         String JavaDoc s;
240         Object JavaDoc o;
241         org.netbeans.modules.schema2beans.BaseBean n;
242         str.append(indent);
243         str.append("JndiName"); // NOI18N
244
str.append(indent+"\t"); // NOI18N
245
str.append("<"); // NOI18N
246
s = this.getJndiName();
247         str.append((s==null?"null":s.trim())); // NOI18N
248
str.append(">\n"); // NOI18N
249
this.dumpAttributes(JNDI_NAME, 0, str, indent);
250
251         str.append(indent);
252         str.append("DefaultResourcePrincipal"); // NOI18N
253
n = (org.netbeans.modules.schema2beans.BaseBean) this.getDefaultResourcePrincipal();
254         if (n != null)
255             n.dump(str, indent + "\t"); // NOI18N
256
else
257             str.append(indent+"\tnull"); // NOI18N
258
this.dumpAttributes(DEFAULT_RESOURCE_PRINCIPAL, 0, str, indent);
259
260         str.append(indent);
261         str.append("PropertyElement["+this.sizePropertyElement()+"]"); // NOI18N
262
for(int i=0; i<this.sizePropertyElement(); i++)
263         {
264             str.append(indent+"\t");
265             str.append("#"+i+":");
266             n = (org.netbeans.modules.schema2beans.BaseBean) this.getPropertyElement(i);
267             if (n != null)
268                 n.dump(str, indent + "\t"); // NOI18N
269
else
270                 str.append(indent+"\tnull"); // NOI18N
271
this.dumpAttributes(PROPERTY, i, str, indent);
272         }
273
274         str.append(indent);
275         str.append("CreateTablesAtDeploy"); // NOI18N
276
str.append(indent+"\t"); // NOI18N
277
str.append("<"); // NOI18N
278
s = this.getCreateTablesAtDeploy();
279         str.append((s==null?"null":s.trim())); // NOI18N
280
str.append(">\n"); // NOI18N
281
this.dumpAttributes(CREATE_TABLES_AT_DEPLOY, 0, str, indent);
282
283         str.append(indent);
284         str.append("DropTablesAtUndeploy"); // NOI18N
285
str.append(indent+"\t"); // NOI18N
286
str.append("<"); // NOI18N
287
s = this.getDropTablesAtUndeploy();
288         str.append((s==null?"null":s.trim())); // NOI18N
289
str.append(">\n"); // NOI18N
290
this.dumpAttributes(DROP_TABLES_AT_UNDEPLOY, 0, str, indent);
291
292         str.append(indent);
293         str.append("DatabaseVendorName"); // NOI18N
294
str.append(indent+"\t"); // NOI18N
295
str.append("<"); // NOI18N
296
s = this.getDatabaseVendorName();
297         str.append((s==null?"null":s.trim())); // NOI18N
298
str.append(">\n"); // NOI18N
299
this.dumpAttributes(DATABASE_VENDOR_NAME, 0, str, indent);
300
301         str.append(indent);
302         str.append("SchemaGeneratorProperties"); // NOI18N
303
n = (org.netbeans.modules.schema2beans.BaseBean) this.getSchemaGeneratorProperties();
304         if (n != null)
305             n.dump(str, indent + "\t"); // NOI18N
306
else
307             str.append(indent+"\tnull"); // NOI18N
308
this.dumpAttributes(SCHEMA_GENERATOR_PROPERTIES, 0, str, indent);
309
310     }
311     public String JavaDoc dumpBeanNode(){
312         StringBuffer JavaDoc str = new StringBuffer JavaDoc();
313         str.append("CmpResource\n"); // NOI18N
314
this.dump(str, "\n "); // NOI18N
315
return str.toString();
316     }}
317
318 // END_NOI18N
319

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

1165
Popular Tags