Fix Javadoc errors

See gh-1467
This commit is contained in:
Stéphane Nicoll
2025-02-27 13:56:10 +01:00
parent 30d5f1e6a5
commit 4ffe014733
27 changed files with 86 additions and 162 deletions

View File

@@ -36,7 +36,6 @@
<properties>
<java.version>17</java.version>
<maven.javadoc.failOnError>false</maven.javadoc.failOnError>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
<spring-asciidoctor-backends.version>0.0.5</spring-asciidoctor-backends.version>
@@ -827,7 +826,7 @@
<artifactId>maven-javadoc-plugin</artifactId>
<version>2.10.4</version>
<configuration>
<additionalparam>-Xdoclint:none</additionalparam>
<additionalparam>-Xdoclint:-missing</additionalparam>
<additionalparam>-quiet</additionalparam>
</configuration>
<executions>

View File

@@ -94,14 +94,14 @@ import org.springframework.ws.transport.support.TransportUtils;
* <li>Call {@link #hasError(WebServiceConnection,WebServiceMessage) hasError()} to check
* if the connection has an error. For an HTTP transport, a status code other than
* {@code 2xx} indicates an error. However, since a status code of 500 can also indicate a
* SOAP fault, the template verifies whether the error is not a fault.</li>
* SOAP fault, the template verifies whether the error is not a fault.
* <ul>
* <li>If the connection has an error, call the {@link #handleError handleError()} method,
* which by default throws a {@link WebServiceTransportException}.</li>
* <li>If the connection has no error, continue with the next step.</li>
* </ul>
* <li>Invoke {@link WebServiceConnection#receive(WebServiceMessageFactory) receive} on
* the connection to read the response message, if any.</li>
* the connection to read the response message, if any.
* <ul>
* <li>If no response was received, return {@code null} or {@code false}</li>
* <li>Call {@link #hasFault(WebServiceConnection,WebServiceMessage) hasFault()} to

View File

@@ -41,7 +41,7 @@ import org.springframework.ws.transport.WebServiceMessageSender;
* template are to be used.
* <p>
* Note that when {@link #setWebServiceTemplate(WebServiceTemplate) injecting a
* {@code WebServiceTemplate}} directly, the convenience setters
* WebServiceTemplate directly}, the convenience setters
* ({@link #setMarshaller(Marshaller)}, {@link #setUnmarshaller(Unmarshaller)},
* {@link #setMessageSender(WebServiceMessageSender)},
* {@link #setMessageSenders(WebServiceMessageSender[])}, and

View File

@@ -91,6 +91,7 @@ public class Wsdl11DestinationProvider extends AbstractCachingDestinationProvide
* <p>
* The expression can use the following bound prefixes: <blockquote>
* <table>
* <caption>Bound Prefixes</caption>
* <tr>
* <th>Prefix</th>
* <th>Namespace</th>

View File

@@ -25,7 +25,7 @@ import org.springframework.util.ClassUtils;
import org.springframework.util.StringUtils;
/**
* Parser for the <code>&lt;sws:marshalling-endpoints/&gt; element.
* Parser for the {@code <sws:marshalling-endpoints/>} element.
*
* @author Arjen Poutsma
* @since 1.5.0

View File

@@ -27,7 +27,7 @@ import org.springframework.beans.factory.xml.ParserContext;
import org.springframework.util.xml.DomUtils;
/**
* Parser for the <code>&lt;sws:xpath-endpoints/&gt; element.
* Parser for the {@code <sws:xpath-endpoints>} element.
*
* @author Arjen Poutsma
* @since 1.5.0

View File

@@ -30,20 +30,19 @@ import org.springframework.context.annotation.Import;
* Web Services configuration defined in {@link WsConfigurationSupport} imported. For
* instance:
*
* <pre class="code">
* <pre><code class='java'>
* &#064;Configuration
* &#064;EnableWs
* &#064;ComponentScan(basePackageClasses = { MyConfiguration.class })
* public class MyWsConfiguration {
*
* }
* </pre>
* }</code></pre>
* <p>
* Customize the imported configuration by implementing the {@link WsConfigurer} interface
* or more likely by extending the {@link WsConfigurerAdapter} base class and overriding
* individual methods:
*
* <pre class="code">
* <pre><code class='java'>
* &#064;Configuration
* &#064;EnableWs
* &#064;ComponentScan(basePackageClasses = { MyConfiguration.class })
@@ -60,14 +59,13 @@ import org.springframework.context.annotation.Import;
* }
*
* // More overridden methods ...
* }
* </pre>
* }</code></pre>
* <p>
* If the customization options of {@link WsConfigurer} do not expose something you need
* to configure, consider removing the {@code @EnableWs} annotation and extending directly
* from {@link WsConfigurationSupport} overriding selected {@code @Bean} methods:
*
* <pre class="code">
* <pre><code class='java'>
* &#064;Configuration
* &#064;ComponentScan(basePackageClasses = { MyConfiguration.class })
* public class MyConfiguration extends WsConfigurationSupport {
@@ -83,8 +81,7 @@ import org.springframework.context.annotation.Import;
* // Create or delegate to "super" to create and
* // customize properties of DefaultMethodEndpointAdapter
* }
* }
* </pre>
* }</code></pre>
*
* @see WsConfigurer
* @see WsConfigurerAdapter

View File

@@ -33,15 +33,10 @@ import org.springframework.ws.support.MarshallingUtils;
* Adapter that supports endpoint methods that use marshalling. Supports methods with the
* following signature:
*
* <pre>
* void handleMyMessage(MyUnmarshalledType request);
* </pre>
*
* or
*
* <pre>
* MyMarshalledType handleMyMessage(MyUnmarshalledType request);
* </pre>
* <pre><code class='java'>
* void handleMyMessage(MyUnmarshalledType request);</code></pre> or
* <pre><code class='java'>
* MyMarshalledType handleMyMessage(MyUnmarshalledType request);</code></pre>
*
* I.e. methods that take a single parameter that {@link Unmarshaller#supports(Class) is
* supported} by the {@link Unmarshaller}, and return either {@code void} or a type

View File

@@ -27,9 +27,8 @@ import org.springframework.ws.soap.server.SoapMessageDispatcher;
* Adapter that supports endpoint methods with message contexts. Supports methods with the
* following signature:
*
* <pre>
* void handleMyMessage(MessageContext request);
* </pre>
* <pre><code class='java'>
* void handleMyMessage(MessageContext request);</code></pre>
*
* I.e. methods that take a single {@link MessageContext} parameter, and return
* {@code void}. The method can have any name, as long as it is mapped by an

View File

@@ -28,21 +28,12 @@ import org.springframework.ws.soap.server.SoapMessageDispatcher;
/**
* Adapter that supports endpoint methods that use marshalling. Supports methods with the
* following signature:
*
* <pre>
* void handleMyMessage(Source request);
* </pre>
*
* or
*
* <pre>
* Source handleMyMessage(Source request);
* </pre>
*
* I.e. methods that take a single {@link Source} parameter, and return either
* {@code void} or a {@link Source}. The method can have any name, as long as it is mapped
* by an {@link org.springframework.ws.server.EndpointMapping}.
* following signature: <pre><code class='java'>
* void handleMyMessage(Source request);</code></pre> or <pre><code class='java'>
* Source handleMyMessage(Source request);</code></pre> I.e. methods that take a single
* {@link Source} parameter, and return either {@code void} or a {@link Source}. The
* method can have any name, as long as it is mapped by an
* {@link org.springframework.ws.server.EndpointMapping}.
* <p>
* This adapter is registered by default by the {@link MessageDispatcher} and
* {@link SoapMessageDispatcher}.

View File

@@ -45,20 +45,14 @@ import org.springframework.xml.namespace.SimpleNamespaceContext;
* Adapter that supports endpoint methods that use XPath expressions. Supports methods
* with the following signature:
*
* <pre>
* void handleMyMessage(@XPathParam("/root/child/text") String param);
* </pre>
*
* or
*
* <pre>
* <pre><code class='java'>
* void handleMyMessage(@XPathParam("/root/child/text") String param);</code></pre> or
* <pre><code class='java'>
* Source handleMyMessage(@XPathParam("/root/child/text") String param1,
* &#64;XPathParam("/root/child/number") double param2);
* </pre>
*
* I.e. methods that return either {@code void} or a {@link Source}, and have parameters
* annotated with {@link XPathParam} that specify the XPath expression that should be
* bound to that parameter. The parameter can be of the following types:
* &#64;XPathParam("/root/child/number") double param2);</code></pre> I.e. methods
* that return either {@code void} or a {@link Source}, and have parameters annotated with
* {@link XPathParam} that specify the XPath expression that should be bound to that
* parameter. The parameter can be of the following types:
* <ul>
* <li>{@code boolean}, or {@link Boolean}</li>
* <li>{@code double}, or {@link Double}</li>

View File

@@ -39,23 +39,18 @@ import org.springframework.xml.transform.TransformerHelper;
* <p>
* Endpoints typically have the following form:
*
* <pre>
* <pre><code class='java'>
* &#64;Endpoint
* public class MyEndpoint{
* public void doSomethingWithRequest(&#64;RequestBody MyRootElement rootElement) {
* ...
* }
* }
* </pre>
*
* where MyRootElement is annotated with {@code @XmlRootElement}:
*
* <pre>
* }</code></pre> where MyRootElement is annotated with {@code @XmlRootElement}:
* <pre><code class='java'>
* &#64;XmlRootElement(name = "myRoot", namespace = "http://springframework.org/spring-ws")
* public class MyRootElement {
* ...
* }
* </pre>
* }</code></pre>
*
* @author Arjen Poutsma
* @since 2.0

View File

@@ -29,13 +29,11 @@ import org.springframework.ws.soap.SoapMessage;
* the message.
* <p>
* A usage example with {@link org.springframework.ws.client.core.WebServiceTemplate}:
*
* <pre>
* <pre><code class='java'>
* WebServiceTemplate template = new WebServiceTemplate(messageFactory);
* Result result = new DOMResult();
* template.sendSourceAndReceiveToResult(new StringSource("&lt;content xmlns=\"http://tempuri.org\"/&gt;"),
* new SoapActionCallback("http://tempuri.org/SOAPAction"), result);
* </pre>
* new SoapActionCallback("http://tempuri.org/SOAPAction"), result);</code></pre>
*
* @author Arjen Poutsma
* @since 1.0.0

View File

@@ -27,11 +27,7 @@ import org.springframework.xml.namespace.QNameEditor;
/**
* PropertyEditor for {@code SoapFaultDefinition} objects. Takes strings of form
*
* <pre>
* faultCode,faultString,locale
* </pre>
*
* {@code faultCode,faultString,locale}<br/>
* where {@code faultCode} is the string representation of a {@code QName},
* {@code faultStringOrReason} is the optional fault string, and {@code locale} is the
* optional string representations for the {@code faultStringOrReason}language. By
@@ -43,22 +39,11 @@ import org.springframework.xml.namespace.QNameEditor;
* {@code SENDER} to{@code Client}/{@code Sender} fault respectively.
* <p>
* For example:
*
* <pre>
* RECEIVER,Server error
* </pre>
*
* or
*
* <pre>
* CLIENT,Client error
* </pre>
*
* or
*
* <pre>
* {http://springframework.org/spring-ws}spring-ws:FatalError},A fatal error has occurred
* </pre>
* <ul>
* <li>{@code RECEIVER,Server error}</li>
* <li>{@code CLIENT,Client error}</li>
* <li><code>{http://springframework.org/spring-ws}spring-ws:FatalError},A fatal error has occurred</code></li>
* </ul>
*
* @author Arjen Poutsma
* @see javax.xml.namespace.QName#toString()

View File

@@ -39,10 +39,8 @@ import org.springframework.xml.namespace.QNameUtils;
* {@link SoapHeader} to indicate the SOAP header to resolve. This resolver supports
* simple {@link SoapHeaderElement} parameters and {@link List} parameters for elements
* that appear multiple times in the same SOAP header.
* </p>
* The following snippet shows an example of supported declarations.
*
* <pre>
* <p>
* The following snippet shows an example of supported declarations. <pre>
* {@code
* public void soapHeaderElement(@SoapHeader("{http://springframework.org/ws}header") SoapHeaderElement element)
*

View File

@@ -40,15 +40,14 @@ import org.springframework.ws.soap.server.endpoint.annotation.SoapActions;
* <p>
* Endpoints typically have the following form:
*
* <pre>
* <pre><code class='java'>
* &#64;Endpoint
* public class MyEndpoint{
* &#64;SoapAction("http://springframework.org/spring-ws/SoapAction")
* public Source doSomethingWithRequest() {
* ...
* }
* }
* </pre>
* }</code></pre>
*
* @author Arjen Poutsma
* @since 1.0.0

View File

@@ -34,12 +34,12 @@ import org.springframework.ws.soap.SoapFaultException;
public interface Soap11Body extends SoapBody {
/**
* Adds a SOAP 1.1 <faultCode>Fault</faultCode> to the body with a localized message.
* Adding a fault removes the current content of the body.
* Adds a SOAP 1.1 {@code Fault} to the body with a localized message. Adding a fault
* removes the current content of the body.
* @param faultCode the fully qualified fault faultCode
* @param faultString the faultString
* @param faultStringLocale the faultString locale. May be {@code null}
* @return the added <faultCode>Soap11Fault</faultCode>
* @return the added {@code Soap11Fault}
* @throws IllegalArgumentException if the fault faultCode is not fully qualified
*/
Soap11Fault addFault(QName faultCode, String faultString, Locale faultStringLocale) throws SoapFaultException;

View File

@@ -129,7 +129,7 @@ public class HttpComponents5ClientFactory implements FactoryBean<CloseableHttpCl
/**
* Sets the maximum number of connections allowed for the underlying HttpClient.
* @param maxTotalConnections the maximum number of connections allowed
* @see PoolingHttpClientConnectionManager...
* @see PoolingHttpClientConnectionManager
*/
public void setMaxTotalConnections(int maxTotalConnections) {
@@ -154,7 +154,7 @@ public class HttpComponents5ClientFactory implements FactoryBean<CloseableHttpCl
* The host can be specified as a URI (with scheme and port).
* @param maxConnectionsPerHost a properties object specifying the maximum number of
* connection
* @see PoolingHttpClientConnectionManager...
* @see PoolingHttpClientConnectionManager
*/
public void setMaxConnectionsPerHost(Map<String, String> maxConnectionsPerHost) {
this.maxConnectionsPerHost = maxConnectionsPerHost;

View File

@@ -37,9 +37,7 @@ import org.springframework.xml.xsd.XsdSchemaCollection;
* {@link SuffixBasedPortTypesProvider}, {@link SoapProvider} underneath; effectively
* equivalent to using a {@link ProviderBasedWsdl4jDefinition} with all these providers.
* <p>
* Example configuration:
*
* <pre>
* Example configuration: <pre><code class='xml'>
* &lt;bean id=&quot;airline&quot; class=&quot;org.springframework.ws.wsdl.wsdl11.DefaultWsdl11Definition&quot;&gt;
* &lt;property name=&quot;schema&quot;&gt;
* &lt;bean class=&quot;org.springframework.xml.xsd.SimpleXsdSchema&quot;&gt;
@@ -48,8 +46,7 @@ import org.springframework.xml.xsd.XsdSchemaCollection;
* &lt;/property&gt;
* &lt;property name=&quot;portTypeName&quot; value=&quot;Airline&quot;/&gt;
* &lt;property name=&quot;locationUri&quot; value=&quot;http://localhost:8080/airline/services&quot;/&gt;
* &lt;/bean&gt;
* </pre>
* &lt;/bean&gt;</code></pre>
*
* @author Arjen Poutsma
* @since 1.5.0

View File

@@ -84,9 +84,9 @@ public abstract class KeyStoreUtils {
* If {@code javax.net.ssl.trustStore} is defined but the specified file does not
* exist, then a default, empty trust store is created.</li>
* <li>If the {@code javax.net.ssl.trustStore} system property was not specified, but
* if the file {@code $JAVA_HOME/lib/security/jssecacerts} exists, that file is
* used.</li> Otherwise,
* <li>If the file {@code $JAVA_HOME/lib/security/cacerts} exists, that file is used.
* if the file {@code $JAVA_HOME/lib/security/jssecacerts} exists, that file is used.
* <li>If the file {@code $JAVA_HOME/lib/security/cacerts} exists, that file is
* used.</li>
* </ol>
* <p>
* This behavior corresponds to the standard J2SDK behavior for SSL trust stores.

View File

@@ -71,6 +71,7 @@ import org.springframework.ws.soap.security.wss4j2.callback.UsernameTokenPrincip
* <p>
* Valid <strong>validation</strong> actions are: <blockquote>
* <table>
* <caption>Validation Actions</caption>
* <tr>
* <th>Validation action</th>
* <th>Description</th>
@@ -100,6 +101,7 @@ import org.springframework.ws.soap.security.wss4j2.callback.UsernameTokenPrincip
* <p>
* <strong>Securement</strong> actions are: <blockquote>
* <table>
* <caption>Securement Actions</caption>
* <tr>
* <th>Securement action</th>
* <th>Description</th>
@@ -264,18 +266,14 @@ public class Wss4jSecurityInterceptor extends AbstractWsSecurityInterceptor impl
* The encryption mode specifier is either {@code {Content}} or {@code {Element}}.
* Please refer to the W3C XML Encryption specification about the differences between
* Element and Content encryption. The encryption mode defaults to {@code Content} if
* it is omitted. Example of a list:
*
* <pre>
* it is omitted. Example of a list: <pre><code class="xml">
* &lt;property name="securementEncryptionParts"
* value="{Content}{http://example.org/paymentv2}CreditCard;
* {Element}{}UserName" />
* </pre>
*
* The first entry of the list identifies the element {@code CreditCard} in the
* namespace {@code http://example.org/paymentv2}, and will encrypt its content. Be
* aware that the element name, the namespace identifier, and the encryption modifier
* are case-sensitive.
* {Element}{}UserName" /&gt;
* </code></pre> The first entry of the list identifies the element {@code CreditCard}
* in the namespace {@code http://example.org/paymentv2}, and will encrypt its
* content. Be aware that the element name, the namespace identifier, and the
* encryption modifier are case-sensitive.
* <p>
* The encryption modifier and the namespace identifier can be omitted. In this case
* the encryption mode defaults to {@code Content} and the namespace is set to the

View File

@@ -48,6 +48,7 @@ import org.springframework.ws.transport.jms.support.JmsTransportUtils;
* {@link Topic} that will be resolved by the {@link #getDestinationResolver() destination
* resolver}. Valid {@code param-name} include:
* <table>
* <caption>Parameter Names</caption>
* <tr>
* <th><i>param-name</i></th>
* <th><i>Description</i></th>
@@ -91,7 +92,7 @@ import org.springframework.ws.transport.jms.support.JmsTransportUtils;
* Some examples of JMS URIs are: <blockquote> {@code jms:SomeQueue}<br>
* {@code jms:SomeTopic?priority=3&deliveryMode=NON_PERSISTENT}<br>
* {@code jms:RequestQueue?replyToName=ResponseQueueName}<br>
* {@code jms:Queue?messageType=TEXT_MESSAGE}
* {@code jms:Queue?messageType=TEXT_MESSAGE}</blockquote>
*
* @author Arjen Poutsma
* @see <a href="https://datatracker.ietf.org/doc/rfc6167">IRI Scheme for Java(tm) Message

View File

@@ -49,25 +49,23 @@ import org.springframework.ws.transport.mail.support.MailTransportUtils;
* the server-side message receiver polling strategy.
* <p>
* This message sender supports URI's of the following format: <blockquote>
* <tt><b>mailto:</b></tt><i>to</i>[<tt><b>?</b></tt><i>param-name</i><tt><b>=</b></tt><i>param-value</i>][<tt><b>&amp;</b></tt><i>param-name</i><tt><b>=</b></tt><i>param-value</i>]*
* </blockquote> where the characters <tt><b>:</b></tt>, <tt><b>?</b></tt>, and
* <tt><b>&amp;</b></tt> stand for themselves. The <i>to</i> represents an RFC 822
* mailbox. Valid <i>param-name</i> include: <blockquote>
* {@code mailto:<to>[?param-name=param-value][&param-name=param-value]*} </blockquote>
* where the characters {@code :}, {@code ?}, and {@code &} stand for themselves. The
* {@code to} represents an RFC 822 mailbox. Valid {@code param-name} include:
* <table>
* <caption>Parameter Names</caption>
* <tr>
* <th><i>param-name</i></th>
* <th><i>Description</i></th>
* </tr>
* <tr>
* <td><tt>subject</tt></td>
* <td>{@code subject}</td>
* <td>The subject of the request message.</td>
* </tr>
* </table>
* </blockquote>
* <p>
* Some examples of email URIs are: <blockquote><tt>mailto:john@example.com</tt><br>
* <tt>mailto:john@example.com@?subject=SOAP%20Test</tt><br>
* </blockquote>
* Some examples of email URIs are: {@code mailto:john@example.com}<br>
* {@code mailto:john@example.com@?subject=SOAP%20Test}<br>
*
* @author Arjen Poutsma
* @see <a href="http://www.ietf.org/rfc/rfc2368.txt">The mailto URL scheme</a>

View File

@@ -34,7 +34,7 @@ import org.springframework.ws.transport.xmpp.support.XmppTransportUtils;
* {@link #setConnection(org.jivesoftware.smack.XMPPConnection) connection}to be set.
* <p>
* This message sender supports URI's of the following format: <blockquote>
* <tt><b>xmpp:</b></tt><i>to</i> </blockquote> The <i>to</i> represents a Jabber ID.
* {@code xmpp:<to>} </blockquote> The {@code to} represents a Jabber ID.
*
* @author Gildas Cuisinier
* @author Arjen Poutsma

View File

@@ -49,9 +49,7 @@ import org.springframework.ws.test.support.MockStrategiesHelper;
* can typically use the Code Completion features (i.e. ctrl-space) in your IDE to set up
* the mocks.
* <p>
* For example: <blockquote>
*
* <pre>
* For example: <pre><code class="java">
* import org.junit.*;
* import org.springframework.beans.factory.annotation.Autowired;
* import org.springframework.test.context.ContextConfiguration;
@@ -92,10 +90,7 @@ import org.springframework.ws.test.support.MockStrategiesHelper;
*
* <strong>mockServer.verify();</strong>
* }
* }
* </pre>
*
* </blockquote>
* }</code></pre>
*
* @author Arjen Poutsma
* @author Lukas Krecan

View File

@@ -58,9 +58,7 @@ import static org.springframework.ws.test.support.AssertionErrors.fail;
* can typically use the Code Completion features (i.e. ctrl-space) in your IDE to set up
* the mocks.
* <p>
* For example: <blockquote>
*
* <pre>
* For example: <pre><code class="java">
* import org.junit.*;
* import org.springframework.beans.factory.annotation.Autowired;
* import org.springframework.context.ApplicationContext;
@@ -101,10 +99,7 @@ import static org.springframework.ws.test.support.AssertionErrors.fail;
*
* <strong>mockClient.sendRequest(withPayload(requestPayload)).andExpect(payload(expectedResponsePayload))</strong>;
* }
* }
* </pre>
*
* </blockquote>
* }</code></pre>
*
* @author Arjen Poutsma
* @author Lukas Krecan

View File

@@ -26,23 +26,12 @@ import org.springframework.util.StringUtils;
* PropertyEditor for {@code javax.xml.namespace.QName}, to populate a property of type
* QName from a String value.
* <p>
* Expects the syntax
*
* <pre>
* localPart
* </pre>
*
* or
*
* <pre>
* {namespace}localPart
* </pre>
*
* or
*
* <pre>
* {namespace}prefix:localPart
* </pre>
* Expects one of the following syntaxes:
* <ul>
* <li>{@code localPart}</li>
* <li>{@code {namespace}localPart}</li>
* <li>{@code {namespace}prefix:localPart}</li>
* </ul>
*
* This resembles the {@code toString()} representation of {@code QName} itself, but
* allows for prefixes to be specified as well.