Review Javadoc

Closes gh-1467
This commit is contained in:
Stéphane Nicoll
2025-02-26 14:36:27 +01:00
parent e5740412bf
commit da47205e58
52 changed files with 137 additions and 155 deletions

View File

@@ -15,6 +15,6 @@
*/
/**
* Provides the <code>DestinationProvider</code> interface.
* Provides the {@code DestinationProvider} interface.
*/
package org.springframework.ws.client.support.destination;

View File

@@ -78,7 +78,9 @@ public abstract class AbstractValidatingInterceptor extends TransformerObjectSup
this.schemaLanguage = schemaLanguage;
}
/** Returns the schema resources to use for validation. */
/**
* Returns the schema resources to use for validation.
*/
public Resource[] getSchemas() {
return schemas;
}
@@ -86,8 +88,8 @@ public abstract class AbstractValidatingInterceptor extends TransformerObjectSup
/**
* Sets the schema resource to use for validation. Setting this property,
* {@link #setXsdSchemaCollection(XsdSchemaCollection) xsdSchemaCollection},
* {@link #setSchema(Resource) schema}, or {@link #setSchemas(Resource[]) schemas} is
* required.
* {@link #setSchemas(Resource[]) schemas}, or {@link #setXsdSchema(XsdSchema)
* xsdSchema} is required.
*/
public void setSchema(Resource schema) {
setSchemas(schema);
@@ -96,8 +98,8 @@ public abstract class AbstractValidatingInterceptor extends TransformerObjectSup
/**
* Sets the schema resources to use for validation. Setting this property,
* {@link #setXsdSchemaCollection(XsdSchemaCollection) xsdSchemaCollection},
* {@link #setSchema(Resource) schema}, or {@link #setSchemas(Resource[]) schemas} is
* required.
* {@link #setSchema(Resource) schema}, or {@link #setXsdSchema(XsdSchema) xsdSchema}
* is required.
*/
public void setSchemas(Resource... schemas) {
Assert.notEmpty(schemas, "schemas must not be empty or null");

View File

@@ -15,6 +15,6 @@
*/
/**
* Provides the <code>ClientInterceptor</code> interface, and validating interceptors.
* Provides the {@code ClientInterceptor} interface, and validating interceptors.
*/
package org.springframework.ws.client.support.interceptor;

View File

@@ -15,6 +15,6 @@
*/
/**
* Contains the <code>MessageContext</code> interface and implementations thereof.
* Contains the {@code MessageContext} interface and implementations thereof.
*/
package org.springframework.ws.context;

View File

@@ -58,7 +58,7 @@ public class DomPoxMessageFactory extends TransformerObjectSupport implements We
/**
* Provide your own {@link DocumentBuilderFactory}.
* @param documentBuilderFactory
* @param documentBuilderFactory the document builder factory to use
*/
public DomPoxMessageFactory(DocumentBuilderFactory documentBuilderFactory) {
this.documentBuilderFactory = documentBuilderFactory;

View File

@@ -68,9 +68,6 @@ public abstract class AbstractEndpointExceptionResolver implements EndpointExcep
* Default is no warn logging. Specify this setting to activate warn logging into a
* specific category. Alternatively, override the {@link #logException} method for
* custom logging.
* @see org.apache.commons.logging.LogFactory#getLog(String)
* @see org.apache.log4j.Logger#getLogger(String)
* @see java.util.logging.Logger#getLogger(String)
*/
public void setWarnLogCategory(String loggerName) {
this.warnLogger = LogFactory.getLog(loggerName);

View File

@@ -33,7 +33,7 @@ import org.springframework.xml.transform.TransformerObjectSupport;
* Abstract base class for endpoints that handle the message payload as JDOM elements.
* <p>
* Offers the message payload as a JDOM {@link Element}, and allows subclasses to create a
* response by returning an {@code Element}. <pAn {@code AbstractJDomPayloadEndpoint} can
* response by returning an {@code Element}. An {@code AbstractJDomPayloadEndpoint} can
* accept only <i>one</i> payload element. Multiple payload elements are not in accordance
* with WS-I.
*

View File

@@ -71,9 +71,6 @@ public abstract class AbstractLoggingInterceptor extends TransformerObjectSuppor
* <p>
* This can be specified to not log into the category of a class but rather into a
* specific named category.
* @see org.apache.commons.logging.LogFactory#getLog(String)
* @see org.apache.log4j.Logger#getLogger(String)
* @see java.util.logging.Logger#getLogger(String)
*/
public void setLoggerName(String loggerName) {
this.logger = LogFactory.getLog(loggerName);

View File

@@ -32,7 +32,6 @@ import org.w3c.dom.NodeList;
import org.springframework.core.MethodParameter;
import org.springframework.core.convert.ConversionService;
import org.springframework.core.convert.support.ConversionServiceFactory;
import org.springframework.core.convert.support.DefaultConversionService;
import org.springframework.ws.context.MessageContext;
import org.springframework.ws.server.endpoint.annotation.XPathParam;
@@ -64,9 +63,7 @@ public class XPathParamMethodArgumentResolver implements MethodArgumentResolver
/**
* Sets the conversion service to use.
* <p>
* Defaults to the
* {@linkplain ConversionServiceFactory#createDefaultConversionService() default
* conversion service}.
* Defaults to the {@linkplain DefaultConversionService default conversion service}.
*/
public void setConversionService(ConversionService conversionService) {
this.conversionService = conversionService;

View File

@@ -15,7 +15,7 @@
*/
/**
* Provides DOM-based implementations of the <code>MethodArgumentResolver</code> and
* <code>MethodReturnValueHandler</code> interfaces.
* Provides DOM-based implementations of the {@code MethodArgumentResolver} and
* {@code MethodReturnValueHandler} interfaces.
*/
package org.springframework.ws.server.endpoint.adapter.method.dom;

View File

@@ -15,7 +15,7 @@
*/
/**
* Provides JAXB2-based implementations of the <code>MethodArgumentResolver</code> and
* <code>MethodReturnValueHandler</code> interfaces.
* Provides JAXB2-based implementations of the {@code MethodArgumentResolver} and
* {@code MethodReturnValueHandler} interfaces.
*/
package org.springframework.ws.server.endpoint.adapter.method.jaxb;

View File

@@ -15,8 +15,7 @@
*/
/**
* Provides the <code>MethodArgumentResolver</code> and
* <code>MethodReturnValueHandler</code> abstractions, and various implementations
* thereof.
* Provides the {@code MethodArgumentResolver} and {@code MethodReturnValueHandler}
* abstractions, and various implementations thereof.
*/
package org.springframework.ws.server.endpoint.adapter.method;

View File

@@ -15,6 +15,6 @@
*/
/**
* Provides miscellaneous <code>EndpointAdapter</code> implementations.
* Provides miscellaneous {@code EndpointAdapter} implementations.
*/
package org.springframework.ws.server.endpoint.adapter;

View File

@@ -84,7 +84,9 @@ public abstract class AbstractValidatingInterceptor extends TransformerObjectSup
this.schemaLanguage = schemaLanguage;
}
/** Returns the schema resources to use for validation. */
/**
* Returns the schema resources to use for validation.
*/
public Resource[] getSchemas() {
return schemas;
}
@@ -92,8 +94,8 @@ public abstract class AbstractValidatingInterceptor extends TransformerObjectSup
/**
* Sets the schema resource to use for validation. Setting this property,
* {@link #setXsdSchemaCollection(XsdSchemaCollection) xsdSchemaCollection},
* {@link #setSchema(Resource) schema}, or {@link #setSchemas(Resource[]) schemas} is
* required.
* {@link #setSchemas(Resource[]) schemas}, or {@link #setXsdSchema(XsdSchema)
* xsdSchema} is required.
*/
public void setSchema(Resource schema) {
setSchemas(schema);
@@ -102,8 +104,8 @@ public abstract class AbstractValidatingInterceptor extends TransformerObjectSup
/**
* Sets the schema resources to use for validation. Setting this property,
* {@link #setXsdSchemaCollection(XsdSchemaCollection) xsdSchemaCollection},
* {@link #setSchema(Resource) schema}, or {@link #setSchemas(Resource[]) schemas} is
* required.
* {@link #setSchema(Resource) schema}, or {@link #setXsdSchema(XsdSchema) xsdSchema}
* is required.
*/
public void setSchemas(Resource... schemas) {
Assert.notEmpty(schemas, "schemas must not be empty or null");
@@ -120,7 +122,6 @@ public abstract class AbstractValidatingInterceptor extends TransformerObjectSup
* {@link #setSchema(Resource) schema}, or {@link #setSchemas(Resource[]) schemas} is
* required.
* @param schema the xsd schema to use
* @throws IOException in case of I/O errors
*/
public void setXsdSchema(XsdSchema schema) {
this.validator = schema.createValidator();
@@ -131,7 +132,6 @@ public abstract class AbstractValidatingInterceptor extends TransformerObjectSup
* {@link #setXsdSchema(XsdSchema) xsdSchema}, {@link #setSchema(Resource) schema}, or
* {@link #setSchemas(Resource[]) schemas} is required.
* @param schemaCollection the xsd schema collection to use
* @throws IOException in case of I/O errors
*/
public void setXsdSchemaCollection(XsdSchemaCollection schemaCollection) {
this.validator = schemaCollection.createValidator();

View File

@@ -26,7 +26,8 @@ import org.springframework.ws.server.endpoint.AbstractLoggingInterceptor;
* that logs the payload of request and response messages.
* <p>
* By default, both request and response messages are logged, but this behaviour can be
* changed using the {@link #logRequest} and {@link #logResponse} properties.
* changed using the {@link #setLogRequest(boolean) logRequest} and
* {@link #setLogResponse(boolean) logResponse} properties.
*
* @author Arjen Poutsma
* @see #setLogRequest(boolean)

View File

@@ -15,6 +15,6 @@
*/
/**
* Provides miscellaneous endpoints <code>EndpointInterceptor</code> implementations.
* Provides miscellaneous endpoints {@code EndpointInterceptor} implementations.
*/
package org.springframework.ws.server.endpoint.interceptor;

View File

@@ -194,7 +194,7 @@ public abstract class AbstractMethodEndpointMapping<T> extends AbstractEndpointM
/**
* Returns the endpoint keys for the given method. Should return an empty array if the
* method is not to be registered. The default delegates to
* {@link #getLookupKeysForMethod(Method)}.
* {@link #getLookupKeyForMethod(Method)}.
* @param method the method
* @return a list of registration keys
* @since 2.2

View File

@@ -62,7 +62,7 @@ public class PayloadRootAnnotationMethodEndpointMapping extends AbstractAnnotati
/**
* Override the default {@link TransformerFactory}.
* @param transformerFactory
* @param transformerFactory the transformer factory to use
*/
public static void setTransformerFactory(TransformerFactory transformerFactory) {
PayloadRootAnnotationMethodEndpointMapping.transformerFactory = transformerFactory;

View File

@@ -57,7 +57,7 @@ public class PayloadRootQNameEndpointMapping extends AbstractQNameEndpointMappin
/**
* Override the default {@link TransformerFactory}.
* @param transformerFactory
* @param transformerFactory the transformer factory to use
*/
public static void setTransformerFactory(TransformerFactory transformerFactory) {
PayloadRootQNameEndpointMapping.transformerFactory = transformerFactory;

View File

@@ -15,6 +15,6 @@
*/
/**
* Provides JAXB2-based <code>EndpointMapping</code> implementations.
* Provides JAXB2-based {@code EndpointMapping} implementations.
*/
package org.springframework.ws.server.endpoint.mapping.jaxb;

View File

@@ -15,6 +15,6 @@
*/
/**
* Provides miscellaneous endpoints <code>EndpointMapping</code> implementations.
* Provides miscellaneous endpoints {@code EndpointMapping} implementations.
*/
package org.springframework.ws.server.endpoint.mapping;

View File

@@ -15,6 +15,6 @@
*/
/**
* Provides standard endpoint, and <code>EndpointAdapter</code> implementations.
* Provides standard endpoint, and {@code EndpointAdapter} implementations.
*/
package org.springframework.ws.server.endpoint;

View File

@@ -15,7 +15,7 @@
*/
/**
* Provides helper classes for <code>EndpointAdapter</code>,
* <code>EndpointInteceptor</code>, and <code>EndpointMapping</code> implementations.
* Provides helper classes for {@code EndpointAdapter}, {@code EndpointInterceptor}, and
* {@code EndpointMapping} implementations.
*/
package org.springframework.ws.server.endpoint.support;

View File

@@ -15,7 +15,7 @@
*/
/**
* Core package for WS-Addressing support. Contains the <code>EndpointReference</code> and
* <code>MessageAddressingProperties</code> classes.
* Core package for WS-Addressing support. Contains the {@code EndpointReference} and
* {@code MessageAddressingProperties} classes.
*/
package org.springframework.ws.soap.addressing.core;

View File

@@ -15,7 +15,6 @@
*/
/**
* Contains servers-side WS-Addressing support, in the form of
* <code>EndpointMappings</code>.
* Contains servers-side WS-Addressing support, in the form of {@code EndpointMappings}.
*/
package org.springframework.ws.soap.addressing.server;

View File

@@ -43,11 +43,11 @@ import org.springframework.xml.namespace.QNameUtils;
* The following snippet shows an example of supported declarations.
*
* <pre>
* <code>
* {@code
* public void soapHeaderElement(@SoapHeader("{http://springframework.org/ws}header") SoapHeaderElement element)
*
* public void soapHeaderElementList(@SoapHeader("{http://springframework.org/ws}header") List&lt;SoapHeaderElement&gt; elements)
* </code> </pre>
* public void soapHeaderElementList(@SoapHeader("{http://springframework.org/ws}header") List<SoapHeaderElement> elements)
* } </pre>
*
* @author Tareq Abedrabbo
* @author Arjen Poutsma

View File

@@ -15,7 +15,7 @@
*/
/**
* Provides miscellaneous endpoints <code>EndpointInterceptor</code> implementations for
* SOAP purposes.
* Provides miscellaneous endpoints {@code EndpointInterceptor} implementations for SOAP
* purposes.
*/
package org.springframework.ws.soap.server.endpoint.interceptor;

View File

@@ -15,7 +15,7 @@
*/
/**
* Provides miscellaneous endpoints <code>EndpointMapping</code> implementations for SOAP
* Provides miscellaneous endpoints {@code EndpointMapping} implementations for SOAP
* purposes.
*/
package org.springframework.ws.soap.server.endpoint.mapping;

View File

@@ -15,7 +15,7 @@
*/
/**
* Provides <code>EndpointAdapter</code>, <code>EndpointMapping</code>, and
* <code>EndpointExceptionResolver</code> implementations for SOAP.
* Provides {@code EndpointAdapter}, {@code EndpointMapping}, and
* {@code EndpointExceptionResolver} implementations for SOAP.
*/
package org.springframework.ws.soap.server.endpoint;

View File

@@ -41,7 +41,7 @@ public abstract class AbstractHttpSenderConnection extends AbstractSenderConnect
implements FaultAwareWebServiceConnection {
/**
* Cached result of {@link #hasResponse}.
* Cached result of {@code hasResponse}.
*/
private Boolean hasResponse;

View File

@@ -40,7 +40,7 @@ import org.springframework.ws.client.support.interceptor.ClientInterceptor;
* {@link FactoryBean} to set up a {@link CloseableHttpClient} using HttpComponents
* HttpClient 5.
*
* @see http://hc.apache.org/httpcomponents-client
* @see <a href=https://hc.apache.org/httpcomponents-client>HttpComponents</a>
* @author Lars Uffmann
* @since 4.0.5
*/

View File

@@ -16,8 +16,8 @@
/**
* Package providing support for handling messages via HTTP. Includes the
* <code>MessageDispatcherServlet</code> and <code>WebServiceHttpHandler</code> for
* server-side access, and the <code>HttpUrlConnectionMessageSender</code> and
* <code>CommonsHttpMessageSender</code> for client-side access.
* {@code MessageDispatcherServlet} and {@code WebServiceHttpHandler} for server-side
* access, and the {@code HttpUrlConnectionMessageSender} and
* {@code CommonsHttpMessageSender} for client-side access.
*/
package org.springframework.ws.transport.http;

View File

@@ -44,7 +44,6 @@ public class AbstractHttpSenderConnectionTest {
* before passing it to the message factory. This is a regression test for SWS-707.
* @param chunking Specifies whether the test should simulate a response with chunking
* enabled.
* @throws Exception
*/
private void testSupportsStreaming(boolean chunking) throws Exception {

View File

@@ -216,7 +216,6 @@ public abstract class AbstractWsSecurityInterceptor implements SoapEndpointInter
* if the {@link #setSecureRequest(boolean) secureRequest} property is {@code true}.
* @param messageContext the message context, containing the request to be secured
* @return {@code true} if the response was secured; {@code false} otherwise.
* @throws Exception in case of errors
* @see #secureMessage(org.springframework.ws.soap.SoapMessage,org.springframework.ws.context.MessageContext)
*/
@Override
@@ -246,7 +245,6 @@ public abstract class AbstractWsSecurityInterceptor implements SoapEndpointInter
* {@code true}.
* @param messageContext the message context, containing the response to be validated
* @return {@code true} if the request was valid; {@code false} otherwise.
* @throws Exception in case of errors
* @see #validateMessage(org.springframework.ws.soap.SoapMessage,org.springframework.ws.context.MessageContext)
*/
@Override

View File

@@ -15,6 +15,6 @@
*/
/**
* Contains generic <code>CallbackHandler</code> implementations.
* Contains generic {@code CallbackHandler} implementations.
*/
package org.springframework.ws.soap.security.callback;

View File

@@ -16,6 +16,6 @@
/**
* Provides WS-Security implementation classes. Contains the
* <code>AbstractWsSecurityInterceptor</code> and exceptions.
* {@code AbstractWsSecurityInterceptor} and exceptions.
*/
package org.springframework.ws.soap.security;

View File

@@ -63,7 +63,6 @@ import org.springframework.ws.soap.security.wss4j2.callback.UsernameTokenPrincip
/**
* A WS-Security endpoint interceptor based on Apache's WSS4J. This interceptor supports
* messages created by the
* {@link org.springframework.ws.soap.axiom.AxiomSoapMessageFactory} and the
* {@link org.springframework.ws.soap.saaj.SaajSoapMessageFactory}.
* <p>
* The validation and securement actions executed by this interceptor are configured via
@@ -207,7 +206,7 @@ public class Wss4jSecurityInterceptor extends AbstractWsSecurityInterceptor impl
/**
* Inject a customize {@link WSSecurityEngine}.
* @param securityEngine
* @param securityEngine the security engine to use
*/
public Wss4jSecurityInterceptor(WSSecurityEngine securityEngine) {
this.securityEngine = securityEngine;
@@ -236,20 +235,19 @@ public class Wss4jSecurityInterceptor extends AbstractWsSecurityInterceptor impl
/**
* Defines which key identifier type to use. The WS-Security specifications recommends
* to use the identifier type {@code IssuerSerial}. For possible encryption key
* identifier types refer to
* {@link org.apache.ws.security.handler.WSHandlerConstants#keyIdentifier}. For
* encryption {@code IssuerSerial}, {@code X509KeyIdentifier},
* {@code DirectReference}, {@code Thumbprint}, {@code SKIKeyIdentifier}, and
* {@code EmbeddedKeyName} are valid only.
* identifier types refer to {@link WSHandlerConstants}. For encryption
* {@code IssuerSerial}, {@code X509KeyIdentifier}, {@code DirectReference},
* {@code Thumbprint}, {@code SKIKeyIdentifier}, and {@code EmbeddedKeyName} are valid
* only.
*/
public void setSecurementEncryptionKeyIdentifier(String securementEncryptionKeyIdentifier) {
handler.setOption(WSHandlerConstants.ENC_KEY_ID, securementEncryptionKeyIdentifier);
}
/**
* Defines which algorithm to use to encrypt the generated symmetric key. Currently
* Defines which algorithm to use to encrypt the generated symmetric key. Currently,
* WSS4J supports {@link WSConstants#KEYTRANSPORT_RSA15} and
* {@link WSConstants#KEYTRANSPORT_RSAOEP}.
* {@link WSConstants#KEYTRANSPORT_RSAOAEP}.
*/
public void setSecurementEncryptionKeyTransportAlgorithm(String securementEncryptionKeyTransportAlgorithm) {
handler.setOption(WSHandlerConstants.ENC_KEY_TRANSPORT, securementEncryptionKeyTransportAlgorithm);
@@ -277,7 +275,7 @@ public class Wss4jSecurityInterceptor extends AbstractWsSecurityInterceptor impl
* 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.
* 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
@@ -289,7 +287,7 @@ public class Wss4jSecurityInterceptor extends AbstractWsSecurityInterceptor impl
* namespace.
* <p>
* To specify an element without a namespace use the string {@code Null} as the
* namespace name (this is a case sensitive string)
* namespace name (this is a case-sensitive string)
* <p>
* If no list is specified, the handler encrypts the SOAP Body in {@code Content} mode
* by default.
@@ -300,7 +298,7 @@ public class Wss4jSecurityInterceptor extends AbstractWsSecurityInterceptor impl
/**
* Defines which symmetric encryption algorithm to use. WSS4J supports the following
* alorithms: {@link WSConstants#TRIPLE_DES}, {@link WSConstants#AES_128},
* algorithms: {@link WSConstants#TRIPLE_DES}, {@link WSConstants#AES_128},
* {@link WSConstants#AES_256}, and {@link WSConstants#AES_192}. Except for AES 192
* all of these algorithms are required by the XML Encryption specification.
*/
@@ -315,14 +313,12 @@ public class Wss4jSecurityInterceptor extends AbstractWsSecurityInterceptor impl
* the generated symmetric key.
* <p>
* If this parameter is not set, then the encryption function falls back to the
* {@link org.apache.ws.security.handler.WSHandlerConstants#USER} parameter to get the
* certificate.
* {@link WSHandlerConstants#USER} parameter to get the certificate.
* <p>
* If <b>only</b> encryption of the SOAP body data is requested, it is recommended to
* use this parameter to define the username. The application can then use the
* standard user and password functions (see example at
* {@link org.apache.ws.security.handler.WSHandlerConstants#USER} to enable HTTP
* authentication functions.
* standard user and password functions, see example at
* {@link WSHandlerConstants#USER} to enable HTTP authentication functions.
* <p>
* Encryption only does not authenticate a user / sender, therefore it does not need a
* password.
@@ -339,7 +335,7 @@ public class Wss4jSecurityInterceptor extends AbstractWsSecurityInterceptor impl
}
/**
* Specific parameter for UsernameToken action to define the encoding of the passowrd.
* Specific parameter for UsernameToken action to define the encoding of the password.
* <p>
* The parameter can be set to either {@link WSConstants#PW_DIGEST} or to
* {@link WSConstants#PW_TEXT}.
@@ -373,9 +369,8 @@ public class Wss4jSecurityInterceptor extends AbstractWsSecurityInterceptor impl
/**
* Defines which key identifier type to use. The WS-Security specifications recommends
* to use the identifier type {@code IssuerSerial}. For possible signature key
* identifier types refer to
* {@link org.apache.ws.security.handler.WSHandlerConstants#keyIdentifier}. For
* signature {@code IssuerSerial} and {@code DirectReference} are valid only.
* identifier types refer to {@link WSHandlerConstants}. For signature
* {@code IssuerSerial} and {@code DirectReference} are valid only.
*/
public void setSecurementSignatureKeyIdentifier(String securementSignatureKeyIdentifier) {
handler.setOption(WSHandlerConstants.SIG_KEY_ID, securementSignatureKeyIdentifier);
@@ -402,7 +397,7 @@ public class Wss4jSecurityInterceptor extends AbstractWsSecurityInterceptor impl
* </pre>
*
* To specify an element without a namespace use the string {@code Null} as the
* namespace name (this is a case sensitive string)
* namespace name (this is a case-sensitive string)
* <p>
* If there is no other element in the request with a local name of {@code Body} then
* the SOAP namespace identifier can be empty ({@code {}}).
@@ -451,7 +446,7 @@ public class Wss4jSecurityInterceptor extends AbstractWsSecurityInterceptor impl
/**
* Sets the SAML Callback used for generating SAML tokens.
* @param samlCallback
* @param samlCallbackHandler the SAML callback handler
*/
public void setSecurementSamlCallbackHandler(CallbackHandler samlCallbackHandler) {
this.samlCallbackHandler = samlCallbackHandler;
@@ -509,8 +504,8 @@ public class Wss4jSecurityInterceptor extends AbstractWsSecurityInterceptor impl
}
/**
* Whether to enable signatureConfirmation or not. By default signatureConfirmation is
* enabled
* Whether to enable signatureConfirmation or not. By default, signatureConfirmation
* is enabled.
*/
public void setEnableSignatureConfirmation(boolean enableSignatureConfirmation) {
@@ -524,8 +519,7 @@ public class Wss4jSecurityInterceptor extends AbstractWsSecurityInterceptor impl
}
/**
* Sets whether or not timestamp verification is done with the server-side time to
* live
* Sets whether timestamp verification is done with the server-side time to live
*/
public void setTimestampStrict(boolean timestampStrict) {
this.timestampStrict = timestampStrict;
@@ -540,7 +534,7 @@ public class Wss4jSecurityInterceptor extends AbstractWsSecurityInterceptor impl
}
/**
* Sets whether or not a {@code Nonce} element is added to the {@code UsernameToken}s.
* Sets whether a {@code Nonce} element is added to the {@code UsernameToken}s.
* Default is {@code false}.
*/
public void setSecurementUsernameTokenNonce(boolean securementUsernameTokenNonce) {
@@ -548,8 +542,8 @@ public class Wss4jSecurityInterceptor extends AbstractWsSecurityInterceptor impl
}
/**
* Sets whether or not a {@code Created} element is added to the
* {@code UsernameToken}s. Default is {@code false}.
* Sets whether a {@code Created} element is added to the {@code UsernameToken}s.
* Default is {@code false}.
*/
public void setSecurementUsernameTokenCreated(boolean securementUsernameTokenCreated) {
handler.setOption(ConfigurationConstants.ADD_USERNAMETOKEN_CREATED, securementUsernameTokenCreated);
@@ -839,7 +833,7 @@ public class Wss4jSecurityInterceptor extends AbstractWsSecurityInterceptor impl
/**
* Verifies the trust of a certificate.
* @param result
* @param result the {@link WSHandlerResult} to use
*/
protected void verifyCertificateTrust(WSHandlerResult result) throws WSSecurityException {
@@ -863,7 +857,7 @@ public class Wss4jSecurityInterceptor extends AbstractWsSecurityInterceptor impl
/**
* Verifies the timestamp.
* @param result
* @param result the {@link WSHandlerResult} to use
*/
protected void verifyTimestamp(WSHandlerResult result) throws WSSecurityException {

View File

@@ -15,6 +15,6 @@
*/
/**
* Contains <code>CallbackHandler</code> implementations for WSS4J 2.0.
* Contains {@code CallbackHandler} implementations for WSS4J 2.0.
*/
package org.springframework.ws.soap.security.wss4j2.callback;

View File

@@ -39,7 +39,7 @@ import org.springframework.util.Assert;
* @author Tareq Abed Rabbo
* @author Arjen Poutsma
* @author Jamin Hitchcock
* @see org.apache.ws.security.components.crypto.Crypto
* @see Crypto
* @since 2.3.0
*/
public class CryptoFactoryBean implements FactoryBean<Crypto>, InitializingBean {
@@ -50,10 +50,12 @@ public class CryptoFactoryBean implements FactoryBean<Crypto>, InitializingBean
private static final String CRYPTO_PROVIDER_PROPERTY = "org.apache.wss4j.crypto.provider";
private static final String CRYPTO_MERLIN_FILE_PROPERTY = "org.apache.ws.security.crypto.merlin.file";
/**
* Sets the configuration of the Crypto. Setting this property overrides all
* previously set configuration, through the type-safe properties
* @see org.apache.ws.security.components.crypto.CryptoFactory#getInstance(java.util.Properties)
* @see CryptoFactory#getInstance(java.util.Properties)
*/
public void setConfiguration(Properties properties) {
Assert.notNull(properties, "'properties' must not be null");
@@ -61,11 +63,9 @@ public class CryptoFactoryBean implements FactoryBean<Crypto>, InitializingBean
}
/**
* Sets the {@link org.apache.ws.security.components.crypto.Crypto} provider name.
* Defaults to {@link org.apache.ws.security.components.crypto.Merlin}.
* Sets the {@link Crypto} provider name. Defaults to {@link Merlin}.
* <p>
* This property maps to the WSS4J {@code org.apache.ws.security.crypto.provider}
* property.
* This property maps to the WSS4J {@value CRYPTO_PROVIDER_PROPERTY} property.
* @param cryptoProviderClass the crypto provider class
*/
public void setCryptoProvider(Class<? extends Crypto> cryptoProviderClass) {
@@ -73,17 +73,15 @@ public class CryptoFactoryBean implements FactoryBean<Crypto>, InitializingBean
}
/**
* Sets the location of the key store to be loaded in the
* {@link org.apache.ws.security.components.crypto.Crypto} instance.
* Sets the location of the key store to be loaded in the {@link Crypto} instance.
* <p>
* This property maps to the WSS4J {@code org.apache.ws.security.crypto.merlin.file}
* property.
* This property maps to the WSS4J {@value CRYPTO_MERLIN_FILE_PROPERTY} property.
* @param location the key store location
* @throws java.io.IOException when the resource cannot be opened
*/
public void setKeyStoreLocation(Resource location) throws IOException {
String resourcePath = getResourcePath(location);
this.configuration.setProperty("org.apache.ws.security.crypto.merlin.file", resourcePath);
this.configuration.setProperty(CRYPTO_MERLIN_FILE_PROPERTY, resourcePath);
}
private String getResourcePath(Resource resource) throws IOException {

View File

@@ -35,7 +35,6 @@ import org.springframework.ws.transport.support.SimpleWebServiceMessageReceiverO
* registered}.
*
* @author Arjen Poutsma
* @see org.springframework.remoting.support.SimpleHttpServerFactoryBean
* @since 1.5.0
*/
public class WebServiceMessageReceiverHttpHandler extends SimpleWebServiceMessageReceiverObjectSupport

View File

@@ -24,6 +24,7 @@ import jakarta.jms.ConnectionFactory;
import jakarta.jms.Destination;
import jakarta.jms.JMSException;
import jakarta.jms.Message;
import jakarta.jms.Queue;
import jakarta.jms.Session;
import jakarta.jms.Topic;
@@ -41,47 +42,45 @@ import org.springframework.ws.transport.jms.support.JmsTransportUtils;
* a JMS {@link ConnectionFactory} to operate.
* <p>
* This message sender supports URI's of the following format: <blockquote>
* <tt><b>jms:</b></tt><i>destination</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>destination</i> represents the name
* of the {@link Queue} or {@link Topic} that will be resolved by the
* {@link #getDestinationResolver() destination resolver}. Valid <i>param-name</i>
* include: <blockquote>
* {@code jms:<destination>[?param-name=param-value][&param-name=param-value]}
* </blockquote> where the characters {@code :}, {@code ?}, and {@code &} stand for
* themselves. The {@code <destination>} represents the name of the {@link Queue} or
* {@link Topic} that will be resolved by the {@link #getDestinationResolver() destination
* resolver}. Valid {@code param-name} include:
* <table>
* <tr>
* <th><i>param-name</i></th>
* <th><i>Description</i></th>
* </tr>
* <tr>
* <td><tt>deliveryMode</tt></td>
* <td>{@code deliveryMode}</td>
* <td>Indicates whether the request message is persistent or not. This may be
* <tt>PERSISTENT</tt> or <tt>NON_PERSISTENT</tt>. See
* {@code PERSISTENT} or {@code NON_PERSISTENT}. See
* {@link jakarta.jms.MessageProducer#setDeliveryMode(int)}</td>
* </tr>
* <tr>
* <td><tt>messageType</tt></td>
* <td>The message type. This may be <tt>BINARY_MESSAGE</tt> (the default) or
* <tt>TEXT_MESSAGE</tt></td>
* <td>{@code messageType}</td>
* <td>The message type. This may be {@code BINARY_MESSAGE} (the default) or
* {@code TEXT_MESSAGE}</td>
* </tr>
* <tr>
* <td><tt>priority</tt></td>
* <td>{@code priority}</td>
* <td>The JMS priority (0-9) associated with the request message. See
* {@link jakarta.jms.MessageProducer#setPriority(int)}</td>
* </tr>
* <tr>
* <td><tt>replyToName</tt></td>
* <td>{@code replyToName}</td>
* <td>The name of the destination to which the response message must be sent, that will
* be resolved by the {@link #getDestinationResolver() destination resolver}.</td>
* be resolved by the {@link #getDestinationResolver() destination resolver}</td>
* </tr>
* <tr>
* <td><tt>timeToLive</tt></td>
* <td>{@code timeToLive}</td>
* <td>The lifetime, in milliseconds, of the request message. See
* {@link jakarta.jms.MessageProducer#setTimeToLive(long)}</td>
* </tr>
* </table>
* </blockquote>
* <p>
* If the <tt>replyToName</tt> is not set, a {@link Session#createTemporaryQueue()
* If the {@code replyToName} is not set, a {@link Session#createTemporaryQueue()
* temporary queue} is used.
* <p>
* This class uses {@link jakarta.jms.BytesMessage} messages by default, but can be
@@ -89,14 +88,14 @@ import org.springframework.ws.transport.jms.support.JmsTransportUtils;
* {@code BytesMessages} are preferred, since {@code TextMessages} do not support
* attachments and character encodings reliably.
* <p>
* Some examples of JMS URIs are: <blockquote> <tt>jms:SomeQueue</tt><br>
* <tt>jms:SomeTopic?priority=3&deliveryMode=NON_PERSISTENT</tt><br>
* <tt>jms:RequestQueue?replyToName=ResponseQueueName</tt><br>
* <tt>jms:Queue?messageType=TEXT_MESSAGE</blockquote>
* 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}
*
* @author Arjen Poutsma
* @see <a href="http://tools.ietf.org/id/draft-merrick-jms-iri-00.txt">IRI Scheme for
* Java(tm) Message Service 1.0</a>
* @see <a href="https://datatracker.ietf.org/doc/rfc6167">IRI Scheme for Java(tm) Message
* Service 1.0</a>
* @since 1.5.0
*/
public class JmsMessageSender extends JmsDestinationAccessor implements WebServiceMessageSender {
@@ -108,7 +107,7 @@ public class JmsMessageSender extends JmsDestinationAccessor implements WebServi
public static final long DEFAULT_RECEIVE_TIMEOUT = -1;
/**
* Default encoding used to read fromn and write to {@link jakarta.jms.TextMessage}
* Default encoding used to read from and write to {@link jakarta.jms.TextMessage}
* messages.
*/
public static final String DEFAULT_TEXT_MESSAGE_ENCODING = "UTF-8";

View File

@@ -24,6 +24,7 @@ import jakarta.mail.Session;
import jakarta.mail.URLName;
import jakarta.mail.internet.AddressException;
import jakarta.mail.internet.InternetAddress;
import jakarta.mail.internet.MimeMessage;
import org.springframework.beans.factory.InitializingBean;
import org.springframework.util.Assert;
@@ -42,7 +43,7 @@ import org.springframework.ws.transport.mail.support.MailTransportUtils;
* created by this message sender will result in a blocking call, for the amount of
* milliseconds specified by the {@link #setReceiveSleepTime(long) receiveSleepTime}
* property. This will give the server time to formulate a response message. By default,
* this propery is set to 1 minute. For a proper request-response conversation to work,
* this property is set to 1 minute. For a proper request-response conversation to work,
* this property value must not be smaller the
* {@link PollingMonitoringStrategy#setPollingInterval(long) pollingInterval} property of
* the server-side message receiver polling strategy.
@@ -50,8 +51,8 @@ import org.springframework.ws.transport.mail.support.MailTransportUtils;
* 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 a RFC 822 mailbox.
* Valid <i>param-name</i> include: <blockquote>
* <tt><b>&amp;</b></tt> stand for themselves. The <i>to</i> represents an RFC 822
* mailbox. Valid <i>param-name</i> include: <blockquote>
* <table>
* <tr>
* <th><i>param-name</i></th>
@@ -133,7 +134,7 @@ public class MailMessageSender implements WebServiceMessageSender, InitializingB
}
/**
* Sets the JavaMail Store URI to be used for retrieving response messages. Typically
* Sets the JavaMail Store URI to be used for retrieving response messages. Typically,
* takes the form of {@code [imap|pop3]://user:password@host:port/INBOX}. Setting this
* property is required.
* <p>
@@ -145,9 +146,9 @@ public class MailMessageSender implements WebServiceMessageSender, InitializingB
}
/**
* Sets the JavaMail Transport URI to be used for sending response messages. Typically
* takes the form of {@code smtp://user:password@host:port}. Setting this property is
* required.
* Sets the JavaMail Transport URI to be used for sending response messages.
* Typically, takes the form of {@code smtp://user:password@host:port}. Setting this
* property is required.
* <p>
* For example, {@code smtp://john:secret@smtp.example.com}
* @see Session#getTransport(URLName)

View File

@@ -138,7 +138,7 @@ public abstract class AbstractMonitoringStrategy implements MonitoringStrategy {
/**
* Fetches the specified messages from the specified folder. Default implementation
* {@link Folder#fetch(Message[], FetchProfile) fetches} every
* {@link javax.mail.FetchProfile.Item}.
* {@link jakarta.mail.FetchProfile.Item}.
* @param folder the folder to fetch messages from
* @param messages the messages to fetch
* @throws MessagingException in case of JavMail errors

View File

@@ -42,8 +42,8 @@ public abstract class AbstractAsyncStandaloneMessageReceiver extends AbstractSta
* Default is {@link SimpleAsyncTaskExecutor}, starting up a number of new threads.
* <p>
* Specify an alternative task executor for integration with an existing thread pool,
* such as the {@link org.springframework.scheduling.commonj.WorkManagerTaskExecutor}
* to integrate with WebSphere or WebLogic.
* such as the
* {@link org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor}.
*/
public void setTaskExecutor(TaskExecutor taskExecutor) {
this.taskExecutor = taskExecutor;

View File

@@ -20,7 +20,6 @@ import java.io.IOException;
import org.jivesoftware.smack.SmackException;
import org.jivesoftware.smack.StanzaListener;
import org.jivesoftware.smack.XMPPConnection;
import org.jivesoftware.smack.XMPPException;
import org.jivesoftware.smack.filter.StanzaFilter;
import org.jivesoftware.smack.filter.StanzaTypeFilter;
@@ -32,8 +31,8 @@ import org.springframework.ws.transport.support.AbstractStandaloneMessageReceive
/**
* Server-side component for receiving XMPP (Jabber) messages. Requires a
* {@linkplain #setConnection(XMPPConnection) connection} to be set, in addition to the
* {@link #setMessageFactory(org.springframework.ws.WebServiceMessageFactory)
* {@linkplain #setConnection(XMPPTCPConnection)} connection} to be set, in addition to
* the {@link #setMessageFactory(org.springframework.ws.WebServiceMessageFactory)
* messageFactory} and
* {@link #setMessageReceiver(org.springframework.ws.transport.WebServiceMessageReceiver)
* messageReceiver} required by the base class.

View File

@@ -60,7 +60,9 @@ public class XmppMessageSender implements WebServiceMessageSender, InitializingB
private XMPPConnection connection;
/** Sets the {@code XMPPConnection}. Setting this property is required. */
/**
* Sets the {@code XMPPConnection}. Setting this property is required.
*/
public void setConnection(XMPPConnection connection) {
this.connection = connection;
}
@@ -68,7 +70,7 @@ public class XmppMessageSender implements WebServiceMessageSender, InitializingB
/**
* Set the timeout to use for receive calls. The default is -1, which means no
* timeout.
* @see org.jivesoftware.smack.PacketCollector#nextResult(long)
* @see org.jivesoftware.smack.StanzaCollector#nextResult(long)
*/
public void setReceiveTimeout(long receiveTimeout) {
this.receiveTimeout = receiveTimeout;

View File

@@ -30,6 +30,7 @@ import static org.springframework.ws.test.support.AssertionErrors.assertTrue;
* @deprecated Migrate to
* {@link org.springframework.ws.test.support.matcher.xmlunit2.DiffMatcher}.
*/
@Deprecated
public abstract class DiffMatcher implements WebServiceMessageMatcher {
@Override
@@ -43,7 +44,6 @@ public abstract class DiffMatcher implements WebServiceMessageMatcher {
* Creates a {@link Diff} for the given message.
* @param message the message
* @return the diff
* @throws Exception in case of errors
*/
protected abstract Diff createDiff(WebServiceMessage message);

View File

@@ -38,6 +38,7 @@ import static org.springframework.ws.test.support.AssertionErrors.fail;
* @deprecated Migrate to
* {@link org.springframework.ws.test.support.matcher.xmlunit2.PayloadDiffMatcher}.s
*/
@Deprecated
public class PayloadDiffMatcher extends DiffMatcher {
private final Source expected;

View File

@@ -41,6 +41,7 @@ import static org.springframework.ws.test.support.AssertionErrors.fail;
* @deprecated Migrate to
* {@link org.springframework.ws.test.support.matcher.xmlunit2.SoapEnvelopeDiffMatcher}.
*/
@Deprecated
public class SoapEnvelopeDiffMatcher extends AbstractSoapMessageMatcher {
private final Source expected;

View File

@@ -43,7 +43,6 @@ public abstract class DiffMatcher implements WebServiceMessageMatcher {
* Creates a {@link Diff} for the given message.
* @param message the message
* @return the diff
* @throws Exception in case of errors
*/
protected abstract Diff createDiff(WebServiceMessage message);

View File

@@ -15,7 +15,7 @@
*/
/**
* Contains a implementation of the <code>XsdSchema</code> interfaces that uses Apache
* Contains a implementation of the {@code XsdSchema} interfaces that uses Apache
* WS-Commons XML Schema.
*/
package org.springframework.xml.xsd.commons;

View File

@@ -15,7 +15,7 @@
*/
/**
* Provides an abstraction over XSD XML schemas. Contains the <code>XsdSchema</code> and
* Provides an abstraction over XSD XML schemas. Contains the {@code XsdSchema} and
* related interfaces.
*/
package org.springframework.xml.xsd;