/
jaxws-api.xml
4107 lines (4101 loc) · 319 KB
/
jaxws-api.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2018, 2020 Oracle and/or its affiliates. All rights reserved.
This program and the accompanying materials are made available under the
terms of the Eclipse Public License v. 2.0, which is available at
http://www.eclipse.org/legal/epl-2.0.
This Source Code may also be made available under the following Secondary
Licenses when the conditions for such availability set forth in the
Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
version 2 with the GNU Classpath Exception, which is available at
https://www.gnu.org/software/classpath/license.html.
SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
-->
<javadoc>
<package name="jakarta.xml.ws">
<classes>
<class modifiers="public final" name="WebServicePermission">
<extends name="BasicPermission" package="java.security"/>
<superclasses>
<superclass name="Permission" package="java.security"/>
<superclass name="Object" package="java.lang"/>
</superclasses>
<comment>
<lead>This class defines web service permissions.</lead>
<detail> Web service Permissions are identified by name (also referred to as a "target name") alone. There are no actions associated with them. The following permission target name is defined: publishEndpoint The publishEndpoint permission allows publishing a web service endpoint using the publish methods defined by the jakarta.xml.ws.Endpoint class.</detail>
<see class="Endpoint" package="jakarta.xml.ws"/>
<see class="BasicPermission" package="java.security"/>
<see class="Permission" package="java.security"/>
<see class="Permissions" package="java.security"/>
<see class="SecurityManager" package="java.lang"/>
</comment>
<constructors>
<constructor modifiers="public">
<comment>
<lead>Creates a new permission with the specified name.</lead>
</comment>
<parameters>
<parameter name="name" package="java.lang" type="String">
<comment>the name of the WebServicePermission</comment>
</parameter>
</parameters>
</constructor>
<constructor modifiers="public">
<comment>
<lead>Creates a new permission with the specified name and actions.</lead>
<detail> The actions parameter is currently unused and it should be null.</detail>
</comment>
<parameters>
<parameter name="name" package="java.lang" type="String">
<comment>the name of the WebServicePermission</comment>
</parameter>
<parameter name="actions" package="java.lang" type="String">
<comment>should be null</comment>
</parameter>
</parameters>
</constructor>
</constructors>
</class>
<class modifiers="public abstract" name="WebServiceFeature">
<extends name="Object" package="java.lang"/>
<since>2.1</since>
<comment>
<lead>A WebServiceFeature is used to represent a feature that can be enabled or disabled for a web service.</lead>
<detail> The JAX-WS specification will define some standard features and JAX-WS implementors are free to define additional features if necessary. Vendor specific features may not be portable so caution should be used when using them. Each Feature definition MUST define a public static final String ID that can be used in the Feature annotation to refer to the feature. This ID MUST be unique across all features of all vendors. When defining a vendor specific feature ID, use a vendor specific namespace in the ID string.</detail>
<see class="RespectBindingFeature" package="jakarta.xml.ws"/>
<see class="AddressingFeature" package="jakarta.xml.ws.soap"/>
<see class="MTOMFeature" package="jakarta.xml.ws.soap"/>
</comment>
<fields>
<field modifiers="protected" name="enabled" type="boolean">
<comment>
<lead>Specifies if the feature is enabled or disabled</lead>
</comment>
</field>
</fields>
<constructors>
<constructor modifiers="protected">
<comment/>
</constructor>
</constructors>
<methods>
<method modifiers="public abstract" name="getID">
<comment>
<lead>Get the unique identifier for this WebServiceFeature.</lead>
</comment>
<returns package="java.lang" type="String">
<comment>the unique identifier for this feature.</comment>
</returns>
</method>
<method modifiers="public" name="isEnabled">
<comment>
<lead>Returns true if this feature is enabled.</lead>
</comment>
<returns type="boolean">
<comment>true if and only if the feature is enabled .</comment>
</returns>
</method>
</methods>
</class>
<class modifiers="public" name="WebServiceException">
<extends name="RuntimeException" package="java.lang"/>
<superclasses>
<superclass name="Exception" package="java.lang"/>
<superclass name="Throwable" package="java.lang"/>
<superclass name="Object" package="java.lang"/>
</superclasses>
<since>JAX-WS 2.0</since>
<comment>
<lead>The WebServiceException class is the base exception class for all JAX-WS API runtime exceptions.</lead>
</comment>
<constructors>
<constructor modifiers="public">
<comment>
<lead>Constructs a new exception with null as its detail message.</lead>
<detail> The cause is not initialized.</detail>
</comment>
</constructor>
<constructor modifiers="public">
<comment>
<lead>Constructs a new exception with the specified detail message.</lead>
<detail> The cause is not initialized.</detail>
</comment>
<parameters>
<parameter name="message" package="java.lang" type="String">
<comment>The detail message which is later retrieved using the getMessage method</comment>
</parameter>
</parameters>
</constructor>
<constructor modifiers="public">
<comment>
<lead>Constructs a new exception with the specified detail message and cause.</lead>
</comment>
<parameters>
<parameter name="message" package="java.lang" type="String">
<comment>The detail message which is later retrieved using the getMessage method</comment>
</parameter>
<parameter name="cause" package="java.lang" type="Throwable">
<comment>The cause which is saved for the later retrieval throw by the getCause method</comment>
</parameter>
</parameters>
</constructor>
<constructor modifiers="public">
<comment>
<lead>Constructs a new WebServiceException with the specified cause and a detail message of (cause==null ? null : cause.toString()) (which typically contains the class and detail message of cause).</lead>
</comment>
<parameters>
<parameter name="cause" package="java.lang" type="Throwable">
<comment>The cause which is saved for the later retrieval throw by the getCause method. (A null value is permitted, and indicates that the cause is nonexistent or unknown.)</comment>
</parameter>
</parameters>
</constructor>
</constructors>
</class>
<class modifiers="public" name="Service">
<extends name="Object" package="java.lang"/>
<since>JAX-WS 2.0</since>
<comment>
<lead>Service objects provide the client view of a Web service.</lead>
<see class="Dispatch" package="jakarta.xml.ws"/>
<detail> Service acts as a factory of the following: Proxies for a target service endpoint. Instances of jakarta.xml.ws.Dispatch for dynamic message-oriented invocation of a remote operation. The ports available on a service can be enumerated using the getPorts method. Alternatively, you can pass a service endpoint interface to the unary getPort method and let the runtime select a compatible port. Handler chains for all the objects created by a Service can be set by means of a HandlerResolver. An Executor may be set on the service in order to gain better control over the threads used to dispatch asynchronous callbacks. For instance, thread pooling with certain parameters can be enabled by creating a ThreadPoolExecutor and registering it with the service.</detail>
<see class="Provider" package="jakarta.xml.ws.spi"/>
<see class="HandlerResolver" package="jakarta.xml.ws.handler"/>
<see class="Executor" package="java.util.concurrent"/>
</comment>
<constructors>
<constructor modifiers="protected">
<comment/>
<parameters>
<parameter name="wsdlDocumentLocation" package="java.net" type="URL"/>
<parameter name="serviceName" package="javax.xml.namespace" type="QName"/>
</parameters>
</constructor>
<constructor modifiers="protected">
<comment/>
<parameters>
<parameter name="wsdlDocumentLocation" package="java.net" type="URL"/>
<parameter name="serviceName" package="javax.xml.namespace" type="QName"/>
<parameter dimension="[]" name="features" package="jakarta.xml.ws" type="WebServiceFeature"/>
</parameters>
</constructor>
</constructors>
<methods>
<method modifiers="public" name="getPort">
<comment>
<lead>The getPort method returns a proxy.</lead>
<detail> A service client uses this proxy to invoke operations on the target service endpoint. The serviceEndpointInterface specifies the service endpoint interface that is supported by the created dynamic proxy instance.</detail>
<see class="Proxy" package="java.lang.reflect"/>
<see class="InvocationHandler" package="java.lang.reflect"/>
</comment>
<parameters>
<parameter name="portName" package="javax.xml.namespace" type="QName">
<comment>Qualified name of the service endpoint in the WSDL service description.</comment>
</parameter>
<parameter name="serviceEndpointInterface" package="java.lang" type="Class">
<comment>Service endpoint interface supported by the dynamic proxy instance.</comment>
</parameter>
</parameters>
<returns package="java.lang" type="Object">
<comment>Object Proxy instance that supports the specified service endpoint interface.</comment>
</returns>
</method>
<method modifiers="public" name="getPort">
<since>JAX-WS 2.1</since>
<comment>
<lead>The getPort method returns a proxy.</lead>
<detail> A service client uses this proxy to invoke operations on the target service endpoint. The serviceEndpointInterface specifies the service endpoint interface that is supported by the created dynamic proxy instance.</detail>
<see class="Proxy" package="java.lang.reflect"/>
<see class="InvocationHandler" package="java.lang.reflect"/>
<see class="WebServiceFeature" package="jakarta.xml.ws"/>
</comment>
<parameters>
<parameter name="portName" package="javax.xml.namespace" type="QName">
<comment>Qualified name of the service endpoint in the WSDL service description.</comment>
</parameter>
<parameter name="serviceEndpointInterface" package="java.lang" type="Class">
<comment>Service endpoint interface supported by the dynamic proxy instance.</comment>
</parameter>
<parameter dimension="[]" name="features" package="jakarta.xml.ws" type="WebServiceFeature">
<comment>A list of WebServiceFeatures to configure on the proxy. Supported features not in the features parameter will have their default values.</comment>
</parameter>
</parameters>
<returns package="java.lang" type="Object">
<comment>Object Proxy instance that supports the specified service endpoint interface.</comment>
</returns>
</method>
<method modifiers="public" name="getPort">
<comment>
<lead>The getPort method returns a proxy.</lead>
<detail> The parameter serviceEndpointInterface specifies the service endpoint interface that is supported by the returned proxy. In the implementation of this method, the JAX-WS runtime system takes the responsibility of selecting a protocol binding (and a port) and configuring the proxy accordingly. The returned proxy should not be reconfigured by the client.</detail>
</comment>
<parameters>
<parameter name="serviceEndpointInterface" package="java.lang" type="Class">
<comment>Service endpoint interface.</comment>
</parameter>
</parameters>
<returns package="java.lang" type="Object">
<comment>Object instance that supports the specified service endpoint interface.</comment>
</returns>
</method>
<method modifiers="public" name="getPort">
<since>JAX-WS 2.1</since>
<comment>
<lead>The getPort method returns a proxy.</lead>
<detail> The parameter serviceEndpointInterface specifies the service endpoint interface that is supported by the returned proxy. In the implementation of this method, the JAX-WS runtime system takes the responsibility of selecting a protocol binding (and a port) and configuring the proxy accordingly. The returned proxy should not be reconfigured by the client.</detail>
<see class="WebServiceFeature" package="jakarta.xml.ws"/>
</comment>
<parameters>
<parameter name="serviceEndpointInterface" package="java.lang" type="Class">
<comment>Service endpoint interface.</comment>
</parameter>
<parameter dimension="[]" name="features" package="jakarta.xml.ws" type="WebServiceFeature">
<comment>A list of WebServiceFeatures to configure on the proxy. Supported features not in the features parameter will have their default values.</comment>
</parameter>
</parameters>
<returns package="java.lang" type="Object">
<comment>Object instance that supports the specified service endpoint interface.</comment>
</returns>
</method>
<method modifiers="public" name="getPort">
<since>JAX-WS 2.1</since>
<comment>
<lead>The getPort method returns a proxy.</lead>
<detail> The parameter endpointReference specifies the endpoint that will be invoked by the returned proxy. If there are any reference parameters in the endpointReference, then those reference parameters MUST appear as SOAP headers, indicating them to be reference parameters, on all messages sent to the endpoint. The endpointReference's address MUST be used for invocations on the endpoint. The parameter serviceEndpointInterface specifies the service endpoint interface that is supported by the returned proxy. In the implementation of this method, the JAX-WS runtime system takes the responsibility of selecting a protocol binding (and a port) and configuring the proxy accordingly from the WSDL associated with this Service instance or from the metadata from the endpointReference. If this Service instance has a WSDL and the endpointReference metadata also has a WSDL, then the WSDL from this instance MUST be used. If this Service instance does not have a WSDL and the endpointReference does have a WSDL, then the WSDL from the endpointReference MAY be used. The returned proxy should not be reconfigured by the client. If this Service instance has a known proxy port that matches the information contained in the WSDL, then that proxy is returned, otherwise a WebServiceException is thrown. Calling this method has the same behavior as the following port = service.getPort(portName, serviceEndpointInterface); where the portName is retrieved from the metadata of the endpointReference or from the serviceEndpointInterface and the WSDL associated with this Service instance.</detail>
</comment>
<parameters>
<parameter name="endpointReference" package="jakarta.xml.ws" type="EndpointReference">
<comment>The EndpointReference for the target service endpoint that will be invoked by the returned proxy.</comment>
</parameter>
<parameter name="serviceEndpointInterface" package="java.lang" type="Class">
<comment>Service endpoint interface.</comment>
</parameter>
<parameter dimension="[]" name="features" package="jakarta.xml.ws" type="WebServiceFeature">
<comment>A list of WebServiceFeatures to configure on the proxy. Supported features not in the features parameter will have their default values.</comment>
</parameter>
</parameters>
<returns package="java.lang" type="Object">
<comment>Object Proxy instance that supports the specified service endpoint interface.</comment>
</returns>
</method>
<method modifiers="public" name="addPort">
<comment>
<lead>Creates a new port for the service.</lead>
<detail> Ports created in this way contain no WSDL port type information and can only be used for creating Dispatchinstances.</detail>
<see class="SOAPBinding" member="SOAP11HTTP_BINDING" package="jakarta.xml.ws.soap"/>
<see class="SOAPBinding" member="SOAP12HTTP_BINDING" package="jakarta.xml.ws.soap"/>
<see class="HTTPBinding" member="HTTP_BINDING" package="jakarta.xml.ws.http"/>
</comment>
<parameters>
<parameter name="portName" package="javax.xml.namespace" type="QName">
<comment>Qualified name for the target service endpoint.</comment>
</parameter>
<parameter name="bindingId" package="java.lang" type="String">
<comment>A String identifier of a binding.</comment>
</parameter>
<parameter name="endpointAddress" package="java.lang" type="String">
<comment>Address of the target service endpoint as a URI.</comment>
</parameter>
</parameters>
<returns type="void"/>
</method>
<method modifiers="public" name="createDispatch">
<comment>
<lead>Creates a Dispatch instance for use with objects of the client's choosing.</lead>
<see class="Source" package="javax.xml.transform"/>
<see class="SOAPMessage" package="javax.xml.soap"/>
</comment>
<parameters>
<parameter name="portName" package="javax.xml.namespace" type="QName">
<comment>Qualified name for the target service endpoint</comment>
</parameter>
<parameter name="type" package="java.lang" type="Class">
<comment>The class of object used for messages or message payloads. Implementations are required to support javax.xml.transform.Source, javax.xml.soap.SOAPMessage and javax.activation.DataSource, depending on the binding in use.</comment>
</parameter>
<parameter name="mode" package="jakarta.xml.ws.Service" type="Service.Mode">
<comment>Controls whether the created dispatch instance is message or payload oriented, i.e. whether the client will work with complete protocol messages or message payloads. E.g. when using the SOAP protocol, this parameter controls whether the client will work with SOAP messages or the contents of a SOAP body. Mode MUST be MESSAGE when type is SOAPMessage.</comment>
</parameter>
</parameters>
<returns package="jakarta.xml.ws" type="Dispatch">
<comment>Dispatch instance.</comment>
</returns>
</method>
<method modifiers="public" name="createDispatch">
<since>JAX-WS 2.1</since>
<comment>
<lead>Creates a Dispatch instance for use with objects of the client's choosing.</lead>
<see class="Source" package="javax.xml.transform"/>
<see class="SOAPMessage" package="javax.xml.soap"/>
<see class="WebServiceFeature" package="jakarta.xml.ws"/>
</comment>
<parameters>
<parameter name="portName" package="javax.xml.namespace" type="QName">
<comment>Qualified name for the target service endpoint</comment>
</parameter>
<parameter name="type" package="java.lang" type="Class">
<comment>The class of object used for messages or message payloads. Implementations are required to support javax.xml.transform.Source and javax.xml.soap.SOAPMessage.</comment>
</parameter>
<parameter name="mode" package="jakarta.xml.ws.Service" type="Service.Mode">
<comment>Controls whether the created dispatch instance is message or payload oriented, i.e. whether the client will work with complete protocol messages or message payloads. E.g. when using the SOAP protocol, this parameter controls whether the client will work with SOAP messages or the contents of a SOAP body. Mode MUST be MESSAGE when type is SOAPMessage.</comment>
</parameter>
<parameter dimension="[]" name="features" package="jakarta.xml.ws" type="WebServiceFeature">
<comment>A list of WebServiceFeatures to configure on the proxy. Supported features not in the features parameter will have their default values.</comment>
</parameter>
</parameters>
<returns package="jakarta.xml.ws" type="Dispatch">
<comment>Dispatch instance.</comment>
</returns>
</method>
<method modifiers="public" name="createDispatch">
<since>JAX-WS 2.1</since>
<comment>
<lead>Creates a Dispatch instance for use with objects of the client's choosing.</lead>
<detail> If there are any reference parameters in the endpointReference, then those reference parameters MUST appear as SOAP headers, indicating them to be reference parameters, on all messages sent to the endpoint. The endpointReference's address MUST be used for invocations on the endpoint. In the implementation of this method, the JAX-WS runtime system takes the responsibility of selecting a protocol binding (and a port) and configuring the dispatch accordingly from the WSDL associated with this Service instance or from the metadata from the endpointReference. If this Service instance has a WSDL and the endpointReference also has a WSDL in its metadata, then the WSDL from this instance MUST be used. If this Service instance does not have a WSDL and the endpointReference does have a WSDL, then the WSDL from the endpointReference MAY be used. An implementation MUST be able to retrieve the portName from the endpointReference metadata. This method behaves the same as calling dispatch = service.createDispatch(portName, type, mode, features); where the portName is retrieved from the WSDL or EndpointReference metadata.</detail>
<see class="Source" package="javax.xml.transform"/>
<see class="SOAPMessage" package="javax.xml.soap"/>
<see class="WebServiceFeature" package="jakarta.xml.ws"/>
</comment>
<parameters>
<parameter name="endpointReference" package="jakarta.xml.ws" type="EndpointReference">
<comment>The EndpointReference for the target service endpoint that will be invoked by the returned Dispatch object.</comment>
</parameter>
<parameter name="type" package="java.lang" type="Class">
<comment>The class of object used to messages or message payloads. Implementations are required to support javax.xml.transform.Source and javax.xml.soap.SOAPMessage.</comment>
</parameter>
<parameter name="mode" package="jakarta.xml.ws.Service" type="Service.Mode">
<comment>Controls whether the created dispatch instance is message or payload oriented, i.e. whether the client will work with complete protocol messages or message payloads. E.g. when using the SOAP protocol, this parameter controls whether the client will work with SOAP messages or the contents of a SOAP body. Mode MUST be MESSAGE when type is SOAPMessage.</comment>
</parameter>
<parameter dimension="[]" name="features" package="jakarta.xml.ws" type="WebServiceFeature">
<comment>An array of WebServiceFeatures to configure on the proxy. Supported features not in the features parameter will have their default values.</comment>
</parameter>
</parameters>
<returns package="jakarta.xml.ws" type="Dispatch">
<comment>Dispatch instance</comment>
</returns>
</method>
<method modifiers="public" name="createDispatch">
<comment>
<lead>Creates a Dispatch instance for use with JAXB generated objects.</lead>
<see class="JAXBContext" package="javax.xml.bind"/>
</comment>
<parameters>
<parameter name="portName" package="javax.xml.namespace" type="QName">
<comment>Qualified name for the target service endpoint</comment>
</parameter>
<parameter name="context" package="javax.xml.bind" type="JAXBContext">
<comment>The JAXB context used to marshall and unmarshall messages or message payloads.</comment>
</parameter>
<parameter name="mode" package="jakarta.xml.ws.Service" type="Service.Mode">
<comment>Controls whether the created dispatch instance is message or payload oriented, i.e. whether the client will work with complete protocol messages or message payloads. E.g. when using the SOAP protocol, this parameter controls whether the client will work with SOAP messages or the contents of a SOAP body.</comment>
</parameter>
</parameters>
<returns package="jakarta.xml.ws" type="Dispatch">
<comment>Dispatch instance.</comment>
</returns>
</method>
<method modifiers="public" name="createDispatch">
<since>JAX-WS 2.1</since>
<comment>
<lead>Creates a Dispatch instance for use with JAXB generated objects.</lead>
<see class="JAXBContext" package="javax.xml.bind"/>
<see class="WebServiceFeature" package="jakarta.xml.ws"/>
</comment>
<parameters>
<parameter name="portName" package="javax.xml.namespace" type="QName">
<comment>Qualified name for the target service endpoint</comment>
</parameter>
<parameter name="context" package="javax.xml.bind" type="JAXBContext">
<comment>The JAXB context used to marshall and unmarshall messages or message payloads.</comment>
</parameter>
<parameter name="mode" package="jakarta.xml.ws.Service" type="Service.Mode">
<comment>Controls whether the created dispatch instance is message or payload oriented, i.e. whether the client will work with complete protocol messages or message payloads. E.g. when using the SOAP protocol, this parameter controls whether the client will work with SOAP messages or the contents of a SOAP body.</comment>
</parameter>
<parameter dimension="[]" name="features" package="jakarta.xml.ws" type="WebServiceFeature">
<comment>A list of WebServiceFeatures to configure on the proxy. Supported features not in the features parameter will have their default values.</comment>
</parameter>
</parameters>
<returns package="jakarta.xml.ws" type="Dispatch">
<comment>Dispatch instance.</comment>
</returns>
</method>
<method modifiers="public" name="createDispatch">
<since>JAX-WS 2.1</since>
<comment>
<lead>Creates a Dispatch instance for use with JAXB generated objects.</lead>
<detail> If there are any reference parameters in the endpointReference, then those reference parameters MUST appear as SOAP headers, indicating them to be reference parameters, on all messages sent to the endpoint. The endpointReference's address MUST be used for invocations on the endpoint. In the implementation of this method, the JAX-WS runtime system takes the responsibility of selecting a protocol binding (and a port) and configuring the dispatch accordingly from the WSDL associated with this Service instance or from the metadata from the endpointReference. If this Service instance has a WSDL and the endpointReference also has a WSDL in its metadata, then the WSDL from this instance MUST be used. If this Service instance does not have a WSDL and the endpointReference does have a WSDL, then the WSDL from the endpointReference MAY be used. An implementation MUST be able to retrieve the portName from the endpointReference metadata. This method behavies the same as calling dispatch = service.createDispatch(portName, context, mode, features); where the portName is retrieved from the WSDL or endpointReference metadata.</detail>
<see class="JAXBContext" package="javax.xml.bind"/>
<see class="WebServiceFeature" package="jakarta.xml.ws"/>
</comment>
<parameters>
<parameter name="endpointReference" package="jakarta.xml.ws" type="EndpointReference">
<comment>The EndpointReference for the target service endpoint that will be invoked by the returned Dispatch object.</comment>
</parameter>
<parameter name="context" package="javax.xml.bind" type="JAXBContext">
<comment>The JAXB context used to marshall and unmarshall messages or message payloads.</comment>
</parameter>
<parameter name="mode" package="jakarta.xml.ws.Service" type="Service.Mode">
<comment>Controls whether the created dispatch instance is message or payload oriented, i.e. whether the client will work with complete protocol messages or message payloads. E.g. when using the SOAP protocol, this parameter controls whether the client will work with SOAP messages or the contents of a SOAP body.</comment>
</parameter>
<parameter dimension="[]" name="features" package="jakarta.xml.ws" type="WebServiceFeature">
<comment>An array of WebServiceFeatures to configure on the proxy. Supported features not in the features parameter will have their default values.</comment>
</parameter>
</parameters>
<returns package="jakarta.xml.ws" type="Dispatch">
<comment>Dispatch instance</comment>
</returns>
</method>
<method modifiers="public" name="getServiceName">
<comment>
<lead>Gets the name of this service.</lead>
</comment>
<returns package="javax.xml.namespace" type="QName">
<comment>Qualified name of this service</comment>
</returns>
</method>
<method modifiers="public" name="getPorts">
<comment>
<lead>Returns an Iterator for the list of QNames of service endpoints grouped by this service</lead>
</comment>
<returns package="java.util" type="Iterator">
<comment>Returns java.util.Iterator with elements of type javax.xml.namespace.QName.</comment>
</returns>
</method>
<method modifiers="public" name="getWSDLDocumentLocation">
<comment>
<lead>Gets the location of the WSDL document for this Service.</lead>
</comment>
<returns package="java.net" type="URL">
<comment>URL for the location of the WSDL document for this service.</comment>
</returns>
</method>
<method modifiers="public" name="getHandlerResolver">
<comment>
<lead>Returns the configured handler resolver.</lead>
</comment>
<returns package="jakarta.xml.ws.handler" type="HandlerResolver">
<comment>HandlerResolver The HandlerResolver being used by this Service instance, or null if there isn't one.</comment>
</returns>
</method>
<method modifiers="public" name="setHandlerResolver">
<comment>
<lead>Sets the HandlerResolver for this Service instance.</lead>
<detail> The handler resolver, if present, will be called once for each proxy or dispatch instance that is created, and the handler chain returned by the resolver will be set on the instance.</detail>
<see class="HandlerResolver" package="jakarta.xml.ws.handler"/>
</comment>
<parameters>
<parameter name="handlerResolver" package="jakarta.xml.ws.handler" type="HandlerResolver">
<comment>The HandlerResolver to use for all subsequently created proxy/dispatch objects.</comment>
</parameter>
</parameters>
<returns type="void"/>
</method>
<method modifiers="public" name="getExecutor">
<comment>
<lead>Returns the executor for this Serviceinstance.</lead>
<detail> The executor is used for all asynchronous invocations that require callbacks.</detail>
<see class="Executor" package="java.util.concurrent"/>
</comment>
<returns package="java.util.concurrent" type="Executor">
<comment>The java.util.concurrent.Executor to be used to invoke a callback.</comment>
</returns>
</method>
<method modifiers="public" name="setExecutor">
<comment>
<lead>Sets the executor for this Service instance.</lead>
<detail> The executor is used for all asynchronous invocations that require callbacks.</detail>
<see class="Executor" package="java.util.concurrent"/>
</comment>
<parameters>
<parameter name="executor" package="java.util.concurrent" type="Executor">
<comment>The java.util.concurrent.Executor to be used to invoke a callback.</comment>
</parameter>
</parameters>
<returns type="void"/>
</method>
<method modifiers="public static" name="create">
<comment>
<lead>Creates a Service instance.</lead>
<detail> The specified WSDL document location and service qualified name MUST uniquely identify a wsdl:service element.</detail>
</comment>
<parameters>
<parameter name="wsdlDocumentLocation" package="java.net" type="URL">
<comment>URL for the WSDL document location for the service</comment>
</parameter>
<parameter name="serviceName" package="javax.xml.namespace" type="QName">
<comment>QName for the service</comment>
</parameter>
</parameters>
<returns package="jakarta.xml.ws" type="Service"/>
</method>
<method modifiers="public static" name="create">
<since>JAX-WS 2.2</since>
<comment>
<lead>Creates a Service instance.</lead>
<detail> The specified WSDL document location and service qualified name MUST uniquely identify a wsdl:service element.</detail>
</comment>
<parameters>
<parameter name="wsdlDocumentLocation" package="java.net" type="URL">
<comment>URL for the WSDL document location for the service</comment>
</parameter>
<parameter name="serviceName" package="javax.xml.namespace" type="QName">
<comment>QName for the service</comment>
</parameter>
<parameter dimension="[]" name="features" package="jakarta.xml.ws" type="WebServiceFeature">
<comment>Web Service features that must be configured on the service. If the provider doesn't understand a feature, it must throw a WebServiceException.</comment>
</parameter>
</parameters>
<returns package="jakarta.xml.ws" type="Service"/>
</method>
<method modifiers="public static" name="create">
<comment>
<lead>Creates a Service instance.</lead>
</comment>
<parameters>
<parameter name="serviceName" package="javax.xml.namespace" type="QName">
<comment>QName for the service</comment>
</parameter>
</parameters>
<returns package="jakarta.xml.ws" type="Service"/>
</method>
<method modifiers="public static" name="create">
<since>JAX-WS 2.2</since>
<comment>
<lead>Creates a Service instance.</lead>
</comment>
<parameters>
<parameter name="serviceName" package="javax.xml.namespace" type="QName">
<comment>QName for the service</comment>
</parameter>
<parameter dimension="[]" name="features" package="jakarta.xml.ws" type="WebServiceFeature">
<comment>Web Service features that must be configured on the service. If the provider doesn't understand a feature, it must throw a WebServiceException.</comment>
</parameter>
</parameters>
<returns package="jakarta.xml.ws" type="Service"/>
</method>
</methods>
</class>
<class modifiers="public static final" name="Service.Mode">
<extends name="Enum" package="java.lang"/>
<superclasses>
<superclass name="Object" package="java.lang"/>
</superclasses>
<comment>
<lead>The orientation of a dynamic client or service.</lead>
<detail> MESSAGE provides access to entire protocol message, PAYLOAD to protocol message payload only.</detail>
</comment>
<fields>
<field modifiers="public static final" name="MESSAGE" package="jakarta.xml.ws.Service" type="Service.Mode">
<comment/>
</field>
<field modifiers="public static final" name="PAYLOAD" package="jakarta.xml.ws.Service" type="Service.Mode">
<comment/>
</field>
</fields>
<methods>
<method modifiers="public static" name="values">
<comment/>
<returns dimension="[]" package="jakarta.xml.ws.Service" type="Service.Mode"/>
</method>
<method modifiers="public static" name="valueOf">
<comment/>
<parameters>
<parameter name="name" package="java.lang" type="String"/>
</parameters>
<returns package="jakarta.xml.ws.Service" type="Service.Mode"/>
</method>
</methods>
</class>
<class modifiers="public final" name="RespectBindingFeature">
<extends name="WebServiceFeature" package="jakarta.xml.ws"/>
<superclasses>
<superclass name="Object" package="java.lang"/>
</superclasses>
<since>JAX-WS 2.1</since>
<comment>
<lead>This feature clarifies the use of the wsdl:binding in a JAX-WS runtime.</lead>
<see class="WebServiceFeature" package="jakarta.xml.ws"/>
<see class="WebServiceException" package="jakarta.xml.ws"/>
<see class="WebServiceException" package="jakarta.xml.ws"/>
<detail> This feature is only useful with web services that have an associated WSDL. Enabling this feature requires that a JAX-WS implementation inspect the wsdl:binding for an endpoint at runtime to make sure that all wsdl:extensions that have the required attribute set to true are understood and are being used. The following describes the affects of this feature with respect to be enabled or disabled: ENABLED: In this Mode, a JAX-WS runtime MUST assure that all required wsdl:binding extensions are either understood and used by the runtime, or explicitly disabled by the web service application. A web service can disable a particular extension if there is a corresponding WebServiceFeature or annotation. Similarly, a web service client can disable particular extension using the corresponding WebServiceFeature while creating a proxy or Dispatch instance. The runtime MUST also make sure that binding of SEI parameters/return values respect the wsdl:binding. With this feature enabled, if a required (wsdl:required="true") wsdl:binding extension is in the WSDL and it is not supported by a JAX-WS runtime and it has not been explicitly turned off by the web service developer, then that JAX-WS runtime MUST behave appropriately based on whether it is on the client or server: Client: runtime MUST throw a WebServiceException no sooner than when one of the methods above is invoked but no later than the first invocation of an endpoint operation. Server: throw a WebServiceException and the endpoint MUST fail to deploy DISABLED: In this Mode, an implementation may choose whether to inspect the wsdl:binding or not and to what degree the wsdl:binding will be inspected. For example, one implementation may choose to behave as if this feature is enabled, another implementation may only choose to verify the SEI's parameter/return type bindings. </detail>
<see class="AddressingFeature" package="jakarta.xml.ws.soap"/>
</comment>
<fields>
<field modifiers="public static final" name="ID" package="java.lang" type="String">
<comment>
<lead>Constant value identifying the RespectBindingFeature</lead>
</comment>
</field>
</fields>
<constructors>
<constructor modifiers="public">
<comment>
<lead>Creates an RespectBindingFeature.</lead>
<detail> The instance created will be enabled.</detail>
</comment>
</constructor>
<constructor modifiers="public">
<comment>
<lead>Creates an RespectBindingFeature</lead>
</comment>
<parameters>
<parameter name="enabled" type="boolean">
<comment>specifies whether this feature should be enabled or not.</comment>
</parameter>
</parameters>
</constructor>
</constructors>
<methods>
<method modifiers="public" name="getID">
<comment>
<lead/>
<detail/>
</comment>
<returns package="java.lang" type="String"/>
</method>
</methods>
</class>
<class modifiers="public" name="ProtocolException">
<extends name="WebServiceException" package="jakarta.xml.ws"/>
<superclasses>
<superclass name="RuntimeException" package="java.lang"/>
<superclass name="Exception" package="java.lang"/>
<superclass name="Throwable" package="java.lang"/>
<superclass name="Object" package="java.lang"/>
</superclasses>
<since>JAX-WS 2.0</since>
<comment>
<lead>The ProtocolException class is a base class for exceptions related to a specific protocol binding.</lead>
<detail> Subclasses are used to communicate protocol level fault information to clients and may be used on the server to control the protocol specific fault representation.</detail>
</comment>
<constructors>
<constructor modifiers="public">
<comment>
<lead>Constructs a new protocol exception with null as its detail message.</lead>
<detail> The cause is not initialized, and may subsequently be initialized by a call to Throwable.initCause(java.lang.Throwable).</detail>
</comment>
</constructor>
<constructor modifiers="public">
<comment>
<lead>Constructs a new protocol exception with the specified detail message.</lead>
<detail> The cause is not initialized, and may subsequently be initialized by a call to Throwable.initCause(java.lang.Throwable).</detail>
</comment>
<parameters>
<parameter name="message" package="java.lang" type="String">
<comment>the detail message. The detail message is saved for later retrieval by the Throwable.getMessage() method.</comment>
</parameter>
</parameters>
</constructor>
<constructor modifiers="public">
<comment>
<lead>Constructs a new runtime exception with the specified detail message and cause.</lead>
<detail> Note that the detail message associated with cause is not automatically incorporated in this runtime exception's detail message.</detail>
</comment>
<parameters>
<parameter name="message" package="java.lang" type="String">
<comment>the detail message (which is saved for later retrieval by the Throwable.getMessage() method).</comment>
</parameter>
<parameter name="cause" package="java.lang" type="Throwable">
<comment>the cause (which is saved for later retrieval by the Throwable.getCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)</comment>
</parameter>
</parameters>
</constructor>
<constructor modifiers="public">
<comment>
<lead>Constructs a new runtime exception with the specified cause and a detail message of (cause==null ? null : cause.toString()) (which typically contains the class and detail message of cause).</lead>
<detail> This constructor is useful for runtime exceptions that are little more than wrappers for other throwables.</detail>
</comment>
<parameters>
<parameter name="cause" package="java.lang" type="Throwable">
<comment>the cause (which is saved for later retrieval by the Throwable.getCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)</comment>
</parameter>
</parameters>
</constructor>
</constructors>
</class>
<class modifiers="public final" name="Holder">
<extends name="Object" package="java.lang"/>
<since>JAX-WS 2.0</since>
<comment>
<lead>Holds a value of type T.</lead>
</comment>
<fields>
<field modifiers="public" name="value" package="java.lang" type="Object">
<comment>
<lead>The value contained in the holder.</lead>
</comment>
</field>
</fields>
<constructors>
<constructor modifiers="public">
<comment>
<lead>Creates a new holder with a null value.</lead>
</comment>
</constructor>
<constructor modifiers="public">
<comment>
<lead>Create a new holder with the specified value.</lead>
</comment>
<parameters>
<parameter name="value" package="java.lang" type="Object">
<comment>The value to be stored in the holder.</comment>
</parameter>
</parameters>
</constructor>
</constructors>
</class>
<class modifiers="public abstract" name="EndpointReference">
<extends name="Object" package="java.lang"/>
<since>JAX-WS 2.1</since>
<comment>
<lead>This class represents an WS-Addressing EndpointReference which is a remote reference to a web service endpoint.</lead>
<see class="Service" package="jakarta.xml.ws"/>
<see class="Endpoint" package="jakarta.xml.ws"/>
<see class="BindingProvider" package="jakarta.xml.ws"/>
<see class="W3CEndpointReference" package="jakarta.xml.ws.wsaddressing"/>
<see class="EndpointReference" member="writeTo" package="jakarta.xml.ws"/>
<see class="W3CEndpointReference" package="jakarta.xml.ws.wsaddressing"/>
<detail> See Web Services Addressing 1.0 - Core for more information on WS-Addressing EndpointReferences. This class is immutable as the typical web service developer need not be concerned with its contents. The web service developer should use this class strictly as a mechanism to reference a remote web service endpoint. See the Service APIs that clients can use to that utilize an EndpointReference. See the jakarta.xml.ws.Endpoint, and jakarta.xml.ws.BindingProvider APIs on how EndpointReferences can be created for published endpoints. Concrete implementations of this class will represent an EndpointReference for a particular version of Addressing. For example the W3CEndpointReference is for use with W3C Web Services Addressing 1.0 - Core Recommendation. If JAX-WS implementors need to support different versions of addressing, they should write their own EndpointReference subclass for that version. This will allow a JAX-WS implementation to create vendor specific EndpointReferences that that vendor can use to flag a different version of addressing. Web service developers that wish to pass or return EndpointReferences in Java methods in an SEI should use concrete instances of an EndpointReference such as the W3CEndpointReference. This way the schema mapped from the SEI will be more descriptive of the type of endpoint reference being passed. JAX-WS implementors are expected to extract the XML infoset from an EndpointReferece using the EndpointReference#writeTo method. JAXB will bind this class to xs:anyType. If a better binding is desired, web services developers should use a concrete subclass such as W3CEndpointReference.</detail>
<see class="W3CEndpointReference" package="jakarta.xml.ws.wsaddressing"/>
<see class="Service" package="jakarta.xml.ws"/>
</comment>
<constructors>
<constructor modifiers="protected">
<comment/>
</constructor>
</constructors>
<methods>
<method modifiers="public static" name="readFrom">
<comment>
<lead>Factory method to read an EndpointReference from the infoset contained in eprInfoset.</lead>
<see class="Provider" member="readEndpointReference" package="jakarta.xml.ws.spi"/>
<detail> This method delegates to the vendor specific implementation of the jakarta.xml.ws.spi.Provider#readEndpointReference method.</detail>
</comment>
<parameters>
<parameter name="eprInfoset" package="javax.xml.transform" type="Source">
<comment>The EndpointReference infoset to be unmarshalled</comment>
</parameter>
</parameters>
<returns package="jakarta.xml.ws" type="EndpointReference">
<comment>the EndpointReference unmarshalled from eprInfoset never null</comment>
</returns>
</method>
<method modifiers="public abstract" name="writeTo">
<comment>
<lead>write this EndpointReference to the specified infoset format</lead>
</comment>
<parameters>
<parameter name="result" package="javax.xml.transform" type="Result">
<comment>for writing infoset</comment>
</parameter>
</parameters>
<returns type="void"/>
</method>
<method modifiers="public" name="getPort">
<comment>
<lead>The getPort method returns a proxy.</lead>
<detail> If there are any reference parameters in the EndpointReference instance, then those reference parameters MUST appear as SOAP headers, indicating them to be reference parameters, on all messages sent to the endpoint. The parameter serviceEndpointInterface specifies the service endpoint interface that is supported by the returned proxy. The EndpointReference instance specifies the endpoint that will be invoked by the returned proxy. In the implementation of this method, the JAX-WS runtime system takes the responsibility of selecting a protocol binding (and a port) and configuring the proxy accordingly from the WSDL Metadata from this EndpointReference or from annotations on the serviceEndpointInterface. For this method to successfully return a proxy, WSDL metadata MUST be available and the EndpointReference instance MUST contain an implementation understood serviceName metadata. Because this port is not created from a Service object, handlers will not automatically be configured, and the HandlerResolver and Executor cannot be get or set for this port. The BindingProvider().getBinding().setHandlerChain() method can be used to manually configure handlers for this port.</detail>
<see class="Proxy" package="java.lang.reflect"/>
<see class="WebServiceFeature" package="jakarta.xml.ws"/>
</comment>
<parameters>
<parameter name="serviceEndpointInterface" package="java.lang" type="Class">
<comment>Service endpoint interface</comment>
</parameter>
<parameter dimension="[]" name="features" package="jakarta.xml.ws" type="WebServiceFeature">
<comment>An array of WebServiceFeatures to configure on the proxy. Supported features not in the features parameter will have their default values.</comment>
</parameter>
</parameters>
<returns package="java.lang" type="Object">
<comment>Object Proxy instance that supports the specified service endpoint interface</comment>
</returns>
</method>
<method modifiers="public" name="toString">
<comment>
<lead>Displays EPR infoset for debugging convenience.</lead>
</comment>
<returns package="java.lang" type="String"/>
</method>
</methods>
</class>
<class modifiers="public abstract" name="Endpoint">
<extends name="Object" package="java.lang"/>
<since>JAX-WS 2.0</since>
<comment>
<lead>A Web service endpoint.</lead>
<detail> Endpoints are created using the static methods defined in this class. An endpoint is always tied to one Binding and one implementor, both set at endpoint creation time. An endpoint is either in a published or an unpublished state. The publish methods can be used to start publishing an endpoint, at which point it starts accepting incoming requests. Conversely, the stop method can be used to stop accepting incoming requests and take the endpoint down. Once stopped, an endpoint cannot be published again. An Executor may be set on the endpoint in order to gain better control over the threads used to dispatch incoming requests. For instance, thread pooling with certain parameters can be enabled by creating a ThreadPoolExecutor and registering it with the endpoint. Handler chains can be set using the contained Binding. An endpoint may have a list of metadata documents, such as WSDL and XMLSchema documents, bound to it. At publishing time, the JAX-WS implementation will try to reuse as much of that metadata as possible instead of generating new ones based on the annotations present on the implementor.</detail>
<see class="Binding" package="jakarta.xml.ws"/>
<see class="BindingType" package="jakarta.xml.ws"/>
<see class="SOAPBinding" package="jakarta.xml.ws.soap"/>
<see class="Executor" package="java.util.concurrent"/>
</comment>
<fields>
<field modifiers="public static final" name="WSDL_SERVICE" package="java.lang" type="String">
<comment>
<lead>Standard property: name of WSDL service.</lead>
<detail> Type: javax.xml.namespace.QName</detail>
</comment>
</field>
<field modifiers="public static final" name="WSDL_PORT" package="java.lang" type="String">
<comment>
<lead>Standard property: name of WSDL port.</lead>
<detail> Type: javax.xml.namespace.QName</detail>
</comment>
</field>
</fields>
<constructors>
<constructor modifiers="public">
<comment/>
</constructor>
</constructors>
<methods>
<method modifiers="public static" name="create">
<comment>
<lead>Creates an endpoint with the specified implementor object.</lead>
<see class="Endpoint" member="publish(String)" package="jakarta.xml.ws"/>
<see class="Endpoint" member="publish(Object)" package="jakarta.xml.ws"/>
<detail> If there is a binding specified via a BindingType annotation then it MUST be used else a default of SOAP 1.1 / HTTP binding MUST be used. The newly created endpoint may be published by calling one of the jakarta.xml.ws.Endpoint#publish(String) and jakarta.xml.ws.Endpoint#publish(Object) methods.</detail>
</comment>
<parameters>
<parameter name="implementor" package="java.lang" type="Object">
<comment>The endpoint implementor.</comment>
</parameter>
</parameters>
<returns package="jakarta.xml.ws" type="Endpoint">
<comment>The newly created endpoint.</comment>
</returns>
</method>
<method modifiers="public static" name="create">
<since>2.2</since>
<comment>
<lead>Creates an endpoint with the specified implementor object and web service features.</lead>
<see class="Endpoint" member="publish(String)" package="jakarta.xml.ws"/>
<see class="Endpoint" member="publish(Object)" package="jakarta.xml.ws"/>
<detail> If there is a binding specified via a BindingType annotation then it MUST be used else a default of SOAP 1.1 / HTTP binding MUST be used. The newly created endpoint may be published by calling one of the jakarta.xml.ws.Endpoint#publish(String) and jakarta.xml.ws.Endpoint#publish(Object) methods.</detail>
</comment>
<parameters>
<parameter name="implementor" package="java.lang" type="Object">
<comment>The endpoint implementor.</comment>
</parameter>
<parameter dimension="[]" name="features" package="jakarta.xml.ws" type="WebServiceFeature">
<comment>A list of WebServiceFeatures to configure on the endpoint. Supported features not in the features parameter will have their default values.</comment>
</parameter>
</parameters>
<returns package="jakarta.xml.ws" type="Endpoint">
<comment>The newly created endpoint.</comment>
</returns>
</method>
<method modifiers="public static" name="create">
<comment>
<lead>Creates an endpoint with the specified binding type and implementor object.</lead>
<see class="Endpoint" member="publish(String)" package="jakarta.xml.ws"/>
<see class="Endpoint" member="publish(Object)" package="jakarta.xml.ws"/>
<detail> The newly created endpoint may be published by calling one of the jakarta.xml.ws.Endpoint#publish(String) and jakarta.xml.ws.Endpoint#publish(Object) methods.</detail>
</comment>
<parameters>
<parameter name="bindingId" package="java.lang" type="String">
<comment>A URI specifying the binding to use. If the bindingID is null and no binding is specified via a BindingType annotation then a default SOAP 1.1 / HTTP binding MUST be used.</comment>
</parameter>
<parameter name="implementor" package="java.lang" type="Object">
<comment>The endpoint implementor.</comment>
</parameter>
</parameters>
<returns package="jakarta.xml.ws" type="Endpoint">
<comment>The newly created endpoint.</comment>
</returns>
</method>
<method modifiers="public static" name="create">
<since>2.2</since>
<comment>
<lead>Creates an endpoint with the specified binding type, implementor object, and web service features.</lead>
<see class="Endpoint" member="publish(String)" package="jakarta.xml.ws"/>
<see class="Endpoint" member="publish(Object)" package="jakarta.xml.ws"/>
<detail> The newly created endpoint may be published by calling one of the jakarta.xml.ws.Endpoint#publish(String) and jakarta.xml.ws.Endpoint#publish(Object) methods.</detail>
</comment>
<parameters>
<parameter name="bindingId" package="java.lang" type="String">
<comment>A URI specifying the binding to use. If the bindingID is null and no binding is specified via a BindingType annotation then a default SOAP 1.1 / HTTP binding MUST be used.</comment>
</parameter>
<parameter name="implementor" package="java.lang" type="Object">
<comment>The endpoint implementor.</comment>
</parameter>
<parameter dimension="[]" name="features" package="jakarta.xml.ws" type="WebServiceFeature">
<comment>A list of WebServiceFeatures to configure on the endpoint. Supported features not in the features parameter will have their default values.</comment>
</parameter>
</parameters>
<returns package="jakarta.xml.ws" type="Endpoint">
<comment>The newly created endpoint.</comment>
</returns>
</method>
<method modifiers="public abstract" name="getBinding">
<comment>
<lead>Returns the binding for this endpoint.</lead>
</comment>
<returns package="jakarta.xml.ws" type="Binding">
<comment>The binding for this endpoint</comment>
</returns>
</method>
<method modifiers="public abstract" name="getImplementor">
<comment>
<lead>Returns the implementation object for this endpoint.</lead>
</comment>
<returns package="java.lang" type="Object">
<comment>The implementor for this endpoint</comment>
</returns>
</method>
<method modifiers="public abstract" name="publish">
<comment>
<lead>Publishes this endpoint at the given address.</lead>
<see class="Endpoint" member="publish(Object)" package="jakarta.xml.ws"/>
<detail> The necessary server infrastructure will be created and configured by the JAX-WS implementation using some default configuration. In order to get more control over the server configuration, please use the jakarta.xml.ws.Endpoint#publish(Object) method instead.</detail>
</comment>
<parameters>
<parameter name="address" package="java.lang" type="String">
<comment>A URI specifying the address to use. The address MUST be compatible with the binding specified at the time the endpoint was created.</comment>
</parameter>
</parameters>
<returns type="void"/>
</method>
<method modifiers="public static" name="publish">
<comment>
<lead>Creates and publishes an endpoint for the specified implementor object at the given address.</lead>
<see class="Endpoint" member="create(String,Object)" package="jakarta.xml.ws"/>
<see class="Endpoint" member="publish(Object)" package="jakarta.xml.ws"/>
<detail> The necessary server infrastructure will be created and configured by the JAX-WS implementation using some default configuration. In order to get more control over the server configuration, please use the jakarta.xml.ws.Endpoint#create(String,Object) and jakarta.xml.ws.Endpoint#publish(Object) methods instead.</detail>
</comment>
<parameters>
<parameter name="address" package="java.lang" type="String">
<comment>A URI specifying the address and transport/protocol to use. A http: URI MUST result in the SOAP 1.1/HTTP binding being used. Implementations may support other URI schemes.</comment>
</parameter>
<parameter name="implementor" package="java.lang" type="Object">
<comment>The endpoint implementor.</comment>
</parameter>
</parameters>
<returns package="jakarta.xml.ws" type="Endpoint">
<comment>The newly created endpoint.</comment>
</returns>
</method>
<method modifiers="public static" name="publish">
<since>2.2</since>
<comment>
<lead>Creates and publishes an endpoint for the specified implementor object at the given address.</lead>
<see class="Endpoint" member="create(String,Object)" package="jakarta.xml.ws"/>
<see class="Endpoint" member="publish(Object)" package="jakarta.xml.ws"/>
<detail> The created endpoint is configured with the web service features. The necessary server infrastructure will be created and configured by the JAX-WS implementation using some default configuration. In order to get more control over the server configuration, please use the jakarta.xml.ws.Endpoint#create(String,Object) and jakarta.xml.ws.Endpoint#publish(Object) methods instead.</detail>
</comment>
<parameters>
<parameter name="address" package="java.lang" type="String">
<comment>A URI specifying the address and transport/protocol to use. A http: URI MUST result in the SOAP 1.1/HTTP binding being used. Implementations may support other URI schemes.</comment>
</parameter>
<parameter name="implementor" package="java.lang" type="Object">
<comment>The endpoint implementor.</comment>
</parameter>
<parameter dimension="[]" name="features" package="jakarta.xml.ws" type="WebServiceFeature">
<comment>A list of WebServiceFeatures to configure on the endpoint. Supported features not in the features parameter will have their default values.</comment>
</parameter>
</parameters>