KickJava   Java API By Example, From Geeks To Geeks.

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


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 BeanCache matches the schema element bean-cache
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 BeanCache extends com.sun.enterprise.tools.common.dd.SunBaseBean
40 {
41
42     static Vector comparators = new Vector();
43
44     static public final String JavaDoc MAX_CACHE_SIZE = "MaxCacheSize"; // NOI18N
45
static public final String JavaDoc RESIZE_QUANTITY = "ResizeQuantity"; // NOI18N
46
static public final String JavaDoc IS_CACHE_OVERFLOW_ALLOWED = "IsCacheOverflowAllowed"; // NOI18N
47
static public final String JavaDoc CACHE_IDLE_TIMEOUT_IN_SECONDS = "CacheIdleTimeoutInSeconds"; // NOI18N
48
static public final String JavaDoc REMOVAL_TIMEOUT_IN_SECONDS = "RemovalTimeoutInSeconds"; // NOI18N
49
static public final String JavaDoc VICTIM_SELECTION_POLICY = "VictimSelectionPolicy"; // NOI18N
50

51     public BeanCache() {
52         this(Common.USE_DEFAULT_VALUES);
53     }
54
55     public BeanCache(int options)
56     {
57         super(comparators, new org.netbeans.modules.schema2beans.Version(1, 2, 0));
58         // Properties (see root bean comments for the bean graph)
59
this.createProperty("max-cache-size", // NOI18N
60
MAX_CACHE_SIZE,
61             Common.TYPE_0_1 | Common.TYPE_STRING | Common.TYPE_KEY,
62             String JavaDoc.class);
63         this.createProperty("resize-quantity", // NOI18N
64
RESIZE_QUANTITY,
65             Common.TYPE_0_1 | Common.TYPE_STRING | Common.TYPE_KEY,
66             String JavaDoc.class);
67         this.createProperty("is-cache-overflow-allowed", // NOI18N
68
IS_CACHE_OVERFLOW_ALLOWED,
69             Common.TYPE_0_1 | Common.TYPE_STRING | Common.TYPE_KEY,
70             String JavaDoc.class);
71         this.createProperty("cache-idle-timeout-in-seconds", // NOI18N
72
CACHE_IDLE_TIMEOUT_IN_SECONDS,
73             Common.TYPE_0_1 | Common.TYPE_STRING | Common.TYPE_KEY,
74             String JavaDoc.class);
75         this.createProperty("removal-timeout-in-seconds", // NOI18N
76
REMOVAL_TIMEOUT_IN_SECONDS,
77             Common.TYPE_0_1 | Common.TYPE_STRING | Common.TYPE_KEY,
78             String JavaDoc.class);
79         this.createProperty("victim-selection-policy", // NOI18N
80
VICTIM_SELECTION_POLICY,
81             Common.TYPE_0_1 | Common.TYPE_STRING | Common.TYPE_KEY,
82             String JavaDoc.class);
83         this.initialize(options);
84     }
85
86     // Setting the default values of the properties
87
void initialize(int options)
88     {
89                         
90     }
91
92     // This attribute is optional
93
public void setMaxCacheSize(String JavaDoc value) {
94         this.setValue(MAX_CACHE_SIZE, value);
95     }
96
97     //
98
public String JavaDoc getMaxCacheSize() {
99         return (String JavaDoc)this.getValue(MAX_CACHE_SIZE);
100     }
101
102     // This attribute is optional
103
public void setResizeQuantity(String JavaDoc value) {
104         this.setValue(RESIZE_QUANTITY, value);
105     }
106
107     //
108
public String JavaDoc getResizeQuantity() {
109         return (String JavaDoc)this.getValue(RESIZE_QUANTITY);
110     }
111
112     // This attribute is optional
113
public void setIsCacheOverflowAllowed(String JavaDoc value) {
114         this.setValue(IS_CACHE_OVERFLOW_ALLOWED, value);
115     }
116
117     //
118
public String JavaDoc getIsCacheOverflowAllowed() {
119         return (String JavaDoc)this.getValue(IS_CACHE_OVERFLOW_ALLOWED);
120     }
121
122     // This attribute is optional
123
public void setCacheIdleTimeoutInSeconds(String JavaDoc value) {
124         this.setValue(CACHE_IDLE_TIMEOUT_IN_SECONDS, value);
125     }
126
127     //
128
public String JavaDoc getCacheIdleTimeoutInSeconds() {
129         return (String JavaDoc)this.getValue(CACHE_IDLE_TIMEOUT_IN_SECONDS);
130     }
131
132     // This attribute is optional
133
public void setRemovalTimeoutInSeconds(String JavaDoc value) {
134         this.setValue(REMOVAL_TIMEOUT_IN_SECONDS, value);
135     }
136
137     //
138
public String JavaDoc getRemovalTimeoutInSeconds() {
139         return (String JavaDoc)this.getValue(REMOVAL_TIMEOUT_IN_SECONDS);
140     }
141
142     // This attribute is optional
143
public void setVictimSelectionPolicy(String JavaDoc value) {
144         this.setValue(VICTIM_SELECTION_POLICY, value);
145     }
146
147     //
148
public String JavaDoc getVictimSelectionPolicy() {
149         return (String JavaDoc)this.getValue(VICTIM_SELECTION_POLICY);
150     }
151
152     //
153
public static void addComparator(org.netbeans.modules.schema2beans.BeanComparator c) {
154         comparators.add(c);
155     }
156
157     //
158
public static void removeComparator(org.netbeans.modules.schema2beans.BeanComparator c) {
159         comparators.remove(c);
160     }
161     public void validate() throws org.netbeans.modules.schema2beans.ValidateException {
162         boolean restrictionFailure = false;
163         // Validating property maxCacheSize
164
if (getMaxCacheSize() != null) {
165         }
166         // Validating property resizeQuantity
167
if (getResizeQuantity() != null) {
168         }
169         // Validating property isCacheOverflowAllowed
170
if (getIsCacheOverflowAllowed() != null) {
171         }
172         // Validating property cacheIdleTimeoutInSeconds
173
if (getCacheIdleTimeoutInSeconds() != null) {
174         }
175         // Validating property removalTimeoutInSeconds
176
if (getRemovalTimeoutInSeconds() != null) {
177         }
178         // Validating property victimSelectionPolicy
179
if (getVictimSelectionPolicy() != null) {
180         }
181     }
182
183     // Dump the content of this bean returning it as a String
184
public void dump(StringBuffer JavaDoc str, String JavaDoc indent){
185         String JavaDoc s;
186         Object JavaDoc o;
187         org.netbeans.modules.schema2beans.BaseBean n;
188         str.append(indent);
189         str.append("MaxCacheSize"); // NOI18N
190
str.append(indent+"\t"); // NOI18N
191
str.append("<"); // NOI18N
192
s = this.getMaxCacheSize();
193         str.append((s==null?"null":s.trim())); // NOI18N
194
str.append(">\n"); // NOI18N
195
this.dumpAttributes(MAX_CACHE_SIZE, 0, str, indent);
196
197         str.append(indent);
198         str.append("ResizeQuantity"); // NOI18N
199
str.append(indent+"\t"); // NOI18N
200
str.append("<"); // NOI18N
201
s = this.getResizeQuantity();
202         str.append((s==null?"null":s.trim())); // NOI18N
203
str.append(">\n"); // NOI18N
204
this.dumpAttributes(RESIZE_QUANTITY, 0, str, indent);
205
206         str.append(indent);
207         str.append("IsCacheOverflowAllowed"); // NOI18N
208
str.append(indent+"\t"); // NOI18N
209
str.append("<"); // NOI18N
210
s = this.getIsCacheOverflowAllowed();
211         str.append((s==null?"null":s.trim())); // NOI18N
212
str.append(">\n"); // NOI18N
213
this.dumpAttributes(IS_CACHE_OVERFLOW_ALLOWED, 0, str, indent);
214
215         str.append(indent);
216         str.append("CacheIdleTimeoutInSeconds"); // NOI18N
217
str.append(indent+"\t"); // NOI18N
218
str.append("<"); // NOI18N
219
s = this.getCacheIdleTimeoutInSeconds();
220         str.append((s==null?"null":s.trim())); // NOI18N
221
str.append(">\n"); // NOI18N
222
this.dumpAttributes(CACHE_IDLE_TIMEOUT_IN_SECONDS, 0, str, indent);
223
224         str.append(indent);
225         str.append("RemovalTimeoutInSeconds"); // NOI18N
226
str.append(indent+"\t"); // NOI18N
227
str.append("<"); // NOI18N
228
s = this.getRemovalTimeoutInSeconds();
229         str.append((s==null?"null":s.trim())); // NOI18N
230
str.append(">\n"); // NOI18N
231
this.dumpAttributes(REMOVAL_TIMEOUT_IN_SECONDS, 0, str, indent);
232
233         str.append(indent);
234         str.append("VictimSelectionPolicy"); // NOI18N
235
str.append(indent+"\t"); // NOI18N
236
str.append("<"); // NOI18N
237
s = this.getVictimSelectionPolicy();
238         str.append((s==null?"null":s.trim())); // NOI18N
239
str.append(">\n"); // NOI18N
240
this.dumpAttributes(VICTIM_SELECTION_POLICY, 0, str, indent);
241
242     }
243     public String JavaDoc dumpBeanNode(){
244         StringBuffer JavaDoc str = new StringBuffer JavaDoc();
245         str.append("BeanCache\n"); // NOI18N
246
this.dump(str, "\n "); // NOI18N
247
return str.toString();
248     }}
249
250 // END_NOI18N
251

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

1097
Popular Tags