Java > Open Source Codes > com > sun > enterprise > tools > common > dd > webapp > Cache


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 Cache matches the schema element cache
26  *
27  * Generated on Tue Sep 02 18:08:42 PDT 2003
28  */
29
30 package com.sun.enterprise.tools.common.dd.webapp;
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 Cache extends com.sun.enterprise.tools.common.dd.SunBaseBean
40 {
41
42     static Vector comparators = new Vector();
43
44     static public final String MAXENTRIES = "MaxEntries"; // NOI18N
45 static public final String TIMEOUTINSECONDS = "TimeoutInSeconds"; // NOI18N
46 static public final String ENABLED = "Enabled"; // NOI18N
47 static public final String CACHE_HELPER = "CacheHelper"; // NOI18N
48 static public final String DEFAULT_HELPER = "DefaultHelper"; // NOI18N
49 static public final String PROPERTY = "WebProperty"; // NOI18N
50 static public final String CACHE_MAPPING = "CacheMapping"; // NOI18N
51
52     public Cache() {
53         this(Common.USE_DEFAULT_VALUES);
54     }
55
56     public Cache(int options)
57     {
58         super(comparators, new org.netbeans.modules.schema2beans.Version(1, 2, 0));
59         // Properties (see root bean comments for the bean graph)
60 this.createProperty("cache-helper", // NOI18N
61 CACHE_HELPER,
62             Common.TYPE_0_N | Common.TYPE_BEAN | Common.TYPE_KEY,
63             CacheHelper.class);
64         this.createAttribute(CACHE_HELPER, "name", "Name",
65                         AttrProp.CDATA | AttrProp.REQUIRED,
66                         null, null);
67         this.createAttribute(CACHE_HELPER, "class-name", "ClassName",
68                         AttrProp.CDATA | AttrProp.REQUIRED,
69                         null, null);
70         this.createProperty("default-helper", // NOI18N
71 DEFAULT_HELPER,
72             Common.TYPE_0_1 | Common.TYPE_BEAN | Common.TYPE_KEY,
73             DefaultHelper.class);
74         this.createProperty("property", // NOI18N
75 PROPERTY,
76             Common.TYPE_0_N | Common.TYPE_BEAN | Common.TYPE_KEY,
77             WebProperty.class);
78         this.createAttribute(PROPERTY, "name", "Name",
79                         AttrProp.CDATA | AttrProp.REQUIRED,
80                         null, null);
81         this.createAttribute(PROPERTY, "value", "Value",
82                         AttrProp.CDATA | AttrProp.REQUIRED,
83                         null, null);
84         this.createProperty("cache-mapping", // NOI18N
85 CACHE_MAPPING,
86             Common.TYPE_0_N | Common.TYPE_BEAN | Common.TYPE_KEY,
87             CacheMapping.class);
88         this.initialize(options);
89     }
90
91     // Setting the default values of the properties
92 void initialize(int options)
93     {
94
95     }
96
97     // This attribute is mandatory
98 public void setMaxEntries(java.lang.String value) {
99         setAttributeValue(MAXENTRIES, value);
100     }
101
102     //
103 public java.lang.String getMaxEntries() {
104         return getAttributeValue(MAXENTRIES);
105     }
106
107     // This attribute is mandatory
108 public void setTimeoutInSeconds(java.lang.String value) {
109         setAttributeValue(TIMEOUTINSECONDS, value);
110     }
111
112     //
113 public java.lang.String getTimeoutInSeconds() {
114         return getAttributeValue(TIMEOUTINSECONDS);
115     }
116
117     // This attribute is mandatory
118 public void setEnabled(java.lang.String value) {
119         setAttributeValue(ENABLED, value);
120     }
121
122     //
123 public java.lang.String getEnabled() {
124         return getAttributeValue(ENABLED);
125     }
126
127     // This attribute is an array, possibly empty
128 public void setCacheHelper(int index, CacheHelper value) {
129         this.setValue(CACHE_HELPER, index, value);
130     }
131
132     //
133 public CacheHelper getCacheHelper(int index) {
134         return (CacheHelper)this.getValue(CACHE_HELPER, index);
135     }
136
137     // This attribute is an array, possibly empty
138 public void setCacheHelper(CacheHelper[] value) {
139         this.setValue(CACHE_HELPER, value);
140     }
141
142     //
143 public CacheHelper[] getCacheHelper() {
144         return (CacheHelper[])this.getValues(CACHE_HELPER);
145     }
146
147     // Return the number of properties
148 public int sizeCacheHelper() {
149         return this.size(CACHE_HELPER);
150     }
151
152     // Add a new element returning its index in the list
153 public int addCacheHelper(com.sun.enterprise.tools.common.dd.webapp.CacheHelper value) {
154         return this.addValue(CACHE_HELPER, value);
155     }
156
157     //
158 // Remove an element using its reference
159 // Returns the index the element had in the list
160 //
161 public int removeCacheHelper(com.sun.enterprise.tools.common.dd.webapp.CacheHelper value) {
162         return this.removeValue(CACHE_HELPER, value);
163     }
164
165     // This attribute is optional
166 public void setDefaultHelper(DefaultHelper value) {
167         this.setValue(DEFAULT_HELPER, value);
168     }
169
170     //
171 public DefaultHelper getDefaultHelper() {
172         return (DefaultHelper)this.getValue(DEFAULT_HELPER);
173     }
174
175     // This attribute is an array, possibly empty
176 public void setWebProperty(int index, WebProperty value) {
177         this.setValue(PROPERTY, index, value);
178     }
179
180     //
181 public WebProperty getWebProperty(int index) {
182         return (WebProperty)this.getValue(PROPERTY, index);
183     }
184
185     // This attribute is an array, possibly empty
186 public void setWebProperty(WebProperty[] value) {
187         this.setValue(PROPERTY, value);
188     }
189
190     //
191 public WebProperty[] getWebProperty() {
192         return (WebProperty[])this.getValues(PROPERTY);
193     }
194
195     // Return the number of properties
196 public int sizeWebProperty() {
197         return this.size(PROPERTY);
198     }
199
200     // Add a new element returning its index in the list
201 public int addWebProperty(com.sun.enterprise.tools.common.dd.webapp.WebProperty value) {
202         return this.addValue(PROPERTY, value);
203     }
204
205     //
206 // Remove an element using its reference
207 // Returns the index the element had in the list
208 //
209 public int removeWebProperty(com.sun.enterprise.tools.common.dd.webapp.WebProperty value) {
210         return this.removeValue(PROPERTY, value);
211     }
212
213     // This attribute is an array, possibly empty
214 public void setCacheMapping(int index, CacheMapping value) {
215         this.setValue(CACHE_MAPPING, index, value);
216     }
217
218     //
219 public CacheMapping getCacheMapping(int index) {
220         return (CacheMapping)this.getValue(CACHE_MAPPING, index);
221     }
222
223     // This attribute is an array, possibly empty
224 public void setCacheMapping(CacheMapping[] value) {
225         this.setValue(CACHE_MAPPING, value);
226     }
227
228     //
229 public CacheMapping[] getCacheMapping() {
230         return (CacheMapping[])this.getValues(CACHE_MAPPING);
231     }
232
233     // Return the number of properties
234 public int sizeCacheMapping() {
235         return this.size(CACHE_MAPPING);
236     }
237
238     // Add a new element returning its index in the list
239 public int addCacheMapping(com.sun.enterprise.tools.common.dd.webapp.CacheMapping value) {
240         return this.addValue(CACHE_MAPPING, value);
241     }
242
243     //
244 // Remove an element using its reference
245 // Returns the index the element had in the list
246 //
247 public int removeCacheMapping(com.sun.enterprise.tools.common.dd.webapp.CacheMapping value) {
248         return this.removeValue(CACHE_MAPPING, value);
249     }
250
251     //
252 public static void addComparator(org.netbeans.modules.schema2beans.BeanComparator c) {
253         comparators.add(c);
254     }
255
256     //
257 public static void removeComparator(org.netbeans.modules.schema2beans.BeanComparator c) {
258         comparators.remove(c);
259     }
260     public void validate() throws org.netbeans.modules.schema2beans.ValidateException {
261         boolean restrictionFailure = false;
262         // Validating property maxEntries
263 if (getMaxEntries() == null) {
264             throw new org.netbeans.modules.schema2beans.ValidateException("getMaxEntries() == null", "maxEntries", this); // NOI18N
265 }
266         // Validating property timeoutInSeconds
267 if (getTimeoutInSeconds() == null) {
268             throw new org.netbeans.modules.schema2beans.ValidateException("getTimeoutInSeconds() == null", "timeoutInSeconds", this); // NOI18N
269 }
270         // Validating property enabled
271 if (getEnabled() == null) {
272             throw new org.netbeans.modules.schema2beans.ValidateException("getEnabled() == null", "enabled", this); // NOI18N
273 }
274         // Validating property cacheHelper
275 for (int _index = 0; _index < sizeCacheHelper(); ++_index) {
276             com.sun.enterprise.tools.common.dd.webapp.CacheHelper element = getCacheHelper(_index);
277             if (element != null) {
278                 element.validate();
279             }
280         }
281         // Validating property defaultHelper
282 if (getDefaultHelper() != null) {
283             getDefaultHelper().validate();
284         }
285         // Validating property webProperty
286 for (int _index = 0; _index < sizeWebProperty(); ++_index) {
287             com.sun.enterprise.tools.common.dd.webapp.WebProperty element = getWebProperty(_index);
288             if (element != null) {
289                 element.validate();
290             }
291         }
292         // Validating property cacheMapping
293 for (int _index = 0; _index < sizeCacheMapping(); ++_index) {
294             com.sun.enterprise.tools.common.dd.webapp.CacheMapping element = getCacheMapping(_index);
295             if (element != null) {
296                 element.validate();
297             }
298         }
299     }
300
301     // Dump the content of this bean returning it as a String
302 public void dump(StringBuffer str, String indent){
303         String s;
304         Object o;
305         org.netbeans.modules.schema2beans.BaseBean n;
306         str.append(indent);
307         str.append("CacheHelper["+this.sizeCacheHelper()+"]"); // NOI18N
308 for(int i=0; i<this.sizeCacheHelper(); i++)
309         {
310             str.append(indent+"\t");
311             str.append("#"+i+":");
312             n = (org.netbeans.modules.schema2beans.BaseBean) this.getCacheHelper(i);
313             if (n != null)
314                 n.dump(str, indent + "\t"); // NOI18N
315 else
316                 str.append(indent+"\tnull"); // NOI18N
317 this.dumpAttributes(CACHE_HELPER, i, str, indent);
318         }
319
320         str.append(indent);
321         str.append("DefaultHelper"); // NOI18N
322 n = (org.netbeans.modules.schema2beans.BaseBean) this.getDefaultHelper();
323         if (n != null)
324             n.dump(str, indent + "\t"); // NOI18N
325 else
326             str.append(indent+"\tnull"); // NOI18N
327 this.dumpAttributes(DEFAULT_HELPER, 0, str, indent);
328
329         str.append(indent);
330         str.append("WebProperty["+this.sizeWebProperty()+"]"); // NOI18N
331 for(int i=0; i<this.sizeWebProperty(); i++)
332         {
333             str.append(indent+"\t");
334             str.append("#"+i+":");
335             n = (org.netbeans.modules.schema2beans.BaseBean) this.getWebProperty(i);
336             if (n != null)
337                 n.dump(str, indent + "\t"); // NOI18N
338 else
339                 str.append(indent+"\tnull"); // NOI18N
340 this.dumpAttributes(PROPERTY, i, str, indent);
341         }
342
343         str.append(indent);
344         str.append("CacheMapping["+this.sizeCacheMapping()+"]"); // NOI18N
345 for(int i=0; i<this.sizeCacheMapping(); i++)
346         {
347             str.append(indent+"\t");
348             str.append("#"+i+":");
349             n = (org.netbeans.modules.schema2beans.BaseBean) this.getCacheMapping(i);
350             if (n != null)
351                 n.dump(str, indent + "\t"); // NOI18N
352 else
353                 str.append(indent+"\tnull"); // NOI18N
354 this.dumpAttributes(CACHE_MAPPING, i, str, indent);
355         }
356
357     }
358     public String dumpBeanNode(){
359         StringBuffer str = new StringBuffer ();
360         str.append("Cache\n"); // NOI18N
361 this.dump(str, "\n "); // NOI18N
362 return str.toString();
363     }}
364
365 // END_NOI18N
366
367
368 /*
369         The following schema file has been used for generation:
370
371 <!--
372   XML DTD for Sun ONE Application Server specific Web Application
373   deployment descriptor. This is a companion DTD for web-app_2_4.xsd
374
375   $Revision: 1.3 $
376 -->
377
378 <!-- root element for vendor specific web application (module) configuration -->
379 <!ELEMENT sun-web-app (context-root?, security-role-mapping*, servlet*, session-config?,
380                        ejb-ref*, resource-ref*, resource-env-ref*, service-ref*,
381                        cache?, class-loader?,
382                        jsp-config?, locale-charset-info?, property*,
383                    message-destination*, webservice-description*)>
384
385 <!--
386  Context Root for the web application when the war file is a standalone module.
387  When the war module is part of the J2EE Application, use the application.xml
388 -->
389 <!ELEMENT context-root (#PCDATA)>
390
391 <!ELEMENT security-role-mapping (role-name, (principal-name | group-name)+)>
392 <!ELEMENT role-name (#PCDATA)>
393
394 <!ELEMENT principal-name (#PCDATA)>
395 <!ELEMENT group-name (#PCDATA)>
396
397 <!ELEMENT servlet (servlet-name, principal-name?, webservice-endpoint*)>
398
399 <!ELEMENT session-config (session-manager?, session-properties?, cookie-properties?)>
400
401 <!ELEMENT session-manager (manager-properties?, store-properties?)>
402 <!ATTLIST session-manager persistence-type CDATA "memory">
403
404 <!ELEMENT manager-properties (property*)>
405 <!ELEMENT store-properties (property*)>
406 <!ELEMENT session-properties (property*)>
407 <!ELEMENT cookie-properties (property*)>
408
409 <!ELEMENT jndi-name (#PCDATA)>
410
411 <!ELEMENT resource-env-ref (resource-env-ref-name, jndi-name)>
412 <!ELEMENT resource-env-ref-name (#PCDATA)>
413            
414 <!ELEMENT resource-ref (res-ref-name, jndi-name, default-resource-principal?)>
415 <!ELEMENT res-ref-name (#PCDATA)>
416
417 <!ELEMENT default-resource-principal ( name, password)>
418
419 <!--
420 This node holds information about a logical message destination
421 -->
422 <!ELEMENT message-destination (message-destination-name, jndi-name)>
423
424 <!--
425 This node holds the name of a logical message destination
426 -->
427 <!ELEMENT message-destination-name (#PCDATA)>
428
429 <!--
430 This text nodes holds a name string.
431 -->
432 <!ELEMENT name (#PCDATA)>
433
434 <!--
435 This element holds password text.
436 -->
437 <!ELEMENT password (#PCDATA)>
438
439
440 <!ELEMENT ejb-ref (ejb-ref-name, jndi-name)>
441 <!ELEMENT ejb-ref-name (#PCDATA)>
442
443 <!-- cache element configures the cache for web application. iAS 7.0 web container
444      supports one such cache object per application: i.e. <cache> is a sub element
445      of <ias-web-app>. A cache can have zero or more cache-mapping elements and
446      zero or more customizable cache-helper classes.
447                                                                                    
448         max-entries Maximum number of entries this cache may hold. [4096]
449         timeout-in-seconds Default timeout for the cache entries in seconds. [30]
450         enabled Is this cache enabled? [false]
451 -->
452 <!ELEMENT cache (cache-helper*, default-helper?, property*, cache-mapping*)>
453 <!ATTLIST cache max-entries CDATA "4096"
454                  timeout-in-seconds CDATA "30"
455                  enabled CDATA "false">
456
457 <!-- cache-helper specifies customizable class which implements CacheHelper interface.
458
459      name Unique name for the helper class; this is referenced in
460                               the cache-mapping elements (see below).
461                               "default" is reserved for the built-in default helper.
462      class-name Fully qualified class name of the cache-helper; this class
463                               must extend the com.sun.appserv.web.CacheHelper class.
464 -->
465 <!ELEMENT cache-helper (property*)>
466 <!ATTLIST cache-helper name CDATA #REQUIRED
467                        class-name CDATA #REQUIRED>
468
469 <!--
470 Default, built-in cache-helper properties
471 -->
472 <!ELEMENT default-helper (property*)>
473
474 <!--
475 cache-mapping element defines what to be cached, the key to be used, any other
476 constraints to be applied and a customizable cache-helper to programmatically
477 hook this information.
478 -->
479 <!ELEMENT cache-mapping ((servlet-name | url-pattern),
480                         (cache-helper-ref |
481                         (timeout?, refresh-field?, http-method*, key-field*, constraint-field*)))>
482
483 <!--
484 servlet-name element defines a named servlet to which this caching is enabled.
485 the specified name must be present in the web application deployment descriptor
486 (web.xml)
487 -->
488 <!ELEMENT servlet-name (#PCDATA)>
489
490 <!--
491 url-pattern element specifies the url pattern to which caching is to be enabled.
492 See Servlet 2.3 specification section SRV. 11.2 for the applicable patterns.
493 -->
494 <!ELEMENT url-pattern (#PCDATA)>
495
496 <!--
497 cache-helper-ref s a reference to the cache-helper used by this cache-mapping
498 -->
499 <!ELEMENT cache-helper-ref (#PCDATA)>
500
501 <!--
502 timeout element defines the cache timeout in seconds applicable for this mapping.
503 default is to use cache object's timeout. The timeout value is specified statically
504 ere (e.g. <timeout> 60 </timeout> or dynamically via fields in the relevant scope.
505
506    name Name of the field where this timeout could be found
507    scope Scope of the field. default scope is request attribute.
508 -->
509 <!ELEMENT timeout (#PCDATA)>
510 <!ATTLIST timeout name CDATA #REQUIRED
511                    scope CDATA 'request.attribute'>
512
513 <!--
514 http-method specifies HTTP method eligible for caching default is GET.
515 -->
516 <!ELEMENT http-method (#PCDATA)>
517
518 <!--
519 specifies the request parameter name that triggers refresh. the cached entry
520 is refreshed when there such a request parameter is set to "true"
521 example:
522 <cache-mapping>
523     <url-pattern> /quote </url-pattern>
524     <refresh-field name="refresh" scope="request.parameter"/>
525 </cache-mapping>
526 -->
527 <!ELEMENT refresh-field EMPTY>
528 <!ATTLIST refresh-field name CDATA #REQUIRED
529                         scope CDATA 'request.parameter'>
530 <!--
531 key-field specifies a component of the key; container looks for the named
532 field in the given scope to access the cached entry. Default is to use
533 the Servlet Path (the path section that corresponds to the servlet mapping
534 which activated this request). See Servlet 2.3 specification section SRV 4.4
535 on Servlet Path.
536
537   name Name of the field to look for in the given scope
538   scope Scope of the field. default scope is request parameter.
539 -->
540 <!ELEMENT key-field EMPTY>
541 <!ATTLIST key-field name CDATA #REQUIRED
542                     scope CDATA 'request.parameter'>
543
544 <!--
545 constraint-field specifies a field whose value is used as a cacheability constraint.
546   
547   name Name of the field to look for in the given scope
548   scope Scope of the field. Default scope is request parameter.
549   cache-on-match Should this constraint check pass, is the response cacheable?
550                            Default is true (i.e. cache the response on success match).
551                            Useful to turn off caching when there is an attribute in the
552                            scope (e.g. don't cache when there is an attribute called UID
553                            in the session.attribute scope).
554   cache-on-match-failure Should the constraint check fail, is response not cacheable?
555                            Default is false (i.e. a failure in enforcing the constraint
556                            would negate caching). Useful to turn on caching when the
557                            an an attribute is not present (e.g. turn on caching
558                            when there is no session or session attribute called UID).
559
560   Example 1: don't cache when there is a session attribute
561   <constraint-field name="UID" scope="session.attribute" cache-on-match="false">
562
563   Example 2: do cache only when there is no session attribute
564   <constraint-field name="UID" scope="session.attribute"
565                     cache-on-match-failure="false">
566 -->
567 <!ELEMENT constraint-field (constraint-field-value*)>
568 <!ATTLIST constraint-field name CDATA #REQUIRED
569                             scope CDATA 'request.parameter'
570                             cache-on-match CDATA 'true'
571                             cache-on-match-failure CDATA 'false'>
572
573 <!--
574 value element specifies the applicable value and a matching expression for a constraint-field
575   match-expr Expression used to match the value. Default is 'equals'.
576
577   Example 1: cache when the category matches with any value other than a specific value
578   <constraint-field name="category" scope="request.parameter>
579     <value match-expr="equals" cache-on-match-failure="true">
580          bogus
581     </value>
582   </constraint-field>
583 -->
584 <!ELEMENT constraint-field-value (#PCDATA)>
585 <!ATTLIST constraint-field-value match-expr CDATA 'equals'
586                             cache-on-match CDATA 'true'
587                             cache-on-match-failure CDATA 'false'>
588
589 <!ELEMENT class-loader EMPTY>
590 <!ATTLIST class-loader extra-class-path CDATA #IMPLIED
591                        delegate CDATA 'true'>
592
593 <!ELEMENT jsp-config (property*)>
594
595 <!ELEMENT locale-charset-info (locale-charset-map+, parameter-encoding?)>
596 <!ATTLIST locale-charset-info default-locale CDATA #REQUIRED>
597
598 <!ELEMENT locale-charset-map (description?)>
599 <!ATTLIST locale-charset-map locale CDATA #REQUIRED
600                              agent CDATA #IMPLIED
601                              charset CDATA #REQUIRED>
602
603 <!ELEMENT parameter-encoding EMPTY>
604 <!ATTLIST parameter-encoding form-hint-field CDATA #IMPLIED
605                  default-charset CDATA #IMPLIED>
606
607 <!--
608 Syntax for supplying properties as name value pairs
609 -->
610 <!ELEMENT property (description?)>
611 <!ATTLIST property name CDATA #REQUIRED
612                    value CDATA #REQUIRED>
613
614 <!ELEMENT description (#PCDATA)>
615
616 <!--
617 This text nodes holds a value string.
618 -->
619 <!ELEMENT value (#PCDATA)>
620
621
622 <!--
623                     W E B S E R V I C E S
624 -->
625 <!--
626 Runtime settings for a web service reference. In the simplest case,
627 there is no runtime information required for a service ref. Runtime info
628 is only needed in the following cases :
629  * to define the port that should be used to resolve a container-managed port
630  * to define default Stub/Call property settings for Stub objects
631  * to define the URL of a final WSDL document to be used instead of
632 the one packaged with a service-ref
633 -->
634 <!ELEMENT service-ref ( service-ref-name, port-info*, call-property*, wsdl-override?, service-impl-class?, service-qname? )>
635
636 <!--
637 Coded name (relative to java:comp/env) for a service-reference
638 -->
639 <!ELEMENT service-ref-name ( #PCDATA )>
640
641 <!--
642 Information for a port within a service-reference.
643
644 Either service-endpoint-interface or wsdl-port or both
645 (service-endpoint-interface and wsdl-port) should be specified.
646
647 If both are specified, wsdl-port represents the
648 port the container should choose for container-managed port selection.
649
650 The same wsdl-port value must not appear in
651 more than one port-info entry within the same service-ref.
652
653 If a particular service-endpoint-interface is using container-managed port
654 selection, it must not appear in more than one port-info entry
655 within the same service-ref.
656
657 -->
658 <!ELEMENT port-info ( service-endpoint-interface?, wsdl-port?, stub-property*, call-property* )>
659
660 <!--
661 Fully qualified name of service endpoint interface
662 -->
663 <!ELEMENT service-endpoint-interface ( #PCDATA )>
664 <!--
665 Port used in port-info.
666 -->
667 <!ELEMENT wsdl-port ( namespaceURI, localpart )>
668
669 <!--
670 JAXRPC property values that should be set on a stub before it's returned to
671 to the web service client. The property names can be any properties supported
672 by the JAXRPC Stub implementation. See javadoc for javax.xml.rpc.Stub
673 -->
674 <!ELEMENT stub-property ( name, value )>
675
676 <!--
677 JAXRPC property values that should be set on a Call object before it's
678 returned to the web service client. The property names can be any
679 properties supported by the JAXRPC Call implementation. See javadoc
680 for javax.xml.rpc.Call
681 -->
682 <!ELEMENT call-property ( name, value )>
683
684 <!--
685 This is a valid URL pointing to a final WSDL document. It is optional.
686 If specified, the WSDL document at this URL will be used during
687 deployment instead of the WSDL document associated with the
688 service-ref in the standard deployment descriptor.
689
690 Examples :
691
692   // available via HTTP
693   <wsdl-override>http://localhost:8000/myservice/myport?WSDL</wsdl-override>
694
695   // in a file
696   <wsdl-override>file:/home/user1/myfinalwsdl.wsdl</wsdl-override>
697
698 -->
699 <!ELEMENT wsdl-override ( #PCDATA )>
700
701 <!--
702 Name of generated service implementation class. This is not set by the
703 deployer. It is derived during deployment.
704 -->
705 <!ELEMENT service-impl-class ( #PCDATA )>
706
707 <!--
708 The service-qname element declares the specific WSDL service
709 element that is being refered to. It is not set by the deployer.
710 It is derived during deployment.
711 -->
712 <!ELEMENT service-qname (namespaceURI, localpart)>
713
714 <!--
715 Runtime information about a web service.
716
717 wsdl-publish-location is optionally used to specify
718 where the final wsdl and any dependent files should be stored. This location
719 resides on the file system from which deployment is initiated.
720
721 -->
722 <!ELEMENT webservice-description ( webservice-description-name, wsdl-publish-location? )>
723
724 <!--
725 Unique name of a webservice within a module
726 -->
727 <!ELEMENT webservice-description-name ( #PCDATA )>
728
729 <!--
730 file: URL of a directory to which a web-service-description's wsdl should be
731 published during deployment. Any required files will be published to this
732 directory, preserving their location relative to the module-specific
733 wsdl directory(META-INF/wsdl or WEB-INF/wsdl).
734
735 Example :
736
737   For an ejb.jar whose webservices.xml wsdl-file element contains
738     META-INF/wsdl/a/Foo.wsdl
739
740   <wsdl-publish-location>file:/home/user1/publish
741   </wsdl-publish-location>
742
743   The final wsdl will be stored in /home/user1/publish/a/Foo.wsdl
744
745 -->
746 <!ELEMENT wsdl-publish-location ( #PCDATA )>
747
748 <!--
749 Information about a web service endpoint.
750 -->
751 <!ELEMENT webservice-endpoint ( port-component-name, endpoint-address-uri?, login-config?, transport-guarantee?, service-qname?, tie-class?, servlet-impl-class? )>
752
753 <!--
754 Unique name of a port component within a module
755 -->
756 <!ELEMENT port-component-name ( #PCDATA )>
757
758 <!--
759 Relative path combined with web server root to form fully qualified
760 endpoint address for a web service endpoint. For servlet endpoints, this
761 value is relative to the servlet's web application context root. In
762 all cases, this value must be a fixed pattern(i.e. no "*" allowed).
763 If the web service endpoint is a servlet that only implements a single
764 endpoint has only one url-pattern, it is not necessary to set
765 this value since the container can derive it from web.xml.
766 -->
767 <!ELEMENT endpoint-address-uri ( #PCDATA )>
768
769 <!--
770 The name of tie implementation class for a port-component. This is
771 not specified by the deployer. It is derived during deployment.
772 -->
773 <!ELEMENT tie-class (#PCDATA)>
774
775 <!--
776 Optional authentication configuration for an EJB web service endpoint.
777 Not needed for servet web service endpoints. Their security configuration
778 is contained in the standard web application descriptor.
779 -->
780 <!ELEMENT login-config ( auth-method )>
781
782 <!--
783 The auth-method element is used to configure the authentication
784 mechanism for the web application. As a prerequisite to gaining access
785 to any web resources which are protected by an authorization
786 constraint, a user must have authenticated using the configured
787 mechanism.
788 -->
789
790 <!ELEMENT auth-method (#PCDATA)>
791
792 <!--
793 Name of application-written servlet impl class contained in deployed war.
794 This is not set by the deployer. It is derived by the container
795 during deployment.
796 -->
797 <!ELEMENT servlet-impl-class (#PCDATA)>
798
799 <!--
800 The transport-guarantee element specifies that the communication
801 between client and server should be NONE, INTEGRAL, or
802 CONFIDENTIAL. NONE means that the application does not require any
803 transport guarantees. A value of INTEGRAL means that the application
804 requires that the data sent between the client and server be sent in
805 such a way that it can't be changed in transit. CONFIDENTIAL means
806 that the application requires that the data be transmitted in a
807 fashion that prevents other entities from observing the contents of
808 the transmission. In most cases, the presence of the INTEGRAL or
809 CONFIDENTIAL flag will indicate that the use of SSL is required.
810 -->
811
812 <!ELEMENT transport-guarantee (#PCDATA)>
813
814 <!--
815 Runtime settings for a web service reference. In the simplest case,
816 there is no runtime information required for a service ref. Runtime info
817 is only needed in the following cases :
818  * to define the port that should be used to resolve a container-managed port
819  * to define default Stub/Call property settings for Stub objects
820  * to define the URL of a final WSDL document to be used instead of
821 the one packaged with a service-ref
822 -->
823
824 <!--
825 The localpart element indicates the local part of a QNAME.
826 -->
827 <!ELEMENT localpart (#PCDATA)>
828
829 <!--
830 The namespaceURI element indicates a URI.
831 -->
832 <!ELEMENT namespaceURI (#PCDATA)>
833
834 */
835

A to Z: JavaDoc & Examples

---

Daily Java News & Articles

---

Open Source Projects

---

Open Source Codes

---

Free Computer Books

---

Remove Frame

---

Popular Tags