diff --git a/.github/workflows/maven.yml b/.github/workflows/maven.yml index 0a93225..964d67e 100644 --- a/.github/workflows/maven.yml +++ b/.github/workflows/maven.yml @@ -23,7 +23,7 @@ jobs: strategy: matrix: - java_version: [ 17, 21 ] + java_version: [ 21 ] steps: - name: Checkout for build diff --git a/api/src/main/java/jakarta/jws/HandlerChain.java b/api/src/main/java/jakarta/jws/HandlerChain.java index d5c58d3..8419a44 100644 --- a/api/src/main/java/jakarta/jws/HandlerChain.java +++ b/api/src/main/java/jakarta/jws/HandlerChain.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2018, 2021 Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2018, 2024 Oracle and/or its affiliates. All rights reserved. * * This program and the accompanying materials are made available under the * terms of the Eclipse Distribution License v. 1.0, which is available at @@ -20,7 +20,7 @@ * where embedding the handler configuration directly in the Java source is not appropriate; for example, where the * handler configuration needs to be shared across multiple Web Services, or where the handler chain consists of * handlers for multiple transports. - * + *

* It is an error to combine this annotation with the @SOAPMessageHandlers annotation. * * @since 1.6 diff --git a/api/src/main/java/jakarta/jws/WebMethod.java b/api/src/main/java/jakarta/jws/WebMethod.java index 62f9851..cd3b162 100644 --- a/api/src/main/java/jakarta/jws/WebMethod.java +++ b/api/src/main/java/jakarta/jws/WebMethod.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2018, 2021 Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2018, 2024 Oracle and/or its affiliates. All rights reserved. * * This program and the accompanying materials are made available under the * terms of the Eclipse Distribution License v. 1.0, which is available at @@ -19,7 +19,7 @@ * Customizes a method that is exposed as a Web Service operation. * The associated method must be public and its parameters return value, * and exceptions must follow the rules defined in Jakarta XML Web Services Specification, section 5. - * + *

* The method is not required to throw java.rmi.RemoteException. * * @since 1.6 diff --git a/api/src/main/java/jakarta/jws/WebParam.java b/api/src/main/java/jakarta/jws/WebParam.java index bdbdb6f..4213010 100644 --- a/api/src/main/java/jakarta/jws/WebParam.java +++ b/api/src/main/java/jakarta/jws/WebParam.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2018, 2022 Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2018, 2024 Oracle and/or its affiliates. All rights reserved. * * This program and the accompanying materials are made available under the * terms of the Eclipse Distribution License v. 1.0, which is available at @@ -68,7 +68,7 @@ enum Mode { /** * The XML namespace for the parameter. *

- * Only used if the operation is document style or the paramater maps to a header. + * Only used if the operation is document style or the parameter maps to a header. * If the target namespace is set to "", this represents the empty namespace. * * @return the XML namespace for the parameter @@ -93,10 +93,10 @@ enum Mode { Mode mode() default Mode.IN; /** - * If true, the parameter is pulled from a message header rather then the message body. + * If true, the parameter is pulled from a message header rather than the message body. * * @return value of {@code true} to pull the parameter from a message header - * rather then the message body or {@code false} otherwise + * rather than the message body or {@code false} otherwise */ boolean header() default false; }; diff --git a/api/src/main/java/jakarta/jws/WebResult.java b/api/src/main/java/jakarta/jws/WebResult.java index 2ce9a53..ae3d54f 100644 --- a/api/src/main/java/jakarta/jws/WebResult.java +++ b/api/src/main/java/jakarta/jws/WebResult.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2018, 2021 Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2018, 2024 Oracle and/or its affiliates. All rights reserved. * * This program and the accompanying materials are made available under the * terms of the Eclipse Distribution License v. 1.0, which is available at @@ -69,10 +69,10 @@ String targetNamespace() default ""; /** - * If true, the result is pulled from a message header rather then the message body. + * If true, the result is pulled from a message header rather than the message body. * * @return value of {@code true} to pull the parameter from a message header - * rather then the message body or {@code false} otherwise + * rather than the message body or {@code false} otherwise * @since 2.0 */ boolean header() default false; diff --git a/api/src/main/java/jakarta/jws/WebService.java b/api/src/main/java/jakarta/jws/WebService.java index f7a13ba..8b99463 100644 --- a/api/src/main/java/jakarta/jws/WebService.java +++ b/api/src/main/java/jakarta/jws/WebService.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2018, 2021 Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2018, 2024 Oracle and/or its affiliates. All rights reserved. * * This program and the accompanying materials are made available under the * terms of the Eclipse Distribution License v. 1.0, which is available at @@ -59,7 +59,7 @@ * This member-value is not allowed on endpoint interfaces. * * @return the service name - * @specdefault The simple name of the Java class + Service". + * @specdefault The simple name of the Java class + Service. */ String serviceName() default ""; diff --git a/api/src/main/java/jakarta/jws/soap/SOAPMessageHandler.java b/api/src/main/java/jakarta/jws/soap/SOAPMessageHandler.java index 6e8aabf..c8955e2 100644 --- a/api/src/main/java/jakarta/jws/soap/SOAPMessageHandler.java +++ b/api/src/main/java/jakarta/jws/soap/SOAPMessageHandler.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2018, 2021 Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2018, 2024 Oracle and/or its affiliates. All rights reserved. * * This program and the accompanying materials are made available under the * terms of the Eclipse Distribution License v. 1.0, which is available at @@ -10,7 +10,8 @@ package jakarta.jws.soap; -@Deprecated public @interface SOAPMessageHandler { +@Deprecated +public @interface SOAPMessageHandler { /** * Name of the handler.Defaults to the name of the handler class. diff --git a/api/src/main/java/jakarta/xml/ws/Action.java b/api/src/main/java/jakarta/xml/ws/Action.java index 5f68db2..677098a 100644 --- a/api/src/main/java/jakarta/xml/ws/Action.java +++ b/api/src/main/java/jakarta/xml/ws/Action.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2005, 2020 Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2005, 2024 Oracle and/or its affiliates. All rights reserved. * * This program and the accompanying materials are made available under the * terms of the Eclipse Distribution License v. 1.0, which is available at @@ -33,65 +33,64 @@ * Example 1: Specify explicit values for {@code Action} message addressing property * for {@code input} and {@code output} messages. * - * 

- * {@literal @}WebService(targetNamespace="http://example.com/numbers")
+ * {@snippet :
+ *  @WebService(targetNamespace="http://example.com/numbers")
  *  public class AddNumbersImpl {
- *     {@literal @}Action(
- *          input="http://example.com/inputAction",
- *          output="http://example.com/outputAction")
+ *      @Action(  // @highlight type="bold"
+ *          input="http://example.com/inputAction",  // @highlight type="bold"
+ *          output="http://example.com/outputAction")  // @highlight type="bold"
  *      public int addNumbers(int number1, int number2) {
  *          return number1 + number2;
  *      }
  *  }
- *
+ * } * * The generated WSDL looks like: - * 
 {@code
- *   
- *     ...
- *     
- *       
- *         wsam:Action="http://example.com/inputAction"/>
- *         wsam:Action="http://example.com/outputAction"/>
- *       
- *     
+ * {@snippet lang="XML" :
+ *  
+ *    ...
+ *    
+ *      
+ *         // @highlight type="bold"
+ *         // @highlight type="bold"
+ *      
+ *    
  *     ...
- *   
+ *  
  * }
- *
* *

* Example 2: Specify explicit value for {@code Action} message addressing property * for only the {@code input} message. The {@code wsam:Action} values for the * WSDL {@code output} message are computed using the algorithm in the Jakarta XML Web Services specification. * - * 

- * {@literal @}WebService(targetNamespace="http://example.com/numbers")
+ * {@snippet :
+ *  @WebService(targetNamespace="http://example.com/numbers")
  *  public class AddNumbersImpl {
- *     {@literal @}Action(input="http://example.com/inputAction")
+ *      @Action(input="http://example.com/inputAction")  // @highlight type="bold"
  *      public int addNumbers(int number1, int number2) {
  *          return number1 + number2;
  *      }
  *  }
- *
+ * } * * The generated WSDL looks like: - * 
 {@code
- *   
- *     ...
- *     
- *       
- *         wsam:Action="http://example.com/inputAction"/>
- *         wsam:Action="http://example.com/numbers/AddNumbersPortType/AddNumbersResponse"/>
- *       
- *     
- *     ...
- *   
- * }
+ * {@snippet lang="XML" : + * + * ... + * + * + * // @highlight type="bold" + * // @highlight type="bold" + * + * + * ... + * + * } * * It is legitimate to specify an explicit value for {@code Action} message addressing property for * {@code output} message only. In this case, {@code wsam:Action} value for the @@ -106,7 +105,6 @@ * * @since 1.6, JAX-WS 2.1 */ - @Documented @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.METHOD) diff --git a/api/src/main/java/jakarta/xml/ws/BindingProvider.java b/api/src/main/java/jakarta/xml/ws/BindingProvider.java index 91668b1..2204f74 100644 --- a/api/src/main/java/jakarta/xml/ws/BindingProvider.java +++ b/api/src/main/java/jakarta/xml/ws/BindingProvider.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2005, 2022 Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2005, 2024 Oracle and/or its affiliates. All rights reserved. * * This program and the accompanying materials are made available under the * terms of the Eclipse Distribution License v. 1.0, which is available at @@ -49,7 +49,7 @@ public interface BindingProvider { /** * Standard property: This boolean property is used by a service - * client to indicate whether or not it wants to participate in + * client to indicate whether it wants to participate in * a session with a service endpoint. If this property is set to * {@code true}, the service client indicates that it wants the session * to be maintained. If set to {@code false}, the session is not maintained. @@ -61,7 +61,7 @@ public interface BindingProvider { /** * Standard property for SOAPAction. This boolean property - * indicates whether or not the value of the + * indicates whether the value of the * {@code jakarta.xml.ws.soap.http.soapaction.uri} property * is used for the value of the SOAPAction. The * default value of this property is {@code false} indicating @@ -92,7 +92,7 @@ public interface BindingProvider { /** * Get the context that is used to initialize the message context * for request messages. - * + *

* Modifications to the request context do not affect the message context of * either synchronous or asynchronous operations that have already been * started. @@ -103,7 +103,7 @@ public interface BindingProvider { /** * Get the context that resulted from processing a response message. - * + *

* The returned context is for the most recently completed synchronous * operation. Subsequent synchronous operation invocations overwrite the * response context. Asynchronous operations return their response context diff --git a/api/src/main/java/jakarta/xml/ws/Dispatch.java b/api/src/main/java/jakarta/xml/ws/Dispatch.java index 516576a..bf0c211 100644 --- a/api/src/main/java/jakarta/xml/ws/Dispatch.java +++ b/api/src/main/java/jakarta/xml/ws/Dispatch.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2005, 2022 Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2005, 2024 Oracle and/or its affiliates. All rights reserved. * * This program and the accompanying materials are made available under the * terms of the Eclipse Distribution License v. 1.0, which is available at @@ -25,7 +25,7 @@ public interface Dispatch extends BindingProvider { /** Invoke a service operation synchronously. - * + *

* The client is responsible for ensuring that the {@code msg} object * when marshalled is formed according to the requirements of the protocol * binding in use. diff --git a/api/src/main/java/jakarta/xml/ws/Endpoint.java b/api/src/main/java/jakarta/xml/ws/Endpoint.java index d80ebf7..887a45f 100644 --- a/api/src/main/java/jakarta/xml/ws/Endpoint.java +++ b/api/src/main/java/jakarta/xml/ws/Endpoint.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2005, 2020 Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2005, 2024 Oracle and/or its affiliates. All rights reserved. * * This program and the accompanying materials are made available under the * terms of the Eclipse Distribution License v. 1.0, which is available at @@ -186,7 +186,7 @@ public static Endpoint create(String bindingId, Object implementor, WebServiceFe * in conjunction with the endpoint's binding. * * @throws java.lang.IllegalStateException - * If the endpoint has been published already or it has been stopped. + * If the endpoint has been published already, or it has been stopped. * * @throws java.lang.SecurityException * If a {@code java.lang.SecurityManger} @@ -201,7 +201,7 @@ public static Endpoint create(String bindingId, Object implementor, WebServiceFe *

* The necessary server infrastructure will be created and * configured by the Jakarta XML Web Services implementation using some default configuration. - * + *

* In order to get more control over the server configuration, please * use the {@link jakarta.xml.ws.Endpoint#create(String,Object)} and * {@link jakarta.xml.ws.Endpoint#publish(Object)} methods instead. @@ -231,7 +231,7 @@ public static Endpoint publish(String address, Object implementor) { *

* The necessary server infrastructure will be created and * configured by the Jakarta XML Web Services implementation using some default configuration. - * + *

* In order to get more control over the server configuration, please * use the {@link jakarta.xml.ws.Endpoint#create(String,Object)} and * {@link jakarta.xml.ws.Endpoint#publish(Object)} methods instead. @@ -274,7 +274,7 @@ public static Endpoint publish(String address, Object implementor, WebServiceFea * endpoint's binding. * * @throws java.lang.IllegalStateException - * If the endpoint has been published already or it has been stopped. + * If the endpoint has been published already, or it has been stopped. * * @throws java.lang.SecurityException * If a {@code java.lang.SecurityManger} @@ -292,7 +292,7 @@ public static Endpoint publish(String address, Object implementor, WebServiceFea * endpoint's binding. * *

- * This is meant for container developers to publish the + * This is meant for container developers to publish * the endpoints portably and not intended for the end * developers. * @@ -307,7 +307,7 @@ public static Endpoint publish(String address, Object implementor, WebServiceFea * endpoint's binding. * * @throws java.lang.IllegalStateException - * If the endpoint has been published already or it has been stopped. + * If the endpoint has been published already, or it has been stopped. * * @throws java.lang.SecurityException * If a {@code java.lang.SecurityManger} @@ -321,7 +321,7 @@ public void publish(HttpContext serverContext) { /** * Stops publishing this endpoint. - * + *

* If the endpoint is not in a published state, this method * has no effect. * @@ -356,7 +356,7 @@ public void publish(HttpContext serverContext) { /** * Returns the executor for this {@code Endpoint}instance. - * + *

* The executor is used to dispatch an incoming request to * the implementor object. * @@ -369,10 +369,10 @@ public void publish(HttpContext serverContext) { /** * Sets the executor for this {@code Endpoint} instance. - * + *

* The executor is used to dispatch an incoming request to * the implementor object. - * + *

* If this {@code Endpoint} is published using the * {@code publish(Object)} method and the specified server * context defines its own threading behavior, the executor @@ -417,7 +417,7 @@ public void publish(HttpContext serverContext) { * returned {@code EndpointReference} instance. * @return EndpointReference of this {@code Endpoint} instance. * If the returned {@code EndpointReference} is of type - * {@code W3CEndpointReference} then it MUST contain the + * {@code W3CEndpointReference} then it MUST contain * the specified {@code referenceParameters}. * @throws WebServiceException If any error in the creation of @@ -443,7 +443,7 @@ public void publish(HttpContext serverContext) { * @return EndpointReference of type {@code clazz} of this * {@code Endpoint} instance. * If the returned {@code EndpointReference} is of type - * {@code W3CEndpointReference} then it MUST contain the + * {@code W3CEndpointReference} then it MUST contain * the specified {@code referenceParameters}. * @throws WebServiceException If any error in the creation of @@ -470,7 +470,7 @@ public abstract T getEndpointReference(Class cl * * @param ctxt that is shared for multiple endpoints * @throws java.lang.IllegalStateException - * If the endpoint has been published already or it has been stopped. + * If the endpoint has been published already, or it has been stopped. * * @since 1.7, JAX-WS 2.2 */ diff --git a/api/src/main/java/jakarta/xml/ws/EndpointContext.java b/api/src/main/java/jakarta/xml/ws/EndpointContext.java index a048a60..90fad69 100644 --- a/api/src/main/java/jakarta/xml/ws/EndpointContext.java +++ b/api/src/main/java/jakarta/xml/ws/EndpointContext.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2009, 2020 Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2009, 2024 Oracle and/or its affiliates. All rights reserved. * * This program and the accompanying materials are made available under the * terms of the Eclipse Distribution License v. 1.0, which is available at @@ -31,7 +31,7 @@ public abstract class EndpointContext { /** - * This gives list of endpoints in an application. For e.g in + * This gives list of endpoints in an application. For e.g. in * servlet container, a war file may contain multiple endpoints. * In case of http, these endpoints are hosted on the same http * server. diff --git a/api/src/main/java/jakarta/xml/ws/EndpointReference.java b/api/src/main/java/jakarta/xml/ws/EndpointReference.java index c2cfb22..b3fd7c9 100644 --- a/api/src/main/java/jakarta/xml/ws/EndpointReference.java +++ b/api/src/main/java/jakarta/xml/ws/EndpointReference.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2005, 2020 Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2005, 2024 Oracle and/or its affiliates. All rights reserved. * * This program and the accompanying materials are made available under the * terms of the Eclipse Distribution License v. 1.0, which is available at @@ -56,7 +56,7 @@ * type of endpoint reference being passed. *

* Jakarta XML Web Services implementors are expected to extract the XML infoset - * from an {@code EndpointReferece} using the + * from an {@code EndpointReference} using the * {@link EndpointReference#writeTo} * method. *

diff --git a/api/src/main/java/jakarta/xml/ws/FaultAction.java b/api/src/main/java/jakarta/xml/ws/FaultAction.java index d3c54c6..2f28d0b 100644 --- a/api/src/main/java/jakarta/xml/ws/FaultAction.java +++ b/api/src/main/java/jakarta/xml/ws/FaultAction.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2005, 2020 Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2005, 2024 Oracle and/or its affiliates. All rights reserved. * * This program and the accompanying materials are made available under the * terms of the Eclipse Distribution License v. 1.0, which is available at @@ -33,106 +33,102 @@ * property for the {@code input}, {@code output} and {@code fault} message * if the Java method throws only one service specific exception. * - * 

- * {@literal @}WebService(targetNamespace="http://example.com/numbers")
+ * {@snippet :
+ *  @WebService(targetNamespace="http://example.com/numbers")
  *  public class AddNumbersImpl {
- *    {@literal @}Action(
- *         fault = {
- *             {@literal @}FaultAction(className=AddNumbersException.class, value="http://example.com/faultAction")
- *         })
- *     public int addNumbers(int number1, int number2)
- *         throws AddNumbersException {
- *         return number1 + number2;
- *     }
+ *      @Action(
+ *          fault = {
+ *              @FaultAction(className=AddNumbersException.class, value="http://example.com/faultAction")   // @highlight type="bold"
+ *          })
+ *      public int addNumbers(int number1, int number2) throws AddNumbersException {
+ *          return number1 + number2;
+ *      }
+ *  }
  * }
- *
* * The generated WSDL looks like: * - * 
 {@code
- *   
- *     ...
- *     
- *       
- *         ...
- *         wsam:Action="http://example.com/faultAction"{@code />
- *       
- *     
- *     ...
- *    }
- *
+ * {@snippet lang="XML" : + * + * ... + * + * + * ... + * // @highlight type="bold" + * + * + * ... + * + * } * *

* Example 2: Here is an example that shows if the explicit value for {@code Action} * message addressing property for the service specific exception is not present. * - * 

- * {@literal @}WebService(targetNamespace="http://example.com/numbers")
+ * {@snippet :
+ *  @WebService(targetNamespace="http://example.com/numbers")
  *  public class AddNumbersImpl {
- *     public int addNumbers(int number1, int number2)
- *         throws AddNumbersException {
- *         return number1 + number2;
- *     }
+ *      public int addNumbers(int number1, int number2) throws AddNumbersException {
+ *          return number1 + number2;
+ *      }
  *  }
- *
+ * } * * The generated WSDL looks like: * - * 
{@code
- *   
- *     ...
- *     
- *       
- *         ...
- *         wsam:Action="http://example.com/numbers/AddNumbersPortType/AddNumbers/Fault/AddNumbersException"{@code />
- *       
- *     
- *     ...
- *   
- * }
+ * {@snippet lang="XML" : + * + * ... + * + * + * ... + * // @highlight type="bold" + * + * + * ... + * + * } * *

* Example 3: Here is an example that shows how to specify explicit values for {@code Action} * message addressing property if the Java method throws more than one service specific exception. * - * 

- * {@literal @}WebService(targetNamespace="http://example.com/numbers")
+ * {@snippet :
+ *  @WebService(targetNamespace="http://example.com/numbers")
  *  public class AddNumbersImpl {
- *    {@literal @}Action(
- *         fault = {
- *             {@literal @}FaultAction(className=AddNumbersException.class, value="http://example.com/addFaultAction"),
- *             {@literal @}FaultAction(className=TooBigNumbersException.class, value="http://example.com/toobigFaultAction")
- *         })
- *     public int addNumbers(int number1, int number2)
- *         throws AddNumbersException, TooBigNumbersException {
+ *      @Action(
+ *          fault = {
+ *              @FaultAction(className=AddNumbersException.class, value="http://example.com/addFaultAction"),   // @highlight type="bold"
+ *              @FaultAction(className=TooBigNumbersException.class, value="http://example.com/toobigFaultAction")   // @highlight type="bold"
+ *          })
+ *      public int addNumbers(int number1, int number2) throws AddNumbersException, TooBigNumbersException {
  *         return number1 + number2;
- *     }
+ *      }
  *  }
- *
+ * } * * The generated WSDL looks like: * - * 
 {@code
- *   
- *     ...
- *     
- *       
- *         ...
- *         wsam:Action="http://example.com/addFaultAction"{@code />
- *         wsam:Action="http://example.com/toobigFaultAction"{@code />
- *       
- *     
- *     ...
- *   
- * }
+ * {@snippet lang="XML" : + * + * ... + * + * + * ... + * // @highlight type="bold" + * // @highlight type="bold" + * + * + * ... + * + * } * * @since 1.6, JAX-WS 2.1 */ - @Documented @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.METHOD) diff --git a/api/src/main/java/jakarta/xml/ws/LogicalMessage.java b/api/src/main/java/jakarta/xml/ws/LogicalMessage.java index 7f5d856..2b48ed9 100644 --- a/api/src/main/java/jakarta/xml/ws/LogicalMessage.java +++ b/api/src/main/java/jakarta/xml/ws/LogicalMessage.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2005, 2022 Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2005, 2024 Oracle and/or its affiliates. All rights reserved. * * This program and the accompanying materials are made available under the * terms of the Eclipse Distribution License v. 1.0, which is available at @@ -29,7 +29,7 @@ public interface LogicalMessage { *

If the returned {@code Source} is an instance of * {@code DOMSource}, then * modifications to the encapsulated DOM tree change the message - * payload in-place, there is no need to susequently call + * payload in-place, there is no need to subsequently call * {@code setPayload}. Other types of {@code Source} provide only * read access to the message payload. * diff --git a/api/src/main/java/jakarta/xml/ws/ProtocolException.java b/api/src/main/java/jakarta/xml/ws/ProtocolException.java index 05b166d..f4444f5 100644 --- a/api/src/main/java/jakarta/xml/ws/ProtocolException.java +++ b/api/src/main/java/jakarta/xml/ws/ProtocolException.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2005, 2021 Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2005, 2024 Oracle and/or its affiliates. All rights reserved. * * This program and the accompanying materials are made available under the * terms of the Eclipse Distribution License v. 1.0, which is available at @@ -45,7 +45,7 @@ public ProtocolException(String message) { /** * Constructs a new runtime exception with the specified detail message and * cause. - * + *

* Note that the detail message associated with cause is not automatically * incorporated in this runtime exception's detail message. * diff --git a/api/src/main/java/jakarta/xml/ws/RespectBindingFeature.java b/api/src/main/java/jakarta/xml/ws/RespectBindingFeature.java index 8334123..6fbc57f 100644 --- a/api/src/main/java/jakarta/xml/ws/RespectBindingFeature.java +++ b/api/src/main/java/jakarta/xml/ws/RespectBindingFeature.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2005, 2022 Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2005, 2024 Oracle and/or its affiliates. All rights reserved. * * This program and the accompanying materials are made available under the * terms of the Eclipse Distribution License v. 1.0, which is available at @@ -15,7 +15,7 @@ /** * This feature clarifies the use of the {@code wsdl:binding} * in a Jakarta XML Web Services runtime. - * + *

* This feature can be used during the creation of SEI proxy, and * {@link Dispatch} instances on the client side and {@link Endpoint} * instances on the server side. This feature cannot be used for {@link Service} diff --git a/api/src/main/java/jakarta/xml/ws/Service.java b/api/src/main/java/jakarta/xml/ws/Service.java index 17b95da..6114d4f 100644 --- a/api/src/main/java/jakarta/xml/ws/Service.java +++ b/api/src/main/java/jakarta/xml/ws/Service.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2005, 2020 Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2005, 2024 Oracle and/or its affiliates. All rights reserved. * * This program and the accompanying materials are made available under the * terms of the Eclipse Distribution License v. 1.0, which is available at @@ -70,7 +70,7 @@ public enum Mode { /** * Creates a {@code Service}. - * + *

* The specified WSDL document location and service qualified name MUST * uniquely identify a {@code wsdl:service} element. * @@ -87,7 +87,7 @@ protected Service(java.net.URL wsdlDocumentLocation, QName serviceName) { /** * Creates a {@code Service}. The created instance is * configured with the web service features. - * + *

* The specified WSDL document location and service qualified name MUST * uniquely identify a {@code wsdl:service} element. * @@ -282,9 +282,9 @@ public T getPort(Class serviceEndpointInterface, * is thrown. *

* Calling this method has the same behavior as the following - * 

-     * {@code port = service.getPort(portName, serviceEndpointInterface);}
-     *
+ * {@snippet : + * port = service.getPort(portName, serviceEndpointInterface); + * } * where the {@code portName} is retrieved from the * metadata of the {@code endpointReference} or from the * {@code serviceEndpointInterface} and the WSDL @@ -439,9 +439,9 @@ public Dispatch createDispatch(QName portName, Class type, * {@code endpointReference} metadata. *

* This method behaves the same as calling - * 

-     * {@code dispatch = service.createDispatch(portName, type, mode, features);}
-     *
+ * {@snippet : + * dispatch = service.createDispatch(portName, type, mode, features); + * } * where the {@code portName} is retrieved from the * WSDL or {@code EndpointReference} metadata. * @@ -573,10 +573,10 @@ public Dispatch createDispatch(QName portName, * An implementation MUST be able to retrieve the {@code portName} from the * {@code endpointReference} metadata. *

- * This method behavies the same as calling - * 

-     * {@code dispatch = service.createDispatch(portName, context, mode, features);}
-     *
+ * This method behaves the same as calling + * {@snippet : + * dispatch = service.createDispatch(portName, context, mode, features); + * } * where the {@code portName} is retrieved from the * WSDL or {@code endpointReference} metadata. * @@ -684,7 +684,7 @@ public void setHandlerResolver(HandlerResolver handlerResolver) { /** * Returns the executor for this {@code Service}instance. - * + *

* The executor is used for all asynchronous invocations that * require callbacks. * @@ -699,7 +699,7 @@ public java.util.concurrent.Executor getExecutor() { /** * Sets the executor for this {@code Service} instance. - * + *

* The executor is used for all asynchronous invocations that * require callbacks. * @@ -718,7 +718,7 @@ public void setExecutor(java.util.concurrent.Executor executor) { /** * Creates a {@code Service} instance. - * + *

* The specified WSDL document location and service qualified name MUST * uniquely identify a {@code wsdl:service} element. * @@ -738,7 +738,7 @@ public static Service create( /** * Creates a {@code Service} instance. The created instance is * configured with the web service features. - * + *

* The specified WSDL document location and service qualified name MUST * uniquely identify a {@code wsdl:service} element. * diff --git a/api/src/main/java/jakarta/xml/ws/WebEndpoint.java b/api/src/main/java/jakarta/xml/ws/WebEndpoint.java index 1b3b2b2..6c35e35 100644 --- a/api/src/main/java/jakarta/xml/ws/WebEndpoint.java +++ b/api/src/main/java/jakarta/xml/ws/WebEndpoint.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2005, 2020 Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2005, 2024 Oracle and/or its affiliates. All rights reserved. * * This program and the accompanying materials are made available under the * terms of the Eclipse Distribution License v. 1.0, which is available at @@ -37,7 +37,7 @@ /** * The local name of the endpoint. * - * @return ocal name of the endpoint + * @return local name of the endpoint **/ String name() default ""; } diff --git a/api/src/main/java/jakarta/xml/ws/WebServiceContext.java b/api/src/main/java/jakarta/xml/ws/WebServiceContext.java index a5ea0be..369b2f6 100644 --- a/api/src/main/java/jakarta/xml/ws/WebServiceContext.java +++ b/api/src/main/java/jakarta/xml/ws/WebServiceContext.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2005, 2022 Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2005, 2024 Oracle and/or its affiliates. All rights reserved. * * This program and the accompanying materials are made available under the * terms of the Eclipse Distribution License v. 1.0, which is available at @@ -21,8 +21,8 @@ * a web service endpoint implementation class to access * message context and security information relative to * a request being served. - * - * Typically a {@code WebServiceContext} is injected + *

+ * Typically, a {@code WebServiceContext} is injected * into an endpoint implementation class using the * {@code Resource} annotation. * @@ -96,7 +96,7 @@ public interface WebServiceContext { * @return EndpointReference of the endpoint associated with this * {@code WebServiceContext}. * If the returned {@code EndpointReference} is of type - * {@code W3CEndpointReference} then it MUST contain the + * {@code W3CEndpointReference} then it MUST contain * the specified {@code referenceParameters}. * * @throws IllegalStateException This exception is thrown @@ -121,7 +121,7 @@ public interface WebServiceContext { * @return EndpointReference of type {@code clazz} of the endpoint * associated with this {@code WebServiceContext} instance. * If the returned {@code EndpointReference} is of type - * {@code W3CEndpointReference} then it MUST contain the + * {@code W3CEndpointReference} then it MUST contain * the specified {@code referenceParameters}. * * @throws IllegalStateException This exception is thrown diff --git a/api/src/main/java/jakarta/xml/ws/WebServiceFeature.java b/api/src/main/java/jakarta/xml/ws/WebServiceFeature.java index aa1c735..20af58d 100644 --- a/api/src/main/java/jakarta/xml/ws/WebServiceFeature.java +++ b/api/src/main/java/jakarta/xml/ws/WebServiceFeature.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2005, 2020 Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2005, 2024 Oracle and/or its affiliates. All rights reserved. * * This program and the accompanying materials are made available under the * terms of the Eclipse Distribution License v. 1.0, which is available at @@ -32,7 +32,7 @@ * @since 1.6, JAX-WS 2.1 */ public abstract class WebServiceFeature { - /** + /* * Each Feature definition MUST define a public static final * String ID that can be used in the Feature annotation to refer * to the feature. diff --git a/api/src/main/java/jakarta/xml/ws/WebServicePermission.java b/api/src/main/java/jakarta/xml/ws/WebServicePermission.java index 1849397..362d25d 100644 --- a/api/src/main/java/jakarta/xml/ws/WebServicePermission.java +++ b/api/src/main/java/jakarta/xml/ws/WebServicePermission.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2005, 2020 Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2005, 2024 Oracle and/or its affiliates. All rights reserved. * * This program and the accompanying materials are made available under the * terms of the Eclipse Distribution License v. 1.0, which is available at @@ -55,7 +55,7 @@ public WebServicePermission(String name) { /** * Creates a new permission with the specified name and actions. - * + *

* The {@code actions} parameter is currently unused and * it should be {@code null}. * diff --git a/api/src/main/java/jakarta/xml/ws/WebServiceRef.java b/api/src/main/java/jakarta/xml/ws/WebServiceRef.java index 762ee91..a3ba19f 100644 --- a/api/src/main/java/jakarta/xml/ws/WebServiceRef.java +++ b/api/src/main/java/jakarta/xml/ws/WebServiceRef.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2005, 2020 Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2005, 2024 Oracle and/or its affiliates. All rights reserved. * * This program and the accompanying materials are made available under the * terms of the Eclipse Distribution License v. 1.0, which is available at @@ -26,7 +26,7 @@ * It can be used to inject both service and proxy * instances. These injected references are not thread safe. * If the references are accessed by multiple threads, - * usual synchronization techinques can be used to + * usual synchronization techniques can be used to * support multiple threads. * *

@@ -40,18 +40,18 @@ *

* For example, in the code below, the injected * {@code StockQuoteProvider} proxy MUST - * have WS-Addressing enabled as specifed by the + * have WS-Addressing enabled as specified by the * {@link Addressing} * annotation. * - * 


- *    public class MyClient {
- *       {@literal @}Addressing
- *       {@literal @}WebServiceRef(StockQuoteService.class)
- *       private StockQuoteProvider stockQuoteProvider;
- *       ...
- *    }
- *
+ * {@snippet : + * public class MyClient { + * @Addressing + * @WebServiceRef(StockQuoteService.class) + * private StockQuoteProvider stockQuoteProvider; + * ... + * } + * } * *

* If a Jakarta XML Web Services implementation encounters an unsupported or unrecognized @@ -76,7 +76,7 @@ * the default is the JavaBeans property name corresponding * to the method. For class annotations, there is no default * and this MUST be specified. - * + *

* The JNDI name can be absolute(with any logical namespace) or relative * to JNDI {@code java:comp/env} namespace. * diff --git a/api/src/main/java/jakarta/xml/ws/WebServiceRefs.java b/api/src/main/java/jakarta/xml/ws/WebServiceRefs.java index 5dcd16f..c9e44f3 100755 --- a/api/src/main/java/jakarta/xml/ws/WebServiceRefs.java +++ b/api/src/main/java/jakarta/xml/ws/WebServiceRefs.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2005, 2020 Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2005, 2024 Oracle and/or its affiliates. All rights reserved. * * This program and the accompanying materials are made available under the * terms of the Eclipse Distribution License v. 1.0, which is available at @@ -39,24 +39,25 @@ * proxy instance, and the {@code StockQuoteService} service * instance are injected using @WebServiceRefs. * - * 


- *    {@literal @}WebServiceRefs({{@literal @}WebServiceRef(name="service/stockquoteservice", value=StockQuoteService.class),
- *                     {@literal @}WebServiceRef(name="service/stockquoteprovider", type=StockQuoteProvider.class, value=StockQuoteService.class})
- *    public class MyClient {
- *        void init() {
- *            Context ic = new InitialContext();
- *            StockQuoteService service = (StockQuoteService) ic.lookup("java:comp/env/service/stockquoteservice");
- *            StockQuoteProvider port = (StockQuoteProvider) ic.lookup("java:comp/env/service/stockquoteprovider");
- *            ...
- *       }
- *       ...
- *    }
- *
+ * {@snippet : + * @WebServiceRefs({ + * @WebServiceRef(name="service/stockquoteservice", value=StockQuoteService.class), + * @WebServiceRef(name="service/stockquoteprovider", type=StockQuoteProvider.class, value=StockQuoteService.class + * }) + * public class MyClient { + * void init() { + * Context ic = new InitialContext(); + * StockQuoteService service = (StockQuoteService) ic.lookup("java:comp/env/service/stockquoteservice"); + * StockQuoteProvider port = (StockQuoteProvider) ic.lookup("java:comp/env/service/stockquoteprovider"); + * ... + * } + * ... + * } + * } * * @see WebServiceRef * @since 1.6, JAX-WS 2.0 */ - @Documented @Retention(RUNTIME) @Target(TYPE) diff --git a/api/src/main/java/jakarta/xml/ws/handler/LogicalHandler.java b/api/src/main/java/jakarta/xml/ws/handler/LogicalHandler.java index 40cc311..3819dc4 100644 --- a/api/src/main/java/jakarta/xml/ws/handler/LogicalHandler.java +++ b/api/src/main/java/jakarta/xml/ws/handler/LogicalHandler.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2005, 2020 Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2005, 2024 Oracle and/or its affiliates. All rights reserved. * * This program and the accompanying materials are made available under the * terms of the Eclipse Distribution License v. 1.0, which is available at @@ -11,7 +11,7 @@ package jakarta.xml.ws.handler; /** The {@code LogicalHandler} extends - * Handler to provide typesafety for the message context parameter. + * Handler to provide type safety for the message context parameter. * * @param message context * @since 1.6, JAX-WS 2.0 diff --git a/api/src/main/java/jakarta/xml/ws/handler/MessageContext.java b/api/src/main/java/jakarta/xml/ws/handler/MessageContext.java index 47d4b92..ce821fa 100644 --- a/api/src/main/java/jakarta/xml/ws/handler/MessageContext.java +++ b/api/src/main/java/jakarta/xml/ws/handler/MessageContext.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2005, 2022 Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2005, 2024 Oracle and/or its affiliates. All rights reserved. * * This program and the accompanying materials are made available under the * terms of the Eclipse Distribution License v. 1.0, which is available at @@ -193,7 +193,7 @@ enum Scope { * * @param name Name of the property * @return Scope of the property - * @throws java.lang.IllegalArgumentException if a non-existant + * @throws java.lang.IllegalArgumentException if a non-existing * property name is specified */ Scope getScope(String name); diff --git a/api/src/main/java/jakarta/xml/ws/handler/soap/SOAPHandler.java b/api/src/main/java/jakarta/xml/ws/handler/soap/SOAPHandler.java index 25857c6..9ac4220 100644 --- a/api/src/main/java/jakarta/xml/ws/handler/soap/SOAPHandler.java +++ b/api/src/main/java/jakarta/xml/ws/handler/soap/SOAPHandler.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2005, 2020 Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2005, 2024 Oracle and/or its affiliates. All rights reserved. * * This program and the accompanying materials are made available under the * terms of the Eclipse Distribution License v. 1.0, which is available at @@ -15,7 +15,7 @@ import java.util.Set; /** The {@code SOAPHandler} class extends {@code Handler} - * to provide typesafety for the message context parameter and add a method + * to provide type safety for the message context parameter and add a method * to obtain access to the headers that may be processed by the handler. * * @param message context diff --git a/api/src/main/java/jakarta/xml/ws/handler/soap/SOAPMessageContext.java b/api/src/main/java/jakarta/xml/ws/handler/soap/SOAPMessageContext.java index 18df600..a2b02e2 100644 --- a/api/src/main/java/jakarta/xml/ws/handler/soap/SOAPMessageContext.java +++ b/api/src/main/java/jakarta/xml/ws/handler/soap/SOAPMessageContext.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2005, 2022 Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2005, 2024 Oracle and/or its affiliates. All rights reserved. * * This program and the accompanying materials are made available under the * terms of the Eclipse Distribution License v. 1.0, which is available at @@ -55,7 +55,7 @@ public interface SOAPMessageContext * @param context The JAXBContext that should be used to unmarshall the * header * @param allRoles If {@code true} then returns headers for all SOAP - * roles, if {@code false} then only returns headers targetted + * roles, if {@code false} then only returns headers targeted * at the roles currently being played by this SOAP node, see * {@code getRoles}. * @return An array of unmarshalled headers; returns an empty array if no @@ -78,7 +78,7 @@ Object[] getHeaders(QName header, JAXBContext context, * SOAP actor roles are invariant during the processing of * SOAP message through the handler chain. * - * @return Array of {@code String} for SOAP actor roles + * @return A Set of {@code String} for SOAP actor roles **/ Set getRoles(); } diff --git a/api/src/main/java/jakarta/xml/ws/http/HTTPException.java b/api/src/main/java/jakarta/xml/ws/http/HTTPException.java index 2d63e23..22e414b 100644 --- a/api/src/main/java/jakarta/xml/ws/http/HTTPException.java +++ b/api/src/main/java/jakarta/xml/ws/http/HTTPException.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2005, 2021 Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2005, 2024 Oracle and/or its affiliates. All rights reserved. * * This program and the accompanying materials are made available under the * terms of the Eclipse Distribution License v. 1.0, which is available at @@ -11,8 +11,7 @@ package jakarta.xml.ws.http; -/** The {@code HTTPException} exception represents a - * XML/HTTP fault. +/** The {@code HTTPException} exception represents an XML/HTTP fault. * *

Since there is no standard format for faults or exceptions * in XML/HTTP messaging, only the HTTP status code is captured. diff --git a/api/src/main/java/jakarta/xml/ws/soap/AddressingFeature.java b/api/src/main/java/jakarta/xml/ws/soap/AddressingFeature.java index 09d54b0..a308a48 100644 --- a/api/src/main/java/jakarta/xml/ws/soap/AddressingFeature.java +++ b/api/src/main/java/jakarta/xml/ws/soap/AddressingFeature.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2005, 2022 Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2005, 2024 Oracle and/or its affiliates. All rights reserved. * * This program and the accompanying materials are made available under the * terms of the Eclipse Distribution License v. 1.0, which is available at @@ -40,7 +40,7 @@ * If the feature is enabled, the {@code required} property determines * whether the endpoint requires WS-Addressing. If it is set true, * WS-Addressing headers MUST be present on incoming and outgoing messages. - * By default the {@code required} property is {@code false}. + * By default, the {@code required} property is {@code false}. * *

* If the web service developer has not explicitly enabled this feature, @@ -59,33 +59,30 @@ * 3.1 WS-Policy Assertions * *

- * Example 1: Possible Policy Assertion in the generated WSDL for - * {@code @Addressing} - * 

 {@code
- *   
- *     
- *    }
- *
+ * Example 1: Possible Policy Assertion in the generated WSDL for {@code @Addressing} + * {@snippet lang="XML" : + * + * + * } + * } * *

- * Example 2: Possible Policy Assertion in the generated WSDL for - * {@code @Addressing(required=true)} - * 

 {@code
- *   
- *     
- *    }
- *
+ * Example 2: Possible Policy Assertion in the generated WSDL for {@code @Addressing(required=true)} + * {@snippet lang="XML" : + * + * + * } + * } * *

- * Example 3: Possible Policy Assertion in the generated WSDL for - * {@code @Addressing(required=true, responses=Responses.ANONYMOUS)} - * 

 {@code
- *   
- *      
- *        
- *      
- *    }
- *
+ * Example 3: Possible Policy Assertion in the generated WSDL for {@code @Addressing(required=true, responses=Responses.ANONYMOUS)} + * {@snippet lang="XML" : + * + * + * + * + * } + * } * *

* See @@ -99,7 +96,6 @@ * @see Addressing * @since 1.6, JAX-WS 2.1 */ - public final class AddressingFeature extends WebServiceFeature { /** * Constant value identifying the AddressingFeature diff --git a/api/src/main/java/jakarta/xml/ws/soap/MTOMFeature.java b/api/src/main/java/jakarta/xml/ws/soap/MTOMFeature.java index 3fc4778..1c16ae6 100644 --- a/api/src/main/java/jakarta/xml/ws/soap/MTOMFeature.java +++ b/api/src/main/java/jakarta/xml/ws/soap/MTOMFeature.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2005, 2022 Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2005, 2024 Oracle and/or its affiliates. All rights reserved. * * This program and the accompanying materials are made available under the * terms of the Eclipse Distribution License v. 1.0, which is available at @@ -18,7 +18,7 @@ /** * This feature represents the use of MTOM with a * web service. - * + *

* This feature can be used during the creation of SEI proxy, and * {@link jakarta.xml.ws.Dispatch} instances on the client side and {@link Endpoint} * instances on the server side. This feature cannot be used for {@link Service} diff --git a/api/src/main/java/jakarta/xml/ws/soap/SOAPFaultException.java b/api/src/main/java/jakarta/xml/ws/soap/SOAPFaultException.java index 64801bb..a6ffa37 100644 --- a/api/src/main/java/jakarta/xml/ws/soap/SOAPFaultException.java +++ b/api/src/main/java/jakarta/xml/ws/soap/SOAPFaultException.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2005, 2021 Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2005, 2024 Oracle and/or its affiliates. All rights reserved. * * This program and the accompanying materials are made available under the * terms of the Eclipse Distribution License v. 1.0, which is available at @@ -24,7 +24,7 @@ * {@code SOAPFactory} used by the binding instance. * *

Note that the value of {@code getFault} is the only part of the - * exception used when searializing a SOAP fault. + * exception used when serializing a SOAP fault. * *

Refer to the SOAP specification for a complete * description of SOAP faults. diff --git a/api/src/main/java/jakarta/xml/ws/spi/FactoryFinder.java b/api/src/main/java/jakarta/xml/ws/spi/FactoryFinder.java index 172879f..df4eab8 100644 --- a/api/src/main/java/jakarta/xml/ws/spi/FactoryFinder.java +++ b/api/src/main/java/jakarta/xml/ws/spi/FactoryFinder.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2005, 2022 Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2005, 2024 Oracle and/or its affiliates. All rights reserved. * * This program and the accompanying materials are made available under the * terms of the Eclipse Distribution License v. 1.0, which is available at @@ -145,7 +145,7 @@ private static boolean isOsgi() { private static T lookupUsingOSGiServiceLoader(String factoryId) { try { LOGGER.fine("Trying to create the provider from the OSGi ServiceLoader"); - // Use reflection to avoid having any dependendcy on ServiceLoader class + // Use reflection to avoid having any dependency on ServiceLoader class Class serviceClass = Class.forName(factoryId); Class[] args = new Class[]{serviceClass}; Class target = Class.forName(OSGI_SERVICE_LOADER_CLASS_NAME); @@ -181,9 +181,9 @@ private static T newInstance(String className, String defaultImplClassName, /** * Get the URL for the Class from it's ClassLoader. - * + *

* Convenience method for {@link #which(Class, ClassLoader)}. - * + *

* Equivalent to calling: which(clazz, clazz.getClassLoader()) * * @param clazz diff --git a/api/src/main/java/jakarta/xml/ws/spi/Invoker.java b/api/src/main/java/jakarta/xml/ws/spi/Invoker.java index 92cc61c..648254f 100644 --- a/api/src/main/java/jakarta/xml/ws/spi/Invoker.java +++ b/api/src/main/java/jakarta/xml/ws/spi/Invoker.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2009, 2020 Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2009, 2024 Oracle and/or its affiliates. All rights reserved. * * This program and the accompanying materials are made available under the * terms of the Eclipse Distribution License v. 1.0, which is available at @@ -21,7 +21,7 @@ * to Jakarta XML Web Services runtime, and Jakarta XML Web Services runtime calls {@link #invoke} * for a web service invocation. Finally, Invoker does the actual * invocation of web service on endpoint instance. - * + *

* Container also injects the provided {@code WebServiceContext} and takes * care of invoking {@code jakarta.annotation.PostConstruct} methods, * if present, on the endpoint implementation. @@ -30,7 +30,6 @@ * @author Jitendra Kotamraju * @since 1.7, JAX-WS 2.2 */ - public abstract class Invoker { /** @@ -68,7 +67,7 @@ public abstract void inject(WebServiceContext webServiceContext) * @throws InvocationTargetException if the invocation done * by reflection API throws this exception - * @see Method#invoke + * @see Method#invoke(Object, Object...) */ public abstract Object invoke(Method m, Object... args) throws IllegalAccessException, IllegalArgumentException, InvocationTargetException; diff --git a/api/src/main/java/jakarta/xml/ws/spi/Provider.java b/api/src/main/java/jakarta/xml/ws/spi/Provider.java index cafb987..70990bf 100644 --- a/api/src/main/java/jakarta/xml/ws/spi/Provider.java +++ b/api/src/main/java/jakarta/xml/ws/spi/Provider.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2005, 2022 Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2005, 2024 Oracle and/or its affiliates. All rights reserved. * * This program and the accompanying materials are made available under the * terms of the Eclipse Distribution License v. 1.0, which is available at @@ -290,7 +290,7 @@ public abstract W3CEndpointReference createW3CEndpointReference(String address, * method can automatically determine the {@code address} of * an endpoint that is published by the same Jakarta EE application and is * identified by the {@code serviceName} and - * {@code portName} propeties. If the {@code address} is + * {@code portName} properties. If the {@code address} is * {@code null} and the {@code serviceName} and * {@code portName} do not identify an endpoint published by the * same Jakarta EE application, a @@ -336,7 +336,7 @@ public abstract W3CEndpointReference createW3CEndpointReference(String address, *

  • If the {@code wsdlDocumentLocation} is NOT {@code null} * and does not represent a valid WSDL. *
  • If the {@code wsdlDocumentLocation} is NOT {@code null} but - * wsdli:wsdlLocation's namespace name cannot be got from the available + * wsdl:wsdlLocation's namespace name cannot be got from the available * metadata. * * @throws WebServiceException If an error occurs while creating the diff --git a/api/src/main/java/jakarta/xml/ws/spi/ServiceDelegate.java b/api/src/main/java/jakarta/xml/ws/spi/ServiceDelegate.java index cb2062f..609104a 100644 --- a/api/src/main/java/jakarta/xml/ws/spi/ServiceDelegate.java +++ b/api/src/main/java/jakarta/xml/ws/spi/ServiceDelegate.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2005, 2020 Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2005, 2024 Oracle and/or its affiliates. All rights reserved. * * This program and the accompanying materials are made available under the * terms of the Eclipse Distribution License v. 1.0, which is available at @@ -146,9 +146,9 @@ public abstract T getPort(QName portName, * is thrown. *

    * Calling this method has the same behavior as the following - * 

    -     * {@code port = service.getPort(portName, serviceEndpointInterface);}
-     *
    + * {@snippet : + * port = service.getPort(portName, serviceEndpointInterface); + * } * where the {@code portName} is retrieved from the * metadata of the {@code endpointReference} or from the * {@code serviceEndpointInterface} and the WSDL @@ -360,9 +360,9 @@ public abstract Dispatch createDispatch(QName portName, Class type, * {@code endpointReference} metadata. *

    * This method behaves the same as calling - * 

    -     * {@code dispatch = service.createDispatch(portName, type, mode, features);}
-     *
    + * {@snippet : + * dispatch = service.createDispatch(portName, type, mode, features); + * } * where the {@code portName} is retrieved from the * WSDL or {@code EndpointReference} metadata. * @@ -491,10 +491,10 @@ public abstract Dispatch createDispatch(QName portName, * An implementation MUST be able to retrieve the {@code portName} from the * {@code endpointReference} metadata. *

    - * This method behavies the same as calling - * 

    -     * {@code dispatch = service.createDispatch(portName, context, mode, features);}
-     *
    + * This method behaves the same as calling + * {@snippet : + * dispatch = service.createDispatch(portName, context, mode, features); + * } * where the {@code portName} is retrieved from the * WSDL or {@code endpointReference} metadata. * @@ -591,7 +591,7 @@ public abstract Dispatch createDispatch(EndpointReference endpointRefere /** * Returns the executor for this {@code Service}instance. - * + *

    * The executor is used for all asynchronous invocations that * require callbacks. * @@ -604,7 +604,7 @@ public abstract Dispatch createDispatch(EndpointReference endpointRefere /** * Sets the executor for this {@code Service} instance. - * + *

    * The executor is used for all asynchronous invocations that * require callbacks. * diff --git a/api/src/main/java/jakarta/xml/ws/spi/ServiceLoaderUtil.java b/api/src/main/java/jakarta/xml/ws/spi/ServiceLoaderUtil.java index 983bad5..acb3430 100644 --- a/api/src/main/java/jakarta/xml/ws/spi/ServiceLoaderUtil.java +++ b/api/src/main/java/jakarta/xml/ws/spi/ServiceLoaderUtil.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2015, 2021 Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2015, 2024 Oracle and/or its affiliates. All rights reserved. * * This program and the accompanying materials are made available under the * terms of the Eclipse Distribution License v. 1.0, which is available at @@ -44,7 +44,7 @@ static P firstByServiceLoader(Class

    spiClass, } static void checkPackageAccess(String className) { - // make sure that the current thread has an access to the package of the given name. + // make sure that the current thread has the access to the package of the given name. SecurityManager s = System.getSecurityManager(); if (s != null) { int i = className.lastIndexOf('.'); diff --git a/api/src/main/java/jakarta/xml/ws/spi/http/HttpContext.java b/api/src/main/java/jakarta/xml/ws/spi/http/HttpContext.java index 4dc66c4..3877558 100644 --- a/api/src/main/java/jakarta/xml/ws/spi/http/HttpContext.java +++ b/api/src/main/java/jakarta/xml/ws/spi/http/HttpContext.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2009, 2020 Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2009, 2024 Oracle and/or its affiliates. All rights reserved. * * This program and the accompanying materials are made available under the * terms of the Eclipse Distribution License v. 1.0, which is available at @@ -18,7 +18,7 @@ * service to a {@link HttpHandler} which is invoked to handle requests * destined for that path on the associated container. *

    - * Container provides the implementation for this and it matches + * Container provides the implementation for this, and it matches * web service requests to corresponding HttpContext objects. * * @author Jitendra Kotamraju @@ -54,14 +54,14 @@ public void setHandler(HttpHandler handler) { * *

    * Endpoint's address for this context can be computed as follows: - * 

    +     * {@snippet :
      *  HttpExchange exch = ...;
      *  String endpointAddress =
      *      exch.getScheme() + "://"
      *      + exch.getLocalAddress().getHostName()
      *      + ":" + exch.getLocalAddress().getPort()
      *      + exch.getContextPath() + getPath();
-     *
    + * } * * @return this context's path */ diff --git a/api/src/main/java/jakarta/xml/ws/spi/http/HttpExchange.java b/api/src/main/java/jakarta/xml/ws/spi/http/HttpExchange.java index 46cc419..2d3164a 100644 --- a/api/src/main/java/jakarta/xml/ws/spi/http/HttpExchange.java +++ b/api/src/main/java/jakarta/xml/ws/spi/http/HttpExchange.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2005, 2020 Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2005, 2024 Oracle and/or its affiliates. All rights reserved. * * This program and the accompanying materials are made available under the * terms of the Eclipse Distribution License v. 1.0, which is available at @@ -21,7 +21,7 @@ import java.security.Principal; /** - * This class encapsulates a HTTP request received and a + * This class encapsulates an HTTP request received and a * response to be generated in one exchange. It provides methods * for examining the request from the client, and for building and * sending the response. @@ -82,7 +82,7 @@ public abstract class HttpExchange { * did not include a header of the specified name, this method returns * null. If there are multiple headers with the same name, this method * returns the first header in the request. The header name is - * case-insensitive. This is a convienence method to get a header + * case-insensitive. This is a convenience method to get a header * (instead of using the {@link #getRequestHeaders}). * * @param name the name of the request header @@ -113,7 +113,7 @@ public abstract class HttpExchange { * @param name the name of the header * @param value the additional header value. If it contains octet string, * it should be encoded according to - * RFC 2047 (http://www.ietf.org/rfc/rfc2047.txt) + * RFC 2047 (https://www.ietf.org/rfc/rfc2047.txt) * * @see #getResponseHeaders */ @@ -273,7 +273,7 @@ public abstract class HttpExchange { *

    If the request has been received by the container using HTTPS, the * following information must be exposed as attributes. These attributes * are {@link #REQUEST_CIPHER_SUITE}, and {@link #REQUEST_KEY_SIZE}. - * If there is a SSL certificate associated with the request, it must + * If there is an SSL certificate associated with the request, it must * be exposed using {@link #REQUEST_X509CERTIFICATE} * * @param name attribute name diff --git a/api/src/main/java/jakarta/xml/ws/spi/http/package-info.java b/api/src/main/java/jakarta/xml/ws/spi/http/package-info.java index bc4a591..983c7a3 100644 --- a/api/src/main/java/jakarta/xml/ws/spi/http/package-info.java +++ b/api/src/main/java/jakarta/xml/ws/spi/http/package-info.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2009, 2020 Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2009, 2024 Oracle and/or its affiliates. All rights reserved. * * This program and the accompanying materials are made available under the * terms of the Eclipse Distribution License v. 1.0, which is available at @@ -26,7 +26,7 @@ in containers (for example servlet containers). This SPI may be got from web service deployment descriptor files.

  • Container needs to create {@link jakarta.xml.ws.spi.http.HttpContext} objects for the deployment. For example, a HttpContext could be - created using servlet configuration(for e.g url-pattern) for the + created using servlet configuration(for e.g. url-pattern) for the web service in servlet container case.
  • Then publishes all the endpoints using {@link jakarta.xml.ws.Endpoint#publish(HttpContext)}. During publish(), diff --git a/api/src/main/java/jakarta/xml/ws/wsaddressing/W3CEndpointReference.java b/api/src/main/java/jakarta/xml/ws/wsaddressing/W3CEndpointReference.java index 37a77d1..f791057 100644 --- a/api/src/main/java/jakarta/xml/ws/wsaddressing/W3CEndpointReference.java +++ b/api/src/main/java/jakarta/xml/ws/wsaddressing/W3CEndpointReference.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2005, 2022 Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2005, 2024 Oracle and/or its affiliates. All rights reserved. * * This program and the accompanying materials are made available under the * terms of the Eclipse Distribution License v. 1.0, which is available at @@ -34,7 +34,7 @@ /** - * This class represents a W3C Addressing EndpointReferece which is + * This class represents a W3C Addressing EndpointReference which is * a remote reference to a web service endpoint that supports the * W3C WS-Addressing 1.0 - Core Recommendation. *

    diff --git a/api/src/main/java/jakarta/xml/ws/wsaddressing/W3CEndpointReferenceBuilder.java b/api/src/main/java/jakarta/xml/ws/wsaddressing/W3CEndpointReferenceBuilder.java index 6f29470..088d8ef 100644 --- a/api/src/main/java/jakarta/xml/ws/wsaddressing/W3CEndpointReferenceBuilder.java +++ b/api/src/main/java/jakarta/xml/ws/wsaddressing/W3CEndpointReferenceBuilder.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2005, 2020 Oracle and/or its affiliates. All rights reserved. + * Copyright (c) 2005, 2024 Oracle and/or its affiliates. All rights reserved. * * This program and the accompanying materials are made available under the * terms of the Eclipse Distribution License v. 1.0, which is available at @@ -24,12 +24,12 @@ /** * This class is used to build {@code W3CEndpointReference} - * instances. The intended use of this clsss is for + * instances. The intended use of this class is for * an application component, for example a factory component, * to create an {@code W3CEndpointReference} for a * web service endpoint published by the same * Jakarta EE application. It can also be used to create - * {@code W3CEndpointReferences} for an Java SE based + * {@code W3CEndpointReferences} for a Java SE based * endpoint by providing the {@code address} property. *

    * When creating a {@code W3CEndpointReference} for an @@ -85,7 +85,7 @@ public W3CEndpointReferenceBuilder address(String address) { * Sets the {@code interfaceName} as the * {@code wsam:InterfaceName} element in the * {@code wsa:Metadata} element. - * + *

    * See * 2.1 Referencing WSDL Metadata from an EPR for more details. * @@ -106,14 +106,14 @@ public W3CEndpointReferenceBuilder interfaceName(QName interfaceName) { * Sets the {@code serviceName} as the * {@code wsam:ServiceName} element in the * {@code wsa:Metadata} element. - * + *

    * See * 2.1 Referencing WSDL Metadata from an EPR for more details. * * @param serviceName The service name of the endpoint to be targeted * by the returned {@code W3CEndpointReference}. This property * may also be used with the {@code endpointName} (portName) - * property to lookup the {@code address} of a web service + * property to look up the {@code address} of a web service * endpoint that is published by the same Jakarta EE application. * * @return A {@code W3CEndpointReferenceBuilder} instance with @@ -138,7 +138,7 @@ public W3CEndpointReferenceBuilder serviceName(QName serviceName) { * @param endpointName The name of the endpoint to be targeted * by the returned {@code W3CEndpointReference}. The * {@code endpointName} (portName) property may also be - * used with the {@code serviceName} property to lookup + * used with the {@code serviceName} property to look up * the {@code address} of a web service * endpoint published by the same Jakarta EE application. * @@ -165,8 +165,8 @@ public W3CEndpointReferenceBuilder endpointName(QName endpointName) { /** * Sets the {@code wsdlDocumentLocation} that will be referenced - * as {@code wsa:Metadata/@wsdli:wsdlLocation}. The namespace name - * for the wsdli:wsdlLocation's value can be taken from the WSDL itself. + * as {@code wsa:Metadata/@wsdl:wsdlLocation}. The namespace name + * for the wsdl:wsdlLocation's value can be taken from the WSDL itself. * *

    * See diff --git a/etc/jenkins/continuous.groovy b/etc/jenkins/continuous.groovy index 3a2fc96..bb8e2ce 100644 --- a/etc/jenkins/continuous.groovy +++ b/etc/jenkins/continuous.groovy @@ -1,4 +1,4 @@ -// Copyright (c) 2019, 2021 Oracle and/or its affiliates. All rights reserved. +// Copyright (c) 2019, 2024 Oracle and/or its affiliates. All rights reserved. // // This program and the accompanying materials are made available under the // terms of the Eclipse Distribution License v. 1.0, which is available at @@ -26,7 +26,7 @@ pipeline { agent any tools { - jdk 'openjdk-jdk11-latest' + jdk 'openjdk-jdk21-latest' maven 'apache-maven-latest' } diff --git a/etc/jenkins/release.groovy b/etc/jenkins/release.groovy index 49101ec..6ec6ab0 100644 --- a/etc/jenkins/release.groovy +++ b/etc/jenkins/release.groovy @@ -1,4 +1,4 @@ -// Copyright (c) 2019 Oracle and/or its affiliates. All rights reserved. +// Copyright (c) 2019, 2024 Oracle and/or its affiliates. All rights reserved. // // This program and the accompanying materials are made available under the // terms of the Eclipse Distribution License v. 1.0, which is available at @@ -24,7 +24,7 @@ pipeline { agent any tools { - jdk 'openjdk-jdk11-latest' + jdk 'openjdk-jdk21-latest' maven 'apache-maven-latest' }