From bbc6bf5f60fa5cb436e5c4e44781e4120ba7b746 Mon Sep 17 00:00:00 2001 From: Arjen Poutsma Date: Wed, 16 Apr 2014 17:30:39 +0200 Subject: [PATCH] Fixing javadoc --- build.gradle | 16 +- .../ws/soap/stroap/StroapMessageFactory.java | 16 +- .../ws/FaultAwareWebServiceMessage.java | 4 +- .../ws/WebServiceException.java | 4 +- .../springframework/ws/WebServiceMessage.java | 16 +- .../ws/WebServiceMessageException.java | 4 +- .../ws/WebServiceMessageFactory.java | 12 +- .../ws/client/WebServiceClientException.java | 4 +- .../ws/client/WebServiceFaultException.java | 6 +- .../ws/client/WebServiceIOException.java | 4 +- .../WebServiceTransformerException.java | 4 +- .../client/WebServiceTransportException.java | 4 +- .../core/SimpleFaultMessageResolver.java | 2 +- .../ws/client/core/SourceExtractor.java | 14 +- .../core/WebServiceMessageCallback.java | 8 +- .../core/WebServiceMessageExtractor.java | 16 +- .../ws/client/core/WebServiceOperations.java | 120 ++-- .../ws/client/core/WebServiceTemplate.java | 96 +-- .../support/WebServiceGatewaySupport.java | 54 +- .../ws/client/support/WebServiceAccessor.java | 18 +- .../AbstractCachingDestinationProvider.java | 10 +- .../destination/DestinationProvider.java | 4 +- .../Wsdl11DestinationProvider.java | 24 +- .../AbstractValidatingInterceptor.java | 44 +- .../interceptor/ClientInterceptor.java | 26 +- .../PayloadValidatingInterceptor.java | 16 +- .../WebServiceValidationException.java | 2 +- .../config/WebServicesNamespaceHandler.java | 2 +- .../ws/context/AbstractMessageContext.java | 4 +- .../ws/context/DefaultMessageContext.java | 6 +- .../ws/context/MessageContext.java | 22 +- .../ws/mime/AbstractMimeMessage.java | 2 +- .../springframework/ws/mime/Attachment.java | 10 +- .../springframework/ws/mime/MimeMessage.java | 16 +- .../ws/pox/PoxMessageException.java | 2 +- .../ws/pox/dom/DomPoxMessage.java | 4 +- .../ws/pox/dom/DomPoxMessageException.java | 2 +- .../ws/pox/dom/DomPoxMessageFactory.java | 4 +- .../ws/server/EndpointAdapter.java | 16 +- .../ws/server/EndpointExceptionResolver.java | 2 +- .../ws/server/EndpointInterceptor.java | 36 +- .../ws/server/EndpointInvocationChain.java | 4 +- .../ws/server/EndpointMapping.java | 32 +- .../ws/server/MessageDispatcher.java | 56 +- .../AbstractDom4jPayloadEndpoint.java | 26 +- .../endpoint/AbstractDomPayloadEndpoint.java | 48 +- .../AbstractEndpointExceptionResolver.java | 26 +- .../endpoint/AbstractJDomPayloadEndpoint.java | 22 +- .../endpoint/AbstractLoggingInterceptor.java | 40 +- .../AbstractMarshallingPayloadEndpoint.java | 36 +- .../endpoint/AbstractSaxPayloadEndpoint.java | 24 +- .../AbstractStaxEventPayloadEndpoint.java | 20 +- .../endpoint/AbstractStaxPayloadEndpoint.java | 24 +- .../AbstractStaxStreamPayloadEndpoint.java | 10 +- ...tValidatingMarshallingPayloadEndpoint.java | 2 +- .../endpoint/AbstractXomPayloadEndpoint.java | 16 +- .../ws/server/endpoint/MessageEndpoint.java | 6 +- .../ws/server/endpoint/MethodEndpoint.java | 4 +- .../ws/server/endpoint/PayloadEndpoint.java | 8 +- .../AbstractMethodEndpointAdapter.java | 4 +- .../adapter/DefaultMethodEndpointAdapter.java | 8 +- ...nericMarshallingMethodEndpointAdapter.java | 16 +- .../MarshallingMethodEndpointAdapter.java | 20 +- .../adapter/MessageEndpointAdapter.java | 6 +- .../adapter/MessageMethodEndpointAdapter.java | 6 +- .../adapter/PayloadEndpointAdapter.java | 6 +- .../adapter/PayloadMethodEndpointAdapter.java | 6 +- ...hParamAnnotationMethodEndpointAdapter.java | 6 +- .../AbstractPayloadMethodProcessor.java | 8 +- .../MarshallingPayloadMethodProcessor.java | 4 +- .../method/SourcePayloadMethodProcessor.java | 4 +- .../StaxPayloadMethodArgumentResolver.java | 4 +- .../XPathParamMethodArgumentResolver.java | 12 +- .../method/dom/XomPayloadMethodProcessor.java | 4 +- .../server/endpoint/annotation/Endpoint.java | 4 +- .../server/endpoint/annotation/Namespace.java | 4 +- .../endpoint/annotation/XPathParam.java | 4 +- .../AbstractValidatingInterceptor.java | 46 +- .../DelegatingSmartEndpointInterceptor.java | 8 +- .../EndpointInterceptorAdapter.java | 16 +- .../PayloadLoggingInterceptor.java | 2 +- .../PayloadTransformingInterceptor.java | 14 +- ...stractAnnotationMethodEndpointMapping.java | 12 +- .../mapping/AbstractEndpointMapping.java | 28 +- .../AbstractMapBasedEndpointMapping.java | 38 +- .../AbstractMethodEndpointMapping.java | 16 +- .../mapping/AbstractQNameEndpointMapping.java | 2 +- ...adRootAnnotationMethodEndpointMapping.java | 4 +- .../PayloadRootQNameEndpointMapping.java | 14 +- .../mapping/SimpleMethodEndpointMapping.java | 18 +- .../endpoint/mapping/UriEndpointMapping.java | 16 +- .../mapping/XPathPayloadEndpointMapping.java | 18 +- .../jaxb/XmlRootElementEndpointMapping.java | 4 +- .../endpoint/support/NamespaceUtils.java | 4 +- .../endpoint/support/PayloadRootUtils.java | 4 +- .../ws/soap/AbstractSoapMessage.java | 12 +- .../org/springframework/ws/soap/SoapBody.java | 64 +- .../springframework/ws/soap/SoapElement.java | 10 +- .../springframework/ws/soap/SoapEnvelope.java | 12 +- .../springframework/ws/soap/SoapFault.java | 10 +- .../ws/soap/SoapFaultDetail.java | 18 +- .../ws/soap/SoapFaultDetailElement.java | 4 +- .../springframework/ws/soap/SoapHeader.java | 8 +- .../ws/soap/SoapHeaderElement.java | 18 +- .../springframework/ws/soap/SoapMessage.java | 16 +- .../ws/soap/SoapMessageCreationException.java | 4 +- .../ws/soap/SoapMessageException.java | 4 +- .../ws/soap/SoapMessageFactory.java | 10 +- .../springframework/ws/soap/SoapVersion.java | 10 +- .../addressing/client/ActionCallback.java | 50 +- .../core/MessageAddressingProperties.java | 4 +- .../messageid/MessageIdStrategy.java | 8 +- .../messageid/UuidMessageIdStrategy.java | 8 +- .../server/AbstractActionEndpointMapping.java | 26 +- .../AbstractActionMethodEndpointMapping.java | 6 +- .../AbstractAddressingEndpointMapping.java | 36 +- .../AnnotationActionEndpointMapping.java | 12 +- .../server/SimpleActionEndpointMapping.java | 18 +- .../version/AbstractAddressingVersion.java | 28 +- .../addressing/version/AddressingVersion.java | 6 +- .../ws/soap/axiom/AxiomHandler.java | 4 +- .../ws/soap/axiom/AxiomResult.java | 6 +- .../ws/soap/axiom/AxiomSoap11Body.java | 2 +- .../ws/soap/axiom/AxiomSoap11Fault.java | 2 +- .../ws/soap/axiom/AxiomSoap11Header.java | 2 +- .../ws/soap/axiom/AxiomSoap12Body.java | 2 +- .../ws/soap/axiom/AxiomSoap12Fault.java | 2 +- .../ws/soap/axiom/AxiomSoap12Header.java | 2 +- .../ws/soap/axiom/AxiomSoapBody.java | 2 +- .../ws/soap/axiom/AxiomSoapEnvelope.java | 2 +- .../ws/soap/axiom/AxiomSoapFaultDetail.java | 2 +- .../axiom/AxiomSoapFaultDetailElement.java | 2 +- .../ws/soap/axiom/AxiomSoapHeader.java | 2 +- .../ws/soap/axiom/AxiomSoapHeaderElement.java | 2 +- .../ws/soap/axiom/AxiomSoapMessage.java | 16 +- .../soap/axiom/AxiomSoapMessageFactory.java | 56 +- .../ws/soap/axiom/support/AxiomUtils.java | 16 +- .../soap/client/SoapFaultClientException.java | 8 +- .../soap/client/core/SoapActionCallback.java | 6 +- .../ws/soap/saaj/SaajAttachment.java | 2 +- .../ws/soap/saaj/SaajSoap11Body.java | 2 +- .../ws/soap/saaj/SaajSoap11Fault.java | 2 +- .../ws/soap/saaj/SaajSoap11Header.java | 2 +- .../ws/soap/saaj/SaajSoap12Body.java | 2 +- .../ws/soap/saaj/SaajSoap12Header.java | 2 +- .../ws/soap/saaj/SaajSoapBody.java | 2 +- .../ws/soap/saaj/SaajSoapElement.java | 2 +- .../ws/soap/saaj/SaajSoapEnvelope.java | 2 +- .../ws/soap/saaj/SaajSoapFault.java | 2 +- .../ws/soap/saaj/SaajSoapFaultDetail.java | 2 +- .../soap/saaj/SaajSoapFaultDetailElement.java | 2 +- .../ws/soap/saaj/SaajSoapHeader.java | 2 +- .../ws/soap/saaj/SaajSoapHeaderElement.java | 2 +- .../ws/soap/saaj/SaajSoapMessage.java | 12 +- .../ws/soap/saaj/SaajSoapMessageFactory.java | 12 +- .../soap/saaj/support/SaajContentHandler.java | 8 +- .../ws/soap/saaj/support/SaajUtils.java | 22 +- .../ws/soap/saaj/support/SaajXmlReader.java | 20 +- .../soap/server/SoapEndpointInterceptor.java | 2 +- .../server/SoapEndpointInvocationChain.java | 12 +- .../ws/soap/server/SoapEndpointMapping.java | 10 +- .../ws/soap/server/SoapMessageDispatcher.java | 12 +- ...gValidatingMarshallingPayloadEndpoint.java | 26 +- ...tSoapFaultDefinitionExceptionResolver.java | 10 +- .../endpoint/SimpleSoapExceptionResolver.java | 14 +- .../server/endpoint/SoapFaultDefinition.java | 12 +- .../endpoint/SoapFaultDefinitionEditor.java | 20 +- .../SoapFaultMappingExceptionResolver.java | 18 +- ...apHeaderElementMethodArgumentResolver.java | 4 +- .../server/endpoint/annotation/FaultCode.java | 14 +- .../endpoint/annotation/SoapAction.java | 4 +- .../server/endpoint/annotation/SoapFault.java | 8 +- ...actFaultCreatingValidatingInterceptor.java | 30 +- .../PayloadValidatingInterceptor.java | 12 +- .../SoapEnvelopeLoggingInterceptor.java | 8 +- .../DelegatingSoapEndpointMapping.java | 18 +- ...ActionAnnotationMethodEndpointMapping.java | 6 +- .../mapping/SoapActionEndpointMapping.java | 20 +- .../ws/soap/soap11/Soap11Body.java | 4 +- .../ws/soap/soap11/Soap11Fault.java | 2 +- .../ws/soap/soap11/Soap11Header.java | 4 +- .../ws/soap/soap12/Soap12Body.java | 10 +- .../ws/soap/soap12/Soap12Fault.java | 4 +- .../ws/soap/soap12/Soap12Header.java | 12 +- .../ws/support/DefaultStrategiesHelper.java | 28 +- .../ws/support/MarshallingUtils.java | 6 +- .../transport/AbstractReceiverConnection.java | 8 +- .../transport/AbstractSenderConnection.java | 6 +- .../AbstractWebServiceConnection.java | 30 +- .../FaultAwareWebServiceConnection.java | 12 +- .../ws/transport/TransportInputStream.java | 6 +- .../ws/transport/TransportOutputStream.java | 2 +- .../ws/transport/WebServiceConnection.java | 16 +- .../ws/transport/WebServiceMessageSender.java | 6 +- .../context/DefaultTransportContext.java | 4 +- .../transport/context/TransportContext.java | 6 +- .../context/TransportContextHolder.java | 12 +- .../AbstractHttpWebServiceMessageSender.java | 12 +- .../http/CommonsHttpMessageSender.java | 26 +- .../http/HttpComponentsMessageSender.java | 18 +- .../transport/http/HttpServletConnection.java | 8 +- .../ws/transport/http/HttpUrlConnection.java | 4 +- .../http/HttpUrlConnectionMessageSender.java | 8 +- .../LocationTransformerObjectSupport.java | 12 +- .../http/MessageDispatcherServlet.java | 48 +- ...bServiceMessageReceiverHandlerAdapter.java | 18 +- .../http/WsdlDefinitionHandlerAdapter.java | 36 +- .../http/XsdSchemaHandlerAdapter.java | 20 +- .../ws/transport/support/TransportUtils.java | 4 +- ...ebServiceMessageReceiverObjectSupport.java | 12 +- .../ws/wsdl/WsdlDefinition.java | 4 +- .../wsdl/wsdl11/DefaultWsdl11Definition.java | 20 +- .../wsdl11/ProviderBasedWsdl4jDefinition.java | 78 +-- .../wsdl/wsdl11/SimpleWsdl11Definition.java | 12 +- .../ws/wsdl/wsdl11/Wsdl11Definition.java | 4 +- .../ws/wsdl/wsdl11/Wsdl4jDefinition.java | 10 +- .../wsdl11/Wsdl4jDefinitionException.java | 2 +- .../provider/AbstractPortTypesProvider.java | 50 +- .../wsdl11/provider/BindingsProvider.java | 4 +- .../provider/DefaultConcretePartProvider.java | 72 +-- .../provider/DefaultMessagesProvider.java | 26 +- .../wsdl/wsdl11/provider/ImportsProvider.java | 4 +- .../wsdl11/provider/MessagesProvider.java | 4 +- .../wsdl11/provider/PortTypesProvider.java | 4 +- .../wsdl11/provider/ServicesProvider.java | 4 +- .../wsdl/wsdl11/provider/Soap11Provider.java | 92 +-- .../wsdl/wsdl11/provider/Soap12Provider.java | 92 +-- .../ws/wsdl/wsdl11/provider/SoapProvider.java | 18 +- .../SuffixBasedPortTypesProvider.java | 18 +- .../wsdl/wsdl11/provider/TypesProvider.java | 4 +- .../ws/MockWebServiceMessage.java | 2 +- .../AbstractWsSecurityInterceptor.java | 44 +- .../security/WsSecurityFaultException.java | 2 +- .../WsSecuritySecurementException.java | 4 +- .../WsSecurityValidationException.java | 4 +- .../callback/AbstractCallbackHandler.java | 4 +- .../callback/CallbackHandlerChain.java | 4 +- .../security/callback/CleanupCallback.java | 4 +- .../support/KeyManagersFactoryBean.java | 4 +- .../security/support/KeyStoreFactoryBean.java | 6 +- .../soap/security/support/KeyStoreUtils.java | 32 +- .../support/TrustManagersFactoryBean.java | 4 +- .../wss4j/Wss4jSecurityInterceptor.java | 177 +++--- .../AbstractWsPasswordCallbackHandler.java | 50 +- .../callback/KeyStoreCallbackHandler.java | 2 +- ...mplePasswordValidationCallbackHandler.java | 2 +- ...rityPasswordValidationCallbackHandler.java | 4 +- .../UsernameTokenPrincipalCallback.java | 10 +- .../wss4j/support/CryptoFactoryBean.java | 37 +- .../x509/X509AuthenticationToken.java | 8 +- .../x509/X509AuthoritiesPopulator.java | 4 +- .../x509/cache/EhCacheBasedX509UserCache.java | 2 +- .../security/xwss/XwsSecurityInterceptor.java | 24 +- .../callback/CryptographyCallbackHandler.java | 128 ++-- .../callback/DefaultTimestampValidator.java | 2 +- .../callback/KeyStoreCallbackHandler.java | 44 +- .../MockValidationCallbackHandler.java | 10 +- ...mplePasswordValidationCallbackHandler.java | 8 +- ...SimpleUsernamePasswordCallbackHandler.java | 6 +- ...gCertificateValidationCallbackHandler.java | 20 +- ...gestPasswordValidationCallbackHandler.java | 18 +- ...TextPasswordValidationCallbackHandler.java | 20 +- ...SpringUsernamePasswordCallbackHandler.java | 6 +- .../callback/XwssCallbackHandlerChain.java | 4 +- ...sCertificateValidationCallbackHandler.java | 12 +- ...TextPasswordValidationCallbackHandler.java | 10 +- .../http/HttpExchangeConnection.java | 4 +- .../http/HttpsUrlConnectionMessageSender.java | 8 +- .../WebServiceMessageReceiverHttpHandler.java | 6 +- .../ws/transport/jms/JmsMessageReceiver.java | 10 +- .../ws/transport/jms/JmsMessageSender.java | 32 +- .../transport/jms/JmsReceiverConnection.java | 8 +- .../jms/WebServiceMessageListener.java | 4 +- .../jms/support/JmsTransportUtils.java | 2 +- .../transport/mail/MailMessageReceiver.java | 36 +- .../ws/transport/mail/MailMessageSender.java | 48 +- .../monitor/AbstractMonitoringStrategy.java | 6 +- .../monitor/ImapIdleMonitoringStrategy.java | 4 +- .../mail/monitor/MonitoringStrategy.java | 2 +- .../monitor/PollingMonitoringStrategy.java | 4 +- .../Pop3PollingMonitoringStrategy.java | 4 +- .../mail/support/MailTransportUtils.java | 16 +- ...bstractAsyncStandaloneMessageReceiver.java | 8 +- .../AbstractStandaloneMessageReceiver.java | 4 +- ...ebServiceMessageReceiverObjectSupport.java | 4 +- .../ws/transport/xmpp/XmppMessageSender.java | 6 +- .../support/XmppConnectionFactoryBean.java | 4 +- .../xmpp/support/XmppTransportUtils.java | 2 +- .../test/client/AbstractResponseCreator.java | 4 +- .../ws/test/client/MockWebServiceServer.java | 12 +- .../test/client/RequestXPathExpectations.java | 4 +- .../ws/test/server/MockWebServiceClient.java | 8 +- .../server/ResponseXPathExpectations.java | 4 +- .../creator/AbstractMessageCreator.java | 4 +- .../matcher/AbstractSoapMessageMatcher.java | 4 +- .../org/springframework/xml/JaxpVersion.java | 12 +- .../org/springframework/xml/XmlException.java | 4 +- .../xml/dom/DomContentHandler.java | 4 +- .../xml/namespace/QNameEditor.java | 8 +- .../xml/namespace/QNameUtils.java | 38 +- .../xml/namespace/SimpleNamespaceContext.java | 6 +- .../xml/sax/AbstractXmlReader.java | 14 +- .../org/springframework/xml/sax/SaxUtils.java | 6 +- .../xml/transform/ResourceSource.java | 4 +- .../xml/transform/StringResult.java | 4 +- .../xml/transform/StringSource.java | 4 +- .../xml/transform/TransformerHelper.java | 8 +- .../transform/TransformerObjectSupport.java | 8 +- .../validation/Jaxp13ValidatorFactory.java | 4 +- .../xml/validation/SchemaLoaderUtils.java | 10 +- .../xml/validation/XmlValidator.java | 16 +- .../xml/validation/XmlValidatorFactory.java | 14 +- .../xpath/JaxenXPathExpressionFactory.java | 12 +- .../xml/xpath/JaxenXPathTemplate.java | 4 +- .../xpath/Jaxp13XPathExpressionFactory.java | 10 +- .../xml/xpath/Jaxp13XPathTemplate.java | 4 +- .../xml/xpath/NodeCallbackHandler.java | 4 +- .../xml/xpath/XPathException.java | 4 +- .../xml/xpath/XPathExpression.java | 28 +- .../xml/xpath/XPathExpressionFactory.java | 6 +- .../xml/xpath/XPathExpressionFactoryBean.java | 4 +- .../xml/xpath/XPathOperations.java | 26 +- .../xml/xpath/XPathParseException.java | 4 +- .../xml/xsd/SimpleXsdSchema.java | 12 +- .../xml/xsd/commons/CommonsXsdSchema.java | 12 +- .../commons/CommonsXsdSchemaCollection.java | 20 +- src/api/stylesheet.css | 599 ++++++++++++++++++ 327 files changed, 2901 insertions(+), 2292 deletions(-) create mode 100644 src/api/stylesheet.css diff --git a/build.gradle b/build.gradle index 94bed6ed..f36ad8d3 100644 --- a/build.gradle +++ b/build.gradle @@ -104,7 +104,7 @@ configure(subprojects) { subproject -> options.author = true options.header = project.name options.links(project.ext.javadocLinks) -// options.addStringOption('Xdoclint:none', '-quiet') + options.addStringOption('Xdoclint:none', '-quiet') // suppress warnings due to cross-module @see and @link references; // note that global 'api' task does display all warnings. @@ -276,14 +276,22 @@ configure(rootProject) { group = 'Documentation' description = 'Generates aggregated Javadoc API documentation.' title = "${rootProject.description} ${version} API" + + dependsOn { + subprojects.collect { + it.tasks.getByName("jar") + } + } + options.memberLevel = org.gradle.external.javadoc.JavadocMemberLevel.PROTECTED options.author = true options.header = rootProject.description options.overview = 'src/api/overview.html' + options.stylesheetFile = file("src/api/stylesheet.css") options.splitIndex = true - options.links( - 'http://docs.jboss.org/jbossas/javadoc/4.0.5/connector' - ) + options.links(project.ext.javadocLinks) + options.addStringOption('Xdoclint:none', '-quiet') + source subprojects.collect { project -> project.sourceSets.main.allJava } diff --git a/sandbox/src/main/java/org/springframework/ws/soap/stroap/StroapMessageFactory.java b/sandbox/src/main/java/org/springframework/ws/soap/stroap/StroapMessageFactory.java index e942d154..398d3dd2 100644 --- a/sandbox/src/main/java/org/springframework/ws/soap/stroap/StroapMessageFactory.java +++ b/sandbox/src/main/java/org/springframework/ws/soap/stroap/StroapMessageFactory.java @@ -93,8 +93,8 @@ public class StroapMessageFactory implements SoapMessageFactory { /** * Create a {@code XMLInputFactory} that this message factory will use to create {@link * javax.xml.stream.XMLEventReader} objects. - *

- * Can be overridden in subclasses, adding further initialization of the factory. The resulting factory is cached, + * + *

Can be overridden in subclasses, adding further initialization of the factory. The resulting factory is cached, * so this method will only be called once. * * @return the created factory @@ -106,8 +106,8 @@ public class StroapMessageFactory implements SoapMessageFactory { /** * Create a {@code XMLOutputFactory} that this message factory will use to create {@link * javax.xml.stream.XMLEventWriter} objects. - *

- * Can be overridden in subclasses, adding further initialization of the factory. The resulting factory is cached, + * + *

Can be overridden in subclasses, adding further initialization of the factory. The resulting factory is cached, * so this method will only be called once. * * @return the created factory @@ -121,8 +121,8 @@ public class StroapMessageFactory implements SoapMessageFactory { /** * Create a {@code XMLEventFactory} that this message factory will use to create {@link * javax.xml.stream.events.XMLEvent} objects. - *

- * Can be overridden in subclasses, adding further initialization of the factory. The resulting factory is cached, + * + *

Can be overridden in subclasses, adding further initialization of the factory. The resulting factory is cached, * so this method will only be called once. * * @return the created factory @@ -133,8 +133,8 @@ public class StroapMessageFactory implements SoapMessageFactory { /** * Create a {@code DocumentBuilderFactory} that this message factory will use to create {@link org.w3c.dom.Document} objects. - *

- * Can be overridden in subclasses, adding further initialization of the factory. The resulting factory is cached, + * + *

Can be overridden in subclasses, adding further initialization of the factory. The resulting factory is cached, * so this method will only be called once. * * @return the created factory diff --git a/spring-ws-core/src/main/java/org/springframework/ws/FaultAwareWebServiceMessage.java b/spring-ws-core/src/main/java/org/springframework/ws/FaultAwareWebServiceMessage.java index b31a2513..087abc15 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/FaultAwareWebServiceMessage.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/FaultAwareWebServiceMessage.java @@ -29,7 +29,7 @@ public interface FaultAwareWebServiceMessage extends WebServiceMessage { /** * Does this message have a fault? * - * @return true if the message has a fault. + * @return {@code true} if the message has a fault. * @see #getFaultReason() */ boolean hasFault(); @@ -37,7 +37,7 @@ public interface FaultAwareWebServiceMessage extends WebServiceMessage { /** * Returns the fault reason message. * - * @return the fault reason message, if any; returns null when no fault is present. + * @return the fault reason message, if any; returns {@code null} when no fault is present. * @see #hasFault() */ String getFaultReason(); diff --git a/spring-ws-core/src/main/java/org/springframework/ws/WebServiceException.java b/spring-ws-core/src/main/java/org/springframework/ws/WebServiceException.java index d2c96455..80d6d91b 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/WebServiceException.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/WebServiceException.java @@ -27,7 +27,7 @@ import org.springframework.core.NestedRuntimeException; public abstract class WebServiceException extends NestedRuntimeException { /** - * Create a new instance of the WebServiceException class. + * Create a new instance of the {@code WebServiceException} class. * * @param msg the detail message */ @@ -36,7 +36,7 @@ public abstract class WebServiceException extends NestedRuntimeException { } /** - * Create a new instance of the WebServiceException class. + * Create a new instance of the {@code WebServiceException} class. * * @param msg the detail message * @param ex the root {@link Throwable exception} diff --git a/spring-ws-core/src/main/java/org/springframework/ws/WebServiceMessage.java b/spring-ws-core/src/main/java/org/springframework/ws/WebServiceMessage.java index 150709e2..93bb09e6 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/WebServiceMessage.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/WebServiceMessage.java @@ -23,7 +23,7 @@ import javax.xml.transform.Source; /** * Represents a protocol-agnostic XML message. - *

+ * *

Contains methods that provide access to the payload of the message. * * @author Arjen Poutsma @@ -34,8 +34,10 @@ import javax.xml.transform.Source; public interface WebServiceMessage { /** - * Returns the contents of the message as a {@link Source}.

Depending on the implementation, this can be - * retrieved multiple times, or just a single time. + * Returns the contents of the message as a {@link Source}. + * + *

Depending on the implementation, this can be retrieved multiple times, or just + * a single time. * * @return the message contents */ @@ -43,10 +45,10 @@ public interface WebServiceMessage { /** * Returns the contents of the message as a {@link Result}. - *

- * Calling this method removes the current payload. - *

- * Implementations that are read-only will throw an {@link UnsupportedOperationException}. + * + *

Calling this method removes the current payload. + * + *

Implementations that are read-only will throw an {@link UnsupportedOperationException}. * * @return the message contents * @throws UnsupportedOperationException if the message is read-only diff --git a/spring-ws-core/src/main/java/org/springframework/ws/WebServiceMessageException.java b/spring-ws-core/src/main/java/org/springframework/ws/WebServiceMessageException.java index eb13c4a7..f0db261f 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/WebServiceMessageException.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/WebServiceMessageException.java @@ -24,12 +24,12 @@ package org.springframework.ws; */ public abstract class WebServiceMessageException extends WebServiceException { - /** Constructor for WebServiceMessageException. */ + /** Constructor for {@code WebServiceMessageException}. */ public WebServiceMessageException(String msg) { super(msg); } - /** Constructor for WebServiceMessageException. */ + /** Constructor for {@code WebServiceMessageException}. */ public WebServiceMessageException(String msg, Throwable ex) { super(msg, ex); } diff --git a/spring-ws-core/src/main/java/org/springframework/ws/WebServiceMessageFactory.java b/spring-ws-core/src/main/java/org/springframework/ws/WebServiceMessageFactory.java index c6d7ee06..218da113 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/WebServiceMessageFactory.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/WebServiceMessageFactory.java @@ -20,10 +20,10 @@ import java.io.IOException; import java.io.InputStream; /** - * The WebServiceMessageFactory serves as a factory for {@link org.springframework.ws.WebServiceMessage + * The {@code WebServiceMessageFactory} serves as a factory for {@link org.springframework.ws.WebServiceMessage * WebServiceMessages}. - *

- *

Allows the creation of empty messages, or messages based on InputStreams. + * + *

Allows the creation of empty messages, or messages based on {@code InputStream}s. * * @author Arjen Poutsma * @see org.springframework.ws.WebServiceMessage @@ -32,7 +32,7 @@ import java.io.InputStream; public interface WebServiceMessageFactory { /** - * Creates a new, empty WebServiceMessage. + * Creates a new, empty {@code WebServiceMessage}. * * @return the empty message */ @@ -40,8 +40,8 @@ public interface WebServiceMessageFactory { /** * Reads a {@link WebServiceMessage} from the given input stream. - *

- * If the given stream is an instance of {@link org.springframework.ws.transport.TransportInputStream + * + *

If the given stream is an instance of {@link org.springframework.ws.transport.TransportInputStream * TransportInputStream}, the headers will be read from the request. * * @param inputStream the input stream to read the message from diff --git a/spring-ws-core/src/main/java/org/springframework/ws/client/WebServiceClientException.java b/spring-ws-core/src/main/java/org/springframework/ws/client/WebServiceClientException.java index 3f54e093..74c3e314 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/client/WebServiceClientException.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/client/WebServiceClientException.java @@ -27,7 +27,7 @@ import org.springframework.ws.WebServiceException; public abstract class WebServiceClientException extends WebServiceException { /** - * Create a new instance of the WebServiceClientException class. + * Create a new instance of the {@code WebServiceClientException} class. * * @param msg the detail message */ @@ -36,7 +36,7 @@ public abstract class WebServiceClientException extends WebServiceException { } /** - * Create a new instance of the WebServiceClientException class. + * Create a new instance of the {@code WebServiceClientException} class. * * @param msg the detail message * @param ex the root {@link Throwable exception} diff --git a/spring-ws-core/src/main/java/org/springframework/ws/client/WebServiceFaultException.java b/spring-ws-core/src/main/java/org/springframework/ws/client/WebServiceFaultException.java index 4e8086e6..8d3240c6 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/client/WebServiceFaultException.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/client/WebServiceFaultException.java @@ -19,7 +19,7 @@ package org.springframework.ws.client; import org.springframework.ws.FaultAwareWebServiceMessage; /** - * Thrown by SimpleFaultMessageResolver when the response message has a fault. + * Thrown by {@code SimpleFaultMessageResolver} when the response message has a fault. * * @author Arjen Poutsma * @since 1.0.0 @@ -28,14 +28,14 @@ public class WebServiceFaultException extends WebServiceClientException { private final FaultAwareWebServiceMessage faultMessage; - /** Create a new instance of the WebServiceFaultException class. */ + /** Create a new instance of the {@code WebServiceFaultException} class. */ public WebServiceFaultException(String msg) { super(msg); faultMessage = null; } /** - * Create a new instance of the WebServiceFaultException class. + * Create a new instance of the {@code WebServiceFaultException} class. * * @param faultMessage the fault message */ diff --git a/spring-ws-core/src/main/java/org/springframework/ws/client/WebServiceIOException.java b/spring-ws-core/src/main/java/org/springframework/ws/client/WebServiceIOException.java index 14d39491..85dc21db 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/client/WebServiceIOException.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/client/WebServiceIOException.java @@ -27,7 +27,7 @@ import java.io.IOException; public class WebServiceIOException extends WebServiceClientException { /** - * Create a new instance of the WebServiceIOException class. + * Create a new instance of the {@code WebServiceIOException} class. * * @param msg the detail message */ @@ -36,7 +36,7 @@ public class WebServiceIOException extends WebServiceClientException { } /** - * Create a new instance of the WebServiceIOException class. + * Create a new instance of the {@code WebServiceIOException} class. * * @param msg the detail message * @param ex the root {@link IOException} diff --git a/spring-ws-core/src/main/java/org/springframework/ws/client/WebServiceTransformerException.java b/spring-ws-core/src/main/java/org/springframework/ws/client/WebServiceTransformerException.java index fd2ff1fc..7ccdc460 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/client/WebServiceTransformerException.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/client/WebServiceTransformerException.java @@ -27,7 +27,7 @@ import javax.xml.transform.TransformerException; public class WebServiceTransformerException extends WebServiceClientException { /** - * Create a new instance of the WebServiceTransformerException class. + * Create a new instance of the {@code WebServiceTransformerException} class. * * @param msg the detail message */ @@ -36,7 +36,7 @@ public class WebServiceTransformerException extends WebServiceClientException { } /** - * Create a new instance of the WebServiceTransformerException class. + * Create a new instance of the {@code WebServiceTransformerException} class. * * @param msg the detail message * @param ex the root {@link Throwable exception} diff --git a/spring-ws-core/src/main/java/org/springframework/ws/client/WebServiceTransportException.java b/spring-ws-core/src/main/java/org/springframework/ws/client/WebServiceTransportException.java index 75a2a7f4..563b9311 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/client/WebServiceTransportException.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/client/WebServiceTransportException.java @@ -27,7 +27,7 @@ import org.springframework.ws.transport.TransportException; public class WebServiceTransportException extends WebServiceIOException { /** - * Create a new instance of the WebServiceTransportException class. + * Create a new instance of the {@code WebServiceTransportException} class. * * @param msg the detail message */ @@ -36,7 +36,7 @@ public class WebServiceTransportException extends WebServiceIOException { } /** - * Create a new instance of the WebServiceTransportException class. + * Create a new instance of the {@code WebServiceTransportException} class. * * @param msg the detail message * @param ex the root {@link TransportException} diff --git a/spring-ws-core/src/main/java/org/springframework/ws/client/core/SimpleFaultMessageResolver.java b/spring-ws-core/src/main/java/org/springframework/ws/client/core/SimpleFaultMessageResolver.java index f5908ed1..63f931cc 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/client/core/SimpleFaultMessageResolver.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/client/core/SimpleFaultMessageResolver.java @@ -29,7 +29,7 @@ import org.springframework.ws.client.WebServiceFaultException; */ public class SimpleFaultMessageResolver implements FaultMessageResolver { - /** Throws a new WebServiceFaultException. */ + /** Throws a new {@code WebServiceFaultException}. */ @Override public void resolveFault(WebServiceMessage message) { if (message instanceof FaultAwareWebServiceMessage) { diff --git a/spring-ws-core/src/main/java/org/springframework/ws/client/core/SourceExtractor.java b/spring-ws-core/src/main/java/org/springframework/ws/client/core/SourceExtractor.java index f24867b4..7a6db967 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/client/core/SourceExtractor.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/client/core/SourceExtractor.java @@ -22,13 +22,13 @@ import javax.xml.transform.TransformerException; /** * Callback interface for extracting a result object from a {@link javax.xml.transform.Source} instance. - *

- * Used for output object creation in {@link WebServiceTemplate}. Alternatively, output sources can also be returned to + * + *

Used for output object creation in {@link WebServiceTemplate}. Alternatively, output sources can also be returned to * client code as-is. In case of a source as execution result, you will almost always want to implement a - * SourceExtractor, to be able to read the message content in a managed fashion, with the connection still + * {@code SourceExtractor}, to be able to read the message content in a managed fashion, with the connection still * open while reading the message. - *

- * Implementations of this interface perform the actual work of extracting results, but don't need to worry about + * + *

Implementations of this interface perform the actual work of extracting results, but don't need to worry about * exception handling, or resource handling. * * @author Arjen Poutsma @@ -38,10 +38,10 @@ import javax.xml.transform.TransformerException; public interface SourceExtractor { /** - * Process the data in the given Source, creating a corresponding result object. + * Process the data in the given {@code Source}, creating a corresponding result object. * * @param source the message payload to extract data from - * @return an arbitrary result object, or null if none (the extractor will typically be stateful in the + * @return an arbitrary result object, or {@code null} if none (the extractor will typically be stateful in the * latter case) * @throws IOException in case of I/O errors */ diff --git a/spring-ws-core/src/main/java/org/springframework/ws/client/core/WebServiceMessageCallback.java b/spring-ws-core/src/main/java/org/springframework/ws/client/core/WebServiceMessageCallback.java index df52dea0..a8142898 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/client/core/WebServiceMessageCallback.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/client/core/WebServiceMessageCallback.java @@ -23,9 +23,9 @@ import org.springframework.ws.WebServiceMessage; /** * Generic callback interface for code that operates on a {@link WebServiceMessage}. - *

- * Implementations can execute any number of operations on the message, such as set the contents of the message, or set - * the SOAPAction header. + * + *

Implementations can execute any number of operations on the message, such as set the contents of the message, or set + * the {@code SOAPAction} header. * * @author Arjen Poutsma * @since 1.0.0 @@ -33,7 +33,7 @@ import org.springframework.ws.WebServiceMessage; public interface WebServiceMessageCallback { /** - * Execute any number of operations on the supplied message. + * Execute any number of operations on the supplied {@code message}. * * @param message the message * @throws IOException in case of I/O errors diff --git a/spring-ws-core/src/main/java/org/springframework/ws/client/core/WebServiceMessageExtractor.java b/spring-ws-core/src/main/java/org/springframework/ws/client/core/WebServiceMessageExtractor.java index 49271723..bd168b6d 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/client/core/WebServiceMessageExtractor.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/client/core/WebServiceMessageExtractor.java @@ -23,13 +23,13 @@ import org.springframework.ws.WebServiceMessage; /** * Callback interface for extracting a result object from a {@link WebServiceMessage} instance. - *

- * Used for output object creation in {@link WebServiceTemplate}. Alternatively, output messages can also be returned to + * + *

Used for output object creation in {@link WebServiceTemplate}. Alternatively, output messages can also be returned to * client code as-is. In case of a message as execution result, you will almost always want to implement a - * WebServiceMessageExtractor, to be able to read the message in a managed fashion, with the connection + * {@code WebServiceMessageExtractor}, to be able to read the message in a managed fashion, with the connection * still open while reading the message. - *

- * Implementations of this interface perform the actual work of extracting results, but don't need to worry about + * + *

Implementations of this interface perform the actual work of extracting results, but don't need to worry about * exception handling, or resource handling. * * @author Arjen Poutsma @@ -38,10 +38,10 @@ import org.springframework.ws.WebServiceMessage; public interface WebServiceMessageExtractor { /** - * Process the data in the given WebServiceMessage, creating a corresponding result object. + * Process the data in the given {@code WebServiceMessage}, creating a corresponding result object. * - * @param message the message to extract data from (possibly a SoapMessage) - * @return an arbitrary result object, or null if none (the extractor will typically be stateful in the + * @param message the message to extract data from (possibly a {@code SoapMessage}) + * @return an arbitrary result object, or {@code null} if none (the extractor will typically be stateful in the * latter case) * @throws IOException in case of I/O errors * @throws TransformerException in case of transformation errors diff --git a/spring-ws-core/src/main/java/org/springframework/ws/client/core/WebServiceOperations.java b/spring-ws-core/src/main/java/org/springframework/ws/client/core/WebServiceOperations.java index 0bd4618d..9b06b08f 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/client/core/WebServiceOperations.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/client/core/WebServiceOperations.java @@ -34,13 +34,13 @@ public interface WebServiceOperations { /** * Sends a web service message that can be manipulated with the given callback, reading the result with a - * WebServiceMessageExtractor. - *

- * This will only work with a default uri specified! + * {@code WebServiceMessageExtractor}. + * + *

This will only work with a default uri specified! * * @param requestCallback the requestCallback to be used for manipulating the request message * @param responseExtractor object that will extract results - * @return an arbitrary result object, as returned by the WebServiceMessageExtractor + * @return an arbitrary result object, as returned by the {@code WebServiceMessageExtractor} * @throws WebServiceClientException if there is a problem sending or receiving the message */ T sendAndReceive(WebServiceMessageCallback requestCallback, WebServiceMessageExtractor responseExtractor) @@ -48,12 +48,12 @@ public interface WebServiceOperations { /** * Sends a web service message that can be manipulated with the given callback, reading the result with a - * WebServiceMessageExtractor. + * {@code WebServiceMessageExtractor}. * * @param uri the URI to send the message to * @param requestCallback the requestCallback to be used for manipulating the request message * @param responseExtractor object that will extract results - * @return an arbitrary result object, as returned by the WebServiceMessageExtractor + * @return an arbitrary result object, as returned by the {@code WebServiceMessageExtractor} * @throws WebServiceClientException if there is a problem sending or receiving the message */ T sendAndReceive(String uri, @@ -63,12 +63,12 @@ public interface WebServiceOperations { /** * Sends a web service message that can be manipulated with the given request callback, handling the response with a * response callback. - *

- * This will only work with a default uri specified! + * + *

This will only work with a default uri specified! * * @param requestCallback the callback to be used for manipulating the request message * @param responseCallback the callback to be used for manipulating the response message - * @return true if a response was received; false otherwise + * @return {@code true} if a response was received; {@code false} otherwise * @throws WebServiceClientException if there is a problem sending or receiving the message */ boolean sendAndReceive(WebServiceMessageCallback requestCallback, WebServiceMessageCallback responseCallback) @@ -81,7 +81,7 @@ public interface WebServiceOperations { * @param uri the URI to send the message to * @param requestCallback the callback to be used for manipulating the request message * @param responseCallback the callback to be used for manipulating the response message - * @return true if a response was received; false otherwise + * @return {@code true} if a response was received; {@code false} otherwise * @throws WebServiceClientException if there is a problem sending or receiving the message */ boolean sendAndReceive(String uri, @@ -94,12 +94,12 @@ public interface WebServiceOperations { /** * Sends a web service message that contains the given payload, marshalled by the configured - * Marshaller. Returns the unmarshalled payload of the response message, if any. - *

- * This will only work with a default uri specified! + * {@code Marshaller}. Returns the unmarshalled payload of the response message, if any. + * + *

This will only work with a default uri specified! * * @param requestPayload the object to marshal into the request message payload - * @return the unmarshalled payload of the response message, or null if no response is given + * @return the unmarshalled payload of the response message, or {@code null} if no response is given * @throws XmlMappingException if there is a problem marshalling or unmarshalling * @throws WebServiceClientException if there is a problem sending or receiving the message * @see WebServiceTemplate#setMarshaller(org.springframework.oxm.Marshaller) @@ -109,11 +109,11 @@ public interface WebServiceOperations { /** * Sends a web service message that contains the given payload, marshalled by the configured - * Marshaller. Returns the unmarshalled payload of the response message, if any. + * {@code Marshaller}. Returns the unmarshalled payload of the response message, if any. * * @param uri the URI to send the message to * @param requestPayload the object to marshal into the request message payload - * @return the unmarshalled payload of the response message, or null if no response is given + * @return the unmarshalled payload of the response message, or {@code null} if no response is given * @throws XmlMappingException if there is a problem marshalling or unmarshalling * @throws WebServiceClientException if there is a problem sending or receiving the message * @see WebServiceTemplate#setMarshaller(org.springframework.oxm.Marshaller) @@ -124,14 +124,14 @@ public interface WebServiceOperations { /** * Sends a web service message that contains the given payload, marshalled by the configured - * Marshaller. Returns the unmarshalled payload of the response message, if any. The given callback + * {@code Marshaller}. Returns the unmarshalled payload of the response message, if any. The given callback * allows changing of the request message after the payload has been marshalled to it. - *

- * This will only work with a default uri specified! + * + *

This will only work with a default uri specified! * * @param requestPayload the object to marshal into the request message payload - * @param requestCallback callback to change message, can be null - * @return the unmarshalled payload of the response message, or null if no response is given + * @param requestCallback callback to change message, can be {@code null} + * @return the unmarshalled payload of the response message, or {@code null} if no response is given * @throws XmlMappingException if there is a problem marshalling or unmarshalling * @throws WebServiceClientException if there is a problem sending or receiving the message * @see WebServiceTemplate#setMarshaller(org.springframework.oxm.Marshaller) @@ -142,13 +142,13 @@ public interface WebServiceOperations { /** * Sends a web service message that contains the given payload, marshalled by the configured - * Marshaller. Returns the unmarshalled payload of the response message, if any. The given callback + * {@code Marshaller}. Returns the unmarshalled payload of the response message, if any. The given callback * allows changing of the request message after the payload has been marshalled to it. * * @param uri the URI to send the message to * @param requestPayload the object to marshal into the request message payload - * @param requestCallback callback to change message, can be null - * @return the unmarshalled payload of the response message, or null if no response is given + * @param requestCallback callback to change message, can be {@code null} + * @return the unmarshalled payload of the response message, or {@code null} if no response is given * @throws XmlMappingException if there is a problem marshalling or unmarshalling * @throws WebServiceClientException if there is a problem sending or receiving the message * @see WebServiceTemplate#setMarshaller(org.springframework.oxm.Marshaller) @@ -163,13 +163,13 @@ public interface WebServiceOperations { /** * Sends a web service message that contains the given payload, reading the result with a - * SourceExtractor. - *

- * This will only work with a default uri specified! + * {@code SourceExtractor}. + * + *

This will only work with a default uri specified! * * @param requestPayload the payload of the request message * @param responseExtractor object that will extract results - * @return an arbitrary result object, as returned by the SourceExtractor + * @return an arbitrary result object, as returned by the {@code SourceExtractor} * @throws WebServiceClientException if there is a problem sending or receiving the message */ T sendSourceAndReceive(Source requestPayload, SourceExtractor responseExtractor) @@ -177,12 +177,12 @@ public interface WebServiceOperations { /** * Sends a web service message that contains the given payload, reading the result with a - * SourceExtractor. + * {@code SourceExtractor}. * * @param uri the URI to send the message to * @param requestPayload the payload of the request message * @param responseExtractor object that will extract results - * @return an arbitrary result object, as returned by the SourceExtractor + * @return an arbitrary result object, as returned by the {@code SourceExtractor} * @throws WebServiceClientException if there is a problem sending or receiving the message */ T sendSourceAndReceive(String uri, Source requestPayload, SourceExtractor responseExtractor) @@ -190,16 +190,16 @@ public interface WebServiceOperations { /** * Sends a web service message that contains the given payload, reading the result with a - * SourceExtractor. - *

- * The given callback allows changing of the request message after the payload has been written to it. - *

- * This will only work with a default uri specified! + * {@code SourceExtractor}. + * + *

The given callback allows changing of the request message after the payload has been written to it. + * + *

This will only work with a default uri specified! * * @param requestPayload the payload of the request message - * @param requestCallback callback to change message, can be null + * @param requestCallback callback to change message, can be {@code null} * @param responseExtractor object that will extract results - * @return an arbitrary result object, as returned by the SourceExtractor + * @return an arbitrary result object, as returned by the {@code SourceExtractor} * @throws WebServiceClientException if there is a problem sending or receiving the message */ T sendSourceAndReceive(Source requestPayload, @@ -208,15 +208,15 @@ public interface WebServiceOperations { /** * Sends a web service message that contains the given payload, reading the result with a - * SourceExtractor. - *

- * The given callback allows changing of the request message after the payload has been written to it. + * {@code SourceExtractor}. + * + *

The given callback allows changing of the request message after the payload has been written to it. * * @param uri the URI to send the message to * @param requestPayload the payload of the request message - * @param requestCallback callback to change message, can be null + * @param requestCallback callback to change message, can be {@code null} * @param responseExtractor object that will extract results - * @return an arbitrary result object, as returned by the SourceExtractor + * @return an arbitrary result object, as returned by the {@code SourceExtractor} * @throws WebServiceClientException if there is a problem sending or receiving the message */ T sendSourceAndReceive(String uri, @@ -230,25 +230,25 @@ public interface WebServiceOperations { /** * Sends a web service message that contains the given payload. Writes the response, if any, to the given - * Result. - *

- * This will only work with a default uri specified! + * {@code Result}. + * + *

This will only work with a default uri specified! * * @param requestPayload the payload of the request message * @param responseResult the result to write the response payload to - * @return true if a response was received; false otherwise + * @return {@code true} if a response was received; {@code false} otherwise * @throws WebServiceClientException if there is a problem sending or receiving the message */ boolean sendSourceAndReceiveToResult(Source requestPayload, Result responseResult) throws WebServiceClientException; /** * Sends a web service message that contains the given payload. Writes the response, if any, to the given - * Result. + * {@code Result}. * * @param uri the URI to send the message to * @param requestPayload the payload of the request message * @param responseResult the result to write the response payload to - * @return true if a response was received; false otherwise + * @return {@code true} if a response was received; {@code false} otherwise * @throws WebServiceClientException if there is a problem sending or receiving the message */ boolean sendSourceAndReceiveToResult(String uri, Source requestPayload, Result responseResult) @@ -256,16 +256,16 @@ public interface WebServiceOperations { /** * Sends a web service message that contains the given payload. Writes the response, if any, to the given - * Result. - *

- * The given callback allows changing of the request message after the payload has been written to it. - *

- * This will only work with a default uri specified! + * {@code Result}. + * + *

The given callback allows changing of the request message after the payload has been written to it. + * + *

This will only work with a default uri specified! * * @param requestPayload the payload of the request message - * @param requestCallback callback to change message, can be null + * @param requestCallback callback to change message, can be {@code null} * @param responseResult the result to write the response payload to - * @return true if a response was received; false otherwise + * @return {@code true} if a response was received; {@code false} otherwise * @throws WebServiceClientException if there is a problem sending or receiving the message */ boolean sendSourceAndReceiveToResult(Source requestPayload, @@ -274,15 +274,15 @@ public interface WebServiceOperations { /** * Sends a web service message that contains the given payload. Writes the response, if any, to the given - * Result. - *

- * The given callback allows changing of the request message after the payload has been written to it. + * {@code Result}. + * + *

The given callback allows changing of the request message after the payload has been written to it. * * @param uri the URI to send the message to * @param requestPayload the payload of the request message - * @param requestCallback callback to change message, can be null + * @param requestCallback callback to change message, can be {@code null} * @param responseResult the result to write the response payload to - * @return true if a response was received; false otherwise + * @return {@code true} if a response was received; {@code false} otherwise * @throws WebServiceClientException if there is a problem sending or receiving the message */ boolean sendSourceAndReceiveToResult(String uri, diff --git a/spring-ws-core/src/main/java/org/springframework/ws/client/core/WebServiceTemplate.java b/spring-ws-core/src/main/java/org/springframework/ws/client/core/WebServiceTemplate.java index c087facf..5d931492 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/client/core/WebServiceTemplate.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/client/core/WebServiceTemplate.java @@ -62,33 +62,33 @@ import org.springframework.ws.transport.support.TransportUtils; /** * The central class for client-side Web services. It provides a message-driven approach to sending and * receiving {@link WebServiceMessage} instances. - *

- * Code using this class need only implement callback interfaces, provide {@link Source} objects to read data from, or + * + *

Code using this class need only implement callback interfaces, provide {@link Source} objects to read data from, or * use the pluggable {@link Marshaller} support. For invoking the {@link #marshalSendAndReceive marshalling methods}, * the {@link #setMarshaller(Marshaller) marshaller} and {@link #setUnmarshaller(Unmarshaller) unmarshaller} properties * must be set. - *

- * This template uses a {@link SoapFaultMessageResolver} to handle fault response messages. Another {@link + * + *

This template uses a {@link SoapFaultMessageResolver} to handle fault response messages. Another {@link * FaultMessageResolver} can be defined with with {@link #setFaultMessageResolver(FaultMessageResolver) - * faultMessageResolver} property. If this property is set to null, no fault resolving is performed. - *

- * This template uses the following algorithm for sending and receiving.

  1. Call {@link #createConnection(URI) + * faultMessageResolver} property. If this property is set to {@code null}, no fault resolving is performed. + * + *

    This template uses the following algorithm for sending and receiving.

    1. Call {@link #createConnection(URI) * createConnection()}.
    2. Call {@link WebServiceMessageFactory#createWebServiceMessage() * createWebServiceMessage()} on the registered message factory to create a request message.
    3. Invoke {@link * WebServiceMessageCallback#doWithMessage(WebServiceMessage) doWithMessage()} on the request callback, if any. This - * step stores content in the request message, based on Source, marshalling, etc.
    4. Invoke {@link + * step stores content in the request message, based on {@code Source}, marshalling, etc.
    5. Invoke {@link * ClientInterceptor#handleRequest(MessageContext) handleRequest()} on the registered {@link * #setInterceptors(ClientInterceptor[]) interceptors}. Interceptors are executed in order. If any of the interceptors * creates a response message in the message context, skip to step 7.
    6. Call {@link * WebServiceConnection#send(WebServiceMessage) send()} on the connection.
    7. Call {@link * #hasError(WebServiceConnection,WebServiceMessage) hasError()} to check if the connection has an error. For an HTTP - * transport, a status code other than 2xx indicates an error. However, since a status code of 500 can also + * 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.
      • If the connection has an * error, call the {@link #handleError handleError()} method, which by default throws a {@link * WebServiceTransportException}.
      • If the connection has no error, continue with the next step.
      *
    8. Invoke {@link WebServiceConnection#receive(WebServiceMessageFactory) receive} on the connection to read the - * response message, if any.
      • If no response was received, return null or - * false
      • Call {@link #hasFault(WebServiceConnection,WebServiceMessage) hasFault()} to determine + * response message, if any.
        • If no response was received, return {@code null} or + * {@code false}
        • Call {@link #hasFault(WebServiceConnection,WebServiceMessage) hasFault()} to determine * whether the response has a fault. If it has, call {@link ClientInterceptor#handleFault(MessageContext)} and the * {@link #handleFault handleFault()} method.
        • Otherwise, invoke {@link ClientInterceptor#handleResponse(MessageContext)} * and {@link WebServiceMessageExtractor#extractData(WebServiceMessage) extractData()} on the response extractor, or @@ -125,13 +125,13 @@ public class WebServiceTemplate extends WebServiceAccessor implements WebService private DestinationProvider destinationProvider; - /** Creates a new WebServiceTemplate using default settings. */ + /** Creates a new {@code WebServiceTemplate} using default settings. */ public WebServiceTemplate() { initDefaultStrategies(); } /** - * Creates a new WebServiceTemplate based on the given message factory. + * Creates a new {@code WebServiceTemplate} based on the given message factory. * * @param messageFactory the message factory to use */ @@ -141,15 +141,15 @@ public class WebServiceTemplate extends WebServiceAccessor implements WebService } /** - * Creates a new WebServiceTemplate with the given marshaller. If the given {@link + * Creates a new {@code WebServiceTemplate} with the given marshaller. If the given {@link * Marshaller} also implements the {@link Unmarshaller} interface, it is used for both marshalling and * unmarshalling. Otherwise, an exception is thrown. - *

          - * Note that all {@link Marshaller} implementations in Spring also implement the {@link Unmarshaller} interface, + * + *

          Note that all {@link Marshaller} implementations in Spring also implement the {@link Unmarshaller} interface, * so that you can safely use this constructor. * * @param marshaller object used as marshaller and unmarshaller - * @throws IllegalArgumentException when marshaller does not implement the {@link Unmarshaller} + * @throws IllegalArgumentException when {@code marshaller} does not implement the {@link Unmarshaller} * interface * @since 2.0.3 */ @@ -168,7 +168,7 @@ public class WebServiceTemplate extends WebServiceAccessor implements WebService } /** - * Creates a new MarshallingMethodEndpointAdapter with the given marshaller and unmarshaller. + * Creates a new {@code MarshallingMethodEndpointAdapter} with the given marshaller and unmarshaller. * * @param marshaller the marshaller to use * @param unmarshaller the unmarshaller to use @@ -195,8 +195,8 @@ public class WebServiceTemplate extends WebServiceAccessor implements WebService /** * Set the default URI to be used on operations that do not have a URI parameter. - *

          - * Typically, either this property is set, or {@link #setDestinationProvider(DestinationProvider)}, but not both. + * + *

          Typically, either this property is set, or {@link #setDestinationProvider(DestinationProvider)}, but not both. * * @see #marshalSendAndReceive(Object) * @see #marshalSendAndReceive(Object,WebServiceMessageCallback) @@ -222,8 +222,8 @@ public class WebServiceTemplate extends WebServiceAccessor implements WebService /** * Set the destination provider URI to be used on operations that do not have a URI parameter. - *

          - * Typically, either this property is set, or {@link #setDefaultUri(String)}, but not both. + * + *

          Typically, either this property is set, or {@link #setDefaultUri(String)}, but not both. * * @see #marshalSendAndReceive(Object) * @see #marshalSendAndReceive(Object,WebServiceMessageCallback) @@ -264,7 +264,7 @@ public class WebServiceTemplate extends WebServiceAccessor implements WebService /** * Sets the fault resolver for this template. Default is the - * {@link org.springframework.ws.soap.client.core.SoapFaultMessageResolver, SoapFaultMessageResolver}, but may be + * {@link org.springframework.ws.soap.client.core.SoapFaultMessageResolver SoapFaultMessageResolver}, but may be * set to {@code null} to disable fault handling. */ public void setFaultMessageResolver(FaultMessageResolver faultMessageResolver) { @@ -273,12 +273,12 @@ public class WebServiceTemplate extends WebServiceAccessor implements WebService /** * Indicates whether the {@linkplain WebServiceConnection#hasError() connection} should be checked for error - * indicators (true), or whether these should be ignored (false). The default is - * true. - *

          - * When using an HTTP transport, this property defines whether to check the HTTP response status code is in the 2xx + * indicators ({@code true}), or whether these should be ignored ({@code false}). The default is + * {@code true}. + * + *

          When using an HTTP transport, this property defines whether to check the HTTP response status code is in the 2xx * Successful range. Both the SOAP specification and the WS-I Basic Profile define that a Web service must return a - * "200 OK" or "202 Accepted" HTTP status code for a normal response. Setting this property to false + * "200 OK" or "202 Accepted" HTTP status code for a normal response. Setting this property to {@code false} * allows this template to deal with non-conforming services. * * @see #hasError(WebServiceConnection, WebServiceMessage) @@ -292,13 +292,13 @@ public class WebServiceTemplate extends WebServiceAccessor implements WebService /** * Indicates whether the {@linkplain FaultAwareWebServiceConnection#hasFault() connection} should be checked for - * fault indicators (true), or whether we should rely on the {@link - * FaultAwareWebServiceMessage#hasFault() message} only (false). The default is true. - *

          - * When using an HTTP transport, this property defines whether to check the HTTP response status code for fault + * fault indicators ({@code true}), or whether we should rely on the {@link + * FaultAwareWebServiceMessage#hasFault() message} only ({@code false}). The default is {@code true}. + * + *

          When using an HTTP transport, this property defines whether to check the HTTP response status code for fault * indicators. Both the SOAP specification and the WS-I Basic Profile define that a Web service must return a "500 * Internal Server Error" HTTP status code if the response envelope is a Fault. Setting this property to - * false allows this template to deal with non-conforming services. + * {@code false} allows this template to deal with non-conforming services. * * @see #hasFault(WebServiceConnection,WebServiceMessage) * @see SOAP 1.1 specification @@ -312,7 +312,7 @@ public class WebServiceTemplate extends WebServiceAccessor implements WebService /** * Returns the client interceptors to apply to all web service invocations made by this template. * - * @return array of endpoint interceptors, or null if none + * @return array of endpoint interceptors, or {@code null} if none */ public ClientInterceptor[] getInterceptors() { return interceptors; @@ -321,7 +321,7 @@ public class WebServiceTemplate extends WebServiceAccessor implements WebService /** * Sets the client interceptors to apply to all web service invocations made by this template. * - * @param interceptors array of endpoint interceptors, or null if none + * @param interceptors array of endpoint interceptors, or {@code null} if none */ public final void setInterceptors(ClientInterceptor[] interceptors) { this.interceptors = interceptors; @@ -575,7 +575,7 @@ public class WebServiceTemplate extends WebServiceAccessor implements WebService * @param connection the connection to use * @param requestCallback the requestCallback to be used for manipulating the request message * @param responseExtractor object that will extract results - * @return an arbitrary result object, as returned by the WebServiceMessageExtractor + * @return an arbitrary result object, as returned by the {@code WebServiceMessageExtractor} * @throws WebServiceClientException if there is a problem sending or receiving the message * @throws IOException in case of I/O errors */ @@ -656,13 +656,13 @@ public class WebServiceTemplate extends WebServiceAccessor implements WebService /** * Determines whether the given connection or message context has an error. - *

          - * This implementation checks the {@link WebServiceConnection#hasError() connection} first. If it indicates an + * + *

          This implementation checks the {@link WebServiceConnection#hasError() connection} first. If it indicates an * error, it makes sure that it is not a {@link FaultAwareWebServiceConnection#hasFault() fault}. * * @param connection the connection (possibly a {@link FaultAwareWebServiceConnection} * @param request the response message (possibly a {@link FaultAwareWebServiceMessage} - * @return true if the connection has an error; false otherwise + * @return {@code true} if the connection has an error; {@code false} otherwise * @throws IOException in case of I/O errors */ protected boolean hasError(WebServiceConnection connection, WebServiceMessage request) throws IOException { @@ -722,14 +722,14 @@ public class WebServiceTemplate extends WebServiceAccessor implements WebService /** * Determines whether the given connection or message has a fault. - *

          - * This implementation checks the {@link FaultAwareWebServiceConnection#hasFault() connection} if the {@link + * + *

          This implementation checks the {@link FaultAwareWebServiceConnection#hasFault() connection} if the {@link * #setCheckConnectionForFault(boolean) checkConnectionForFault} property is true, and defaults to the {@link * FaultAwareWebServiceMessage#hasFault() message} otherwise. * * @param connection the connection (possibly a {@link FaultAwareWebServiceConnection} * @param response the response message (possibly a {@link FaultAwareWebServiceMessage} - * @return true if either the connection or the message has a fault; false otherwise + * @return {@code true} if either the connection or the message has a fault; {@code false} otherwise * @throws IOException in case of I/O errors */ protected boolean hasFault(WebServiceConnection connection, WebServiceMessage response) throws IOException { @@ -750,8 +750,8 @@ public class WebServiceTemplate extends WebServiceAccessor implements WebService /** * Trigger handleResponse on the defined ClientInterceptors. Will just invoke said method on all interceptors whose - * handleRequest invocation returned true, in addition to the last interceptor who returned - * false. + * handleRequest invocation returned {@code true}, in addition to the last interceptor who returned + * {@code false}. * * @param interceptorIndex index of last interceptor that was called * @param messageContext the message context, whose request and response are filled @@ -770,8 +770,8 @@ public class WebServiceTemplate extends WebServiceAccessor implements WebService /** * Trigger handleFault on the defined ClientInterceptors. Will just invoke said method on all interceptors whose - * handleRequest invocation returned true, in addition to the last interceptor who returned - * false. + * handleRequest invocation returned {@code true}, in addition to the last interceptor who returned + * {@code false}. * * @param interceptorIndex index of last interceptor that was called * @param messageContext the message context, whose request and response are filled @@ -792,10 +792,10 @@ public class WebServiceTemplate extends WebServiceAccessor implements WebService * Trigger afterCompletion callbacks on the mapped ClientInterceptors. Will just * invoke afterCompletion for all interceptors whose handleRequest invocation has * successfully completed and returned true, in addition to the last interceptor who - * returned false. + * returned {@code false}. * @param mappedEndpoint the mapped EndpointInvocationChain * @param interceptorIndex index of last interceptor that successfully completed - * @param ex Exception thrown on handler execution, or null if none + * @param ex Exception thrown on handler execution, or {@code null} if none * @see ClientInterceptor#afterCompletion */ private void triggerAfterCompletion(int interceptorIndex, diff --git a/spring-ws-core/src/main/java/org/springframework/ws/client/core/support/WebServiceGatewaySupport.java b/spring-ws-core/src/main/java/org/springframework/ws/client/core/support/WebServiceGatewaySupport.java index b734bd69..01ca6b5b 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/client/core/support/WebServiceGatewaySupport.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/client/core/support/WebServiceGatewaySupport.java @@ -31,15 +31,15 @@ import org.springframework.ws.transport.WebServiceMessageSender; /** * Convenient super class for application classes that need Web service access. - *

          - * Requires a {@link WebServiceMessageFactory} or a {@link WebServiceTemplate} instance to be set. It will create its - * own WebServiceTemplate if WebServiceMessageFactory is passed in. - *

          - * In addition to the message factory property, this gateway offers {@link Marshaller} and {@link Unmarshaller} + * + *

          Requires a {@link WebServiceMessageFactory} or a {@link WebServiceTemplate} instance to be set. It will create its + * own {@code WebServiceTemplate} if {@code WebServiceMessageFactory} is passed in. + * + *

          In addition to the message factory property, this gateway offers {@link Marshaller} and {@link Unmarshaller} * properties. Setting these is required when the {@link WebServiceTemplate#marshalSendAndReceive(Object) marshalling * methods} of the template are to be used. - *

          - * Note that when {@link #setWebServiceTemplate(WebServiceTemplate) injecting a WebServiceTemplate} + * + *

          Note that when {@link #setWebServiceTemplate(WebServiceTemplate) injecting a {@code WebServiceTemplate}} * directly, the convenience setters ({@link #setMarshaller(Marshaller)}, {@link #setUnmarshaller(Unmarshaller)}, {@link * #setMessageSender(WebServiceMessageSender)}, {@link #setMessageSenders(WebServiceMessageSender[])}, and {@link * #setDefaultUri(String)}) should not be used on this class, but on the template directly. @@ -58,15 +58,15 @@ public abstract class WebServiceGatewaySupport implements InitializingBean { private WebServiceTemplate webServiceTemplate; /** - * Creates a new instance of the WebServiceGatewaySupport class, with a default - * WebServiceTemplate. + * Creates a new instance of the {@code WebServiceGatewaySupport} class, with a default + * {@code WebServiceTemplate}. */ protected WebServiceGatewaySupport() { webServiceTemplate = new WebServiceTemplate(); } /** - * Creates a new WebServiceGatewaySupport instance based on the given message factory. + * Creates a new {@code WebServiceGatewaySupport} instance based on the given message factory. * * @param messageFactory the message factory to use */ @@ -74,12 +74,12 @@ public abstract class WebServiceGatewaySupport implements InitializingBean { webServiceTemplate = new WebServiceTemplate(messageFactory); } - /** Returns the WebServiceMessageFactory used by the gateway. */ + /** Returns the {@code WebServiceMessageFactory} used by the gateway. */ public final WebServiceMessageFactory getMessageFactory() { return webServiceTemplate.getMessageFactory(); } - /** Set the WebServiceMessageFactory to be used by the gateway. */ + /** Set the {@code WebServiceMessageFactory} to be used by the gateway. */ public final void setMessageFactory(WebServiceMessageFactory messageFactory) { webServiceTemplate.setMessageFactory(messageFactory); } @@ -104,30 +104,30 @@ public abstract class WebServiceGatewaySupport implements InitializingBean { webServiceTemplate.setDestinationProvider(destinationProvider); } - /** Sets a single WebServiceMessageSender to be used by the gateway. */ + /** Sets a single {@code WebServiceMessageSender} to be used by the gateway. */ public final void setMessageSender(WebServiceMessageSender messageSender) { webServiceTemplate.setMessageSender(messageSender); } - /** Returns the WebServiceMessageSenders used by the gateway. */ + /** Returns the {@code WebServiceMessageSender}s used by the gateway. */ public final WebServiceMessageSender[] getMessageSenders() { return webServiceTemplate.getMessageSenders(); } - /** Sets multiple WebServiceMessageSender to be used by the gateway. */ + /** Sets multiple {@code WebServiceMessageSender} to be used by the gateway. */ public final void setMessageSenders(WebServiceMessageSender[] messageSenders) { webServiceTemplate.setMessageSenders(messageSenders); } - /** Returns the WebServiceTemplate for the gateway. */ + /** Returns the {@code WebServiceTemplate} for the gateway. */ public final WebServiceTemplate getWebServiceTemplate() { return webServiceTemplate; } /** - * Sets the WebServiceTemplate to be used by the gateway. - *

          - * When using this property, the convenience setters ({@link #setMarshaller(Marshaller)}, {@link + * Sets the {@code WebServiceTemplate} to be used by the gateway. + * + *

          When using this property, the convenience setters ({@link #setMarshaller(Marshaller)}, {@link * #setUnmarshaller(Unmarshaller)}, {@link #setMessageSender(WebServiceMessageSender)}, {@link * #setMessageSenders(WebServiceMessageSender[])}, and {@link #setDefaultUri(String)}) should not be set on this * class, but on the template directly. @@ -137,14 +137,14 @@ public abstract class WebServiceGatewaySupport implements InitializingBean { this.webServiceTemplate = webServiceTemplate; } - /** Returns the Marshaller used by the gateway. */ + /** Returns the {@code Marshaller} used by the gateway. */ public final Marshaller getMarshaller() { return webServiceTemplate.getMarshaller(); } /** - * Sets the Marshaller used by the gateway. Setting this property is only required if the marshalling - * functionality of WebServiceTemplate is to be used. + * Sets the {@code Marshaller} used by the gateway. Setting this property is only required if the marshalling + * functionality of {@code WebServiceTemplate} is to be used. * * @see WebServiceTemplate#marshalSendAndReceive */ @@ -152,14 +152,14 @@ public abstract class WebServiceGatewaySupport implements InitializingBean { webServiceTemplate.setMarshaller(marshaller); } - /** Returns the Unmarshaller used by the gateway. */ + /** Returns the {@code Unmarshaller} used by the gateway. */ public final Unmarshaller getUnmarshaller() { return webServiceTemplate.getUnmarshaller(); } /** - * Sets the Unmarshaller used by the gateway. Setting this property is only required if the marshalling - * functionality of WebServiceTemplate is to be used. + * Sets the {@code Unmarshaller} used by the gateway. Setting this property is only required if the marshalling + * functionality of {@code WebServiceTemplate} is to be used. * * @see WebServiceTemplate#marshalSendAndReceive */ @@ -167,12 +167,12 @@ public abstract class WebServiceGatewaySupport implements InitializingBean { webServiceTemplate.setUnmarshaller(unmarshaller); } - /** Returns the ClientInterceptors used by the template. */ + /** Returns the {@code ClientInterceptors} used by the template. */ public final ClientInterceptor[] getInterceptors() { return webServiceTemplate.getInterceptors(); } - /** Sets the ClientInterceptors used by the gateway. */ + /** Sets the {@code ClientInterceptors} used by the gateway. */ public final void setInterceptors(ClientInterceptor[] interceptors) { webServiceTemplate.setInterceptors(interceptors); } diff --git a/spring-ws-core/src/main/java/org/springframework/ws/client/support/WebServiceAccessor.java b/spring-ws-core/src/main/java/org/springframework/ws/client/support/WebServiceAccessor.java index 9c46c5ab..15fba65d 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/client/support/WebServiceAccessor.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/client/support/WebServiceAccessor.java @@ -28,10 +28,10 @@ import org.springframework.ws.transport.WebServiceMessageSender; import org.springframework.xml.transform.TransformerObjectSupport; /** - * Base class for WebServiceTemplate and other WS-accessing helpers. Defines common properties like the + * Base class for {@code WebServiceTemplate} and other WS-accessing helpers. Defines common properties like the * {@link WebServiceMessageFactory} and {@link WebServiceMessageSender}. - *

          - * Not intended to be used directly. See {@link org.springframework.ws.client.core.WebServiceTemplate}. + * + *

          Not intended to be used directly. See {@link org.springframework.ws.client.core.WebServiceTemplate}. * * @author Arjen Poutsma * @see org.springframework.ws.client.core.WebServiceTemplate @@ -60,8 +60,8 @@ public abstract class WebServiceAccessor extends TransformerObjectSupport implem /** * Sets the single message sender used for sending messages. - *

          - * This message sender will be used to resolve an URI to a {@link WebServiceConnection}. + * + *

          This message sender will be used to resolve an URI to a {@link WebServiceConnection}. * * @see #createConnection(URI) */ @@ -72,8 +72,8 @@ public abstract class WebServiceAccessor extends TransformerObjectSupport implem /** * Sets the message senders used for sending messages. - *

          - * These message senders will be used to resolve an URI to a {@link WebServiceConnection}. + * + *

          These message senders will be used to resolve an URI to a {@link WebServiceConnection}. * * @see #createConnection(URI) */ @@ -90,8 +90,8 @@ public abstract class WebServiceAccessor extends TransformerObjectSupport implem /** * Creates a connection to the given URI, or throws an exception when it cannot be resolved. - *

          - * Default implementation iterates over all configured {@link WebServiceMessageSender} objects, and calls {@link + * + *

          Default implementation iterates over all configured {@link WebServiceMessageSender} objects, and calls {@link * WebServiceMessageSender#supports(URI)} for each of them. If the sender supports the parameter URI, it creates a * connection using {@link WebServiceMessageSender#createConnection(URI)} . * diff --git a/spring-ws-core/src/main/java/org/springframework/ws/client/support/destination/AbstractCachingDestinationProvider.java b/spring-ws-core/src/main/java/org/springframework/ws/client/support/destination/AbstractCachingDestinationProvider.java index 6cb28790..b92f9577 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/client/support/destination/AbstractCachingDestinationProvider.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/client/support/destination/AbstractCachingDestinationProvider.java @@ -23,8 +23,8 @@ import org.apache.commons.logging.LogFactory; /** * Abstract base class for {@link DestinationProvider} implementations that cache destination URI. - *

          - * Caching can be disabled by setting the {@link #setCache(boolean) cache} property to false; forcing a + * + *

          Caching can be disabled by setting the {@link #setCache(boolean) cache} property to {@code false}; forcing a * destination lookup for every call. * * @author Arjen Poutsma @@ -40,7 +40,7 @@ public abstract class AbstractCachingDestinationProvider implements DestinationP private boolean cache = true; /** - * Set whether to cache resolved destinations. Default is true. This flag can be turned off to + * Set whether to cache resolved destinations. Default is {@code true}. This flag can be turned off to * re-lookup a destination for each operation, which allows for hot restarting of destinations. This is mainly * useful during development. */ @@ -63,8 +63,8 @@ public abstract class AbstractCachingDestinationProvider implements DestinationP /** * Abstract template method that looks up the URI. - *

          - * If {@linkplain #setCache(boolean) caching} is enabled, this method will only be called once. + * + *

          If {@linkplain #setCache(boolean) caching} is enabled, this method will only be called once. * * @return the destination URI */ diff --git a/spring-ws-core/src/main/java/org/springframework/ws/client/support/destination/DestinationProvider.java b/spring-ws-core/src/main/java/org/springframework/ws/client/support/destination/DestinationProvider.java index 72d9bf52..4939dd4c 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/client/support/destination/DestinationProvider.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/client/support/destination/DestinationProvider.java @@ -21,8 +21,8 @@ import java.net.URI; /** * Strategy interface for providing a {@link org.springframework.ws.client.core.WebServiceTemplate} destination URI at * runtime. - *

          - * Typically implemented by providers that use WSDL, a UDDI registry, or some other form to determine the destination + * + *

          Typically implemented by providers that use WSDL, a UDDI registry, or some other form to determine the destination * URI. * * @author Arjen Poutsma diff --git a/spring-ws-core/src/main/java/org/springframework/ws/client/support/destination/Wsdl11DestinationProvider.java b/spring-ws-core/src/main/java/org/springframework/ws/client/support/destination/Wsdl11DestinationProvider.java index a74c0c67..967ecd10 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/client/support/destination/Wsdl11DestinationProvider.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/client/support/destination/Wsdl11DestinationProvider.java @@ -37,8 +37,8 @@ import org.springframework.xml.xpath.XPathExpressionFactory; /** * Implementation of the {@link DestinationProvider} that resolves a destination URI from a WSDL file. - *

          - * The extraction relies on an XPath expression to locate the URI. By default, the {@link + * + *

          The extraction relies on an XPath expression to locate the URI. By default, the {@link * #DEFAULT_WSDL_LOCATION_EXPRESSION} will be used, but this expression can be overridden by setting the {@link * #setLocationExpression(String) locationExpression} property. * @@ -48,7 +48,7 @@ import org.springframework.xml.xpath.XPathExpressionFactory; */ public class Wsdl11DestinationProvider extends AbstractCachingDestinationProvider { - /** Default XPath expression used for extracting all location attributes from the WSDL definition. */ + /** Default XPath expression used for extracting all {@code location} attributes from the WSDL definition. */ public static final String DEFAULT_WSDL_LOCATION_EXPRESSION = "/wsdl:definitions/wsdl:service/wsdl:port/soap:address/@location"; @@ -69,7 +69,7 @@ public class Wsdl11DestinationProvider extends AbstractCachingDestinationProvide .createXPathExpression(DEFAULT_WSDL_LOCATION_EXPRESSION, expressionNamespaces); } - /** Sets a WSDL location from which the service destination URI will be resolved. */ + /** Sets a WSDL location from which the service destination {@code URI} will be resolved. */ public void setWsdl(Resource wsdlResource) { Assert.notNull(wsdlResource, "'wsdl' must not be null"); Assert.isTrue(wsdlResource.exists(), wsdlResource + " does not exist"); @@ -77,15 +77,15 @@ public class Wsdl11DestinationProvider extends AbstractCachingDestinationProvide } /** - * Sets the XPath expression to use when extracting the service location URI from a WSDL. - *

          - * The expression can use the following bound prefixes:

          - * - * - * + * Sets the XPath expression to use when extracting the service location {@code URI} from a WSDL. + * + *

          The expression can use the following bound prefixes:

          PrefixNamespace
          wsdlhttp://schemas.xmlsoap.org/wsdl/
          soaphttp://schemas.xmlsoap.org/wsdl/soap/
          soap12http://schemas.xmlsoap.org/wsdl/soap12/
          + * + * + * *
          PrefixNamespace
          {@code wsdl}{@code http://schemas.xmlsoap.org/wsdl/}
          {@code soap}{@code http://schemas.xmlsoap.org/wsdl/soap/}
          {@code soap12}{@code http://schemas.xmlsoap.org/wsdl/soap12/}
          - *

          - * Defaults to {@link #DEFAULT_WSDL_LOCATION_EXPRESSION}. + * + *

          Defaults to {@link #DEFAULT_WSDL_LOCATION_EXPRESSION}. */ public void setLocationExpression(String expression) { Assert.hasText(expression, "'expression' must not be empty"); diff --git a/spring-ws-core/src/main/java/org/springframework/ws/client/support/interceptor/AbstractValidatingInterceptor.java b/spring-ws-core/src/main/java/org/springframework/ws/client/support/interceptor/AbstractValidatingInterceptor.java index 26019aaf..cc9a4a67 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/client/support/interceptor/AbstractValidatingInterceptor.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/client/support/interceptor/AbstractValidatingInterceptor.java @@ -40,9 +40,9 @@ import org.springframework.xml.xsd.XsdSchemaCollection; * Abstract base class for {@link ClientInterceptor} implementations that validate part of the message using a schema. * The exact message part is determined by the {@link #getValidationRequestSource(WebServiceMessage)} and {@link * #getValidationResponseSource(WebServiceMessage)} template methods. - *

          - * By default, only the request message is validated, but this behaviour can be changed using the - * validateRequest and validateResponse properties. + * + *

          By default, only the request message is validated, but this behaviour can be changed using the + * {@code validateRequest} and {@code validateResponse} properties. * * @author Arjen Poutsma * @see #getValidationRequestSource(WebServiceMessage) @@ -67,7 +67,7 @@ public abstract class AbstractValidatingInterceptor extends TransformerObjectSup } /** - * Sets the schema language. Default is the W3C XML Schema: http://www.w3.org/2001/XMLSchema". + * Sets the schema language. Default is the W3C XML Schema: {@code http://www.w3.org/2001/XMLSchema"}. * * @see XmlValidatorFactory#SCHEMA_W3C_XML * @see XmlValidatorFactory#SCHEMA_RELAX_NG @@ -128,12 +128,12 @@ public abstract class AbstractValidatingInterceptor extends TransformerObjectSup this.validator = schemaCollection.createValidator(); } - /** Indicates whether the request should be validated against the schema. Default is true. */ + /** Indicates whether the request should be validated against the schema. Default is {@code true}. */ public void setValidateRequest(boolean validateRequest) { this.validateRequest = validateRequest; } - /** Indicates whether the response should be validated against the schema. Default is false. */ + /** Indicates whether the response should be validated against the schema. Default is {@code false}. */ public void setValidateResponse(boolean validateResponse) { this.validateResponse = validateResponse; } @@ -155,12 +155,12 @@ public abstract class AbstractValidatingInterceptor extends TransformerObjectSup /** * Validates the request message in the given message context. Validation only occurs if {@link - * #setValidateRequest(boolean) validateRequest} is set to true, which is the default. - *

          - * Returns true if the request is valid, or false if it isn't. + * #setValidateRequest(boolean) validateRequest} is set to {@code true}, which is the default. + * + *

          Returns {@code true} if the request is valid, or {@code false} if it isn't. * * @param messageContext the message context - * @return true if the message is valid; false otherwise + * @return {@code true} if the message is valid; {@code false} otherwise * @see #setValidateRequest(boolean) */ @Override @@ -188,13 +188,13 @@ public abstract class AbstractValidatingInterceptor extends TransformerObjectSup /** * Template method that is called when the request message contains validation errors. - *

          - * Default implementation logs all errors, and throws a {@link WebServiceValidationException}. Subclasses can + * + *

          Default implementation logs all errors, and throws a {@link WebServiceValidationException}. Subclasses can * override this method to customize this behavior. * * @param messageContext the message context * @param errors the validation errors - * @return true to continue processing the request, false otherwise + * @return {@code true} to continue processing the request, {@code false} otherwise */ protected boolean handleRequestValidationErrors(MessageContext messageContext, SAXParseException[] errors) { for (SAXParseException error : errors) { @@ -205,13 +205,13 @@ public abstract class AbstractValidatingInterceptor extends TransformerObjectSup /** * Validates the response message in the given message context. Validation only occurs if {@link - * #setValidateResponse(boolean) validateResponse} is set to true, which is not the + * #setValidateResponse(boolean) validateResponse} is set to {@code true}, which is not the * default. - *

          - * Returns true if the request is valid, or false if it isn't. + * + *

          Returns {@code true} if the request is valid, or {@code false} if it isn't. * * @param messageContext the message context. - * @return true if the response is valid; false otherwise + * @return {@code true} if the response is valid; {@code false} otherwise * @see #setValidateResponse(boolean) */ @Override @@ -239,13 +239,13 @@ public abstract class AbstractValidatingInterceptor extends TransformerObjectSup /** * Template method that is called when the response message contains validation errors. - *

          - * Default implementation logs all errors, and returns false, i.e. do not cot continue to process the + * + *

          Default implementation logs all errors, and returns {@code false}, i.e. do not cot continue to process the * respone interceptor chain. * * @param messageContext the message context * @param errors the validation errors - * @return true to continue the reponse interceptor chain, false (the default) otherwise + * @return {@code true} to continue the reponse interceptor chain, {@code false} (the default) otherwise */ protected boolean handleResponseValidationErrors(MessageContext messageContext, SAXParseException[] errors) throws WebServiceValidationException { @@ -271,7 +271,7 @@ public abstract class AbstractValidatingInterceptor extends TransformerObjectSup * Abstract template method that returns the part of the request message that is to be validated. * * @param request the request message - * @return the part of the message that is to validated, or null not to validate anything + * @return the part of the message that is to validated, or {@code null} not to validate anything */ protected abstract Source getValidationRequestSource(WebServiceMessage request); @@ -279,7 +279,7 @@ public abstract class AbstractValidatingInterceptor extends TransformerObjectSup * Abstract template method that returns the part of the response message that is to be validated. * * @param response the response message - * @return the part of the message that is to validated, or null not to validate anything + * @return the part of the message that is to validated, or {@code null} not to validate anything */ protected abstract Source getValidationResponseSource(WebServiceMessage response); } diff --git a/spring-ws-core/src/main/java/org/springframework/ws/client/support/interceptor/ClientInterceptor.java b/spring-ws-core/src/main/java/org/springframework/ws/client/support/interceptor/ClientInterceptor.java index 1353e63a..5074b40d 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/client/support/interceptor/ClientInterceptor.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/client/support/interceptor/ClientInterceptor.java @@ -25,15 +25,15 @@ import org.springframework.ws.transport.WebServiceConnection; * Workflow interface that allows for customized client-side message interception. Applications can register any number * of existing or custom interceptors on a {@link org.springframework.ws.client.core.WebServiceTemplate}, to add common * pre- and postprocessing behavior without needing to modify payload handling code. - *

          - * A ClientInterceptor gets called after payload creation (using {@link + * + *

          A {@code ClientInterceptor} gets called after payload creation (using {@link * org.springframework.ws.client.core.WebServiceTemplate#marshalSendAndReceive(Object)} or similar methods, and after * {@link org.springframework.ws.client.core.WebServiceMessageCallback callback} invocation, but before the message is * sent over the {@link WebServiceConnection}. This mechanism can be used for a large field of preprocessing aspects, * e.g. for authorization checks, or message header checks. Its main purpose is to allow for factoring out meta-data * (i.e. {@link SoapHeader}) related code. - *

          - * Client interceptors are defined on a {@link org.springframework.ws.client.core.WebServiceTemplate}, using the {@link + * + *

          Client interceptors are defined on a {@link org.springframework.ws.client.core.WebServiceTemplate}, using the {@link * org.springframework.ws.client.core.WebServiceTemplate#setInterceptors(ClientInterceptor[]) interceptors} property. * * @author Giovanni Cuccu @@ -48,7 +48,7 @@ public interface ClientInterceptor { * message is sent. * * @param messageContext contains the outgoing request message - * @return true to continue processing of the request interceptors; false to indicate + * @return {@code true} to continue processing of the request interceptors; {@code false} to indicate * blocking of the request endpoint chain * @throws WebServiceClientException in case of errors * @see MessageContext#getRequest() @@ -58,11 +58,11 @@ public interface ClientInterceptor { /** * Processes the incoming response message. Called for non-fault response messages before payload handling in the * {@link org.springframework.ws.client.core.WebServiceTemplate}. - *

          - * Note: Will only be called if this interceptor's {@link #handleRequest} method has successfully completed. + * + *

          Note: Will only be called if this interceptor's {@link #handleRequest} method has successfully completed. * * @param messageContext contains the outgoing request message - * @return true to continue processing of the request interceptors; false to indicate + * @return {@code true} to continue processing of the request interceptors; {@code false} to indicate * blocking of the response endpoint chain * @throws WebServiceClientException in case of errors * @see MessageContext#getResponse() @@ -72,11 +72,11 @@ public interface ClientInterceptor { /** * Processes the incoming response fault. Called for response fault messages before payload handling in the {@link * org.springframework.ws.client.core.WebServiceTemplate}. - *

          - * Note: Will only be called if this interceptor's {@link #handleRequest} method has successfully completed. + * + *

          Note: Will only be called if this interceptor's {@link #handleRequest} method has successfully completed. * * @param messageContext contains the outgoing request message - * @return true to continue processing of the request interceptors; false to indicate + * @return {@code true} to continue processing of the request interceptors; {@code false} to indicate * blocking of the request endpoint chain * @throws WebServiceClientException in case of errors * @see MessageContext#getResponse() @@ -87,8 +87,8 @@ public interface ClientInterceptor { /** * Callback after completion of request and response (fault) processing. Will be called on any outcome, thus * allows for proper resource cleanup. - *

          - * Note: Will only be called if this interceptor's {@link #handleRequest} method has successfully completed. + * + *

          Note: Will only be called if this interceptor's {@link #handleRequest} method has successfully completed. * * @param messageContext contains both request and response messages, the response should contains a Fault * @param ex exception thrown on handler execution, if any diff --git a/spring-ws-core/src/main/java/org/springframework/ws/client/support/interceptor/PayloadValidatingInterceptor.java b/spring-ws-core/src/main/java/org/springframework/ws/client/support/interceptor/PayloadValidatingInterceptor.java index cd95f1e2..b33309c0 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/client/support/interceptor/PayloadValidatingInterceptor.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/client/support/interceptor/PayloadValidatingInterceptor.java @@ -21,14 +21,14 @@ import javax.xml.transform.Source; import org.springframework.ws.WebServiceMessage; /** - * Client-side interceptor that validates the contents of WebServiceMessages using a schema. Allows for + * Client-side interceptor that validates the contents of {@code WebServiceMessage}s using a schema. Allows for * both W3C XML and RELAX NG schemas. - *

          - * When the payload is invalid, this interceptor stops processing of the interceptor chain. - *

          - * The schema to validate against is set with the schema property or schemas property. By + * + *

          When the payload is invalid, this interceptor stops processing of the interceptor chain. + * + *

          The schema to validate against is set with the {@code schema} property or {@code schemas} property. By * default, only the request message is validated, but this behaviour can be changed using the - * validateRequest and validateResponse properties. Responses that contains faults are not + * {@code validateRequest} and {@code validateResponse} properties. Responses that contains faults are not * validated. * * @author Stefan Schmidt @@ -45,7 +45,7 @@ public class PayloadValidatingInterceptor extends AbstractValidatingInterceptor * Returns the part of the request message that is to be validated. Default * * @param request the request message - * @return the part of the message that is to validated, or null not to validate anything + * @return the part of the message that is to validated, or {@code null} not to validate anything */ @Override protected Source getValidationRequestSource(WebServiceMessage request) { @@ -56,7 +56,7 @@ public class PayloadValidatingInterceptor extends AbstractValidatingInterceptor * Returns the part of the response message that is to be validated. * * @param response the response message - * @return the part of the message that is to validated, or null not to validate anything + * @return the part of the message that is to validated, or {@code null} not to validate anything */ @Override protected Source getValidationResponseSource(WebServiceMessage response) { diff --git a/spring-ws-core/src/main/java/org/springframework/ws/client/support/interceptor/WebServiceValidationException.java b/spring-ws-core/src/main/java/org/springframework/ws/client/support/interceptor/WebServiceValidationException.java index aac41c0a..2447d742 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/client/support/interceptor/WebServiceValidationException.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/client/support/interceptor/WebServiceValidationException.java @@ -32,7 +32,7 @@ public class WebServiceValidationException extends WebServiceClientException { private SAXParseException[] validationErrors; /** - * Create a new instance of the WebServiceValidationException class. + * Create a new instance of the {@code WebServiceValidationException} class. */ public WebServiceValidationException(SAXParseException[] validationErrors) { super(createMessage(validationErrors)); diff --git a/spring-ws-core/src/main/java/org/springframework/ws/config/WebServicesNamespaceHandler.java b/spring-ws-core/src/main/java/org/springframework/ws/config/WebServicesNamespaceHandler.java index d4a4385c..5ecbda4d 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/config/WebServicesNamespaceHandler.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/config/WebServicesNamespaceHandler.java @@ -20,7 +20,7 @@ import org.springframework.beans.factory.xml.NamespaceHandler; import org.springframework.beans.factory.xml.NamespaceHandlerSupport; /** - * {@link NamespaceHandler} for the 'web-services' namespace. + * {@link NamespaceHandler} for the '{@code web-services}' namespace. * * @author Arjen Poutsma * @since 1.5.0 diff --git a/spring-ws-core/src/main/java/org/springframework/ws/context/AbstractMessageContext.java b/spring-ws-core/src/main/java/org/springframework/ws/context/AbstractMessageContext.java index a701a5ad..f1c4596f 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/context/AbstractMessageContext.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/context/AbstractMessageContext.java @@ -30,8 +30,8 @@ import org.springframework.util.StringUtils; public abstract class AbstractMessageContext implements MessageContext { /** - * Keys are Strings, values are Objects. Lazily initialized by - * getProperties(). + * Keys are {@code Strings}, values are {@code Objects}. Lazily initialized by + * {@code getProperties()}. */ private Map properties; diff --git a/spring-ws-core/src/main/java/org/springframework/ws/context/DefaultMessageContext.java b/spring-ws-core/src/main/java/org/springframework/ws/context/DefaultMessageContext.java index 4a514f4b..52536faf 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/context/DefaultMessageContext.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/context/DefaultMessageContext.java @@ -24,7 +24,7 @@ import org.springframework.ws.WebServiceMessage; import org.springframework.ws.WebServiceMessageFactory; /** - * Default implementation of MessageContext. + * Default implementation of {@code MessageContext}. * * @author Arjen Poutsma * @since 1.0.0 @@ -37,13 +37,13 @@ public class DefaultMessageContext extends AbstractMessageContext { private WebServiceMessage response; - /** Construct a new, empty instance of the DefaultMessageContext with the given message factory. */ + /** Construct a new, empty instance of the {@code DefaultMessageContext} with the given message factory. */ public DefaultMessageContext(WebServiceMessageFactory messageFactory) { this(messageFactory.createWebServiceMessage(), messageFactory); } /** - * Construct a new instance of the DefaultMessageContext with the given request message and message + * Construct a new instance of the {@code DefaultMessageContext} with the given request message and message * factory. */ public DefaultMessageContext(WebServiceMessage request, WebServiceMessageFactory messageFactory) { diff --git a/spring-ws-core/src/main/java/org/springframework/ws/context/MessageContext.java b/spring-ws-core/src/main/java/org/springframework/ws/context/MessageContext.java index 5fd04563..c20ff734 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/context/MessageContext.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/context/MessageContext.java @@ -24,11 +24,11 @@ import org.springframework.ws.server.EndpointInterceptor; /** * Context holder for message requests. - *

          - * Contains both the message request as well as the response. Response message are usually lazily created (but do not + * + *

          Contains both the message request as well as the response. Response message are usually lazily created (but do not * have to be). - *

          - * Also contains properties, which can be used to by {@link EndpointInterceptor interceptors} to pass information on to + * + *

          Also contains properties, which can be used to by {@link EndpointInterceptor interceptors} to pass information on to * endpoints. * * @author Arjen Poutsma @@ -46,7 +46,7 @@ public interface MessageContext { /** * Indicates whether this context has a response. * - * @return true if this context has a response; false otherwise + * @return {@code true} if this context has a response; {@code false} otherwise */ boolean hasResponse(); @@ -84,8 +84,8 @@ public interface MessageContext { void readResponse(InputStream inputStream) throws IOException; /** - * Sets the name and value of a property associated with the MessageContext. If the - * MessageContext contains a value of the same property, the old value is replaced. + * Sets the name and value of a property associated with the {@code MessageContext}. If the + * {@code MessageContext} contains a value of the same property, the old value is replaced. * * @param name name of the property associated with the value * @param value value of the property @@ -93,7 +93,7 @@ public interface MessageContext { void setProperty(String name, Object value); /** - * Gets the value of a specific property from the MessageContext. + * Gets the value of a specific property from the {@code MessageContext}. * * @param name name of the property whose value is to be retrieved * @return value of the property @@ -101,7 +101,7 @@ public interface MessageContext { Object getProperty(String name); /** - * Removes a property from the MessageContext. + * Removes a property from the {@code MessageContext}. * * @param name name of the property to be removed */ @@ -111,12 +111,12 @@ public interface MessageContext { * Check if this message context contains a property with the given name. * * @param name the name of the property to look for - * @return true if the MessageContext contains the property; false otherwise + * @return {@code true} if the {@code MessageContext} contains the property; {@code false} otherwise */ boolean containsProperty(String name); /** - * Return the names of all properties in this MessageContext. + * Return the names of all properties in this {@code MessageContext}. * * @return the names of all properties in this context, or an empty array if none defined */ diff --git a/spring-ws-core/src/main/java/org/springframework/ws/mime/AbstractMimeMessage.java b/spring-ws-core/src/main/java/org/springframework/ws/mime/AbstractMimeMessage.java index 1c35fc1f..9346bb18 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/mime/AbstractMimeMessage.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/mime/AbstractMimeMessage.java @@ -57,7 +57,7 @@ public abstract class AbstractMimeMessage implements MimeMessage { } /** - * Activation framework DataSource that wraps a Spring InputStreamSource. + * Activation framework {@code DataSource} that wraps a Spring {@code InputStreamSource}. * * @author Arjen Poutsma * @since 1.0.0 diff --git a/spring-ws-core/src/main/java/org/springframework/ws/mime/Attachment.java b/spring-ws-core/src/main/java/org/springframework/ws/mime/Attachment.java index db0b1baf..57d401f9 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/mime/Attachment.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/mime/Attachment.java @@ -33,19 +33,19 @@ public interface Attachment { /** * Returns the content identifier of the attachment. * - * @return the content id, or null if empty or not defined + * @return the content id, or {@code null} if empty or not defined */ String getContentId(); /** * Returns the content type of the attachment. * - * @return the content type, or null if empty or not defined + * @return the content type, or {@code null} if empty or not defined */ String getContentType(); /** - * Return an InputStream to read the contents of the attachment from. The user is responsible for + * Return an {@code InputStream} to read the contents of the attachment from. The user is responsible for * closing the stream. * * @return the contents of the file as stream, or an empty stream if empty @@ -54,9 +54,9 @@ public interface Attachment { InputStream getInputStream() throws IOException; /** - * Returns the size of the attachment in bytes. Returns -1 if the size cannot be determined. + * Returns the size of the attachment in bytes. Returns {@code -1} if the size cannot be determined. * - * @return the size of the attachment, 0 if empty, or -1 if the size cannot be determined + * @return the size of the attachment, {@code 0} if empty, or {@code -1} if the size cannot be determined */ long getSize(); diff --git a/spring-ws-core/src/main/java/org/springframework/ws/mime/MimeMessage.java b/spring-ws-core/src/main/java/org/springframework/ws/mime/MimeMessage.java index f3423ac0..7e337ad0 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/mime/MimeMessage.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/mime/MimeMessage.java @@ -36,7 +36,7 @@ public interface MimeMessage extends WebServiceMessage { /** * Indicates whether this message is a XOP package. * - * @return true when the constraints specified in Identifying + * @return {@code true} when the constraints specified in Identifying * XOP Documents are met. * @see XOP Packages */ @@ -45,7 +45,7 @@ public interface MimeMessage extends WebServiceMessage { /** * Turns this message into a XOP package. * - * @return true when the message is a XOP package + * @return {@code true} when the message is a XOP package * @see XOP Packages */ boolean convertToXopPackage(); @@ -53,13 +53,13 @@ public interface MimeMessage extends WebServiceMessage { /** * Returns the {@link Attachment} with the specified content Id. * - * @return the attachment with the specified content id; or null if it cannot be found + * @return the attachment with the specified content id; or {@code null} if it cannot be found * @throws AttachmentException in case of errors */ Attachment getAttachment(String contentId) throws AttachmentException; /** - * Returns an Iterator over all {@link Attachment} objects that are part of this message. + * Returns an {@code Iterator} over all {@link Attachment} objects that are part of this message. * * @return an iterator over all attachments * @throws AttachmentException in case of errors @@ -69,8 +69,8 @@ public interface MimeMessage extends WebServiceMessage { /** * Add an attachment to the message, taking the content from a {@link File}. - *

          - * The content type will be determined by the name of the given content file. Do not use this for temporary files + * + *

          The content type will be determined by the name of the given content file. Do not use this for temporary files * with arbitrary filenames (possibly ending in ".tmp" or the like)! * * @param contentId the content Id of the attachment @@ -82,8 +82,8 @@ public interface MimeMessage extends WebServiceMessage { /** * Add an attachment to the message, taking the content from an {@link InputStreamSource}. - *

          - * Note that the stream returned by the source needs to be a fresh one on each call, as underlying + * + *

          Note that the stream returned by the source needs to be a fresh one on each call, as underlying * implementations can invoke {@link InputStreamSource#getInputStream()} multiple times. * * @param contentId the content Id of the attachment diff --git a/spring-ws-core/src/main/java/org/springframework/ws/pox/PoxMessageException.java b/spring-ws-core/src/main/java/org/springframework/ws/pox/PoxMessageException.java index 4e8a760e..291c1a3e 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/pox/PoxMessageException.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/pox/PoxMessageException.java @@ -19,7 +19,7 @@ package org.springframework.ws.pox; import org.springframework.ws.WebServiceMessageException; /** - * Specific subclass of WebServiceMessageException for Plain Old XML messages. + * Specific subclass of {@code WebServiceMessageException} for Plain Old XML messages. * * @author Arjen Poutsma * @since 1.0.0 diff --git a/spring-ws-core/src/main/java/org/springframework/ws/pox/dom/DomPoxMessage.java b/spring-ws-core/src/main/java/org/springframework/ws/pox/dom/DomPoxMessage.java index bf9bb134..3122e220 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/pox/dom/DomPoxMessage.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/pox/dom/DomPoxMessage.java @@ -37,7 +37,7 @@ import org.springframework.ws.transport.TransportOutputStream; import org.springframework.xml.namespace.QNameUtils; /** - * Implementation of the PoxMessage interface that is based on a DOM Document. + * Implementation of the {@code PoxMessage} interface that is based on a DOM Document. * * @author Arjen Poutsma * @see Document @@ -52,7 +52,7 @@ public class DomPoxMessage implements PoxMessage { private final Transformer transformer; /** - * Constructs a new instance of the DomPoxMessage with the given document. + * Constructs a new instance of the {@code DomPoxMessage} with the given document. * * @param document the document to base the message on */ diff --git a/spring-ws-core/src/main/java/org/springframework/ws/pox/dom/DomPoxMessageException.java b/spring-ws-core/src/main/java/org/springframework/ws/pox/dom/DomPoxMessageException.java index 2e590e9e..7f04afc0 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/pox/dom/DomPoxMessageException.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/pox/dom/DomPoxMessageException.java @@ -19,7 +19,7 @@ package org.springframework.ws.pox.dom; import org.springframework.ws.pox.PoxMessageException; /** - * Specific subclass of PoxMessageException for DOM Plain Old XML messages. + * Specific subclass of {@code PoxMessageException} for DOM Plain Old XML messages. * * @author Arjen Poutsma * @since 1.0.0 diff --git a/spring-ws-core/src/main/java/org/springframework/ws/pox/dom/DomPoxMessageFactory.java b/spring-ws-core/src/main/java/org/springframework/ws/pox/dom/DomPoxMessageFactory.java index 26c07220..0672d194 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/pox/dom/DomPoxMessageFactory.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/pox/dom/DomPoxMessageFactory.java @@ -58,12 +58,12 @@ public class DomPoxMessageFactory extends TransformerObjectSupport implements We this.contentType = contentType; } - /** Set whether or not the XML parser should be XML namespace aware. Default is true. */ + /** Set whether or not the XML parser should be XML namespace aware. Default is {@code true}. */ public void setNamespaceAware(boolean namespaceAware) { documentBuilderFactory.setNamespaceAware(namespaceAware); } - /** Set if the XML parser should validate the document. Default is false. */ + /** Set if the XML parser should validate the document. Default is {@code false}. */ public void setValidating(boolean validating) { documentBuilderFactory.setValidating(validating); } diff --git a/spring-ws-core/src/main/java/org/springframework/ws/server/EndpointAdapter.java b/spring-ws-core/src/main/java/org/springframework/ws/server/EndpointAdapter.java index 6e616f18..7a1690d4 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/server/EndpointAdapter.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/server/EndpointAdapter.java @@ -20,9 +20,9 @@ import org.springframework.ws.context.MessageContext; /** * Interface that must be implemented for each endpoint type to handle a message request. This interface is used to - * allow the MessageDispatcher to be indefinitely extensible. It accesses all installed endpoints through + * allow the {@code MessageDispatcher} to be indefinitely extensible. It accesses all installed endpoints through * this interface, meaning that is does not contain code specific to any endpoint type. - *

          + * *

          This interface is not intended for application developers. It is available for those who want to develop their own * message flow. * @@ -33,21 +33,21 @@ import org.springframework.ws.context.MessageContext; public interface EndpointAdapter { /** - * Does this EndpointAdapter support the given endpoint? - *

          - *

          Typical EndpointAdapters will base the decision on the endpoint type. + * Does this {@code EndpointAdapter} support the given {@code endpoint}? + * + *

          Typical {@code EndpointAdapters} will base the decision on the endpoint type. * * @param endpoint endpoint object to check - * @return true if this EndpointAdapter supports the supplied endpoint + * @return {@code true} if this {@code EndpointAdapter} supports the supplied {@code endpoint} */ boolean supports(Object endpoint); /** - * Use the given endpoint to handle the request. + * Use the given {@code endpoint} to handle the request. * * @param messageContext the current message context * @param endpoint the endpoint to use. This object must have previously been passed to the {@link - * #supports(Object)} method of this interface, which must have returned true + * #supports(Object)} method of this interface, which must have returned {@code true} * @throws Exception in case of errors */ void invoke(MessageContext messageContext, Object endpoint) throws Exception; diff --git a/spring-ws-core/src/main/java/org/springframework/ws/server/EndpointExceptionResolver.java b/spring-ws-core/src/main/java/org/springframework/ws/server/EndpointExceptionResolver.java index d70ff3ba..349d2f8d 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/server/EndpointExceptionResolver.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/server/EndpointExceptionResolver.java @@ -32,7 +32,7 @@ public interface EndpointExceptionResolver { * @param messageContext current message context * @param endpoint the executed endpoint, or null if none chosen at the time of the exception * @param ex the exception that got thrown during endpoint execution - * @return true if resolved; false otherwise + * @return {@code true} if resolved; {@code false} otherwise */ boolean resolveException(MessageContext messageContext, Object endpoint, Exception ex); } diff --git a/spring-ws-core/src/main/java/org/springframework/ws/server/EndpointInterceptor.java b/spring-ws-core/src/main/java/org/springframework/ws/server/EndpointInterceptor.java index d14f4d89..301fbeb3 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/server/EndpointInterceptor.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/server/EndpointInterceptor.java @@ -22,13 +22,13 @@ import org.springframework.ws.context.MessageContext; * Workflow interface that allows for customized endpoint invocation chains. Applications can register any number of * existing or custom interceptors for certain groups of endpoints, to add common preprocessing behavior without needing * to modify each endpoint implementation. - *

          - * An {@code EndpointInterceptor} gets called before the appropriate {@link EndpointAdapter} triggers the + * + *

          An {@code EndpointInterceptor} gets called before the appropriate {@link EndpointAdapter} triggers the * invocation of the endpoint itself. This mechanism can be used for a large field of preprocessing aspects, e.g. for * authorization checks, or message header checks. Its main purpose is to allow for factoring out repetitive endpoint * code. - *

          - * Typically an interceptor chain is defined per {@link EndpointMapping} bean, sharing its granularity. To be able to + * + *

          Typically an interceptor chain is defined per {@link EndpointMapping} bean, sharing its granularity. To be able to * apply a certain interceptor chain to a group of handlers, one needs to map the desired handlers via one * {@code EndpointMapping} bean. The interceptors themselves are defined as beans in the application context, * referenced by the mapping bean definition via its {@code interceptors} property (in XML: a <list> of @@ -45,8 +45,8 @@ public interface EndpointInterceptor { /** * Processes the incoming request message. Called after {@link EndpointMapping} determined an appropriate endpoint * object, but before {@link EndpointAdapter} invokes the endpoint. - *

          - * {@link MessageDispatcher} processes an endpoint in an invocation chain, consisting of any number of interceptors, + * + *

          {@link MessageDispatcher} processes an endpoint in an invocation chain, consisting of any number of interceptors, * with the endpoint itself at the end. With this method, each interceptor can decide to abort the chain, typically * creating a custom response. * @@ -62,12 +62,12 @@ public interface EndpointInterceptor { /** * Processes the outgoing response message. Called after {@link EndpointAdapter} actually invoked the endpoint. Can * manipulate the response, if any, by adding new headers, etc. - *

          - * {@link MessageDispatcher} processes an endpoint in an invocation chain, consisting of any number of interceptors, + * + *

          {@link MessageDispatcher} processes an endpoint in an invocation chain, consisting of any number of interceptors, * with the endpoint itself at the end. With this method, each interceptor can post-process an invocation, getting * applied in inverse order of the execution chain. - *

          - * Note: Will only be called if this interceptor's {@link #handleRequest} method has successfully completed. + * + *

          Note: Will only be called if this interceptor's {@link #handleRequest} method has successfully completed. * * @param messageContext contains both request and response messages * @param endpoint chosen endpoint to invoke @@ -83,12 +83,12 @@ public interface EndpointInterceptor { /** * Processes the outgoing response fault. Called after {@link EndpointAdapter} actually invoked the endpoint. Can * manipulate the response, if any, by adding new headers, etc. - *

          - * {@link MessageDispatcher} processes an endpoint in an invocation chain, consisting of any number of interceptors, + * + *

          {@link MessageDispatcher} processes an endpoint in an invocation chain, consisting of any number of interceptors, * with the endpoint itself at the end. With this method, each interceptor can post-process an invocation, getting * applied in inverse order of the execution chain. - *

          - * Note: Will only be called if this interceptor's {@link #handleRequest} method has successfully completed. + * + *

          Note: Will only be called if this interceptor's {@link #handleRequest} method has successfully completed. * * @param messageContext contains both request and response messages, the response should contains a Fault * @param endpoint chosen endpoint to invoke @@ -100,10 +100,10 @@ public interface EndpointInterceptor { /** * Callback after completion of request and response (fault) processing. Will be called on any outcome of endpoint * invocation, thus allows for proper resource cleanup. - *

          - * Note: Will only be called if this interceptor's {@link #handleRequest} method has successfully completed. - *

          - * As with the {@link #handleResponse} method, the method will be invoked on each interceptor in the chain in + * + *

          Note: Will only be called if this interceptor's {@link #handleRequest} method has successfully completed. + * + *

          As with the {@link #handleResponse} method, the method will be invoked on each interceptor in the chain in * reverse order, so the first interceptor will be the last to be invoked. * * @param messageContext contains both request and response messages, the response should contains a Fault diff --git a/spring-ws-core/src/main/java/org/springframework/ws/server/EndpointInvocationChain.java b/spring-ws-core/src/main/java/org/springframework/ws/server/EndpointInvocationChain.java index ee3c38b6..8f926b50 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/server/EndpointInvocationChain.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/server/EndpointInvocationChain.java @@ -30,7 +30,7 @@ public class EndpointInvocationChain { private EndpointInterceptor[] interceptors; /** - * Create new EndpointInvocationChain. + * Create new {@code EndpointInvocationChain}. * * @param endpoint the endpoint object to invoke */ @@ -39,7 +39,7 @@ public class EndpointInvocationChain { } /** - * Create new EndpointInvocationChain. + * Create new {@code EndpointInvocationChain}. * * @param endpoint the endpoint object to invoke * @param interceptors the array of interceptors to apply diff --git a/spring-ws-core/src/main/java/org/springframework/ws/server/EndpointMapping.java b/spring-ws-core/src/main/java/org/springframework/ws/server/EndpointMapping.java index b950afa4..42149074 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/server/EndpointMapping.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/server/EndpointMapping.java @@ -20,15 +20,15 @@ import org.springframework.ws.context.MessageContext; /** * Defines a mapping between message requests and endpoint objects. - *

          - * This class can be implemented by application developers, although this is not always necessary, as - * PayloadRootQNameEndpointMapping and SoapActionEndpointMapping are included. - *

          - * HandlerMapping implementations can support mapped interceptors but do not have to. An endpoint will always be wrapped - * in a EndpointExecutionChain instance, optionally accompanied by some EndpointInterceptor - * instances. The MessageDispacher will first call each EndpointInterceptor's - * handlerRequest method in the given order, finally invoking the endpoint itself if all - * handlerRequest methods have returned true. + * + *

          This class can be implemented by application developers, although this is not always necessary, as + * {@code PayloadRootQNameEndpointMapping} and {@code SoapActionEndpointMapping} are included. + * + *

          HandlerMapping implementations can support mapped interceptors but do not have to. An endpoint will always be wrapped + * in a {@code EndpointExecutionChain} instance, optionally accompanied by some {@code EndpointInterceptor} + * instances. The {@code MessageDispacher} will first call each {@code EndpointInterceptor}'s + * {@code handlerRequest} method in the given order, finally invoking the endpoint itself if all + * {@code handlerRequest} methods have returned {@code true}. * * @author Arjen Poutsma * @see org.springframework.ws.server.endpoint.mapping.AbstractEndpointMapping @@ -41,16 +41,16 @@ public interface EndpointMapping { /** * Returns an endpoint and any interceptors for this message context. The choice may be made on message contents, * transport request url, a routing table, or any factor the implementing class chooses. - *

          - * The returned EndpointExecutionChain contains an endpoint Object, rather than even a tag interface, - * so that endpoints are not constrained in any way. For example, a EndpointAdapter could be written to + * + *

          The returned {@code EndpointExecutionChain} contains an endpoint Object, rather than even a tag interface, + * so that endpoints are not constrained in any way. For example, a {@code EndpointAdapter} could be written to * allow another framework's endpoint objects to be used. - *

          - * Returns null if no match was found. This is by design. The MessageDispatcher will query - * all registered EndpointMapping beans to find a match, and only decide there is an error if none can + * + *

          Returns {@code null} if no match was found. This is by design. The {@code MessageDispatcher} will query + * all registered {@code EndpointMapping} beans to find a match, and only decide there is an error if none can * find an endpoint. * - * @return a HandlerExecutionChain instance containing endpoint object and any interceptors, or null if + * @return a HandlerExecutionChain instance containing endpoint object and any interceptors, or {@code null} if * no mapping is found * @throws Exception if there is an internal error */ diff --git a/spring-ws-core/src/main/java/org/springframework/ws/server/MessageDispatcher.java b/spring-ws-core/src/main/java/org/springframework/ws/server/MessageDispatcher.java index 6c4b07a2..9573fc6e 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/server/MessageDispatcher.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/server/MessageDispatcher.java @@ -49,8 +49,8 @@ import org.springframework.ws.transport.WebServiceMessageReceiver; /** * Central dispatcher for use within Spring-WS, dispatching Web service messages to registered endpoints. - *

          - * This dispatcher is quite similar to Spring MVCs {@link DispatcherServlet}. Just like its counterpart, this dispatcher + * + *

          This dispatcher is quite similar to Spring MVCs {@link DispatcherServlet}. Just like its counterpart, this dispatcher * is very flexible. This class is SOAP agnostic; in typical SOAP Web Services, the {@link SoapMessageDispatcher} * subclass is used. *

            @@ -113,37 +113,37 @@ public class MessageDispatcher implements WebServiceMessageReceiver, BeanNameAwa /** List of EndpointMappings used in this dispatcher. */ private List endpointMappings; - /** Initializes a new instance of the MessageDispatcher. */ + /** Initializes a new instance of the {@code MessageDispatcher}. */ public MessageDispatcher() { defaultStrategiesHelper = new DefaultStrategiesHelper(getClass()); } - /** Returns the EndpointAdapters to use by this MessageDispatcher. */ + /** Returns the {@code EndpointAdapter}s to use by this {@code MessageDispatcher}. */ public List getEndpointAdapters() { return endpointAdapters; } - /** Sets the EndpointAdapters to use by this MessageDispatcher. */ + /** Sets the {@code EndpointAdapter}s to use by this {@code MessageDispatcher}. */ public void setEndpointAdapters(List endpointAdapters) { this.endpointAdapters = endpointAdapters; } - /** Returns the EndpointExceptionResolvers to use by this MessageDispatcher. */ + /** Returns the {@code EndpointExceptionResolver}s to use by this {@code MessageDispatcher}. */ public List getEndpointExceptionResolvers() { return endpointExceptionResolvers; } - /** Sets the EndpointExceptionResolvers to use by this MessageDispatcher. */ + /** Sets the {@code EndpointExceptionResolver}s to use by this {@code MessageDispatcher}. */ public void setEndpointExceptionResolvers(List endpointExceptionResolvers) { this.endpointExceptionResolvers = endpointExceptionResolvers; } - /** Returns the EndpointMappings to use by this MessageDispatcher. */ + /** Returns the {@code EndpointMapping}s to use by this {@code MessageDispatcher}. */ public List getEndpointMappings() { return endpointMappings; } - /** Sets the EndpointMappings to use by this MessageDispatcher. */ + /** Sets the {@code EndpointMapping}s to use by this {@code MessageDispatcher}. */ public void setEndpointMappings(List endpointMappings) { this.endpointMappings = endpointMappings; } @@ -265,7 +265,7 @@ public class MessageDispatcher implements WebServiceMessageReceiver, BeanNameAwa /** * Returns the endpoint for this request. All endpoint mappings are tried, in order. * - * @return the EndpointInvocationChain, or null if no endpoint could be found. + * @return the {@code EndpointInvocationChain}, or {@code null} if no endpoint could be found. */ protected EndpointInvocationChain getEndpoint(MessageContext messageContext) throws Exception { for (EndpointMapping endpointMapping : getEndpointMappings()) { @@ -285,7 +285,7 @@ public class MessageDispatcher implements WebServiceMessageReceiver, BeanNameAwa } /** - * Returns the EndpointAdapter for the given endpoint. + * Returns the {@code EndpointAdapter} for the given endpoint. * * @param endpoint the endpoint to find an adapter for * @return the adapter @@ -305,21 +305,21 @@ public class MessageDispatcher implements WebServiceMessageReceiver, BeanNameAwa /** * Callback for pre-processing of given invocation chain and message context. Gets called before invocation of - * handleRequest on the interceptors. - *

            - * Default implementation does nothing, and returns true. + * {@code handleRequest} on the interceptors. * - * @param mappedEndpoint the mapped EndpointInvocationChain + *

            Default implementation does nothing, and returns {@code true}. + * + * @param mappedEndpoint the mapped {@code EndpointInvocationChain} * @param messageContext the message context - * @return true if processing should continue; false otherwise + * @return {@code true} if processing should continue; {@code false} otherwise */ protected boolean handleRequest(EndpointInvocationChain mappedEndpoint, MessageContext messageContext) { return true; } /** - * Determine an error SOAPMessage response via the registered EndpointExceptionResolvers. - * Most likely, the response contains a SOAPFault. If no suitable resolver was found, the exception is + * Determine an error {@code SOAPMessage} response via the registered {@code EndpointExceptionResolvers}. + * Most likely, the response contains a {@code SOAPFault}. If no suitable resolver was found, the exception is * rethrown. * * @param messageContext current SOAPMessage request @@ -345,8 +345,8 @@ public class MessageDispatcher implements WebServiceMessageReceiver, BeanNameAwa /** * Trigger handleResponse or handleFault on the mapped EndpointInterceptors. Will just invoke said method on all - * interceptors whose handleRequest invocation returned true, in addition to the last interceptor who - * returned false. + * interceptors whose handleRequest invocation returned {@code true}, in addition to the last interceptor who + * returned {@code false}. * * @param mappedEndpoint the mapped EndpointInvocationChain * @param interceptorIndex index of last interceptor that was called @@ -381,11 +381,11 @@ public class MessageDispatcher implements WebServiceMessageReceiver, BeanNameAwa * Trigger afterCompletion callbacks on the mapped EndpointInterceptors. * Will just invoke afterCompletion for all interceptors whose handleRequest invocation * has successfully completed and returned true, in addition to the last interceptor who - * returned false. + * returned {@code false}. * * @param mappedEndpoint the mapped EndpointInvocationChain * @param interceptorIndex index of last interceptor that successfully completed - * @param ex Exception thrown on handler execution, or null if none + * @param ex Exception thrown on handler execution, or {@code null} if none * @see EndpointInterceptor#afterCompletion */ private void triggerAfterCompletion(EndpointInvocationChain mappedEndpoint, @@ -412,8 +412,8 @@ public class MessageDispatcher implements WebServiceMessageReceiver, BeanNameAwa /** - * Initialize the EndpointAdapters used by this class. If no adapter beans are explicitly set by using - * the endpointAdapters property, we use the default strategies. + * Initialize the {@code EndpointAdapters} used by this class. If no adapter beans are explicitly set by using + * the {@code endpointAdapters} property, we use the default strategies. * * @see #setEndpointAdapters(java.util.List) */ @@ -436,8 +436,8 @@ public class MessageDispatcher implements WebServiceMessageReceiver, BeanNameAwa } /** - * Initialize the EndpointExceptionResolver used by this class. If no resolver beans are explicitly set - * by using the endpointExceptionResolvers property, we use the default strategies. + * Initialize the {@code EndpointExceptionResolver} used by this class. If no resolver beans are explicitly set + * by using the {@code endpointExceptionResolvers} property, we use the default strategies. * * @see #setEndpointExceptionResolvers(java.util.List) */ @@ -460,8 +460,8 @@ public class MessageDispatcher implements WebServiceMessageReceiver, BeanNameAwa } /** - * Initialize the EndpointMappings used by this class. If no mapping beans are explictely set by using - * the endpointMappings property, we use the default strategies. + * Initialize the {@code EndpointMappings} used by this class. If no mapping beans are explictely set by using + * the {@code endpointMappings} property, we use the default strategies. * * @see #setEndpointMappings(java.util.List) */ diff --git a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/AbstractDom4jPayloadEndpoint.java b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/AbstractDom4jPayloadEndpoint.java index 1659a781..9780eac6 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/AbstractDom4jPayloadEndpoint.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/AbstractDom4jPayloadEndpoint.java @@ -32,9 +32,9 @@ import org.springframework.xml.transform.TransformerObjectSupport; /** * Abstract base class for endpoints that handle the message payload as dom4j elements. Offers the message payload as a - * dom4j Element, and allows subclasses to create a response by returning an Element. - *

            - * An AbstractDom4JPayloadEndpoint only accept one payload element. Multiple payload elements are not in + * dom4j {@code Element}, and allows subclasses to create a response by returning an {@code Element}. + * + *

            An {@code AbstractDom4JPayloadEndpoint} only accept one payload element. Multiple payload elements are not in * accordance with WS-I. * * @author Arjen Poutsma @@ -49,8 +49,8 @@ public abstract class AbstractDom4jPayloadEndpoint extends TransformerObjectSupp /** * Set if the request {@link Source} should always be transformed into a new {@link DocumentResult}. - *

            - * Default is {@code false}, which is faster. + * + *

            Default is {@code false}, which is faster. */ public void setAlwaysTransform(boolean alwaysTransform) { this.alwaysTransform = alwaysTransform; @@ -71,8 +71,8 @@ public abstract class AbstractDom4jPayloadEndpoint extends TransformerObjectSupp /** * Returns the payload element of the given source. - *

            - * Default implementation checks whether the source is a {@link javax.xml.transform.dom.DOMSource}, and uses a + * + *

            Default implementation checks whether the source is a {@link javax.xml.transform.dom.DOMSource}, and uses a * {@link org.jdom.input.DOMBuilder} to create a JDOM {@link org.jdom.Element}. In all other cases, or when * {@linkplain #setAlwaysTransform(boolean) alwaysTransform} is {@code true}, the source is transformed into a * {@link org.jdom.transform.JDOMResult}, which is more expensive. If the passed source is {@code null}, {@code @@ -102,15 +102,15 @@ public abstract class AbstractDom4jPayloadEndpoint extends TransformerObjectSupp } /** - * Template method. Subclasses must implement this. Offers the request payload as a dom4j Element, and - * allows subclasses to return a response Element. - *

            - * The given dom4j Document is to be used for constructing a response element, by using - * addElement. + * Template method. Subclasses must implement this. Offers the request payload as a dom4j {@code Element}, and + * allows subclasses to return a response {@code Element}. + * + *

            The given dom4j {@code Document} is to be used for constructing a response element, by using + * {@code addElement}. * * @param requestElement the contents of the SOAP message as dom4j elements * @param responseDocument a dom4j document to be used for constructing a response - * @return the response element. Can be null to specify no response. + * @return the response element. Can be {@code null} to specify no response. */ protected abstract Element invokeInternal(Element requestElement, Document responseDocument) throws Exception; } diff --git a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/AbstractDomPayloadEndpoint.java b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/AbstractDomPayloadEndpoint.java index bedbbf75..b938213e 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/AbstractDomPayloadEndpoint.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/AbstractDomPayloadEndpoint.java @@ -32,11 +32,11 @@ import org.springframework.xml.transform.TransformerObjectSupport; /** * Abstract base class for endpoints that handle the message payload as DOM elements. - *

            - * Offers the message payload as a DOM Element, and allows subclasses to create a response by returning an - * Element. - *

            - * An AbstractDomPayloadEndpoint only accept one payload element. Multiple payload elements are + * + *

            Offers the message payload as a DOM {@code Element}, and allows subclasses to create a response by returning an + * {@code Element}. + * + *

            An {@code AbstractDomPayloadEndpoint} only accept one payload element. Multiple payload elements are * not in accordance with WS-I. * * @author Arjen Poutsma @@ -58,12 +58,12 @@ public abstract class AbstractDomPayloadEndpoint extends TransformerObjectSuppor private boolean alwaysTransform = false; - /** Set whether or not the XML parser should be XML namespace aware. Default is true. */ + /** Set whether or not the XML parser should be XML namespace aware. Default is {@code true}. */ public void setNamespaceAware(boolean namespaceAware) { this.namespaceAware = namespaceAware; } - /** Set if the XML parser should validate the document. Default is false. */ + /** Set if the XML parser should validate the document. Default is {@code false}. */ public void setValidating(boolean validating) { this.validating = validating; } @@ -79,8 +79,8 @@ public abstract class AbstractDomPayloadEndpoint extends TransformerObjectSuppor /** * Set if the request {@link Source} should always be transformed into a new {@link DOMResult}. - *

            - * Default is {@code false}, which is faster. + * + *

            Default is {@code false}, which is faster. */ public void setAlwaysTransform(boolean alwaysTransform) { this.alwaysTransform = alwaysTransform; @@ -99,11 +99,11 @@ public abstract class AbstractDomPayloadEndpoint extends TransformerObjectSuppor } /** - * Create a DocumentBuilder that this endpoint will use for parsing XML documents. Can be overridden in + * Create a {@code DocumentBuilder} that this endpoint will use for parsing XML documents. Can be overridden in * subclasses, adding further initialization of the builder. * - * @param factory the DocumentBuilderFactory that the DocumentBuilder should be created with - * @return the DocumentBuilder + * @param factory the {@code DocumentBuilderFactory} that the DocumentBuilder should be created with + * @return the {@code DocumentBuilder} * @throws ParserConfigurationException if thrown by JAXP methods */ protected DocumentBuilder createDocumentBuilder(DocumentBuilderFactory factory) @@ -112,9 +112,9 @@ public abstract class AbstractDomPayloadEndpoint extends TransformerObjectSuppor } /** - * Create a DocumentBuilderFactory that this endpoint will use for constructing XML documents. Can be + * Create a {@code DocumentBuilderFactory} that this endpoint will use for constructing XML documents. Can be * overridden in subclasses, adding further initialization of the factory. The resulting - * DocumentBuilderFactory is cached, so this method will only be called once. + * {@code DocumentBuilderFactory} is cached, so this method will only be called once. * * @return the DocumentBuilderFactory * @throws ParserConfigurationException if thrown by JAXP methods @@ -129,8 +129,8 @@ public abstract class AbstractDomPayloadEndpoint extends TransformerObjectSuppor /** * Returns the payload element of the given source. - *

            - * Default implementation checks whether the source is a {@link DOMSource}, and returns the {@linkplain + * + *

            Default implementation checks whether the source is a {@link DOMSource}, and returns the {@linkplain * DOMSource#getNode() node} of that. In all other cases, or when {@linkplain #setAlwaysTransform(boolean) * alwaysTransform} is {@code true}, the source is transformed into a {@link DOMResult}, which is more expensive. If * the passed source is {@code null}, {@code null} is returned. @@ -162,16 +162,16 @@ public abstract class AbstractDomPayloadEndpoint extends TransformerObjectSuppor /** * Template method that subclasses must implement to process the request. - *

            - *

            Offers the request payload as a DOM Element, and allows subclasses to return a response - * Element. - *

            - *

            The given DOM Document is to be used for constructing Nodes, by using the various - * create methods. + * + *

            Offers the request payload as a DOM {@code Element}, and allows subclasses to return a response + * {@code Element}. + * + *

            The given DOM {@code Document} is to be used for constructing {@code Node}s, by using the various + * {@code create} methods. * * @param requestElement the contents of the SOAP message as DOM elements - * @param responseDocument a DOM document to be used for constructing Nodes - * @return the response element. Can be null to specify no response. + * @param responseDocument a DOM document to be used for constructing {@code Node}s + * @return the response element. Can be {@code null} to specify no response. */ protected abstract Element invokeInternal(Element requestElement, Document responseDocument) throws Exception; diff --git a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/AbstractEndpointExceptionResolver.java b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/AbstractEndpointExceptionResolver.java index 2a4e7881..ccdd8398 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/AbstractEndpointExceptionResolver.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/AbstractEndpointExceptionResolver.java @@ -27,7 +27,7 @@ import org.springframework.ws.server.EndpointExceptionResolver; /** * Abstract base class for {@link EndpointExceptionResolver EndpointExceptionResolvers}. - *

            + * *

            Provides a set of mapped endpoints that the resolver should map. * * @author Arjen Poutsma @@ -48,10 +48,10 @@ public abstract class AbstractEndpointExceptionResolver implements EndpointExcep /** * Specify the set of endpoints that this exception resolver should map.

            The exception mappings and the default * fault will only apply to the specified endpoints. - *

            - * If no endpoints are set, both the exception mappings and the default fault will apply to all handlers. This means + * + *

            If no endpoints are set, both the exception mappings and the default fault will apply to all handlers. This means * that a specified default fault will be used as fallback for all exceptions; any further - * EndpointExceptionResolvers in the chain will be ignored in this case. + * {@code EndpointExceptionResolvers} in the chain will be ignored in this case. */ public void setMappedEndpoints(Set mappedEndpoints) { this.mappedEndpoints = mappedEndpoints; @@ -60,8 +60,8 @@ public abstract class AbstractEndpointExceptionResolver implements EndpointExcep /** * Set the log category for warn logging. The name will be passed to the underlying logger implementation through * Commons Logging, getting interpreted as log category according to the logger's configuration. - *

            - * Default is no warn logging. Specify this setting to activate warn logging into a specific category. + * + *

            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) @@ -74,8 +74,8 @@ public abstract class AbstractEndpointExceptionResolver implements EndpointExcep /** * Specify the order value for this mapping. - *

            - * Default value is {@link Integer#MAX_VALUE}, meaning that it's non-ordered. + * + *

            Default value is {@link Integer#MAX_VALUE}, meaning that it's non-ordered. * * @see org.springframework.core.Ordered#getOrder() */ @@ -89,7 +89,7 @@ public abstract class AbstractEndpointExceptionResolver implements EndpointExcep } /** - * Default implementation that checks whether the given endpoint is in the set of {@link + * Default implementation that checks whether the given {@code endpoint} is in the set of {@link * #setMappedEndpoints mapped endpoints}. * * @see #resolveExceptionInternal(MessageContext,Object,Exception) @@ -111,8 +111,8 @@ public abstract class AbstractEndpointExceptionResolver implements EndpointExcep /** * Log the given exception at warn level, provided that warn logging has been activated through the {@link * #setWarnLogCategory "warnLogCategory"} property. - *

            - * Calls {@link #buildLogMessage} in order to determine the concrete message to log. Always passes the full + * + *

            Calls {@link #buildLogMessage} in order to determine the concrete message to log. Always passes the full * exception to the logger. * * @param ex the exception that got thrown during handler execution @@ -142,9 +142,9 @@ public abstract class AbstractEndpointExceptionResolver implements EndpointExcep * Template method for resolving exceptions that is called by {@link #resolveException}. * * @param messageContext current message context - * @param endpoint the executed endpoint, or null if none chosen at the time of the exception + * @param endpoint the executed endpoint, or {@code null} if none chosen at the time of the exception * @param ex the exception that got thrown during endpoint execution - * @return true if resolved; false otherwise + * @return {@code true} if resolved; {@code false} otherwise * @see #resolveException(MessageContext,Object,Exception) */ protected abstract boolean resolveExceptionInternal(MessageContext messageContext, Object endpoint, Exception ex); diff --git a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/AbstractJDomPayloadEndpoint.java b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/AbstractJDomPayloadEndpoint.java index f0d5932b..5b6514bb 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/AbstractJDomPayloadEndpoint.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/AbstractJDomPayloadEndpoint.java @@ -31,11 +31,11 @@ import org.springframework.xml.transform.TransformerObjectSupport; /** * Abstract base class for endpoints that handle the message payload as JDOM elements. - *

            + * *

            Offers the message payload as a JDOM {@link Element}, and allows subclasses to create a response by returning an - * Element. - *

            - * AbstractJDomPayloadEndpoint can accept only one payload element. Multiple payload elements + * {@code Element}. + * + * one payload element. Multiple payload elements * are not in accordance with WS-I. * * @author Arjen Poutsma @@ -49,8 +49,8 @@ public abstract class AbstractJDomPayloadEndpoint extends TransformerObjectSuppo /** * Set if the request {@link Source} should always be transformed into a new {@link JDOMResult}. - *

            - * Default is {@code false}, which is faster. + * + *

            Default is {@code false}, which is faster. */ public void setAlwaysTransform(boolean alwaysTransform) { this.alwaysTransform = alwaysTransform; @@ -65,8 +65,8 @@ public abstract class AbstractJDomPayloadEndpoint extends TransformerObjectSuppo /** * Returns the payload element of the given source. - *

            - * Default implementation checks whether the source is a {@link DOMSource}, and uses a {@link DOMBuilder} to create + * + *

            Default implementation checks whether the source is a {@link DOMSource}, and uses a {@link DOMBuilder} to create * a JDOM {@link Element}. In all other cases, or when {@linkplain #setAlwaysTransform(boolean) alwaysTransform} is * {@code true}, the source is transformed into a {@link JDOMResult}, which is more expensive. If the passed source * is {@code null}, {@code null} is returned. @@ -97,11 +97,11 @@ public abstract class AbstractJDomPayloadEndpoint extends TransformerObjectSuppo } /** - * Template method. Subclasses must implement this. Offers the request payload as a JDOM Element, and - * allows subclasses to return a response Element. + * Template method. Subclasses must implement this. Offers the request payload as a JDOM {@code Element}, and + * allows subclasses to return a response {@code Element}. * * @param requestElement the contents of the SOAP message as JDOM element - * @return the response element. Can be null to specify no response. + * @return the response element. Can be {@code null} to specify no response. */ protected abstract Element invokeInternal(Element requestElement) throws Exception; } diff --git a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/AbstractLoggingInterceptor.java b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/AbstractLoggingInterceptor.java index 46fc499d..73162dc6 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/AbstractLoggingInterceptor.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/AbstractLoggingInterceptor.java @@ -33,9 +33,9 @@ import org.springframework.ws.server.EndpointInterceptor; import org.springframework.xml.transform.TransformerObjectSupport; /** - * Abstract base class for EndpointInterceptor instances that log a part of a - * WebServiceMessage. By default, both request and response messages are logged, but this behaviour can be - * changed using the logRequest and logResponse properties. + * Abstract base class for {@code EndpointInterceptor} instances that log a part of a + * {@code WebServiceMessage}. By default, both request and response messages are logged, but this behaviour can be + * changed using the {@code logRequest} and {@code logResponse} properties. * * @author Arjen Poutsma * @since 1.0.0 @@ -43,8 +43,8 @@ import org.springframework.xml.transform.TransformerObjectSupport; public abstract class AbstractLoggingInterceptor extends TransformerObjectSupport implements EndpointInterceptor { /** - * The default Log instance used to write trace messages. This instance is mapped to the implementing - * Class. + * The default {@code Log} instance used to write trace messages. This instance is mapped to the implementing + * {@code Class}. */ protected transient Log logger = LogFactory.getLog(getClass()); @@ -52,12 +52,12 @@ public abstract class AbstractLoggingInterceptor extends TransformerObjectSuppor private boolean logResponse = true; - /** Indicates whether the request should be logged. Default is true. */ + /** Indicates whether the request should be logged. Default is {@code true}. */ public final void setLogRequest(boolean logRequest) { this.logRequest = logRequest; } - /** Indicates whether the response should be logged. Default is true. */ + /** Indicates whether the response should be logged. Default is {@code true}. */ public final void setLogResponse(boolean logResponse) { this.logResponse = logResponse; } @@ -65,8 +65,8 @@ public abstract class AbstractLoggingInterceptor extends TransformerObjectSuppor /** * Set the name of the logger to use. The name will be passed to the underlying logger implementation through * Commons Logging, getting interpreted as log category according to the logger's configuration. - *

            - * This can be specified to not log into the category of a class but rather into a specific named category. + * + *

            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) @@ -77,11 +77,11 @@ public abstract class AbstractLoggingInterceptor extends TransformerObjectSuppor } /** - * Logs the request message payload. Logging only occurs if logRequest is set to true, + * Logs the request message payload. Logging only occurs if {@code logRequest} is set to {@code true}, * which is the default. * * @param messageContext the message context - * @return true + * @return {@code true} * @throws TransformerException when the payload cannot be transformed to a string */ @Override @@ -93,11 +93,11 @@ public abstract class AbstractLoggingInterceptor extends TransformerObjectSuppor } /** - * Logs the response message payload. Logging only occurs if logResponse is set to true, + * Logs the response message payload. Logging only occurs if {@code logResponse} is set to {@code true}, * which is the default. * * @param messageContext the message context - * @return true + * @return {@code true} * @throws TransformerException when the payload cannot be transformed to a string */ @Override @@ -121,8 +121,8 @@ public abstract class AbstractLoggingInterceptor extends TransformerObjectSuppor /** * Determine whether the {@link #logger} field is enabled. - *

            - * Default is true when the "debug" level is enabled. Subclasses can override this to change the level + * + *

            Default is {@code true} when the "debug" level is enabled. Subclasses can override this to change the level * under which logging occurs. */ protected boolean isLogEnabled() { @@ -138,8 +138,8 @@ public abstract class AbstractLoggingInterceptor extends TransformerObjectSuppor /** * Logs the given {@link Source source} to the {@link #logger}, using the message as a prefix. - *

            - * By default, this message creates a string representation of the given source, and delegates to {@link + * + *

            By default, this message creates a string representation of the given source, and delegates to {@link * #logMessage(String)}. * * @param logMessage the log message @@ -158,8 +158,8 @@ public abstract class AbstractLoggingInterceptor extends TransformerObjectSuppor /** * Logs the given string message. - *

            - * By default, this method uses a "debug" level of logging. Subclasses can override this method to change the level + * + *

            By default, this method uses a "debug" level of logging. Subclasses can override this method to change the level * of logging used by the logger. * * @param message the message @@ -169,7 +169,7 @@ public abstract class AbstractLoggingInterceptor extends TransformerObjectSuppor } /** - * Abstract template method that returns the Source for the given WebServiceMessage. + * Abstract template method that returns the {@code Source} for the given {@code WebServiceMessage}. * * @param message the message * @return the source of the message diff --git a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/AbstractMarshallingPayloadEndpoint.java b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/AbstractMarshallingPayloadEndpoint.java index fb5cd48c..e8bccdb7 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/AbstractMarshallingPayloadEndpoint.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/AbstractMarshallingPayloadEndpoint.java @@ -31,7 +31,7 @@ import org.springframework.ws.support.MarshallingUtils; /** * Endpoint that unmarshals the request payload, and marshals the response object. This endpoint needs a - * Marshaller and Unmarshaller, both of which can be set using properties. An abstract + * {@code Marshaller} and {@code Unmarshaller}, both of which can be set using properties. An abstract * template method is invoked using the request object as a parameter, and allows for a response object to be returned. * * @author Arjen Poutsma @@ -54,7 +54,7 @@ public abstract class AbstractMarshallingPayloadEndpoint implements MessageEndpo private Unmarshaller unmarshaller; /** - * Creates a new AbstractMarshallingPayloadEndpoint. The {@link Marshaller} and {@link Unmarshaller} + * Creates a new {@code AbstractMarshallingPayloadEndpoint}. The {@link Marshaller} and {@link Unmarshaller} * must be injected using properties. * * @see #setMarshaller(org.springframework.oxm.Marshaller) @@ -64,15 +64,15 @@ public abstract class AbstractMarshallingPayloadEndpoint implements MessageEndpo } /** - * Creates a new AbstractMarshallingPayloadEndpoint with the given marshaller. The given {@link + * Creates a new {@code AbstractMarshallingPayloadEndpoint} with the given marshaller. The given {@link * Marshaller} should also implements the {@link Unmarshaller}, since it is used for both marshalling and * unmarshalling. If it is not, an exception is thrown. - *

            - * Note that all {@link Marshaller} implementations in Spring-WS also implement the {@link Unmarshaller} interface, + * + *

            Note that all {@link Marshaller} implementations in Spring-WS also implement the {@link Unmarshaller} interface, * so that you can safely use this constructor. * * @param marshaller object used as marshaller and unmarshaller - * @throws IllegalArgumentException when marshaller does not implement the {@link Unmarshaller} + * @throws IllegalArgumentException when {@code marshaller} does not implement the {@link Unmarshaller} * interface * @see #AbstractMarshallingPayloadEndpoint(Marshaller,Unmarshaller) */ @@ -90,7 +90,7 @@ public abstract class AbstractMarshallingPayloadEndpoint implements MessageEndpo } /** - * Creates a new AbstractMarshallingPayloadEndpoint with the given marshaller and unmarshaller. + * Creates a new {@code AbstractMarshallingPayloadEndpoint} with the given marshaller and unmarshaller. * * @param marshaller the marshaller to use * @param unmarshaller the unmarshaller to use @@ -154,12 +154,12 @@ public abstract class AbstractMarshallingPayloadEndpoint implements MessageEndpo /** * Callback for post-processing in terms of unmarshalling. Called on each message request, after standard * unmarshalling. - *

            - * Default implementation returns true. + * + *

            Default implementation returns {@code true}. * * @param messageContext the message context * @param requestObject the object unmarshalled from the {@link MessageContext#getRequest() request} - * @return true to continue and call {@link #invokeInternal(Object)}; false otherwise + * @return {@code true} to continue and call {@link #invokeInternal(Object)}; {@code false} otherwise */ protected boolean onUnmarshalRequest(MessageContext messageContext, Object requestObject) throws Exception { return true; @@ -177,8 +177,8 @@ public abstract class AbstractMarshallingPayloadEndpoint implements MessageEndpo /** * Callback for post-processing in terms of marshalling. Called on each message request, after standard marshalling * of the response. Only invoked when {@link #invokeInternal(Object)} returns an object. - *

            - * Default implementation is empty. + * + *

            Default implementation is empty. * * @param messageContext the message context * @param requestObject the object unmarshalled from the {@link MessageContext#getRequest() request} @@ -189,8 +189,8 @@ public abstract class AbstractMarshallingPayloadEndpoint implements MessageEndpo /** * Template method that gets called after the marshaller and unmarshaller have been set. - *

            - * The default implementation does nothing. + * + *

            The default implementation does nothing. * * @deprecated as of Spring Web Services 1.5: {@link #afterPropertiesSet()} is no longer final, so this can safely * be overridden in subclasses @@ -201,12 +201,12 @@ public abstract class AbstractMarshallingPayloadEndpoint implements MessageEndpo /** * Template method that subclasses must implement to process a request. - *

            - * The unmarshalled request object is passed as a parameter, and the returned object is marshalled to a response. If - * no response is required, return null. + * + *

            The unmarshalled request object is passed as a parameter, and the returned object is marshalled to a response. If + * no response is required, return {@code null}. * * @param requestObject the unmarshalled message payload as an object - * @return the object to be marshalled as response, or null if a response is not required + * @return the object to be marshalled as response, or {@code null} if a response is not required */ protected abstract Object invokeInternal(Object requestObject) throws Exception; } diff --git a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/AbstractSaxPayloadEndpoint.java b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/AbstractSaxPayloadEndpoint.java index 5011c620..b097e667 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/AbstractSaxPayloadEndpoint.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/AbstractSaxPayloadEndpoint.java @@ -24,11 +24,11 @@ import org.xml.sax.ContentHandler; import org.springframework.xml.transform.TransformerObjectSupport; /** - * Abstract base class for endpoints that handle the message payload with a SAX ContentHandler. Allows - * subclasses to create a response by returning a Source. - *

            - * Implementations of this class should create a new handler for each call of createContentHandler, because - * of thread safety. The handlers is later passed on to createResponse, so it can be used for holding + * Abstract base class for endpoints that handle the message payload with a SAX {@code ContentHandler}. Allows + * subclasses to create a response by returning a {@code Source}. + * + *

            Implementations of this class should create a new handler for each call of {@code createContentHandler}, because + * of thread safety. The handlers is later passed on to {@code createResponse}, so it can be used for holding * request-specific state. * * @author Arjen Poutsma @@ -41,7 +41,7 @@ import org.springframework.xml.transform.TransformerObjectSupport; public abstract class AbstractSaxPayloadEndpoint extends TransformerObjectSupport implements PayloadEndpoint { /** - * Invokes the provided ContentHandler on the given request. After parsing has been done, the provided + * Invokes the provided {@code ContentHandler} on the given request. After parsing has been done, the provided * response is returned. * * @see #createContentHandler() @@ -59,10 +59,10 @@ public abstract class AbstractSaxPayloadEndpoint extends TransformerObjectSuppor } /** - * Returns the SAX ContentHandler used to parse the incoming request payload. A new instance should be + * Returns the SAX {@code ContentHandler} used to parse the incoming request payload. A new instance should be * created for each call, because of thread-safety. The content handler can be used to hold request-specific state. - *

            - * If an incoming message does not contain a payload, this method will not be invoked. + * + *

            If an incoming message does not contain a payload, this method will not be invoked. * * @return a SAX content handler to be used for parsing */ @@ -70,10 +70,10 @@ public abstract class AbstractSaxPayloadEndpoint extends TransformerObjectSuppor /** * Returns the response to be given, if any. This method is called after the request payload has been parsed using - * the SAX ContentHandler. The passed ContentHandler is created by {@link + * the SAX {@code ContentHandler}. The passed {@code ContentHandler} is created by {@link * #createContentHandler()}: it can be used to hold request-specific state. - *

            - * If an incoming message does not contain a payload, this method will be invoked with null as content + * + *

            If an incoming message does not contain a payload, this method will be invoked with {@code null} as content * handler. * * @param contentHandler the content handler used to parse the request diff --git a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/AbstractStaxEventPayloadEndpoint.java b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/AbstractStaxEventPayloadEndpoint.java index 829fe3d3..ef4623a1 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/AbstractStaxEventPayloadEndpoint.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/AbstractStaxEventPayloadEndpoint.java @@ -38,7 +38,7 @@ import org.springframework.ws.context.MessageContext; /** * Abstract base class for endpoints that handle the message payload with event-based StAX. Allows subclasses to read - * the request with a XMLEventReader, and to create a response using a XMLEventWriter. + * the request with a {@code XMLEventReader}, and to create a response using a {@code XMLEventWriter}. * * @author Arjen Poutsma * @see #invokeInternal(javax.xml.stream.XMLEventReader,javax.xml.stream.util.XMLEventConsumer, @@ -62,17 +62,17 @@ public abstract class AbstractStaxEventPayloadEndpoint extends AbstractStaxPaylo } /** - * Create a XMLEventFactory that this endpoint will use to create XMLEvents. Can be + * Create a {@code XMLEventFactory} that this endpoint will use to create {@code XMLEvent}s. Can be * overridden in subclasses, adding further initialization of the factory. The resulting - * XMLEventFactory is cached, so this method will only be called once. + * {@code XMLEventFactory} is cached, so this method will only be called once. * - * @return the created XMLEventFactory + * @return the created {@code XMLEventFactory} */ protected XMLEventFactory createXmlEventFactory() { return XMLEventFactory.newInstance(); } - /** Returns an XMLEventFactory to read XML from. */ + /** Returns an {@code XMLEventFactory} to read XML from. */ private XMLEventFactory getEventFactory() { if (eventFactory == null) { eventFactory = createXmlEventFactory(); @@ -137,20 +137,20 @@ public abstract class AbstractStaxEventPayloadEndpoint extends AbstractStaxPaylo } /** - * Template method. Subclasses must implement this. Offers the request payload as a XMLEventReader, and - * a XMLEventWriter to write the response payload to. + * Template method. Subclasses must implement this. Offers the request payload as a {@code XMLEventReader}, and + * a {@code XMLEventWriter} to write the response payload to. * * @param eventReader the reader to read the payload events from * @param eventWriter the writer to write payload events to - * @param eventFactory an XMLEventFactory that can be used to create events + * @param eventFactory an {@code XMLEventFactory} that can be used to create events */ protected abstract void invokeInternal(XMLEventReader eventReader, XMLEventConsumer eventWriter, XMLEventFactory eventFactory) throws Exception; /** - * Implementation of the XMLEventWriter interface that creates a response - * WebServiceMessage as soon as any method is called, thus lazily creating the response. + * Implementation of the {@code XMLEventWriter} interface that creates a response + * {@code WebServiceMessage} as soon as any method is called, thus lazily creating the response. */ private class ResponseCreatingEventWriter implements XMLEventWriter { diff --git a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/AbstractStaxPayloadEndpoint.java b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/AbstractStaxPayloadEndpoint.java index 9c48c0c8..2f9e5d9a 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/AbstractStaxPayloadEndpoint.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/AbstractStaxPayloadEndpoint.java @@ -22,8 +22,8 @@ import javax.xml.stream.XMLOutputFactory; import org.springframework.xml.transform.TransformerObjectSupport; /** - * Abstract base class for endpoints use StAX. Provides an XMLInputFactory and an - * XMLOutputFactory. + * Abstract base class for endpoints use StAX. Provides an {@code XMLInputFactory} and an + * {@code XMLOutputFactory}. * * @author Arjen Poutsma * @see XMLInputFactory @@ -39,7 +39,7 @@ public abstract class AbstractStaxPayloadEndpoint extends TransformerObjectSuppo private XMLOutputFactory outputFactory; - /** Returns an XMLInputFactory to read XML from. */ + /** Returns an {@code XMLInputFactory} to read XML from. */ protected final XMLInputFactory getInputFactory() { if (inputFactory == null) { inputFactory = createXmlInputFactory(); @@ -47,7 +47,7 @@ public abstract class AbstractStaxPayloadEndpoint extends TransformerObjectSuppo return inputFactory; } - /** Returns an XMLOutputFactory to write XML to. */ + /** Returns an {@code XMLOutputFactory} to write XML to. */ protected final XMLOutputFactory getOutputFactory() { if (outputFactory == null) { outputFactory = createXmlOutputFactory(); @@ -56,22 +56,22 @@ public abstract class AbstractStaxPayloadEndpoint extends TransformerObjectSuppo } /** - * Create a XMLInputFactory that this endpoint will use to create XMLStreamReaders or - * XMLEventReader. Can be overridden in subclasses, adding further initialization of the factory. The - * resulting XMLInputFactory is cached, so this method will only be called once. + * Create a {@code XMLInputFactory} that this endpoint will use to create {@code XMLStreamReader}s or + * {@code XMLEventReader}. Can be overridden in subclasses, adding further initialization of the factory. The + * resulting {@code XMLInputFactory} is cached, so this method will only be called once. * - * @return the created XMLInputFactory + * @return the created {@code XMLInputFactory} */ protected XMLInputFactory createXmlInputFactory() { return XMLInputFactory.newInstance(); } /** - * Create a XMLOutputFactory that this endpoint will use to create XMLStreamWriterss or - * XMLEventWriters. Can be overridden in subclasses, adding further initialization of the factory. The - * resulting XMLOutputFactory is cached, so this method will only be called once. + * Create a {@code XMLOutputFactory} that this endpoint will use to create {@code XMLStreamWriters}s or + * {@code XMLEventWriters}. Can be overridden in subclasses, adding further initialization of the factory. The + * resulting {@code XMLOutputFactory} is cached, so this method will only be called once. * - * @return the created XMLOutputFactory + * @return the created {@code XMLOutputFactory} */ protected XMLOutputFactory createXmlOutputFactory() { return XMLOutputFactory.newInstance(); diff --git a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/AbstractStaxStreamPayloadEndpoint.java b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/AbstractStaxStreamPayloadEndpoint.java index 1a318eec..78be7787 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/AbstractStaxStreamPayloadEndpoint.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/AbstractStaxStreamPayloadEndpoint.java @@ -35,7 +35,7 @@ import org.springframework.ws.context.MessageContext; /** * Abstract base class for endpoints that handle the message payload with streaming StAX. Allows subclasses to read the - * request with a XMLStreamReader, and to create a response using a XMLStreamWriter. + * request with a {@code XMLStreamReader}, and to create a response using a {@code XMLStreamWriter}. * * @author Arjen Poutsma * @see #invokeInternal(javax.xml.stream.XMLStreamReader,javax.xml.stream.XMLStreamWriter) @@ -114,8 +114,8 @@ public abstract class AbstractStaxStreamPayloadEndpoint extends AbstractStaxPayl } /** - * Template method. Subclasses must implement this. Offers the request payload as a XMLStreamReader, - * and a XMLStreamWriter to write the response payload to. + * Template method. Subclasses must implement this. Offers the request payload as a {@code XMLStreamReader}, + * and a {@code XMLStreamWriter} to write the response payload to. * * @param streamReader the reader to read the payload from * @param streamWriter the writer to write the payload to @@ -123,8 +123,8 @@ public abstract class AbstractStaxStreamPayloadEndpoint extends AbstractStaxPayl protected abstract void invokeInternal(XMLStreamReader streamReader, XMLStreamWriter streamWriter) throws Exception; /** - * Implementation of the XMLStreamWriter interface that creates a response - * WebServiceMessage as soon as any method is called, thus lazily creating the response. + * Implementation of the {@code XMLStreamWriter} interface that creates a response + * {@code WebServiceMessage} as soon as any method is called, thus lazily creating the response. */ private class ResponseCreatingStreamWriter implements XMLStreamWriter { diff --git a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/AbstractValidatingMarshallingPayloadEndpoint.java b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/AbstractValidatingMarshallingPayloadEndpoint.java index c5d4a805..63493dd5 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/AbstractValidatingMarshallingPayloadEndpoint.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/AbstractValidatingMarshallingPayloadEndpoint.java @@ -96,7 +96,7 @@ public abstract class AbstractValidatingMarshallingPayloadEndpoint extends Abstr * @param messageContext the message context * @param requestObject the object unmarshalled from the {@link MessageContext#getRequest() request} * @param errors validation errors holder - * @return true to continue and call {@link #invokeInternal(Object)}; false otherwise + * @return {@code true} to continue and call {@link #invokeInternal(Object)}; {@code false} otherwise */ protected abstract boolean onValidationErrors(MessageContext messageContext, Object requestObject, Errors errors); } diff --git a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/AbstractXomPayloadEndpoint.java b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/AbstractXomPayloadEndpoint.java index 8e8b091c..cb16577f 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/AbstractXomPayloadEndpoint.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/AbstractXomPayloadEndpoint.java @@ -52,9 +52,9 @@ import org.springframework.xml.transform.TraxUtils; /** * Abstract base class for endpoints that handle the message payload as XOM elements. Offers the message payload as a - * XOM Element, and allows subclasses to create a response by returning an Element. - *

            - * An AbstractXomPayloadEndpoint only accept one payload element. Multiple payload elements are not in + * XOM {@code Element}, and allows subclasses to create a response by returning an {@code Element}. + * + *

            An {@code AbstractXomPayloadEndpoint} only accept one payload element. Multiple payload elements are not in * accordance with WS-I. * * @author Arjen Poutsma @@ -97,8 +97,8 @@ public abstract class AbstractXomPayloadEndpoint extends TransformerObjectSuppor /** * Creates a {@link Serializer} to be used for writing the response to. - *

            - * Default implementation uses the UTF-8 encoding and does not set any options, but this may be changed in + * + *

            Default implementation uses the UTF-8 encoding and does not set any options, but this may be changed in * subclasses. * * @param outputStream the output stream to serialize to @@ -109,11 +109,11 @@ public abstract class AbstractXomPayloadEndpoint extends TransformerObjectSuppor } /** - * Template method. Subclasses must implement this. Offers the request payload as a XOM Element, and - * allows subclasses to return a response Element. + * Template method. Subclasses must implement this. Offers the request payload as a XOM {@code Element}, and + * allows subclasses to return a response {@code Element}. * * @param requestElement the contents of the SOAP message as XOM element - * @return the response element. Can be null to specify no response. + * @return the response element. Can be {@code null} to specify no response. */ protected abstract Element invokeInternal(Element requestElement) throws Exception; diff --git a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/MessageEndpoint.java b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/MessageEndpoint.java index 7c487827..5911fb82 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/MessageEndpoint.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/MessageEndpoint.java @@ -20,7 +20,7 @@ import org.springframework.ws.context.MessageContext; /** * Defines the basic contract for Web Services interested in the entire message payload. - *

            + * *

            The main entrypoint is {@link #invoke(MessageContext)}, which gets invoked with the message context. This context * contains the {@link MessageContext#getRequest() request}, and can be used to create a response. * @@ -32,8 +32,8 @@ public interface MessageEndpoint { /** * Invokes an operation. - *

            - *

            The given messageContext can be used to create a response. + * + *

            The given {@code messageContext} can be used to create a response. * * @param messageContext the message context * @throws Exception if an exception occurs diff --git a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/MethodEndpoint.java b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/MethodEndpoint.java index 91cbc843..f365d58b 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/MethodEndpoint.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/MethodEndpoint.java @@ -26,8 +26,8 @@ import org.springframework.util.ReflectionUtils; /** * Represents a bean method that will be invoked as part of an incoming Web service message. - *

            - * Consists of a {@link Method}, and a bean {@link Object}. + * + *

            Consists of a {@link Method}, and a bean {@link Object}. * * @author Arjen Poutsma * @since 1.0.0 diff --git a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/PayloadEndpoint.java b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/PayloadEndpoint.java index dc30f89d..3c7fe954 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/PayloadEndpoint.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/PayloadEndpoint.java @@ -20,8 +20,8 @@ import javax.xml.transform.Source; /** * Defines the basic contract for Web Services interested in just the message payload. - *

            - * The main entrypoint is {@link #invoke(Source)}, which gets invoked with the contents of the requesting message. + * + *

            The main entrypoint is {@link #invoke(Source)}, which gets invoked with the contents of the requesting message. * * @author Arjen Poutsma * @since 1.0.0 @@ -31,8 +31,8 @@ public interface PayloadEndpoint { /** * Invokes the endpoint with the given request payload, and possibly returns a response. * - * @param request the payload of the request message, may be null - * @return the payload of the response message, may be null to indicate no response + * @param request the payload of the request message, may be {@code null} + * @return the payload of the response message, may be {@code null} to indicate no response * @throws Exception if an exception occurs */ Source invoke(Source request) throws Exception; diff --git a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/adapter/AbstractMethodEndpointAdapter.java b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/adapter/AbstractMethodEndpointAdapter.java index 45eaa984..1a7185f2 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/adapter/AbstractMethodEndpointAdapter.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/adapter/AbstractMethodEndpointAdapter.java @@ -46,8 +46,8 @@ public abstract class AbstractMethodEndpointAdapter extends TransformerObjectSup * * @param messageContext the current message context * @param endpoint the endpoint to use. This object must have previously been passed to the - * supportsInternal method of this interface, which must have returned - * true + * {@code supportsInternal} method of this interface, which must have returned + * {@code true} * @throws Exception in case of errors */ @Override diff --git a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/adapter/DefaultMethodEndpointAdapter.java b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/adapter/DefaultMethodEndpointAdapter.java index d9cecfe6..5583128e 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/adapter/DefaultMethodEndpointAdapter.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/adapter/DefaultMethodEndpointAdapter.java @@ -302,8 +302,8 @@ public class DefaultMethodEndpointAdapter extends AbstractMethodEndpointAdapter /** * Returns the argument array for the given method endpoint. - *

            - * This implementation iterates over the set {@linkplain #setMethodArgumentResolvers(List) argument resolvers} to + * + *

            This implementation iterates over the set {@linkplain #setMethodArgumentResolvers(List) argument resolvers} to * resolve each argument. * * @param messageContext the current message context @@ -328,8 +328,8 @@ public class DefaultMethodEndpointAdapter extends AbstractMethodEndpointAdapter /** * Handle the return value for the given method endpoint. - *

            - * This implementation iterates over the set {@linkplain #setMethodReturnValueHandlers(java.util.List)} return value + * + *

            This implementation iterates over the set {@linkplain #setMethodReturnValueHandlers(java.util.List)} return value * handlers} to resolve the return value. * * @param messageContext the current message context diff --git a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/adapter/GenericMarshallingMethodEndpointAdapter.java b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/adapter/GenericMarshallingMethodEndpointAdapter.java index ec611d28..f815eeda 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/adapter/GenericMarshallingMethodEndpointAdapter.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/adapter/GenericMarshallingMethodEndpointAdapter.java @@ -29,8 +29,8 @@ import org.springframework.ws.server.endpoint.MethodEndpoint; * Subclass of {@link MarshallingMethodEndpointAdapter} that supports {@link GenericMarshaller} and {@link * GenericUnmarshaller}. More specifically, this adapter is aware of the {@link Method#getGenericParameterTypes()} and * {@link Method#getGenericReturnType()}. - *

            - * Prefer to use this adapter rather than the plain {@link MarshallingMethodEndpointAdapter} in combination with Java 5 + * + *

            Prefer to use this adapter rather than the plain {@link MarshallingMethodEndpointAdapter} in combination with Java 5 * marshallers, such as the {@link Jaxb2Marshaller}. * * @author Arjen Poutsma @@ -43,7 +43,7 @@ import org.springframework.ws.server.endpoint.MethodEndpoint; public class GenericMarshallingMethodEndpointAdapter extends MarshallingMethodEndpointAdapter { /** - * Creates a new GenericMarshallingMethodEndpointAdapter. The {@link Marshaller} and {@link + * Creates a new {@code GenericMarshallingMethodEndpointAdapter}. The {@link Marshaller} and {@link * Unmarshaller} must be injected using properties. * * @see #setMarshaller(org.springframework.oxm.Marshaller) @@ -53,15 +53,15 @@ public class GenericMarshallingMethodEndpointAdapter extends MarshallingMethodEn } /** - * Creates a new GenericMarshallingMethodEndpointAdapter with the given marshaller. If the given {@link + * Creates a new {@code GenericMarshallingMethodEndpointAdapter} with the given marshaller. If the given {@link * Marshaller} also implements the {@link Unmarshaller} interface, it is used for both marshalling and * unmarshalling. Otherwise, an exception is thrown. - *

            - * Note that all {@link Marshaller} implementations in Spring-WS also implement the {@link Unmarshaller} interface, + * + *

            Note that all {@link Marshaller} implementations in Spring-WS also implement the {@link Unmarshaller} interface, * so that you can safely use this constructor. * * @param marshaller object used as marshaller and unmarshaller - * @throws IllegalArgumentException when marshaller does not implement the {@link Unmarshaller} + * @throws IllegalArgumentException when {@code marshaller} does not implement the {@link Unmarshaller} * interface */ public GenericMarshallingMethodEndpointAdapter(Marshaller marshaller) { @@ -69,7 +69,7 @@ public class GenericMarshallingMethodEndpointAdapter extends MarshallingMethodEn } /** - * Creates a new GenericMarshallingMethodEndpointAdapter with the given marshaller and unmarshaller. + * Creates a new {@code GenericMarshallingMethodEndpointAdapter} with the given marshaller and unmarshaller. * * @param marshaller the marshaller to use * @param unmarshaller the unmarshaller to use diff --git a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/adapter/MarshallingMethodEndpointAdapter.java b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/adapter/MarshallingMethodEndpointAdapter.java index 0c3f306e..6f67358a 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/adapter/MarshallingMethodEndpointAdapter.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/adapter/MarshallingMethodEndpointAdapter.java @@ -39,10 +39,10 @@ import org.springframework.ws.support.MarshallingUtils; * MyMarshalledType handleMyMessage(MyUnmarshalledType request); * * I.e. methods that take a single parameter that {@link Unmarshaller#supports(Class) is supported} by the {@link - * Unmarshaller}, and return either void or a type {@link Marshaller#supports(Class) supported} by the + * Unmarshaller}, and return either {@code void} or a type {@link Marshaller#supports(Class) supported} by the * {@link Marshaller}. The method can have any name, as long as it is mapped by an {@link EndpointMapping}. - *

            - * This endpoint needs a Marshaller and Unmarshaller, both of which can be set using + * + *

            This endpoint needs a {@code Marshaller} and {@code Unmarshaller}, both of which can be set using * properties. * * @author Arjen Poutsma @@ -61,7 +61,7 @@ public class MarshallingMethodEndpointAdapter extends AbstractMethodEndpointAdap private Unmarshaller unmarshaller; /** - * Creates a new MarshallingMethodEndpointAdapter. The {@link Marshaller} and {@link Unmarshaller} must + * Creates a new {@code MarshallingMethodEndpointAdapter}. The {@link Marshaller} and {@link Unmarshaller} must * be injected using properties. * * @see #setMarshaller(org.springframework.oxm.Marshaller) @@ -71,15 +71,15 @@ public class MarshallingMethodEndpointAdapter extends AbstractMethodEndpointAdap } /** - * Creates a new MarshallingMethodEndpointAdapter with the given marshaller. If the given {@link + * Creates a new {@code MarshallingMethodEndpointAdapter} with the given marshaller. If the given {@link * Marshaller} also implements the {@link Unmarshaller} interface, it is used for both marshalling and * unmarshalling. Otherwise, an exception is thrown. - *

            - * Note that all {@link Marshaller} implementations in Spring also implement the {@link Unmarshaller} interface, + * + *

            Note that all {@link Marshaller} implementations in Spring also implement the {@link Unmarshaller} interface, * so that you can safely use this constructor. * * @param marshaller object used as marshaller and unmarshaller - * @throws IllegalArgumentException when marshaller does not implement the {@link Unmarshaller} + * @throws IllegalArgumentException when {@code marshaller} does not implement the {@link Unmarshaller} * interface */ public MarshallingMethodEndpointAdapter(Marshaller marshaller) { @@ -96,7 +96,7 @@ public class MarshallingMethodEndpointAdapter extends AbstractMethodEndpointAdap } /** - * Creates a new MarshallingMethodEndpointAdapter with the given marshaller and unmarshaller. + * Creates a new {@code MarshallingMethodEndpointAdapter} with the given marshaller and unmarshaller. * * @param marshaller the marshaller to use * @param unmarshaller the unmarshaller to use @@ -161,7 +161,7 @@ public class MarshallingMethodEndpointAdapter extends AbstractMethodEndpointAdap } /** - * Supports a method with a single, unmarshallable parameter, and that return void or a marshallable + * Supports a method with a single, unmarshallable parameter, and that return {@code void} or a marshallable * type. * * @see Marshaller#supports(Class) diff --git a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/adapter/MessageEndpointAdapter.java b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/adapter/MessageEndpointAdapter.java index c50210b0..bf67c595 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/adapter/MessageEndpointAdapter.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/adapter/MessageEndpointAdapter.java @@ -23,9 +23,9 @@ import org.springframework.ws.server.endpoint.MessageEndpoint; import org.springframework.ws.soap.server.SoapMessageDispatcher; /** - * Adapter to use a MessageEndpoint as the endpoint for a EndpointInvocationChain. - *

            - * This adapter is registered by default by the {@link MessageDispatcher} and {@link SoapMessageDispatcher}. + * Adapter to use a {@code MessageEndpoint} as the endpoint for a {@code EndpointInvocationChain}. + * + *

            This adapter is registered by default by the {@link MessageDispatcher} and {@link SoapMessageDispatcher}. * * @author Arjen Poutsma * @see org.springframework.ws.server.EndpointInvocationChain diff --git a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/adapter/MessageMethodEndpointAdapter.java b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/adapter/MessageMethodEndpointAdapter.java index 41447d38..bdffe26b 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/adapter/MessageMethodEndpointAdapter.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/adapter/MessageMethodEndpointAdapter.java @@ -28,10 +28,10 @@ import org.springframework.ws.soap.server.SoapMessageDispatcher; *

              * void handleMyMessage(MessageContext request);
              * 
            - * I.e. methods that take a single {@link MessageContext} parameter, and return void. The method can have + * 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 {@link org.springframework.ws.server.EndpointMapping}. - *

            - * This adapter is registered by default by the {@link MessageDispatcher} and {@link SoapMessageDispatcher}. + * + *

            This adapter is registered by default by the {@link MessageDispatcher} and {@link SoapMessageDispatcher}. * * @author Arjen Poutsma * @since 1.0.0 diff --git a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/adapter/PayloadEndpointAdapter.java b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/adapter/PayloadEndpointAdapter.java index 82b99561..1969f772 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/adapter/PayloadEndpointAdapter.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/adapter/PayloadEndpointAdapter.java @@ -27,9 +27,9 @@ import org.springframework.ws.soap.server.SoapMessageDispatcher; import org.springframework.xml.transform.TransformerObjectSupport; /** - * Adapter to use a PayloadEndpoint as the endpoint for a EndpointInvocationChain. - *

            - * This adapter is registered by default by the {@link MessageDispatcher} and {@link SoapMessageDispatcher}. + * Adapter to use a {@code PayloadEndpoint} as the endpoint for a {@code EndpointInvocationChain}. + * + *

            This adapter is registered by default by the {@link MessageDispatcher} and {@link SoapMessageDispatcher}. * * @author Arjen Poutsma * @see org.springframework.ws.server.endpoint.PayloadEndpoint diff --git a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/adapter/PayloadMethodEndpointAdapter.java b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/adapter/PayloadMethodEndpointAdapter.java index fe75f0d6..c5cef60b 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/adapter/PayloadMethodEndpointAdapter.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/adapter/PayloadMethodEndpointAdapter.java @@ -34,10 +34,10 @@ import org.springframework.ws.soap.server.SoapMessageDispatcher; *

              * Source handleMyMessage(Source request);
              * 
            - * I.e. methods that take a single {@link Source} parameter, and return either void or a {@link Source}. + * 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}. - *

            - * This adapter is registered by default by the {@link MessageDispatcher} and {@link SoapMessageDispatcher}. + * + *

            This adapter is registered by default by the {@link MessageDispatcher} and {@link SoapMessageDispatcher}. * * @author Arjen Poutsma * @since 1.0.0 diff --git a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/adapter/XPathParamAnnotationMethodEndpointAdapter.java b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/adapter/XPathParamAnnotationMethodEndpointAdapter.java index d752d4a8..3c4cebc8 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/adapter/XPathParamAnnotationMethodEndpointAdapter.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/adapter/XPathParamAnnotationMethodEndpointAdapter.java @@ -50,9 +50,9 @@ import org.springframework.xml.namespace.SimpleNamespaceContext; * Source handleMyMessage(@XPathParam("/root/child/text")String param1, @XPathParam("/root/child/number")double * param2); * - * I.e. methods that return either void or a {@link Source}, and have parameters annotated with {@link + * 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:

            • boolean, or {@link Boolean}
            • double, or {@link + * following types:
              • {@code boolean}, or {@link Boolean}
              • {@code double}, or {@link * Double}
              • {@link String}
              • {@link Node}
              • {@link NodeList}
              * * @author Arjen Poutsma @@ -79,7 +79,7 @@ public class XPathParamAnnotationMethodEndpointAdapter extends AbstractMethodEnd xpathFactory = XPathFactory.newInstance(); } - /** Supports methods with @XPathParam parameters, and return either Source or nothing. */ + /** Supports methods with @XPathParam parameters, and return either {@code Source} or nothing. */ @Override protected boolean supportsInternal(MethodEndpoint methodEndpoint) { Method method = methodEndpoint.getMethod(); diff --git a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/adapter/method/AbstractPayloadMethodProcessor.java b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/adapter/method/AbstractPayloadMethodProcessor.java index 6cf6569c..f90d00d4 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/adapter/method/AbstractPayloadMethodProcessor.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/adapter/method/AbstractPayloadMethodProcessor.java @@ -42,8 +42,8 @@ public abstract class AbstractPayloadMethodProcessor extends TransformerObjectSu /** * {@inheritDoc} - *

              - * This implementation gets checks if the given parameter is annotated with {@link RequestPayload}, and invokes + * + *

              This implementation gets checks if the given parameter is annotated with {@link RequestPayload}, and invokes * {@link #supportsRequestPayloadParameter(org.springframework.core.MethodParameter)} afterwards. */ @Override @@ -70,8 +70,8 @@ public abstract class AbstractPayloadMethodProcessor extends TransformerObjectSu /** * {@inheritDoc} - *

              - * This implementation gets checks if the method of the given return type is annotated with {@link ResponsePayload}, + * + *

              This implementation gets checks if the method of the given return type is annotated with {@link ResponsePayload}, * and invokes {@link #supportsResponsePayloadReturnType(org.springframework.core.MethodParameter)} afterwards. */ @Override diff --git a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/adapter/method/MarshallingPayloadMethodProcessor.java b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/adapter/method/MarshallingPayloadMethodProcessor.java index 52d8bcad..df90a50c 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/adapter/method/MarshallingPayloadMethodProcessor.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/adapter/method/MarshallingPayloadMethodProcessor.java @@ -53,8 +53,8 @@ public class MarshallingPayloadMethodProcessor extends AbstractPayloadMethodProc * Creates a new {@code MarshallingPayloadMethodProcessor} with the given marshaller. If the given {@link * Marshaller} also implements the {@link Unmarshaller} interface, it is used for both marshalling and * unmarshalling. Otherwise, an exception is thrown. - *

              - * Note that all {@link Marshaller} implementations in Spring also implement the {@link Unmarshaller} interface, so + * + *

              Note that all {@link Marshaller} implementations in Spring also implement the {@link Unmarshaller} interface, so * that you can safely use this constructor. * * @param marshaller object used as marshaller and unmarshaller diff --git a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/adapter/method/SourcePayloadMethodProcessor.java b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/adapter/method/SourcePayloadMethodProcessor.java index c5f4a4b6..26ca4f25 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/adapter/method/SourcePayloadMethodProcessor.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/adapter/method/SourcePayloadMethodProcessor.java @@ -118,8 +118,8 @@ public class SourcePayloadMethodProcessor extends AbstractPayloadSourceMethodPro /** * Create a {@code XMLInputFactory} that this resolver will use to create {@link javax.xml.stream.XMLStreamReader} * and {@link javax.xml.stream.XMLEventReader} objects. - *

              - * Can be overridden in subclasses, adding further initialization of the factory. The resulting factory is cached, + * + *

              Can be overridden in subclasses, adding further initialization of the factory. The resulting factory is cached, * so this method will only be called once. * * @return the created factory diff --git a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/adapter/method/StaxPayloadMethodArgumentResolver.java b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/adapter/method/StaxPayloadMethodArgumentResolver.java index 9619a81c..15f42a07 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/adapter/method/StaxPayloadMethodArgumentResolver.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/adapter/method/StaxPayloadMethodArgumentResolver.java @@ -145,8 +145,8 @@ public class StaxPayloadMethodArgumentResolver extends TransformerObjectSupport /** * Create a {@code XMLInputFactory} that this resolver will use to create {@link XMLStreamReader} and {@link * XMLEventReader} objects. - *

              - * Can be overridden in subclasses, adding further initialization of the factory. The resulting factory is cached, + * + *

              Can be overridden in subclasses, adding further initialization of the factory. The resulting factory is cached, * so this method will only be called once. * * @return the created factory diff --git a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/adapter/method/XPathParamMethodArgumentResolver.java b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/adapter/method/XPathParamMethodArgumentResolver.java index f264d626..2278ee81 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/adapter/method/XPathParamMethodArgumentResolver.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/adapter/method/XPathParamMethodArgumentResolver.java @@ -40,8 +40,8 @@ import org.springframework.xml.transform.TransformerHelper; /** * Implementation of {@link MethodArgumentResolver} that supports the {@link XPathParam @XPathParam} annotation. - *

              - * This resolver supports parameters annotated with {@link XPathParam @XPathParam} that specifies the XPath expression + * + *

              This resolver supports parameters annotated with {@link XPathParam @XPathParam} that specifies the XPath expression * that should be bound to that parameter. The parameter can either a "natively supported" XPath type ({@link Boolean * boolean}, {@link Double double}, {@link String}, {@link Node}, or {@link NodeList}), or a type that is {@linkplain * ConversionService#canConvert(Class, Class) supported} by the {@link ConversionService}. @@ -59,8 +59,8 @@ public class XPathParamMethodArgumentResolver implements MethodArgumentResolver /** * Sets the conversion service to use. - *

              - * Defaults to the {@linkplain ConversionServiceFactory#createDefaultConversionService() default conversion + * + *

              Defaults to the {@linkplain ConversionServiceFactory#createDefaultConversionService() default conversion * service}. */ public void setConversionService(ConversionService conversionService) { @@ -144,8 +144,8 @@ public class XPathParamMethodArgumentResolver implements MethodArgumentResolver /** * Create a {@code XPathFactory} that this resolver will use to create {@link XPath} objects. - *

              - * Can be overridden in subclasses, adding further initialization of the factory. The resulting factory is cached, + * + *

              Can be overridden in subclasses, adding further initialization of the factory. The resulting factory is cached, * so this method will only be called once. * * @return the created factory diff --git a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/adapter/method/dom/XomPayloadMethodProcessor.java b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/adapter/method/dom/XomPayloadMethodProcessor.java index 7bfab24d..4185d7f8 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/adapter/method/dom/XomPayloadMethodProcessor.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/adapter/method/dom/XomPayloadMethodProcessor.java @@ -97,8 +97,8 @@ public class XomPayloadMethodProcessor extends AbstractPayloadSourceMethodProces /** * Create a {@code DocumentBuilderFactory} that this resolver will use to create response payloads. - *

              - * Can be overridden in subclasses, adding further initialization of the factory. The resulting factory is cached, + * + *

              Can be overridden in subclasses, adding further initialization of the factory. The resulting factory is cached, * so this method will only be called once. * * @return the created factory diff --git a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/annotation/Endpoint.java b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/annotation/Endpoint.java index b75166f3..a1a6a958 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/annotation/Endpoint.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/annotation/Endpoint.java @@ -28,8 +28,8 @@ import org.springframework.ws.soap.server.endpoint.mapping.SoapActionAnnotationM /** * Indicates that an annotated class is an "Endpoint" (e.g. a web service endpoint). - *

              - * This annotation serves as a specialization of {@link Component @Component}, allowing for implementation classes to be + * + *

              This annotation serves as a specialization of {@link Component @Component}, allowing for implementation classes to be * autodetected through classpath scanning. Instances of this class are typically picked up by an {@link * AbstractAnnotationMethodEndpointMapping} implementation, such as {@link SoapActionAnnotationMethodEndpointMapping}. * diff --git a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/annotation/Namespace.java b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/annotation/Namespace.java index 375786aa..fd839a68 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/annotation/Namespace.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/annotation/Namespace.java @@ -25,8 +25,8 @@ import javax.xml.XMLConstants; /** * Sets up a namespace to be used in an {@link Endpoint @Endpoint} method, class, or package. - *

              - * Typically used in combination with {@link XPathParam @XPathParam}, or {@link PayloadRoot @PayloadRoot}. + * + *

              Typically used in combination with {@link XPathParam @XPathParam}, or {@link PayloadRoot @PayloadRoot}. * * @author Arjen Poutsma * @see XPathParam diff --git a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/annotation/XPathParam.java b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/annotation/XPathParam.java index e9c968f8..fd268ea2 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/annotation/XPathParam.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/annotation/XPathParam.java @@ -24,8 +24,8 @@ import java.lang.annotation.Target; /** * Indicates that a method parameter should be bound to an XPath expression. The annotation value signifies the XPath - * expression to use. The parameter can be of the following types:

              • boolean, or {@link - * Boolean}
              • double, or {@link Double}
              • {@link String}
              • {@link + * expression to use. The parameter can be of the following types:
                • {@code boolean}, or {@link + * Boolean}
                • {@code double}, or {@link Double}
                • {@link String}
                • {@link * org.w3c.dom.Node}
                • {@link org.w3c.dom.NodeList}
                * * @author Arjen Poutsma diff --git a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/interceptor/AbstractValidatingInterceptor.java b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/interceptor/AbstractValidatingInterceptor.java index 40fd737a..50d01c80 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/interceptor/AbstractValidatingInterceptor.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/interceptor/AbstractValidatingInterceptor.java @@ -41,12 +41,12 @@ import org.springframework.xml.xsd.XsdSchema; import org.springframework.xml.xsd.XsdSchemaCollection; /** - * Abstract base class for EndpointInterceptor implementations that validate part of the message using a - * schema. The exact message part is determined by the getValidationRequestSource and - * getValidationResponseSource template methods. - *

                - * By default, only the request message is validated, but this behaviour can be changed using the - * validateRequest and validateResponse properties. + * Abstract base class for {@code EndpointInterceptor} implementations that validate part of the message using a + * schema. The exact message part is determined by the {@code getValidationRequestSource} and + * {@code getValidationResponseSource} template methods. + * + *

                By default, only the request message is validated, but this behaviour can be changed using the + * {@code validateRequest} and {@code validateResponse} properties. * * @author Arjen Poutsma * @see #getValidationRequestSource(org.springframework.ws.WebServiceMessage) @@ -73,7 +73,7 @@ public abstract class AbstractValidatingInterceptor extends TransformerObjectSup } /** - * Sets the schema language. Default is the W3C XML Schema: http://www.w3.org/2001/XMLSchema". + * Sets the schema language. Default is the W3C XML Schema: {@code http://www.w3.org/2001/XMLSchema"}. * * @see org.springframework.xml.validation.XmlValidatorFactory#SCHEMA_W3C_XML * @see org.springframework.xml.validation.XmlValidatorFactory#SCHEMA_RELAX_NG @@ -143,12 +143,12 @@ public abstract class AbstractValidatingInterceptor extends TransformerObjectSup this.errorHandler = errorHandler; } - /** Indicates whether the request should be validated against the schema. Default is true. */ + /** Indicates whether the request should be validated against the schema. Default is {@code true}. */ public void setValidateRequest(boolean validateRequest) { this.validateRequest = validateRequest; } - /** Indicates whether the response should be validated against the schema. Default is false. */ + /** Indicates whether the response should be validated against the schema. Default is {@code false}. */ public void setValidateResponse(boolean validateResponse) { this.validateResponse = validateResponse; } @@ -170,13 +170,13 @@ public abstract class AbstractValidatingInterceptor extends TransformerObjectSup /** * Validates the request message in the given message context. Validation only occurs if - * validateRequest is set to true, which is the default. - *

                - * Returns true if the request is valid, or false if it isn't. Additionally, when the + * {@code validateRequest} is set to {@code true}, which is the default. + * + *

                Returns {@code true} if the request is valid, or {@code false} if it isn't. Additionally, when the * request message is a {@link SoapMessage}, a {@link SoapFault} is added as response. * * @param messageContext the message context - * @return true if the message is valid; false otherwise + * @return {@code true} if the message is valid; {@code false} otherwise * @see #setValidateRequest(boolean) */ @Override @@ -199,11 +199,11 @@ public abstract class AbstractValidatingInterceptor extends TransformerObjectSup /** * Template method that is called when the request message contains validation errors. Default implementation logs - * all errors, and returns false, i.e. do not process the request. + * all errors, and returns {@code false}, i.e. do not process the request. * * @param messageContext the message context * @param errors the validation errors - * @return true to continue processing the request, false (the default) otherwise + * @return {@code true} to continue processing the request, {@code false} (the default) otherwise */ protected boolean handleRequestValidationErrors(MessageContext messageContext, SAXParseException[] errors) throws TransformerException { @@ -215,12 +215,12 @@ public abstract class AbstractValidatingInterceptor extends TransformerObjectSup /** * Validates the response message in the given message context. Validation only occurs if - * validateResponse is set to true, which is not the default. - *

                - * Returns true if the request is valid, or false if it isn't. + * {@code validateResponse} is set to {@code true}, which is not the default. + * + *

                Returns {@code true} if the request is valid, or {@code false} if it isn't. * * @param messageContext the message context. - * @return true if the response is valid; false otherwise + * @return {@code true} if the response is valid; {@code false} otherwise * @see #setValidateResponse(boolean) */ @Override @@ -242,11 +242,11 @@ public abstract class AbstractValidatingInterceptor extends TransformerObjectSup /** * Template method that is called when the response message contains validation errors. Default implementation logs - * all errors, and returns false, i.e. do not cot continue to process the response interceptor chain. + * all errors, and returns {@code false}, i.e. do not cot continue to process the response interceptor chain. * * @param messageContext the message context * @param errors the validation errors - * @return true to continue the response interceptor chain, false (the default) otherwise + * @return {@code true} to continue the response interceptor chain, {@code false} (the default) otherwise */ protected boolean handleResponseValidationErrors(MessageContext messageContext, SAXParseException[] errors) { for (SAXParseException error : errors) { @@ -270,7 +270,7 @@ public abstract class AbstractValidatingInterceptor extends TransformerObjectSup * Abstract template method that returns the part of the request message that is to be validated. * * @param request the request message - * @return the part of the message that is to validated, or null not to validate anything + * @return the part of the message that is to validated, or {@code null} not to validate anything */ protected abstract Source getValidationRequestSource(WebServiceMessage request); @@ -278,7 +278,7 @@ public abstract class AbstractValidatingInterceptor extends TransformerObjectSup * Abstract template method that returns the part of the response message that is to be validated. * * @param response the response message - * @return the part of the message that is to validated, or null not to validate anything + * @return the part of the message that is to validated, or {@code null} not to validate anything */ protected abstract Source getValidationResponseSource(WebServiceMessage response); } diff --git a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/interceptor/DelegatingSmartEndpointInterceptor.java b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/interceptor/DelegatingSmartEndpointInterceptor.java index 6420699d..7df45178 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/interceptor/DelegatingSmartEndpointInterceptor.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/interceptor/DelegatingSmartEndpointInterceptor.java @@ -53,8 +53,8 @@ public class DelegatingSmartEndpointInterceptor implements SmartEndpointIntercep /** * {@inheritDoc} - *

                - * This implementation delegates to {@link #shouldIntercept(WebServiceMessage, Object)}. + * + *

                This implementation delegates to {@link #shouldIntercept(WebServiceMessage, Object)}. */ @Override public boolean shouldIntercept(MessageContext messageContext, Object endpoint) { @@ -64,8 +64,8 @@ public class DelegatingSmartEndpointInterceptor implements SmartEndpointIntercep /** * Indicates whether this interceptor should intercept the given request message. - *

                - * This implementation always returns {@code true}. + * + *

                This implementation always returns {@code true}. * * @param request the request message * @param endpoint chosen endpoint to invoke diff --git a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/interceptor/EndpointInterceptorAdapter.java b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/interceptor/EndpointInterceptorAdapter.java index da1bc52d..d1ffa179 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/interceptor/EndpointInterceptorAdapter.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/interceptor/EndpointInterceptorAdapter.java @@ -24,7 +24,7 @@ import org.springframework.ws.context.MessageContext; import org.springframework.ws.server.EndpointInterceptor; /** - * Default implementation of the EndpointInterceptor interface, for simplified implementation of + * Default implementation of the {@code EndpointInterceptor} interface, for simplified implementation of * pre-only/post-only interceptors. * * @author Arjen Poutsma @@ -35,15 +35,15 @@ public class EndpointInterceptorAdapter implements EndpointInterceptor { /** Logger available to subclasses */ protected final Log logger = LogFactory.getLog(getClass()); - /** Returns false. */ + /** Returns {@code false}. */ public boolean understands(Element header) { return false; } /** - * Returns true. + * Returns {@code true}. * - * @return true + * @return {@code true} */ @Override public boolean handleRequest(MessageContext messageContext, Object endpoint) throws Exception { @@ -51,9 +51,9 @@ public class EndpointInterceptorAdapter implements EndpointInterceptor { } /** - * Returns true. + * Returns {@code true}. * - * @return true + * @return {@code true} */ @Override public boolean handleResponse(MessageContext messageContext, Object endpoint) throws Exception { @@ -61,9 +61,9 @@ public class EndpointInterceptorAdapter implements EndpointInterceptor { } /** - * Returns true. + * Returns {@code true}. * - * @return true + * @return {@code true} */ @Override public boolean handleFault(MessageContext messageContext, Object endpoint) throws Exception { diff --git a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/interceptor/PayloadLoggingInterceptor.java b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/interceptor/PayloadLoggingInterceptor.java index fcc2e44e..2caeb332 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/interceptor/PayloadLoggingInterceptor.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/interceptor/PayloadLoggingInterceptor.java @@ -24,7 +24,7 @@ import org.springframework.ws.server.endpoint.AbstractLoggingInterceptor; /** * Simple {@link org.springframework.ws.server.EndpointInterceptor EndpointInterceptor} that logs the payload of request * and response messages. - *

                + * *

                By default, both request and response messages are logged, but this behaviour can be changed using the {@link * #logRequest} and {@link #logResponse} properties. * diff --git a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/interceptor/PayloadTransformingInterceptor.java b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/interceptor/PayloadTransformingInterceptor.java index a505bf81..c02b8502 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/interceptor/PayloadTransformingInterceptor.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/interceptor/PayloadTransformingInterceptor.java @@ -41,11 +41,11 @@ import org.springframework.xml.transform.ResourceSource; import org.springframework.xml.transform.TransformerObjectSupport; /** - * Interceptor that transforms the payload of WebServiceMessages using XSLT stylesheet. Allows for seperate + * Interceptor that transforms the payload of {@code WebServiceMessage}s using XSLT stylesheet. Allows for seperate * stylesheets for request and response. This interceptor is especially useful when supporting with multiple version of * a Web service: you can transform the older message format to the new format. - *

                - * The stylesheets to use can be set using the requestXslt and responseXslt properties. Both + * + *

                The stylesheets to use can be set using the {@code requestXslt} and {@code responseXslt} properties. Both * of these are optional: if not set, the message is simply not transformed. Setting one of the two is required, * though. * @@ -79,10 +79,10 @@ public class PayloadTransformingInterceptor extends TransformerObjectSupport /** * Transforms the request message in the given message context using a provided stylesheet. Transformation only - * occurs if the requestXslt has been set. + * occurs if the {@code requestXslt} has been set. * * @param messageContext the message context - * @return always returns true + * @return always returns {@code true} * @see #setRequestXslt(org.springframework.core.io.Resource) */ @Override @@ -98,10 +98,10 @@ public class PayloadTransformingInterceptor extends TransformerObjectSupport /** * Transforms the response message in the given message context using a stylesheet. Transformation only occurs if - * the responseXslt has been set. + * the {@code responseXslt} has been set. * * @param messageContext the message context - * @return always returns true + * @return always returns {@code true} * @see #setResponseXslt(org.springframework.core.io.Resource) */ @Override diff --git a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/mapping/AbstractAnnotationMethodEndpointMapping.java b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/mapping/AbstractAnnotationMethodEndpointMapping.java index 84323468..e7eac3bf 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/mapping/AbstractAnnotationMethodEndpointMapping.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/mapping/AbstractAnnotationMethodEndpointMapping.java @@ -26,8 +26,8 @@ import org.springframework.ws.server.endpoint.annotation.Endpoint; /** * Abstract base for {@link org.springframework.ws.server.EndpointMapping} implementations that map classes tagged with * an annotation. By default the annotation is {@link Endpoint}, but this can be overriden in subclasses. - *

                - * The methods of each bean carrying @Endpoint will be registered using {@link #registerMethods(String)}. + * + *

                The methods of each bean carrying @Endpoint will be registered using {@link #registerMethods(String)}. * * @author Arjen Poutsma * @since 1.0.0 @@ -38,12 +38,12 @@ public abstract class AbstractAnnotationMethodEndpointMapping extends Abstrac /** * Set whether to detect endpoint beans in ancestor ApplicationContexts. - *

                - * Default is "false": Only endpoint beans in the current ApplicationContext will be detected, i.e. only in the + * + *

                Default is "false": Only endpoint beans in the current ApplicationContext will be detected, i.e. only in the * context that this EndpointMapping itself is defined in (typically the current MessageDispatcherServlet's * context). - *

                - * Switch this flag on to detect endpoint beans in ancestor contexts (typically the Spring root + * + *

                Switch this flag on to detect endpoint beans in ancestor contexts (typically the Spring root * WebApplicationContext) as well. */ public void setDetectEndpointsInAncestorContexts(boolean detectEndpointsInAncestorContexts) { diff --git a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/mapping/AbstractEndpointMapping.java b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/mapping/AbstractEndpointMapping.java index de25736d..986d2811 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/mapping/AbstractEndpointMapping.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/mapping/AbstractEndpointMapping.java @@ -52,7 +52,7 @@ public abstract class AbstractEndpointMapping extends ApplicationObjectSupport i /** * Returns the the endpoint interceptors to apply to all endpoints mapped by this endpoint mapping. * - * @return array of endpoint interceptors, or null if none + * @return array of endpoint interceptors, or {@code null} if none */ public EndpointInterceptor[] getInterceptors() { return interceptors; @@ -61,7 +61,7 @@ public abstract class AbstractEndpointMapping extends ApplicationObjectSupport i /** * Sets the endpoint interceptors to apply to all endpoints mapped by this endpoint mapping. * - * @param interceptors array of endpoint interceptors, or null if none + * @param interceptors array of endpoint interceptors, or {@code null} if none */ public final void setInterceptors(EndpointInterceptor[] interceptors) { this.interceptors = interceptors; @@ -74,8 +74,8 @@ public abstract class AbstractEndpointMapping extends ApplicationObjectSupport i /** * Specify the order value for this mapping. - *

                - * Default value is {@link Integer#MAX_VALUE}, meaning that it's non-ordered. + * + *

                Default value is {@link Integer#MAX_VALUE}, meaning that it's non-ordered. * * @see org.springframework.core.Ordered#getOrder() */ @@ -149,8 +149,8 @@ public abstract class AbstractEndpointMapping extends ApplicationObjectSupport i } /** - * Creates a new EndpointInvocationChain based on the given message context, endpoint, and - * interceptors. Default implementation creates a simple EndpointInvocationChain based on the set + * Creates a new {@code EndpointInvocationChain} based on the given message context, endpoint, and + * interceptors. Default implementation creates a simple {@code EndpointInvocationChain} based on the set * interceptors. * * @param endpoint the endpoint @@ -176,8 +176,8 @@ public abstract class AbstractEndpointMapping extends ApplicationObjectSupport i /** * Sets the default endpoint for this endpoint mapping. This endpoint will be returned if no specific mapping was * found. - *

                - * Default is null, indicating no default endpoint. + * + *

                Default is {@code null}, indicating no default endpoint. * * @param defaultEndpoint the default endpoint, or null if none */ @@ -190,7 +190,7 @@ public abstract class AbstractEndpointMapping extends ApplicationObjectSupport i * context. * * @param endpointName the endpoint name - * @return the resolved endpoint, or null if the name could not be resolved + * @return the resolved endpoint, or {@code null} if the name could not be resolved */ protected Object resolveStringEndpoint(String endpointName) { if (getApplicationContext().containsBean(endpointName)) { @@ -202,12 +202,12 @@ public abstract class AbstractEndpointMapping extends ApplicationObjectSupport i } /** - * Lookup an endpoint for the given request, returning null if no specific one is found. This template - * method is called by getEndpoint, a null return value will lead to the default handler, if one is + * Lookup an endpoint for the given request, returning {@code null} if no specific one is found. This template + * method is called by getEndpoint, a {@code null} return value will lead to the default handler, if one is * set. - *

                - * The returned endpoint can be a string, in which case it is resolved as a bean name. Also, it can take the form - * beanName#method, in which case the method is resolved. + * + *

                The returned endpoint can be a string, in which case it is resolved as a bean name. Also, it can take the form + * {@code beanName#method}, in which case the method is resolved. * * @return the looked up endpoint instance, or null * @throws Exception if there is an error diff --git a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/mapping/AbstractMapBasedEndpointMapping.java b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/mapping/AbstractMapBasedEndpointMapping.java index 0f50ae18..05647bb5 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/mapping/AbstractMapBasedEndpointMapping.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/mapping/AbstractMapBasedEndpointMapping.java @@ -26,10 +26,10 @@ import org.springframework.util.StringUtils; import org.springframework.ws.context.MessageContext; /** - * Abstract base class for endpoint mapping that are based on a Map. Provides mappings of application + * Abstract base class for endpoint mapping that are based on a {@code Map}. Provides mappings of application * context beans as well as a settable map. - *

                - * Subclasses determine the exact nature of the key in the enpoint map; this can be a qualified name, a SOAP Header, the + * + *

                Subclasses determine the exact nature of the key in the enpoint map; this can be a qualified name, a SOAP Header, the * result of a XPath validation. The values are always endpoint objects, or bean names of endpoint objects. * * @author Arjen Poutsma @@ -48,11 +48,11 @@ public abstract class AbstractMapBasedEndpointMapping extends AbstractEndpointMa /** * Set whether to lazily initialize endpoints. Only applicable to singleton endpoints, as prototypes are always - * lazily initialized. Default is false, as eager initialization allows for more efficiency through + * lazily initialized. Default is {@code false}, as eager initialization allows for more efficiency through * referencing the controller objects directly. - *

                - * If you want to allow your endpoints to be lazily initialized, make them "lazy-init" and set this flag to - * true. Just making them "lazy-init" will not work, as they are initialized through the references + * + *

                If you want to allow your endpoints to be lazily initialized, make them "lazy-init" and set this flag to + * {@code true}. Just making them "lazy-init" will not work, as they are initialized through the references * from the endpoint mapping in this case. */ public void setLazyInitEndpoints(boolean lazyInitEndpoints) { @@ -60,8 +60,8 @@ public abstract class AbstractMapBasedEndpointMapping extends AbstractEndpointMa } /** - * Set whether to register bean names found in the application context. Setting this to true will - * register all beans found in the application context under their name. Default is false. + * Set whether to register bean names found in the application context. Setting this to {@code true} will + * register all beans found in the application context under their name. Default is {@code false}. */ public final void setRegisterBeanNames(boolean registerBeanNames) { this.registerBeanNames = registerBeanNames; @@ -89,13 +89,13 @@ public abstract class AbstractMapBasedEndpointMapping extends AbstractEndpointMa } } - /** Validates the given endpoint key. Should return true is the given string is valid. */ + /** Validates the given endpoint key. Should return {@code true} is the given string is valid. */ protected abstract boolean validateLookupKey(String key); /** - * Returns the the endpoint key for the given message context. Returns null if a key cannot be found. + * Returns the the endpoint key for the given message context. Returns {@code null} if a key cannot be found. * - * @return the registration key; or null + * @return the registration key; or {@code null} */ protected abstract String getLookupKeyForMessage(MessageContext messageContext) throws Exception; @@ -103,7 +103,7 @@ public abstract class AbstractMapBasedEndpointMapping extends AbstractEndpointMa * Lookup an endpoint for the given message. The extraction of the endpoint key is delegated to the concrete * subclass. * - * @return the looked up endpoint, or null + * @return the looked up endpoint, or {@code null} */ @Override protected final Object getEndpointInternal(MessageContext messageContext) throws Exception { @@ -121,7 +121,7 @@ public abstract class AbstractMapBasedEndpointMapping extends AbstractEndpointMa * Looks up an endpoint instance for the given keys. All keys are tried in order. * * @param key key the beans are mapped to - * @return the associated endpoint instance, or null if not found + * @return the associated endpoint instance, or {@code null} if not found */ protected Object lookupEndpoint(String key) { return endpointMap.get(key); @@ -155,12 +155,12 @@ public abstract class AbstractMapBasedEndpointMapping extends AbstractEndpointMa } /** - * Registers annd checks the set endpoints. Checks the beans set through setEndpointMap and - * setMappings, and registers the bean names found in the application context, if - * registerBeanNames is set to true. + * Registers annd checks the set endpoints. Checks the beans set through {@code setEndpointMap} and + * {@code setMappings}, and registers the bean names found in the application context, if + * {@code registerBeanNames} is set to {@code true}. * - * @throws ApplicationContextException if either of the endpoints defined via setEndpointMap or - * setMappings is invalid + * @throws ApplicationContextException if either of the endpoints defined via {@code setEndpointMap} or + * {@code setMappings} is invalid * @see #setEndpointMap(java.util.Map) * @see #setMappings(java.util.Properties) * @see #setRegisterBeanNames(boolean) diff --git a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/mapping/AbstractMethodEndpointMapping.java b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/mapping/AbstractMethodEndpointMapping.java index 90a17248..ee744bea 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/mapping/AbstractMethodEndpointMapping.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/mapping/AbstractMethodEndpointMapping.java @@ -38,8 +38,8 @@ import org.springframework.ws.server.endpoint.MethodEndpoint; /** * Abstract base class for {@link MethodEndpoint} mappings. - *

                - * Subclasses typically implement {@link org.springframework.beans.factory.config.BeanPostProcessor} to look for beans + * + *

                Subclasses typically implement {@link org.springframework.beans.factory.config.BeanPostProcessor} to look for beans * that qualify as endpoint. The methods of this bean are then registered under a specific key with {@link * #registerEndpoint(Object, MethodEndpoint)}. * @@ -54,7 +54,7 @@ public abstract class AbstractMethodEndpointMapping extends AbstractEndpointM * Lookup an endpoint for the given message. The extraction of the endpoint key is delegated to the concrete * subclass. * - * @return the looked up endpoint, or null + * @return the looked up endpoint, or {@code null} * @see #getLookupKeyForMessage(MessageContext) */ @Override @@ -80,7 +80,7 @@ public abstract class AbstractMethodEndpointMapping extends AbstractEndpointM * Looks up an endpoint instance for the given keys. All keys are tried in order. * * @param key key the beans are mapped to - * @return the associated endpoint instance, or null if not found + * @return the associated endpoint instance, or {@code null} if not found */ protected MethodEndpoint lookupEndpoint(T key) { return endpointMap.get(key); @@ -184,11 +184,11 @@ public abstract class AbstractMethodEndpointMapping extends AbstractEndpointM } /** - * Returns the the endpoint key for the given method. Returns null if the method is not to be + * Returns the the endpoint key for the given method. Returns {@code null} if the method is not to be * registered, which is the default. * * @param method the method - * @return a registration key, or null if the method is not to be registered + * @return a registration key, or {@code null} if the method is not to be registered * @see #getLookupKeysForMethod(Method) */ protected T getLookupKeyForMethod(Method method) { @@ -210,8 +210,8 @@ public abstract class AbstractMethodEndpointMapping extends AbstractEndpointM /** * Return the class or interface to use for method reflection. - *

                - * Default implementation delegates to {@link AopUtils#getTargetClass(Object)}. + * + *

                Default implementation delegates to {@link AopUtils#getTargetClass(Object)}. * * @param endpoint the bean instance (might be an AOP proxy) * @return the bean class to expose diff --git a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/mapping/AbstractQNameEndpointMapping.java b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/mapping/AbstractQNameEndpointMapping.java index 832fff21..0d7e898f 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/mapping/AbstractQNameEndpointMapping.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/mapping/AbstractQNameEndpointMapping.java @@ -22,7 +22,7 @@ import org.springframework.ws.context.MessageContext; import org.springframework.xml.namespace.QNameUtils; /** - * Abstract base class for EndpointMappings that resolve qualified names as registration keys. + * Abstract base class for {@code EndpointMapping}s that resolve qualified names as registration keys. * * @author Arjen Poutsma * @since 1.0.0 diff --git a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/mapping/PayloadRootAnnotationMethodEndpointMapping.java b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/mapping/PayloadRootAnnotationMethodEndpointMapping.java index 5a0c3781..66721978 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/mapping/PayloadRootAnnotationMethodEndpointMapping.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/mapping/PayloadRootAnnotationMethodEndpointMapping.java @@ -33,8 +33,8 @@ import org.springframework.ws.server.endpoint.support.PayloadRootUtils; /** * Implementation of the {@link EndpointMapping} interface that uses the {@link PayloadRoot} annotation to map methods * to request payload root elements. - *

                - * Endpoints typically have the following form: + * + *

                Endpoints typically have the following form: *

                  * @Endpoint
                  * public class MyEndpoint{
                diff --git a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/mapping/PayloadRootQNameEndpointMapping.java b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/mapping/PayloadRootQNameEndpointMapping.java
                index f8934fcd..264ba236 100644
                --- a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/mapping/PayloadRootQNameEndpointMapping.java
                +++ b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/mapping/PayloadRootQNameEndpointMapping.java
                @@ -24,21 +24,21 @@ import org.springframework.ws.context.MessageContext;
                 import org.springframework.ws.server.endpoint.support.PayloadRootUtils;
                 
                 /**
                - * Implementation of the EndpointMapping interface to map from the qualified name of the request payload
                + * Implementation of the {@code EndpointMapping} interface to map from the qualified name of the request payload
                  * root element. Supports both mapping to bean instances and mapping to bean names: the latter is required for prototype
                  * endpoints.
                - * 

                - * The endpointMap property is suitable for populating the endpoint map with bean references, e.g. via the + * + *

                The {@code endpointMap} property is suitable for populating the endpoint map with bean references, e.g. via the * map element in XML bean definitions. - *

                - * Mappings to bean names can be set via the mappings property, in a form accepted by the - * java.util.Properties class, like as follows: + * + *

                Mappings to bean names can be set via the {@code mappings} property, in a form accepted by the + * {@code java.util.Properties} class, like as follows: *

                  * {http://www.springframework.org/spring-ws/samples/airline/schemas}BookFlight=bookFlightEndpoint
                  * {http://www.springframework.org/spring-ws/samples/airline/schemas}GetFlights=getFlightsEndpoint
                  * 
                * The syntax is QNAME=ENDPOINT_BEAN_NAME. Qualified names are parsed using the syntax described in - * QNameEditor. + * {@code QNameEditor}. * * @author Arjen Poutsma * @see org.springframework.xml.namespace.QNameEditor diff --git a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/mapping/SimpleMethodEndpointMapping.java b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/mapping/SimpleMethodEndpointMapping.java index fc3437d6..3112bd18 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/mapping/SimpleMethodEndpointMapping.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/mapping/SimpleMethodEndpointMapping.java @@ -29,19 +29,19 @@ import org.springframework.ws.server.endpoint.support.PayloadRootUtils; /** * Simple subclass of {@link AbstractMethodEndpointMapping} that maps from the local name of the request payload to - * methods. Endpoint beans are registered using the endpoints property; the endpoint methods that start - * with methodPrefix and end with methodSuffix will be registered. - *

                - * Endpoints typically have the following form: + * methods. Endpoint beans are registered using the {@code endpoints} property; the endpoint methods that start + * with {@code methodPrefix} and end with {@code methodSuffix} will be registered. + * + *

                Endpoints typically have the following form: *

                  * public class MyEndpoint{
                - * 

                + * * public Source handleMyMessage(Source source) { * ... * } * } *

                - * This method will handle any message that has the MyMessage as a payload root local name. + * This method will handle any message that has the {@code MyMessage} as a payload root local name. * * @author Arjen Poutsma * @see #setEndpoints(Object[]) @@ -68,8 +68,8 @@ public class SimpleMethodEndpointMapping extends AbstractMethodEndpointMappingmethodPrefix and end with - * methodSuffix will be registered. + * Sets the endpoints. The endpoint methods that start with {@code methodPrefix} and end with + * {@code methodSuffix} will be registered. */ public void setEndpoints(Object[] endpoints) { this.endpoints = endpoints; @@ -82,7 +82,7 @@ public class SimpleMethodEndpointMapping extends AbstractMethodEndpointMappinghandle". + * "{@code handle}". * * @see #DEFAULT_METHOD_PREFIX */ diff --git a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/mapping/UriEndpointMapping.java b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/mapping/UriEndpointMapping.java index 7df065f7..d015e1dd 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/mapping/UriEndpointMapping.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/mapping/UriEndpointMapping.java @@ -29,14 +29,14 @@ import org.springframework.ws.transport.context.TransportContextHolder; * Implementation of the {@code EndpointMapping} interface to map from the full request URI or request URI path to * endpoint beans. Supports both mapping to bean instances and mapping to bean names: the latter is required for * prototype handlers. - *

                - * When the {@link #setUsePath(boolean) usePath} property is enabled, the mapping will be based on the URI path rather + * + *

                When the {@link #setUsePath(boolean) usePath} property is enabled, the mapping will be based on the URI path rather * than the full URI. - *

                - * The {@code endpointMap} property is suitable for populating the endpoint map with bean references, e.g. via the map + * + *

                The {@code endpointMap} property is suitable for populating the endpoint map with bean references, e.g. via the map * element in XML bean definitions. - *

                - * Mappings to bean names can be set via the {@code mappings} property, in a form accepted by the {@code + * + *

                Mappings to bean names can be set via the {@code mappings} property, in a form accepted by the {@code * java.util.Properties} class, like as follows: *

                  * http://example.com:8080/services/bookFlight=bookFlightEndpoint
                @@ -47,8 +47,8 @@ import org.springframework.ws.transport.context.TransportContextHolder;
                  * /services/bookFlight=bookFlightEndpoint
                  * 
                * The syntax is [URI|PATH]=ENDPOINT_BEAN_NAME. - *

                - * This endpoint mapping does not read from the request message, and therefore is more suitable for message factories + * + *

                This endpoint mapping does not read from the request message, and therefore is more suitable for message factories * which directly read from the transport request (such as the {@link AxiomSoapMessageFactory} with the {@code * payloadCaching} disabled). However, this endpoint mapping obviously is transport specific. * diff --git a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/mapping/XPathPayloadEndpointMapping.java b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/mapping/XPathPayloadEndpointMapping.java index 359f3d2f..50073716 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/mapping/XPathPayloadEndpointMapping.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/mapping/XPathPayloadEndpointMapping.java @@ -33,18 +33,18 @@ import org.springframework.xml.xpath.XPathExpression; import org.springframework.xml.xpath.XPathExpressionFactory; /** - * Implementation of the EndpointMapping interface that maps to endpoint using an XPath expression. + * Implementation of the {@code EndpointMapping} interface that maps to endpoint using an XPath expression. * Supports both mapping to bean instances and mapping to bean names: the latter is required for prototype endpoints. - *

                - * The XPath expression can be set using the expression property. Setting this property is required. There - * is also an optional namespaces property, which defines to set namespace bindings that are used in the + * + *

                The XPath expression can be set using the {@code expression} property. Setting this property is required. There + * is also an optional {@code namespaces} property, which defines to set namespace bindings that are used in the * expression. - *

                - * The endpointMap property is suitable for populating the endpoint map with bean references, e.g. via the + * + *

                The {@code endpointMap} property is suitable for populating the endpoint map with bean references, e.g. via the * map element in XML bean definitions. - *

                - * Mappings to bean names can be set via the mappings property, in a form accepted by the - * java.util.Properties class, like as follows: + * + *

                Mappings to bean names can be set via the {@code mappings} property, in a form accepted by the + * {@code java.util.Properties} class, like as follows: *

                  * BookFlight=bookFlightEndpoint
                  * GetFlights=getFlightsEndpoint
                diff --git a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/mapping/jaxb/XmlRootElementEndpointMapping.java b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/mapping/jaxb/XmlRootElementEndpointMapping.java
                index e5faf07d..233429c5 100644
                --- a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/mapping/jaxb/XmlRootElementEndpointMapping.java
                +++ b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/mapping/jaxb/XmlRootElementEndpointMapping.java
                @@ -32,8 +32,8 @@ import org.springframework.xml.transform.TransformerHelper;
                 /**
                  * Implementation of the {@link org.springframework.ws.server.EndpointMapping EndpointMapping} interface that uses the
                  * JAXB2 {@link XmlRootElement} annotation to map methods to request payload root elements.
                - * 

                - * Endpoints typically have the following form: + * + *

                Endpoints typically have the following form: *

                  * @Endpoint
                  * public class MyEndpoint{
                diff --git a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/support/NamespaceUtils.java b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/support/NamespaceUtils.java
                index b8c6b099..511af52c 100644
                --- a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/support/NamespaceUtils.java
                +++ b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/support/NamespaceUtils.java
                @@ -39,8 +39,8 @@ public abstract class NamespaceUtils {
                     /**
                      * Creates a {@code NamespaceContext} for the specified method, based on {@link Namespaces @Namespaces} and {@link
                      * Namespace @Namespace} annotations.
                -     * 

                - * This method will search for {@link Namespaces @Namespaces} and {@link Namespace @Namespace} annotation in the + * + *

                This method will search for {@link Namespaces @Namespaces} and {@link Namespace @Namespace} annotation in the * given method, its class, and its package, in reverse order. That is: package-level annotations are overridden by * class-level annotations, which again are overridden by method-level annotations. * diff --git a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/support/PayloadRootUtils.java b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/support/PayloadRootUtils.java index 2d70a28f..e1195bdb 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/support/PayloadRootUtils.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/support/PayloadRootUtils.java @@ -53,8 +53,8 @@ public abstract class PayloadRootUtils { * Returns the root qualified name of the given source, transforming it if necessary. * * @param source the source to get the root element from - * @param transformerFactory a transformer factory, necessary if the given source is not a DOMSource - * @return the root element, or null if source is null + * @param transformerFactory a transformer factory, necessary if the given source is not a {@code DOMSource} + * @return the root element, or {@code null} if {@code source} is {@code null} */ public static QName getPayloadRootQName(Source source, TransformerFactory transformerFactory) throws TransformerException { diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/AbstractSoapMessage.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/AbstractSoapMessage.java index 6d230a7a..0213098d 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/AbstractSoapMessage.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/AbstractSoapMessage.java @@ -31,37 +31,37 @@ public abstract class AbstractSoapMessage extends AbstractMimeMessage implements private SoapVersion version; - /** Returns getEnvelope().getBody(). */ + /** Returns {@code getEnvelope().getBody()}. */ @Override public final SoapBody getSoapBody() { return getEnvelope().getBody(); } - /** Returns getEnvelope().getHeader(). */ + /** Returns {@code getEnvelope().getHeader()}. */ @Override public final SoapHeader getSoapHeader() { return getEnvelope().getHeader(); } - /** Returns getSoapBody().getPayloadSource(). */ + /** Returns {@code getSoapBody().getPayloadSource()}. */ @Override public final Source getPayloadSource() { return getSoapBody().getPayloadSource(); } - /** Returns getSoapBody().getPayloadResult(). */ + /** Returns {@code getSoapBody().getPayloadResult()}. */ @Override public final Result getPayloadResult() { return getSoapBody().getPayloadResult(); } - /** Returns getSoapBody().hasFault(). */ + /** Returns {@code getSoapBody().hasFault()}. */ @Override public final boolean hasFault() { return getSoapBody().hasFault(); } - /** Returns getSoapBody().getFault().getFaultStringOrReason(). */ + /** Returns {@code getSoapBody().getFault().getFaultStringOrReason()}. */ @Override public final String getFaultReason() { if (hasFault()) { diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/SoapBody.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/SoapBody.java index 221a5f00..0cdf957c 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/SoapBody.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/SoapBody.java @@ -23,11 +23,11 @@ import javax.xml.transform.Source; import org.springframework.ws.WebServiceMessage; /** - * Represents the Body element in a SOAP message. A SOAP body contains the payload of the - * message. This payload can be custom XML, or a SoapFault (but not both). - *

                - * Note that the source returned by getSource() includes the SOAP Body element itself. For the contents of - * the body, use getPayloadSource(). + * Represents the {@code Body} element in a SOAP message. A SOAP body contains the payload of the + * message. This payload can be custom XML, or a {@code SoapFault} (but not both). + * + *

                Note that the source returned by {@code getSource()} includes the SOAP Body element itself. For the contents of + * the body, use {@code getPayloadSource()}. * * @author Arjen Poutsma * @see SoapEnvelope#getBody() @@ -39,7 +39,7 @@ import org.springframework.ws.WebServiceMessage; public interface SoapBody extends SoapElement { /** - * Returns a Source that represents the contents of the body. + * Returns a {@code Source} that represents the contents of the body. * * @return the message contents * @see WebServiceMessage#getPayloadSource() @@ -47,9 +47,9 @@ public interface SoapBody extends SoapElement { Source getPayloadSource(); /** - * Returns a Result that represents the contents of the body. - *

                - * Calling this method removes the current content of the body. + * Returns a {@code Result} that represents the contents of the body. + * + *

                Calling this method removes the current content of the body. * * @return the message contents * @see WebServiceMessage#getPayloadResult() @@ -57,63 +57,63 @@ public interface SoapBody extends SoapElement { Result getPayloadResult(); /** - * Adds a MustUnderstand fault to the body. A MustUnderstand is returned when a SOAP - * header with a MustUnderstand attribute is not understood. - *

                - * Adding a fault removes the current content of the body. + * Adds a {@code MustUnderstand} fault to the body. A {@code MustUnderstand} is returned when a SOAP + * header with a {@code MustUnderstand} attribute is not understood. + * + *

                Adding a fault removes the current content of the body. * * @param faultStringOrReason the SOAP 1.1 fault string or SOAP 1.2 reason text * @param locale the language of faultStringOrReason. Optional for SOAP 1.1 - * @return the created SoapFault + * @return the created {@code SoapFault} */ SoapFault addMustUnderstandFault(String faultStringOrReason, Locale locale) throws SoapFaultException; /** - * Adds a Client/Sender fault to the body. For SOAP 1.1, this adds a fault with a - * Client fault code. For SOAP 1.2, this adds a fault with a Sender code. - *

                - * Adding a fault removes the current content of the body. + * Adds a {@code Client}/{@code Sender} fault to the body. For SOAP 1.1, this adds a fault with a + * {@code Client} fault code. For SOAP 1.2, this adds a fault with a {@code Sender} code. + * + *

                Adding a fault removes the current content of the body. * * @param faultStringOrReason the SOAP 1.1 fault string or SOAP 1.2 reason text * @param locale the language of faultStringOrReason. Optional for SOAP 1.1 - * @return the created SoapFault + * @return the created {@code SoapFault} */ SoapFault addClientOrSenderFault(String faultStringOrReason, Locale locale) throws SoapFaultException; /** - * Adds a Server/Receiver fault to the body. For SOAP 1.1, this adds a fault with a - * Server fault code. For SOAP 1.2, this adds a fault with a Receiver code. - *

                - * Adding a fault removes the current content of the body. + * Adds a {@code Server}/{@code Receiver} fault to the body. For SOAP 1.1, this adds a fault with a + * {@code Server} fault code. For SOAP 1.2, this adds a fault with a {@code Receiver} code. + * + *

                Adding a fault removes the current content of the body. * * @param faultStringOrReason the SOAP 1.1 fault string or SOAP 1.2 reason text * @param locale the language of faultStringOrReason. Optional for SOAP 1.1 - * @return the created SoapFault + * @return the created {@code SoapFault} */ SoapFault addServerOrReceiverFault(String faultStringOrReason, Locale locale) throws SoapFaultException; /** - * Adds a VersionMismatch fault to the body. - *

                - * Adding a fault removes the current content of the body. + * Adds a {@code VersionMismatch} fault to the body. + * + *

                Adding a fault removes the current content of the body. * * @param faultStringOrReason the SOAP 1.1 fault string or SOAP 1.2 reason text * @param locale the language of faultStringOrReason. Optional for SOAP 1.1 - * @return the created SoapFault + * @return the created {@code SoapFault} */ SoapFault addVersionMismatchFault(String faultStringOrReason, Locale locale) throws SoapFaultException; /** - * Indicates whether this body has a SoapFault. + * Indicates whether this body has a {@code SoapFault}. * - * @return true if the body has a fault; false otherwise + * @return {@code true} if the body has a fault; {@code false} otherwise */ boolean hasFault(); /** - * Returns the SoapFault of this body. + * Returns the {@code SoapFault} of this body. * - * @return the SoapFault, or null if none is present + * @return the {@code SoapFault}, or {@code null} if none is present */ SoapFault getFault(); } diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/SoapElement.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/SoapElement.java index e1e33dde..89d711d2 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/SoapElement.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/SoapElement.java @@ -37,10 +37,10 @@ public interface SoapElement { QName getName(); /** - * Returns the Source of this element. This includes the element itself, i.e. - * SoapEnvelope.getSource() will include the Envelope tag. + * Returns the {@code Source} of this element. This includes the element itself, i.e. + * {@code SoapEnvelope.getSource()} will include the {@code Envelope} tag. * - * @return the Source of this element + * @return the {@code Source} of this element */ Source getSource(); @@ -63,12 +63,12 @@ public interface SoapElement { * Returns the value of the attribute with the specified qualified name. * * @param name the qualified name - * @return the value, or null if there is no such attribute + * @return the value, or {@code null} if there is no such attribute */ String getAttributeValue(QName name); /** - * Returns an Iterator over all of the attributes in element as {@link QName qualified names}. + * Returns an {@code Iterator} over all of the attributes in element as {@link QName qualified names}. * * @return an iterator over all the attribute names */ diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/SoapEnvelope.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/SoapEnvelope.java index 32ce869a..1cbc4921 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/SoapEnvelope.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/SoapEnvelope.java @@ -17,8 +17,8 @@ package org.springframework.ws.soap; /** - * Represents the Envelope element in a SOAP message. The header contains the optional - * SoapHeader and SoapBody. + * Represents the {@code Envelope} element in a SOAP message. The header contains the optional + * {@code SoapHeader} and {@code SoapBody}. * * @author Arjen Poutsma * @since 1.0.0 @@ -26,17 +26,17 @@ package org.springframework.ws.soap; public interface SoapEnvelope extends SoapElement { /** - * Returns the SoapHeader. Returns null if no header is present. + * Returns the {@code SoapHeader}. Returns {@code null} if no header is present. * - * @return the SoapHeader, or null + * @return the {@code SoapHeader}, or {@code null} * @throws SoapHeaderException if the header cannot be returned */ SoapHeader getHeader() throws SoapHeaderException; /** - * Returns the SoapBody. + * Returns the {@code SoapBody}. * - * @return the SoapBody + * @return the {@code SoapBody} * @throws SoapBodyException if the header cannot be returned */ SoapBody getBody() throws SoapBodyException; diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/SoapFault.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/SoapFault.java index 7bae1493..303e164b 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/SoapFault.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/SoapFault.java @@ -19,9 +19,9 @@ package org.springframework.ws.soap; import javax.xml.namespace.QName; /** - * Represents the Fault element in the body of a SOAP message. - *

                - * A fault consists of a {@link #getFaultCode() fault code}, {@link #getFaultActorOrRole fault string/reason}, and + * Represents the {@code Fault} element in the body of a SOAP message. + * + *

                A fault consists of a {@link #getFaultCode() fault code}, {@link #getFaultActorOrRole fault string/reason}, and * {@link #getFaultActorOrRole() role}. * * @author Arjen Poutsma @@ -45,14 +45,14 @@ public interface SoapFault extends SoapElement { void setFaultActorOrRole(String faultActor); /** - * Returns the optional detail element for this SoapFault. + * Returns the optional detail element for this {@code SoapFault}. * * @return a fault detail */ SoapFaultDetail getFaultDetail(); /** - * Creates an optional SoapFaultDetail object and assigns it to this fault. + * Creates an optional {@code SoapFaultDetail} object and assigns it to this fault. * * @return the created detail */ diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/SoapFaultDetail.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/SoapFaultDetail.java index 4a1a48df..8b09fb75 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/SoapFaultDetail.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/SoapFaultDetail.java @@ -21,7 +21,7 @@ import javax.xml.namespace.QName; import javax.xml.transform.Result; /** - * Represents the detail element in a SOAP fault. A detail contains SoapFaultDetailElements, + * Represents the {@code detail} element in a SOAP fault. A detail contains {@code SoapFaultDetailElement}s, * which represent the individual details. * * @author Arjen Poutsma @@ -31,26 +31,26 @@ import javax.xml.transform.Result; public interface SoapFaultDetail extends SoapElement { /** - * Adds a new SoapFaultDetailElement with the specified qualified name to this detail. + * Adds a new {@code SoapFaultDetailElement} with the specified qualified name to this detail. * * @param name the qualified name of the new detail element - * @return the created SoapFaultDetailElement + * @return the created {@code SoapFaultDetailElement} */ SoapFaultDetailElement addFaultDetailElement(QName name); /** - * Returns a Result that represents the concents of the detail. - *

                - * The result can be used for marshalling. + * Returns a {@code Result} that represents the concents of the detail. * - * @return the Result of this element + *

                The result can be used for marshalling. + * + * @return the {@code Result} of this element */ Result getResult(); /** - * Gets an iterator over all of the SoapFaultDetailElements in this detail. + * Gets an iterator over all of the {@code SoapFaultDetailElement}s in this detail. * - * @return an iterator over all the SoapFaultDetailElements + * @return an iterator over all the {@code SoapFaultDetailElement}s * @see SoapFaultDetailElement */ Iterator getDetailEntries(); diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/SoapFaultDetailElement.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/SoapFaultDetailElement.java index 6e28e368..a7598485 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/SoapFaultDetailElement.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/SoapFaultDetailElement.java @@ -20,7 +20,7 @@ import javax.xml.transform.Result; /** * Represents the content for an individual SOAP detail entry in a SOAP Message. All - * SoapFaultDetailElements are contained in a SoapDetail. + * {@code SoapFaultDetailElement}s are contained in a {@code SoapDetail}. * * @author Arjen Poutsma * @see SoapFaultDetail @@ -28,7 +28,7 @@ import javax.xml.transform.Result; */ public interface SoapFaultDetailElement extends SoapElement { - /** Returns a Result that allows for writing to the contents of the detail element. */ + /** Returns a {@code Result} that allows for writing to the contents of the detail element. */ Result getResult(); /** Adds a new text node to this element. */ diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/SoapHeader.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/SoapHeader.java index c72fd8a1..8019f5ca 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/SoapHeader.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/SoapHeader.java @@ -33,8 +33,8 @@ public interface SoapHeader extends SoapElement { /** * Returns a {@code Result} that represents the contents of the header. - *

                - * The result can be used for marshalling. + * + *

                The result can be used for marshalling. * * @return the {@code Result} of this element */ @@ -51,8 +51,8 @@ public interface SoapHeader extends SoapElement { /** * Removes the {@code SoapHeaderElement} with the specified qualified name from this header. - *

                - * This method will only remove the first child element with the specified name. If no element is found with the + * + *

                This method will only remove the first child element with the specified name. If no element is found with the * specified name, this method has no effect. * * @param name the qualified name of the header element to be removed diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/SoapHeaderElement.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/SoapHeaderElement.java index 28e2a270..926cfddf 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/SoapHeaderElement.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/SoapHeaderElement.java @@ -19,8 +19,8 @@ package org.springframework.ws.soap; import javax.xml.transform.Result; /** - * Represents the contents of an individual SOAP header in the a SOAP message. All SoapHeaderElements are - * contained in a SoapHeader. + * Represents the contents of an individual SOAP header in the a SOAP message. All {@code SoapHeaderElement}s are + * contained in a {@code SoapHeader}. * * @author Arjen Poutsma * @see SoapHeader @@ -30,7 +30,7 @@ public interface SoapHeaderElement extends SoapElement { /** * Returns the actor or role for this header element. In a SOAP 1.1 compliant message, this will read the - * actor attribute; in SOAP 1.2, the role attribute. + * {@code actor} attribute; in SOAP 1.2, the {@code role} attribute. * * @return the role of the header */ @@ -38,29 +38,29 @@ public interface SoapHeaderElement extends SoapElement { /** * Sets the actor or role for this header element. In a SOAP 1.1 compliant message, this will result in an - * actor attribute being set; in SOAP 1.2, a actorOrRole attribute. + * {@code actor} attribute being set; in SOAP 1.2, a {@code actorOrRole} attribute. * * @param actorOrRole the actorOrRole value */ void setActorOrRole(String actorOrRole) throws SoapHeaderException; /** - * Indicates whether the mustUnderstand attribute for this header element is set. + * Indicates whether the {@code mustUnderstand} attribute for this header element is set. * - * @return true if the mustUnderstand attribute is set; false otherwise + * @return {@code true} if the {@code mustUnderstand} attribute is set; {@code false} otherwise */ boolean getMustUnderstand() throws SoapHeaderException; /** - * Sets the mustUnderstand attribute for this header element. If the attribute is on, the role who + * Sets the {@code mustUnderstand} attribute for this header element. If the attribute is on, the role who * receives the header must process it. * - * @param mustUnderstand true to set the mustUnderstand attribute on; false + * @param mustUnderstand {@code true} to set the {@code mustUnderstand} attribute on; {@code false} * to turn it off */ void setMustUnderstand(boolean mustUnderstand) throws SoapHeaderException; - /** Returns a Result that allows for writing to the contents of the header element. */ + /** Returns a {@code Result} that allows for writing to the contents of the header element. */ Result getResult() throws SoapHeaderException; /** diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/SoapMessage.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/SoapMessage.java index e66eaafc..e5a528d0 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/SoapMessage.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/SoapMessage.java @@ -23,8 +23,8 @@ import org.w3c.dom.Document; /** * Represents an abstraction for SOAP messages, providing access to a SOAP Envelope. The contents of the SOAP body can - * be retrieved by getPayloadSource() and getPayloadResult() on - * WebServiceMessage, the super-interface of this interface. + * be retrieved by {@code getPayloadSource()} and {@code getPayloadResult()} on + * {@code WebServiceMessage}, the super-interface of this interface. * * @author Arjen Poutsma * @see #getPayloadSource() @@ -34,11 +34,11 @@ import org.w3c.dom.Document; */ public interface SoapMessage extends MimeMessage, FaultAwareWebServiceMessage { - /** Returns the SoapEnvelope associated with this SoapMessage. */ + /** Returns the {@code SoapEnvelope} associated with this {@code SoapMessage}. */ SoapEnvelope getEnvelope() throws SoapEnvelopeException; /** - * Get the SOAP Action for this message, or null if not present. + * Get the SOAP Action for this message, or {@code null} if not present. * * @return the SOAP Action. */ @@ -52,16 +52,16 @@ public interface SoapMessage extends MimeMessage, FaultAwareWebServiceMessage { void setSoapAction(String soapAction); /** - * Returns the SoapBody associated with this SoapMessage. This is a convenience method for - * getEnvelope().getBody(). + * Returns the {@code SoapBody} associated with this {@code SoapMessage}. This is a convenience method for + * {@code getEnvelope().getBody()}. * * @see SoapEnvelope#getBody() */ SoapBody getSoapBody() throws SoapBodyException; /** - * Returns the SoapHeader associated with this SoapMessage. This is a convenience method - * for getEnvelope().getHeader(). + * Returns the {@code SoapHeader} associated with this {@code SoapMessage}. This is a convenience method + * for {@code getEnvelope().getHeader()}. * * @see SoapEnvelope#getHeader() */ diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/SoapMessageCreationException.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/SoapMessageCreationException.java index 3c2cb51c..78dc6b82 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/SoapMessageCreationException.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/SoapMessageCreationException.java @@ -24,12 +24,12 @@ package org.springframework.ws.soap; */ public class SoapMessageCreationException extends SoapMessageException { - /** Constructor for SoapMessageCreationException. */ + /** Constructor for {@code SoapMessageCreationException}. */ public SoapMessageCreationException(String msg) { super(msg); } - /** Constructor for SoapMessageCreationException. */ + /** Constructor for {@code SoapMessageCreationException}. */ public SoapMessageCreationException(String msg, Throwable ex) { super(msg, ex); } diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/SoapMessageException.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/SoapMessageException.java index 6ac1d518..7a51f76e 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/SoapMessageException.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/SoapMessageException.java @@ -26,12 +26,12 @@ import org.springframework.ws.WebServiceMessageException; */ public abstract class SoapMessageException extends WebServiceMessageException { - /** Constructor for SoapMessageException. */ + /** Constructor for {@code SoapMessageException}. */ public SoapMessageException(String msg) { super(msg); } - /** Constructor for SoapMessageException. */ + /** Constructor for {@code SoapMessageException}. */ public SoapMessageException(String msg, Throwable ex) { super(msg, ex); } diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/SoapMessageFactory.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/SoapMessageFactory.java index 2988de0c..86327cb6 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/SoapMessageFactory.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/SoapMessageFactory.java @@ -23,8 +23,8 @@ import org.springframework.ws.WebServiceMessageFactory; /** * Sub-interface of {@link WebServiceMessageFactory} which contains SOAP-specific properties and methods. - *

                - * The soapVersion property can be used to indicate the SOAP version of the factory. By default, the + * + *

                The {@code soapVersion} property can be used to indicate the SOAP version of the factory. By default, the * version is {@link SoapVersion#SOAP_11}. * * @author Arjen Poutsma @@ -42,7 +42,7 @@ public interface SoapMessageFactory extends WebServiceMessageFactory { void setSoapVersion(SoapVersion version); /** - * Creates a new, empty SoapMessage. + * Creates a new, empty {@code SoapMessage}. * * @return the empty message */ @@ -51,8 +51,8 @@ public interface SoapMessageFactory extends WebServiceMessageFactory { /** * Reads a {@link SoapMessage} from the given input stream. - *

                - * If the given stream is an instance of {@link org.springframework.ws.transport.TransportInputStream + * + *

                If the given stream is an instance of {@link org.springframework.ws.transport.TransportInputStream * TransportInputStream}, the headers will be read from the request. * * @param inputStream the input stream to read the message from diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/SoapVersion.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/SoapVersion.java index e736ec98..9108cb8a 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/SoapVersion.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/SoapVersion.java @@ -233,7 +233,7 @@ public interface SoapVersion { /** Returns the qualified name for a SOAP body. */ QName getBodyName(); - /** Returns the Content-Type MIME header for a SOAP message. */ + /** Returns the {@code Content-Type} MIME header for a SOAP message. */ String getContentType(); /** Returns the qualified name for a SOAP envelope. */ @@ -248,7 +248,7 @@ public interface SoapVersion { /** Returns the qualified name for a SOAP header. */ QName getHeaderName(); - /** Returns the qualified name of the SOAP MustUnderstand attribute. */ + /** Returns the qualified name of the SOAP {@code MustUnderstand} attribute. */ QName getMustUnderstandAttributeName(); /** @@ -260,16 +260,16 @@ public interface SoapVersion { /** Returns the URI indicating that a header element should never be directly processed. */ String getNoneActorOrRoleUri(); - /** Returns the qualified name of the MustUnderstand SOAP Fault value. */ + /** Returns the qualified name of the {@code MustUnderstand} SOAP Fault value. */ QName getMustUnderstandFaultName(); /** Returns the qualified name of the Receiver/Server SOAP Fault value. */ QName getServerOrReceiverFaultName(); - /** Returns the qualified name of the VersionMismatch SOAP Fault value. */ + /** Returns the qualified name of the {@code VersionMismatch} SOAP Fault value. */ QName getVersionMismatchFaultName(); - /** Returns the qualified name of the SOAP actor/role attribute. */ + /** Returns the qualified name of the SOAP {@code actor}/{@code role} attribute. */ QName getActorOrRoleName(); /** Returns the qualified name of the Sender/Client SOAP Fault value. */ diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/addressing/client/ActionCallback.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/addressing/client/ActionCallback.java index 369d71c1..b1c441e2 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/addressing/client/ActionCallback.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/addressing/client/ActionCallback.java @@ -35,10 +35,10 @@ import org.springframework.ws.transport.context.TransportContext; import org.springframework.ws.transport.context.TransportContextHolder; /** - * {@link WebServiceMessageCallback} implementation that sets the WS-Addressing Action header on the + * {@link WebServiceMessageCallback} implementation that sets the WS-Addressing {@code Action} header on the * message. - *

                - * A usage example with {@link org.springframework.ws.client.core.WebServiceTemplate}: + * + *

                A usage example with {@link org.springframework.ws.client.core.WebServiceTemplate}: *

                  * WebServiceTemplate template = new WebServiceTemplate(messageFactory);
                  * Result result = new DOMResult();
                @@ -68,12 +68,12 @@ public class ActionCallback implements WebServiceMessageCallback {
                     private EndpointReference faultTo;
                 
                     /**
                -     * Create a new ActionCallback with the given Action.
                -     * 

                - * The To header of the outgoing message will reflect the {@link org.springframework.ws.transport.WebServiceConnection#getUri() + * Create a new {@code ActionCallback} with the given {@code Action}. + * + *

                The {@code To} header of the outgoing message will reflect the {@link org.springframework.ws.transport.WebServiceConnection#getUri() * connection URI}. - *

                - * The {@link AddressingVersion} is set to {@link Addressing10}. + * + *

                The {@link AddressingVersion} is set to {@link Addressing10}. * * @param action the value of the action property to set */ @@ -82,12 +82,12 @@ public class ActionCallback implements WebServiceMessageCallback { } /** - * Create a new ActionCallback with the given Action. - *

                - * The To header of the outgoing message will reflect the {@link org.springframework.ws.transport.WebServiceConnection#getUri() + * Create a new {@code ActionCallback} with the given {@code Action}. + * + *

                The {@code To} header of the outgoing message will reflect the {@link org.springframework.ws.transport.WebServiceConnection#getUri() * connection URI}. - *

                - * The {@link AddressingVersion} is set to {@link Addressing10}. + * + *

                The {@link AddressingVersion} is set to {@link Addressing10}. * * @param action the value of the action property to set */ @@ -96,9 +96,9 @@ public class ActionCallback implements WebServiceMessageCallback { } /** - * Create a new ActionCallback with the given version and Action. - *

                - * The To header of the outgoing message will reflect the {@link org.springframework.ws.transport.WebServiceConnection#getUri() + * Create a new {@code ActionCallback} with the given version and {@code Action}. + * + *

                The {@code To} header of the outgoing message will reflect the {@link org.springframework.ws.transport.WebServiceConnection#getUri() * connection URI}. * * @param action the value of the action property to set @@ -109,8 +109,8 @@ public class ActionCallback implements WebServiceMessageCallback { } /** - * Create a new ActionCallback with the given version, Action, and optional - * To. + * Create a new {@code ActionCallback} with the given version, {@code Action}, and optional + * {@code To}. * * @param action the value of the action property * @param version the WS-Addressing version to use @@ -135,8 +135,8 @@ public class ActionCallback implements WebServiceMessageCallback { /** * Returns the message id strategy used for creating WS-Addressing MessageIds. - *

                - * By default, the {@link UuidMessageIdStrategy} is used. + * + *

                By default, the {@link UuidMessageIdStrategy} is used. */ public MessageIdStrategy getMessageIdStrategy() { return messageIdStrategy; @@ -144,8 +144,8 @@ public class ActionCallback implements WebServiceMessageCallback { /** * Sets the message id strategy used for creating WS-Addressing MessageIds. - *

                - * By default, the {@link UuidMessageIdStrategy} is used. + * + *

                By default, the {@link UuidMessageIdStrategy} is used. */ public void setMessageIdStrategy(MessageIdStrategy messageIdStrategy) { Assert.notNull(messageIdStrategy, "'messageIdStrategy' must not be null"); @@ -211,9 +211,9 @@ public class ActionCallback implements WebServiceMessageCallback { /** - * Returns the Destination for outgoing messages. - *

                - * Defaults to the {@link org.springframework.ws.transport.WebServiceConnection#getUri() connection URI} if no + * Returns the {@code Destination} for outgoing messages. + * + *

                Defaults to the {@link org.springframework.ws.transport.WebServiceConnection#getUri() connection URI} if no * destination was set. */ protected URI getTo() { diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/addressing/core/MessageAddressingProperties.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/addressing/core/MessageAddressingProperties.java index 15437f87..6d048539 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/addressing/core/MessageAddressingProperties.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/addressing/core/MessageAddressingProperties.java @@ -25,8 +25,8 @@ import org.w3c.dom.Node; /** * Represents a set of Message Addressing Properties, as defined in the WS-Addressing specification. - *

                - * In earlier versions of the spec, these properties were called Message Information Headers. + * + *

                In earlier versions of the spec, these properties were called Message Information Headers. * * @author Arjen Poutsma * @see Message Addressing Properties diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/addressing/messageid/MessageIdStrategy.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/addressing/messageid/MessageIdStrategy.java index afb1ce02..94faf692 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/addressing/messageid/MessageIdStrategy.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/addressing/messageid/MessageIdStrategy.java @@ -21,7 +21,7 @@ import java.net.URI; import org.springframework.ws.soap.SoapMessage; /** - * Strategy interface that encapsulates the creation and validation of WS-Addressing MessageIDs. + * Strategy interface that encapsulates the creation and validation of WS-Addressing {@code MessageID}s. * * @author Arjen Poutsma * @since 1.5.0 @@ -29,15 +29,15 @@ import org.springframework.ws.soap.SoapMessage; public interface MessageIdStrategy { /** - * Indicates whether the given MessageID value is a duplicate or not + * Indicates whether the given {@code MessageID} value is a duplicate or not * * @param messageId the message id - * @return true if a duplicate; false otherwise + * @return {@code true} if a duplicate; {@code false} otherwise */ boolean isDuplicate(URI messageId); /** - * Returns a new WS-Addressing MessageID for the given {@link SoapMessage}. + * Returns a new WS-Addressing {@code MessageID} for the given {@link SoapMessage}. * * @param message the message to create an id for * @return the new message id diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/addressing/messageid/UuidMessageIdStrategy.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/addressing/messageid/UuidMessageIdStrategy.java index 6d3093df..a54dfbfa 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/addressing/messageid/UuidMessageIdStrategy.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/addressing/messageid/UuidMessageIdStrategy.java @@ -23,9 +23,9 @@ import org.springframework.ws.soap.SoapMessage; /** * Implementation of the {@link MessageIdStrategy} interface that uses a {@link UUID} to generate a Message Id. The UUID - * is prefixed by urn:uuid:. - *

                - * Note that the {@link UUID} class is only available on Java 5 and above. + * is prefixed by {@code urn:uuid:}. + * + *

                Note that the {@link UUID} class is only available on Java 5 and above. * * @author Arjen Poutsma * @since 1.5.0 @@ -34,7 +34,7 @@ public class UuidMessageIdStrategy implements MessageIdStrategy { public static final String PREFIX = "urn:uuid:"; - /** Returns false. */ + /** Returns {@code false}. */ @Override public boolean isDuplicate(URI messageId) { return false; diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/addressing/server/AbstractActionEndpointMapping.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/addressing/server/AbstractActionEndpointMapping.java index fbcbcfb8..0a2888a0 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/addressing/server/AbstractActionEndpointMapping.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/addressing/server/AbstractActionEndpointMapping.java @@ -27,11 +27,11 @@ import org.springframework.util.Assert; import org.springframework.ws.soap.addressing.core.MessageAddressingProperties; /** - * Abstract base class for WS-Addressing Action-mapped {@link org.springframework.ws.server.EndpointMapping} + * Abstract base class for WS-Addressing {@code Action}-mapped {@link org.springframework.ws.server.EndpointMapping} * implementations. Provides infrastructure for mapping endpoints to actions. - *

                - * By default, this mapping creates a Action for reply messages based on the request message, plus the - * extra {@link #setOutputActionSuffix(String) suffix}, and a * By default, this mapping creates a Action + * + *

                By default, this mapping creates a {@code Action} for reply messages based on the request message, plus the + * extra {@link #setOutputActionSuffix(String) suffix}, and a * By default, this mapping creates a {@code Action} * for reply messages based on the request message, plus the extra {@link #setOutputActionSuffix(String) suffix}. * * @author Arjen Poutsma @@ -40,10 +40,10 @@ import org.springframework.ws.soap.addressing.core.MessageAddressingProperties; public abstract class AbstractActionEndpointMapping extends AbstractAddressingEndpointMapping implements ApplicationContextAware { - /** The defaults suffix to add to the request Action for reply messages. */ + /** The defaults suffix to add to the request {@code Action} for reply messages. */ public static final String DEFAULT_OUTPUT_ACTION_SUFFIX = "Response"; - /** The defaults suffix to add to response Action for reply messages. */ + /** The defaults suffix to add to response {@code Action} for reply messages. */ public static final String DEFAULT_FAULT_ACTION_SUFFIX = "Fault"; // keys are action URIs, values are endpoints @@ -55,13 +55,13 @@ public abstract class AbstractActionEndpointMapping extends AbstractAddressingEn private ApplicationContext applicationContext; - /** Returns the suffix to add to request Actions for reply messages. */ + /** Returns the suffix to add to request {@code Action}s for reply messages. */ public String getOutputActionSuffix() { return outputActionSuffix; } /** - * Sets the suffix to add to request Actions for reply messages. + * Sets the suffix to add to request {@code Action}s for reply messages. * * @see #DEFAULT_OUTPUT_ACTION_SUFFIX */ @@ -70,13 +70,13 @@ public abstract class AbstractActionEndpointMapping extends AbstractAddressingEn this.outputActionSuffix = outputActionSuffix; } - /** Returns the suffix to add to request Actions for reply fault messages. */ + /** Returns the suffix to add to request {@code Action}s for reply fault messages. */ public String getFaultActionSuffix() { return faultActionSuffix; } /** - * Sets the suffix to add to request Actions for reply fault messages. + * Sets the suffix to add to request {@code Action}s for reply fault messages. * * @see #DEFAULT_FAULT_ACTION_SUFFIX */ @@ -108,11 +108,11 @@ public abstract class AbstractActionEndpointMapping extends AbstractAddressingEn /** * Returns the address property of the given endpoint. The value of this property should match the {@link - * MessageAddressingProperties#getTo() destination} of incoming messages. May return null to ignore + * MessageAddressingProperties#getTo() destination} of incoming messages. May return {@code null} to ignore * the destination. * * @param endpoint the endpoint to return the address for - * @return the endpoint address; or null to ignore the destination property + * @return the endpoint address; or {@code null} to ignore the destination property */ protected abstract URI getEndpointAddress(Object endpoint); @@ -120,7 +120,7 @@ public abstract class AbstractActionEndpointMapping extends AbstractAddressingEn * Looks up an endpoint instance for the given action. All keys are tried in order. * * @param action the action URI - * @return the associated endpoint instance, or null if not found + * @return the associated endpoint instance, or {@code null} if not found */ protected Object lookupEndpoint(URI action) { return endpointMap.get(action); diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/addressing/server/AbstractActionMethodEndpointMapping.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/addressing/server/AbstractActionMethodEndpointMapping.java index 2ec00d7a..65579a28 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/addressing/server/AbstractActionMethodEndpointMapping.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/addressing/server/AbstractActionMethodEndpointMapping.java @@ -24,7 +24,7 @@ import org.springframework.util.Assert; import org.springframework.ws.server.endpoint.MethodEndpoint; /** - * Abstract base class for WS-Addressing Action-mapped {@link org.springframework.ws.server.EndpointMapping} + * Abstract base class for WS-Addressing {@code Action}-mapped {@link org.springframework.ws.server.EndpointMapping} * implementations that map to {@link MethodEndpoint}s. Provides infrastructure for mapping endpoint methods to * actions. * @@ -59,8 +59,8 @@ public abstract class AbstractActionMethodEndpointMapping extends AbstractAction /** * Return the class or interface to use for method reflection. - *

                - * Default implementation delegates to {@link AopUtils#getTargetClass(Object)}. + * + *

                Default implementation delegates to {@link AopUtils#getTargetClass(Object)}. * * @param endpoint the bean instance (might be an AOP proxy) * @return the bean class to expose diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/addressing/server/AbstractAddressingEndpointMapping.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/addressing/server/AbstractAddressingEndpointMapping.java index 25b9bb5c..e8896d38 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/addressing/server/AbstractAddressingEndpointMapping.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/addressing/server/AbstractAddressingEndpointMapping.java @@ -47,15 +47,15 @@ import org.springframework.xml.transform.TransformerObjectSupport; * SoapEndpointMapping} properties, this mapping has a {@link #setVersions(org.springframework.ws.soap.addressing.version.AddressingVersion[]) * versions} property, which defines the WS-Addressing specifications supported. By default, these are {@link * org.springframework.ws.soap.addressing.version.Addressing200408} and {@link org.springframework.ws.soap.addressing.version.Addressing10}. - *

                - * The {@link #setMessageIdStrategy(MessageIdStrategy) messageIdStrategy} property defines the strategy to use for - * creating reply MessageIDs. By default, this is the {@link UuidMessageIdStrategy}. - *

                - * The {@link #setMessageSenders(WebServiceMessageSender[]) messageSenders} are used to send out-of-band reply messages. + * + *

                The {@link #setMessageIdStrategy(MessageIdStrategy) messageIdStrategy} property defines the strategy to use for + * creating reply {@code MessageIDs}. By default, this is the {@link UuidMessageIdStrategy}. + * + *

                The {@link #setMessageSenders(WebServiceMessageSender[]) messageSenders} are used to send out-of-band reply messages. * If a request messages defines a non-anonymous reply address, these senders will be used to send the message. - *

                - * This mapping (and all subclasses) uses an implicit WS-Addressing {@link EndpointInterceptor}, which is added in every - * {@link EndpointInvocationChain} produced. As such, this mapping does not have the standard interceptors + * + *

                This mapping (and all subclasses) uses an implicit WS-Addressing {@link EndpointInterceptor}, which is added in every + * {@link EndpointInvocationChain} produced. As such, this mapping does not have the standard {@code interceptors} * property, but rather a {@link #setPreInterceptors(EndpointInterceptor[]) preInterceptors} and {@link * #setPostInterceptors(EndpointInterceptor[]) postInterceptors} property, which are added before and after the implicit * WS-Addressing interceptor, respectively. @@ -122,8 +122,8 @@ public abstract class AbstractAddressingEndpointMapping extends TransformerObjec /** * Specify the order value for this mapping. - *

                - * Default value is {@link Integer#MAX_VALUE}, meaning that it's non-ordered. + * + *

                Default value is {@link Integer#MAX_VALUE}, meaning that it's non-ordered. * * @see org.springframework.core.Ordered#getOrder() */ @@ -133,7 +133,7 @@ public abstract class AbstractAddressingEndpointMapping extends TransformerObjec /** * Set additional interceptors to be applied before the implicit WS-Addressing interceptor, e.g. - * XwsSecurityInterceptor. + * {@code XwsSecurityInterceptor}. */ public final void setPreInterceptors(EndpointInterceptor[] preInterceptors) { Assert.notNull(preInterceptors, "'preInterceptors' must not be null"); @@ -142,7 +142,7 @@ public abstract class AbstractAddressingEndpointMapping extends TransformerObjec /** * Set additional interceptors to be applied after the implicit WS-Addressing interceptor, e.g. - * PayloadLoggingInterceptor. + * {@code PayloadLoggingInterceptor}. */ public final void setPostInterceptors(EndpointInterceptor[] postInterceptors) { Assert.notNull(postInterceptors, "'postInterceptors' must not be null"); @@ -151,8 +151,8 @@ public abstract class AbstractAddressingEndpointMapping extends TransformerObjec /** * Sets the message id strategy used for creating WS-Addressing MessageIds. - *

                - * By default, the {@link UuidMessageIdStrategy} is used. + * + *

                By default, the {@link UuidMessageIdStrategy} is used. */ public final void setMessageIdStrategy(MessageIdStrategy messageIdStrategy) { Assert.notNull(messageIdStrategy, "'messageIdStrategy' must not be null"); @@ -201,8 +201,8 @@ public abstract class AbstractAddressingEndpointMapping extends TransformerObjec /** * Sets the WS-Addressing versions to be supported by this mapping. - *

                - * By default, this array is set to support {@link org.springframework.ws.soap.addressing.version.Addressing200408 + * + *

                By default, this array is set to support {@link org.springframework.ws.soap.addressing.version.Addressing200408 * the August 2004} and the {@link org.springframework.ws.soap.addressing.version.Addressing10 May 2006} versions of * the specification. */ @@ -300,11 +300,11 @@ public abstract class AbstractAddressingEndpointMapping extends TransformerObjec } /** - * Lookup an endpoint for the given {@link MessageAddressingProperties}, returning null if no specific + * Lookup an endpoint for the given {@link MessageAddressingProperties}, returning {@code null} if no specific * one is found. This template method is called by {@link #getEndpoint(MessageContext)}. * * @param map the message addressing properties - * @return the endpoint, or null + * @return the endpoint, or {@code null} */ protected abstract Object getEndpointInternal(MessageAddressingProperties map); diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/addressing/server/AnnotationActionEndpointMapping.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/addressing/server/AnnotationActionEndpointMapping.java index b58804ad..941f1b1d 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/addressing/server/AnnotationActionEndpointMapping.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/addressing/server/AnnotationActionEndpointMapping.java @@ -35,8 +35,8 @@ import org.springframework.ws.soap.addressing.server.annotation.Address; /** * Implementation of the {@link org.springframework.ws.server.EndpointMapping} interface that uses the * {@link Action @Action} annotation to map methods to a WS-Addressing {@code Action} header. - *

                - * Endpoints typically have the following form: + * + *

                Endpoints typically have the following form: *

                  * @Endpoint
                  * @Address("mailto:joe@fabrikam123.example")
                @@ -47,8 +47,8 @@ import org.springframework.ws.soap.addressing.server.annotation.Address;
                  *    }
                  * }
                  * 
                - *

                - * If set, the {@link Address @Address} annotation on the endpoint class should be equal to the {@link + * + *

                If set, the {@link Address @Address} annotation on the endpoint class should be equal to the {@link * org.springframework.ws.soap.addressing.core.MessageAddressingProperties#getTo() destination} property of the * incoming message. * @@ -86,11 +86,11 @@ public class AnnotationActionEndpointMapping extends AbstractActionMethodEndpoin /** * Returns the address property of the given {@link MethodEndpoint}, by looking for the {@link Address} annotation. * The value of this property should match the {@link org.springframework.ws.soap.addressing.core.MessageAddressingProperties#getTo() - * destination} of incoming messages. Returns null if the anotation is not present, thus ignoring the + * destination} of incoming messages. Returns {@code null} if the anotation is not present, thus ignoring the * destination property. * * @param endpoint the method endpoint to return the address for - * @return the endpoint address; or null to ignore the destination property + * @return the endpoint address; or {@code null} to ignore the destination property */ @Override protected URI getEndpointAddress(Object endpoint) { diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/addressing/server/SimpleActionEndpointMapping.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/addressing/server/SimpleActionEndpointMapping.java index b319b96a..bade2b75 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/addressing/server/SimpleActionEndpointMapping.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/addressing/server/SimpleActionEndpointMapping.java @@ -25,24 +25,24 @@ import java.util.Properties; import org.springframework.beans.BeansException; /** - * Implementation of the EndpointMapping interface to map from WS-Addressing Action Message + * Implementation of the {@code EndpointMapping} interface to map from WS-Addressing {@code Action} Message * Addressing Property to endpoint beans. Supports both mapping to bean instances and mapping to bean names. - *

                - * The endpointMap property is suitable for populating the endpoint map with bean references, e.g. via the + * + *

                The {@code endpointMap} property is suitable for populating the endpoint map with bean references, e.g. via the * map element in XML bean definitions. - *

                - * Mappings to bean names can be set via the mappings property, in a form accepted by the - * java.util.Properties class, like as follows: + * + *

                Mappings to bean names can be set via the {@code mappings} property, in a form accepted by the + * {@code java.util.Properties} class, like as follows: *

                  * http://www.springframework.org/spring-ws/samples/airline/BookFlight=bookFlightEndpoint
                  * http://www.springframework.org/spring-ws/samples/airline/GetFlights=getFlightsEndpoint
                  * 
                * The syntax is WS_ADDRESSING_ACTION=ENDPOINT_BEAN_NAME. - *

                - * If set, the {@link #setAddress(URI) address} property should be equal to the {@link + * + *

                If set, the {@link #setAddress(URI) address} property should be equal to the {@link * org.springframework.ws.soap.addressing.core.MessageAddressingProperties#getTo() destination} property of the * incominging message. As such, it can be used to create multiple Endpoint References, by defining multiple - * SimpleActionEndpointMapping bean definitions with different address property values. + * {@code SimpleActionEndpointMapping} bean definitions with different {@code address} property values. * * @author Arjen Poutsma * @see org.springframework.ws.soap.addressing.core.MessageAddressingProperties#getAction() diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/addressing/version/AbstractAddressingVersion.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/addressing/version/AbstractAddressingVersion.java index 1fb19ca6..55043622 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/addressing/version/AbstractAddressingVersion.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/addressing/version/AbstractAddressingVersion.java @@ -337,57 +337,57 @@ public abstract class AbstractAddressingVersion extends TransformerObjectSupport * Message addressing properties */ - /** Returns the qualified name of the To addressing header. */ + /** Returns the qualified name of the {@code To} addressing header. */ protected QName getToName() { return QNameUtils.createQName(getNamespaceUri(), "To", getNamespacePrefix()); } - /** Returns the qualified name of the From addressing header. */ + /** Returns the qualified name of the {@code From} addressing header. */ protected QName getFromName() { return QNameUtils.createQName(getNamespaceUri(), "From", getNamespacePrefix()); } - /** Returns the qualified name of the ReplyTo addressing header. */ + /** Returns the qualified name of the {@code ReplyTo} addressing header. */ protected QName getReplyToName() { return QNameUtils.createQName(getNamespaceUri(), "ReplyTo", getNamespacePrefix()); } - /** Returns the qualified name of the FaultTo addressing header. */ + /** Returns the qualified name of the {@code FaultTo} addressing header. */ protected QName getFaultToName() { return QNameUtils.createQName(getNamespaceUri(), "FaultTo", getNamespacePrefix()); } - /** Returns the qualified name of the Action addressing header. */ + /** Returns the qualified name of the {@code Action} addressing header. */ protected QName getActionName() { return QNameUtils.createQName(getNamespaceUri(), "Action", getNamespacePrefix()); } - /** Returns the qualified name of the MessageID addressing header. */ + /** Returns the qualified name of the {@code MessageID} addressing header. */ protected QName getMessageIdName() { return QNameUtils.createQName(getNamespaceUri(), "MessageID", getNamespacePrefix()); } - /** Returns the qualified name of the RelatesTo addressing header. */ + /** Returns the qualified name of the {@code RelatesTo} addressing header. */ protected QName getRelatesToName() { return QNameUtils.createQName(getNamespaceUri(), "RelatesTo", getNamespacePrefix()); } - /** Returns the qualified name of the RelatesTo addressing header. */ + /** Returns the qualified name of the {@code RelatesTo} addressing header. */ protected QName getRelationshipTypeName() { return new QName("RelationshipType"); } /** - * Returns the qualified name of the ReferenceProperties in the endpoint reference. Returns - * null when reference properties are not supported by this version of the spec. + * Returns the qualified name of the {@code ReferenceProperties} in the endpoint reference. Returns + * {@code null} when reference properties are not supported by this version of the spec. */ protected QName getReferencePropertiesName() { return QNameUtils.createQName(getNamespaceUri(), "ReferenceProperties", getNamespacePrefix()); } /** - * Returns the qualified name of the ReferenceParameters in the endpoint reference. Returns - * null when reference parameters are not supported by this version of the spec. + * Returns the qualified name of the {@code ReferenceParameters} in the endpoint reference. Returns + * {@code null} when reference parameters are not supported by this version of the spec. */ protected QName getReferenceParametersName() { return QNameUtils.createQName(getNamespaceUri(), "ReferenceParameters", getNamespacePrefix()); @@ -397,7 +397,7 @@ public abstract class AbstractAddressingVersion extends TransformerObjectSupport * Endpoint Reference */ - /** The qualified name of the Address in EndpointReference. */ + /** The qualified name of the {@code Address} in {@code EndpointReference}. */ protected QName getAddressName() { return QNameUtils.createQName(getNamespaceUri(), "Address", getNamespacePrefix()); } @@ -415,7 +415,7 @@ public abstract class AbstractAddressingVersion extends TransformerObjectSupport /** Returns the anonymous URI. */ protected abstract URI getAnonymous(); - /** Returns the none URI, or null if the spec does not define it. */ + /** Returns the none URI, or {@code null} if the spec does not define it. */ protected abstract URI getNone(); /* diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/addressing/version/AddressingVersion.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/addressing/version/AddressingVersion.java index af4a1317..97871271 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/addressing/version/AddressingVersion.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/addressing/version/AddressingVersion.java @@ -49,17 +49,17 @@ public interface AddressingVersion { void addAddressingHeaders(SoapMessage message, MessageAddressingProperties map); /** - * Given a SoapHeaderElement, return whether or not this version understands it. + * Given a {@code SoapHeaderElement}, return whether or not this version understands it. * * @param headerElement the header - * @return true if understood, false otherwise + * @return {@code true} if understood, {@code false} otherwise */ boolean understands(SoapHeaderElement headerElement); /** * Indicates whether the given {@link MessageAddressingProperties} has all required properties. * - * @return true if the to and action properties have been set, and - if a reply or fault endpoint has + * @return {@code true} if the to and action properties have been set, and - if a reply or fault endpoint has * been set - also checks for the message id */ boolean hasRequiredProperties(MessageAddressingProperties map); diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/axiom/AxiomHandler.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/axiom/AxiomHandler.java index c33f051f..6e4fd3c4 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/axiom/AxiomHandler.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/axiom/AxiomHandler.java @@ -40,8 +40,8 @@ import org.springframework.xml.namespace.QNameUtils; /** * Specific SAX {@link ContentHandler} and {@link LexicalHandler} that adds the resulting - * AXIOM OMElement to a specified parent element when endDocument is called. - * Used for returing SAXResults from Axiom elements. + * AXIOM OMElement to a specified parent element when {@code endDocument} is called. + * Used for returing {@code SAXResult}s from Axiom elements. * @author Arjen Poutsma * @since 1.0.0 */ diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/axiom/AxiomResult.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/axiom/AxiomResult.java index 46317ebb..7726112e 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/axiom/AxiomResult.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/axiom/AxiomResult.java @@ -25,7 +25,7 @@ import org.xml.sax.ext.LexicalHandler; /** * Specific TrAX {@link javax.xml.transform.Result} that adds the resulting AXIOM OMElement to a specified parent - * element when endDocument is called. + * element when {@code endDocument} is called. * * @author Arjen Poutsma * @see AxiomHandler @@ -40,7 +40,7 @@ class AxiomResult extends SAXResult { } /** - * Throws a UnsupportedOperationException. + * Throws a {@code UnsupportedOperationException}. * * @throws UnsupportedOperationException always */ @@ -50,7 +50,7 @@ class AxiomResult extends SAXResult { } /** - * Throws a UnsupportedOperationException. + * Throws a {@code UnsupportedOperationException}. * * @throws UnsupportedOperationException always */ diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/axiom/AxiomSoap11Body.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/axiom/AxiomSoap11Body.java index 4061eeb8..07cc5b3a 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/axiom/AxiomSoap11Body.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/axiom/AxiomSoap11Body.java @@ -37,7 +37,7 @@ import org.springframework.ws.soap.soap11.Soap11Fault; import org.springframework.xml.namespace.QNameUtils; /** - * Axiom-specific version of org.springframework.ws.soap.Soap11Body. + * Axiom-specific version of {@code org.springframework.ws.soap.Soap11Body}. * * @author Arjen Poutsma * @since 1.0.0 diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/axiom/AxiomSoap11Fault.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/axiom/AxiomSoap11Fault.java index 9a65ff48..858f3ebd 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/axiom/AxiomSoap11Fault.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/axiom/AxiomSoap11Fault.java @@ -27,7 +27,7 @@ import org.springframework.ws.soap.axiom.support.AxiomUtils; import org.springframework.ws.soap.soap11.Soap11Fault; /** - * Axiom-specific version of org.springframework.ws.soap.Soap11Fault. + * Axiom-specific version of {@code org.springframework.ws.soap.Soap11Fault}. * * @author Arjen Poutsma * @since 1.0.0 diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/axiom/AxiomSoap11Header.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/axiom/AxiomSoap11Header.java index 28301d37..0a88aadc 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/axiom/AxiomSoap11Header.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/axiom/AxiomSoap11Header.java @@ -30,7 +30,7 @@ import org.springframework.ws.soap.SoapHeaderElement; import org.springframework.ws.soap.soap11.Soap11Header; /** - * Axiom-specific version of org.springframework.ws.soap.Soap11Header. + * Axiom-specific version of {@code org.springframework.ws.soap.Soap11Header}. * * @author Arjen Poutsma * @since 1.0.0 diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/axiom/AxiomSoap12Body.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/axiom/AxiomSoap12Body.java index ac600084..a375cd48 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/axiom/AxiomSoap12Body.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/axiom/AxiomSoap12Body.java @@ -35,7 +35,7 @@ import org.springframework.ws.soap.soap12.Soap12Body; import org.springframework.ws.soap.soap12.Soap12Fault; /** - * Axiom-specific version of org.springframework.ws.soap.Soap12Body. + * Axiom-specific version of {@code org.springframework.ws.soap.Soap12Body}. * * @author Arjen Poutsma * @since 1.0.0 diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/axiom/AxiomSoap12Fault.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/axiom/AxiomSoap12Fault.java index 3bbe9996..2145c9b3 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/axiom/AxiomSoap12Fault.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/axiom/AxiomSoap12Fault.java @@ -38,7 +38,7 @@ import org.springframework.ws.soap.axiom.support.AxiomUtils; import org.springframework.ws.soap.soap12.Soap12Fault; import org.springframework.xml.namespace.QNameUtils; -/** Axiom-specific version of org.springframework.ws.soap.Soap12Fault. */ +/** Axiom-specific version of {@code org.springframework.ws.soap.Soap12Fault}. */ class AxiomSoap12Fault extends AxiomSoapFault implements Soap12Fault { AxiomSoap12Fault(SOAPFault axiomFault, SOAPFactory axiomFactory) { diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/axiom/AxiomSoap12Header.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/axiom/AxiomSoap12Header.java index ff8b5cd2..0829e00c 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/axiom/AxiomSoap12Header.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/axiom/AxiomSoap12Header.java @@ -37,7 +37,7 @@ import org.springframework.ws.soap.soap12.Soap12Header; import org.springframework.xml.namespace.QNameUtils; /** - * Axiom-specific version of org.springframework.ws.soap.Soap12Header. + * Axiom-specific version of {@code org.springframework.ws.soap.Soap12Header}. * * @author Arjen Poutsma * @since 1.0.0 diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/axiom/AxiomSoapBody.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/axiom/AxiomSoapBody.java index d0862f99..93fbfcbd 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/axiom/AxiomSoapBody.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/axiom/AxiomSoapBody.java @@ -30,7 +30,7 @@ import org.springframework.ws.soap.axiom.support.AxiomUtils; import org.springframework.ws.stream.StreamingPayload; /** - * Axiom-specific version of org.springframework.ws.soap.Soap11Body. + * Axiom-specific version of {@code org.springframework.ws.soap.Soap11Body}. * * @author Arjen Poutsma * @since 1.0.0 diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/axiom/AxiomSoapEnvelope.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/axiom/AxiomSoapEnvelope.java index 5a38b5ef..86588612 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/axiom/AxiomSoapEnvelope.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/axiom/AxiomSoapEnvelope.java @@ -29,7 +29,7 @@ import org.springframework.ws.soap.SoapEnvelope; import org.springframework.ws.soap.SoapHeader; /** - * Axiom-Specific version of org.springframework.ws.soap.SoapEnvelope. + * Axiom-Specific version of {@code org.springframework.ws.soap.SoapEnvelope}. * * @author Arjen Poutsma * @since 1.0.0 diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/axiom/AxiomSoapFaultDetail.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/axiom/AxiomSoapFaultDetail.java index 3605a98d..60ab30d0 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/axiom/AxiomSoapFaultDetail.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/axiom/AxiomSoapFaultDetail.java @@ -29,7 +29,7 @@ import org.springframework.ws.soap.SoapFaultDetail; import org.springframework.ws.soap.SoapFaultDetailElement; /** - * Axiom-specific version of org.springframework.ws.soap.SoapFaultDetail. + * Axiom-specific version of {@code org.springframework.ws.soap.SoapFaultDetail}. * * @author Arjen Poutsma * @since 1.0.0 diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/axiom/AxiomSoapFaultDetailElement.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/axiom/AxiomSoapFaultDetailElement.java index 27f7d685..7cc3c6a9 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/axiom/AxiomSoapFaultDetailElement.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/axiom/AxiomSoapFaultDetailElement.java @@ -25,7 +25,7 @@ import org.apache.axiom.soap.SOAPFactory; import org.springframework.ws.soap.SoapFaultDetailElement; /** - * Axiom-specific version of org.springframework.ws.soap.SoapFaultDetailElement. + * Axiom-specific version of {@code org.springframework.ws.soap.SoapFaultDetailElement}. * * @author Arjen Poutsma * @since 1.0.0 diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/axiom/AxiomSoapHeader.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/axiom/AxiomSoapHeader.java index 77e5f9a6..7b8cf89a 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/axiom/AxiomSoapHeader.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/axiom/AxiomSoapHeader.java @@ -33,7 +33,7 @@ import org.springframework.ws.soap.SoapHeaderException; import org.springframework.xml.namespace.QNameUtils; /** - * Axiom-specific version of org.springframework.ws.soap.SoapHeader. + * Axiom-specific version of {@code org.springframework.ws.soap.SoapHeader}. * * @author Arjen Poutsma * @since 1.0.0 diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/axiom/AxiomSoapHeaderElement.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/axiom/AxiomSoapHeaderElement.java index a51b08e5..6d74723d 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/axiom/AxiomSoapHeaderElement.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/axiom/AxiomSoapHeaderElement.java @@ -24,7 +24,7 @@ import org.apache.axiom.soap.SOAPHeaderBlock; import org.springframework.ws.soap.SoapHeaderElement; -/** Axiom-specific version of org.springframework.ws.soap.SoapHeaderHeaderElement. */ +/** Axiom-specific version of {@code org.springframework.ws.soap.SoapHeaderHeaderElement}. */ class AxiomSoapHeaderElement extends AxiomSoapElement implements SoapHeaderElement { public AxiomSoapHeaderElement(SOAPHeaderBlock axiomHeaderBlock, SOAPFactory axiomFactory) { diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/axiom/AxiomSoapMessage.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/axiom/AxiomSoapMessage.java index 291e0d71..56646001 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/axiom/AxiomSoapMessage.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/axiom/AxiomSoapMessage.java @@ -82,7 +82,7 @@ public class AxiomSoapMessage extends AbstractSoapMessage implements StreamingWe private OMOutputFormat outputFormat; /** - * Create a new, empty AxiomSoapMessage. + * Create a new, empty {@code AxiomSoapMessage}. * * @param soapFactory the AXIOM SOAPFactory */ @@ -91,7 +91,7 @@ public class AxiomSoapMessage extends AbstractSoapMessage implements StreamingWe } /** - * Create a new, empty AxiomSoapMessage. + * Create a new, empty {@code AxiomSoapMessage}. * * @param soapFactory the AXIOM SOAPFactory */ @@ -107,7 +107,7 @@ public class AxiomSoapMessage extends AbstractSoapMessage implements StreamingWe } /** - * Create a new AxiomSoapMessage based on the given AXIOM SOAPMessage. + * Create a new {@code AxiomSoapMessage} based on the given AXIOM {@code SOAPMessage}. * * @param soapMessage the AXIOM SOAPMessage * @param soapAction the value of the SOAP Action header @@ -121,7 +121,7 @@ public class AxiomSoapMessage extends AbstractSoapMessage implements StreamingWe } /** - * Create a new AxiomSoapMessage based on the given AXIOM SOAPMessage and attachments. + * Create a new {@code AxiomSoapMessage} based on the given AXIOM {@code SOAPMessage} and attachments. * * @param soapMessage the AXIOM SOAPMessage * @param attachments the attachments @@ -146,15 +146,15 @@ public class AxiomSoapMessage extends AbstractSoapMessage implements StreamingWe this.langAttributeOnSoap11FaultString = langAttributeOnSoap11FaultString; } - /** Return the AXIOM SOAPMessage that this AxiomSoapMessage is based on. */ + /** Return the AXIOM {@code SOAPMessage} that this {@code AxiomSoapMessage} is based on. */ public final SOAPMessage getAxiomMessage() { return axiomMessage; } /** - * Sets the AXIOM SOAPMessage that this AxiomSoapMessage is based on. - *

                - * Calling this method also clears the SOAP Action property. + * Sets the AXIOM {@code SOAPMessage} that this {@code AxiomSoapMessage} is based on. + * + *

                Calling this method also clears the SOAP Action property. */ public final void setAxiomMessage(SOAPMessage axiomMessage) { Assert.notNull(axiomMessage, "'axiomMessage' must not be null"); diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/axiom/AxiomSoapMessageFactory.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/axiom/AxiomSoapMessageFactory.java index 07fda156..1d8ce29e 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/axiom/AxiomSoapMessageFactory.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/axiom/AxiomSoapMessageFactory.java @@ -56,22 +56,22 @@ import org.springframework.ws.transport.TransportInputStream; /** * Axiom-specific implementation of the {@link org.springframework.ws.WebServiceMessageFactory WebServiceMessageFactory} * interface. Creates {@link org.springframework.ws.soap.axiom.AxiomSoapMessage AxiomSoapMessages}. - *

                - * To increase reading performance on the the SOAP request created by this message factory, you can set the {@link - * #setPayloadCaching(boolean) payloadCaching} property to false (default is true). This this + * + *

                To increase reading performance on the the SOAP request created by this message factory, you can set the {@link + * #setPayloadCaching(boolean) payloadCaching} property to {@code false} (default is {@code true}). This this * will read the contents of the body directly from the stream. However, when this setting is enabled, the * payload can only be read once. This means that any endpoint mappings or interceptors which are based on the * message payload (such as the {@link PayloadRootQNameEndpointMapping}, the {@link PayloadValidatingInterceptor}, or * the {@link PayloadLoggingInterceptor}) cannot be used. Instead, use an endpoint mapping that does not consume the * payload (i.e. the {@link SoapActionEndpointMapping}). - *

                - * Additionally, this message factory can cache large attachments to disk by setting the {@link - * #setAttachmentCaching(boolean) attachmentCaching} property to true (default is false). + * + *

                Additionally, this message factory can cache large attachments to disk by setting the {@link + * #setAttachmentCaching(boolean) attachmentCaching} property to {@code true} (default is {@code false}). * Optionally, the location where attachments are stored can be defined via the {@link #setAttachmentCacheDir(File) * attachmentCacheDir} property (defaults to the system temp file path). - *

                - * Mostly derived from org.apache.axis2.transport.http.HTTPTransportUtils and - * org.apache.axis2.transport.TransportUtils, which we cannot use since they are not part of the Axiom + * + *

                Mostly derived from {@code org.apache.axis2.transport.http.HTTPTransportUtils} and + * {@code org.apache.axis2.transport.TransportUtils}, which we cannot use since they are not part of the Axiom * distribution. * * @author Arjen Poutsma @@ -110,9 +110,9 @@ public class AxiomSoapMessageFactory implements SoapMessageFactory, Initializing /** - * Indicates whether the SOAP Body payload should be cached or not. Default is true. - *

                - * Setting this to false will increase performance, but also result in the fact that the message + * Indicates whether the SOAP Body payload should be cached or not. Default is {@code true}. + * + *

                Setting this to {@code false} will increase performance, but also result in the fact that the message * payload can only be read once. */ public void setPayloadCaching(boolean payloadCaching) { @@ -120,9 +120,9 @@ public class AxiomSoapMessageFactory implements SoapMessageFactory, Initializing } /** - * Indicates whether SOAP attachments should be cached or not. Default is false. - *

                - * Setting this to true will cause Axiom to store larger attachments on disk, rather than in memory. + * Indicates whether SOAP attachments should be cached or not. Default is {@code false}. + * + *

                Setting this to {@code true} will cause Axiom to store larger attachments on disk, rather than in memory. * This decreases memory consumption, but decreases performance. */ public void setAttachmentCaching(boolean attachmentCaching) { @@ -131,10 +131,10 @@ public class AxiomSoapMessageFactory implements SoapMessageFactory, Initializing /** * Sets the directory where SOAP attachments will be stored. Only used when {@link #setAttachmentCaching(boolean) - * attachmentCaching} is set to true. - *

                - * The parameter should be an existing, writable directory. This property defaults to the temporary directory of the - * operating system (i.e. the value of the java.io.tmpdir system property). + * attachmentCaching} is set to {@code true}. + * + *

                The parameter should be an existing, writable directory. This property defaults to the temporary directory of the + * operating system (i.e. the value of the {@code java.io.tmpdir} system property). */ public void setAttachmentCacheDir(File attachmentCacheDir) { Assert.notNull(attachmentCacheDir, "'attachmentCacheDir' must not be null"); @@ -146,9 +146,9 @@ public class AxiomSoapMessageFactory implements SoapMessageFactory, Initializing /** * Sets the threshold for attachments caching, in bytes. Attachments larger than this threshold will be cached in * the {@link #setAttachmentCacheDir(File) attachment cache directory}. Only used when {@link - * #setAttachmentCaching(boolean) attachmentCaching} is set to true. - *

                - * Defaults to 4096 bytes (i.e. 4 kilobytes). + * #setAttachmentCaching(boolean) attachmentCaching} is set to {@code true}. + * + *

                Defaults to 4096 bytes (i.e. 4 kilobytes). */ public void setAttachmentCacheThreshold(int attachmentCacheThreshold) { Assert.isTrue(attachmentCacheThreshold > 0, "'attachmentCacheThreshold' must be larger than 0"); @@ -171,8 +171,8 @@ public class AxiomSoapMessageFactory implements SoapMessageFactory, Initializing /** * Defines whether a {@code xml:lang} attribute should be set on SOAP 1.1 {@code } elements. - *

                - * The default is {@code true}, to comply with WS-I, but this flag can be set to {@code false} to the older W3C SOAP + * + *

                The default is {@code true}, to comply with WS-I, but this flag can be set to {@code false} to the older W3C SOAP * 1.1 specification. * * @see WS-I Basic Profile 1.1 @@ -351,11 +351,11 @@ public class AxiomSoapMessageFactory implements SoapMessageFactory, Initializing /** * Create a {@code XMLInputFactory} that this resolver will use to create {@link XMLStreamReader} objects. - *

                - * Can be overridden in subclasses, adding further initialization of the factory. The resulting factory is cached, + * + *

                Can be overridden in subclasses, adding further initialization of the factory. The resulting factory is cached, * so this method will only be called once. - *

                - * By default this method creates a standard {@link XMLInputFactory} and configures it + * + *

                By default this method creates a standard {@link XMLInputFactory} and configures it * based on the {@link #setReplacingEntityReferences(boolean) replacingEntityReferences} * and {@link #setSupportingExternalEntities(boolean) supportingExternalEntities} properties. * diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/axiom/support/AxiomUtils.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/axiom/support/AxiomUtils.java index b7a9e97c..d8f3416e 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/axiom/support/AxiomUtils.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/axiom/support/AxiomUtils.java @@ -45,8 +45,8 @@ import org.w3c.dom.ls.LSOutput; import org.w3c.dom.ls.LSSerializer; /** - * Collection of generic utility methods to work with Axiom. Includes conversion from OMNamespaces to - * QNames. + * Collection of generic utility methods to work with Axiom. Includes conversion from {@code OMNamespace}s to + * {@code QName}s. * * @author Arjen Poutsma * @author Tareq Abed Rabbo @@ -58,14 +58,14 @@ import org.w3c.dom.ls.LSSerializer; public abstract class AxiomUtils { /** - * Converts a javax.xml.namespace.QName to a org.apache.axiom.om.OMNamespace. A - * OMElement is used to resolve the namespace, or to declare a new one. + * Converts a {@code javax.xml.namespace.QName} to a {@code org.apache.axiom.om.OMNamespace}. A + * {@code OMElement} is used to resolve the namespace, or to declare a new one. * - * @param qName the QName to convert + * @param qName the {@code QName} to convert * @param resolveElement the element used to resolve the Q * @return the converted SAAJ Name * @throws OMException if conversion is unsuccessful - * @throws IllegalArgumentException if qName is not fully qualified + * @throws IllegalArgumentException if {@code qName} is not fully qualified */ public static OMNamespace toNamespace(QName qName, OMElement resolveElement) throws OMException { String prefix = QNameUtils.getPrefix(qName); @@ -82,7 +82,7 @@ public abstract class AxiomUtils { } /** - * Converts the given locale to a xml:lang string, as used in Axiom Faults. + * Converts the given locale to a {@code xml:lang} string, as used in Axiom Faults. * * @param locale the locale * @return the language string @@ -92,7 +92,7 @@ public abstract class AxiomUtils { } /** - * Converts the given locale to a xml:lang string, as used in Axiom Faults. + * Converts the given locale to a {@code xml:lang} string, as used in Axiom Faults. * * @param language the language string * @return the locale diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/client/SoapFaultClientException.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/client/SoapFaultClientException.java index c142fe69..953cd4c3 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/client/SoapFaultClientException.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/client/SoapFaultClientException.java @@ -24,7 +24,7 @@ import org.springframework.ws.soap.SoapFault; import org.springframework.ws.soap.SoapMessage; /** - * Thrown by SoapFaultMessageResolver when the response message has a fault. + * Thrown by {@code SoapFaultMessageResolver} when the response message has a fault. * * @author Arjen Poutsma * @since 1.0.0 @@ -34,7 +34,7 @@ public class SoapFaultClientException extends WebServiceFaultException { private final SoapFault soapFault; /** - * Create a new instance of the SoapFaultClientException class. + * Create a new instance of the {@code SoapFaultClientException} class. * * @param faultMessage the fault message */ @@ -57,8 +57,8 @@ public class SoapFaultClientException extends WebServiceFaultException { /** * Returns the fault string or reason. For SOAP 1.1, this returns the fault string. For SOAP 1.2, this returns the * fault reason for the default locale. - *

                - * Note that this message returns the same as {@link #getMessage()}. + * + *

                Note that this message returns the same as {@link #getMessage()}. */ public String getFaultStringOrReason() { return soapFault != null ? soapFault.getFaultStringOrReason() : null; diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/client/core/SoapActionCallback.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/client/core/SoapActionCallback.java index 31a0cff7..0290b868 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/client/core/SoapActionCallback.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/client/core/SoapActionCallback.java @@ -26,8 +26,8 @@ import org.springframework.ws.soap.SoapMessage; /** * {@link WebServiceMessageCallback} implementation that sets the SOAP Action header on the message. - *

                - * A usage example with {@link org.springframework.ws.client.core.WebServiceTemplate}: + * + *

                A usage example with {@link org.springframework.ws.client.core.WebServiceTemplate}: *

                  * WebServiceTemplate template = new WebServiceTemplate(messageFactory);
                  * Result result = new DOMResult();
                @@ -44,7 +44,7 @@ public class SoapActionCallback implements WebServiceMessageCallback {
                 
                     private final String soapAction;
                 
                -    /** Create a new SoapActionCallback with the given string SOAPAction. */
                +    /** Create a new {@code SoapActionCallback} with the given string SOAPAction. */
                     public SoapActionCallback(String soapAction) {
                         if (!StringUtils.hasText(soapAction)) {
                             soapAction = "\"\"";
                diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/saaj/SaajAttachment.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/saaj/SaajAttachment.java
                index c42fee13..6a6248a7 100644
                --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/saaj/SaajAttachment.java
                +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/saaj/SaajAttachment.java
                @@ -26,7 +26,7 @@ import org.springframework.util.Assert;
                 import org.springframework.ws.mime.Attachment;
                 
                 /**
                - * SAAJ-specific implementation of the Attachment interface. Wraps a {@link
                + * SAAJ-specific implementation of the {@code Attachment} interface. Wraps a {@link
                  * javax.xml.soap.AttachmentPart}.
                  *
                  * @author Arjen Poutsma
                diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/saaj/SaajSoap11Body.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/saaj/SaajSoap11Body.java
                index f1dc65dd..c85873be 100644
                --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/saaj/SaajSoap11Body.java
                +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/saaj/SaajSoap11Body.java
                @@ -28,7 +28,7 @@ import org.springframework.ws.soap.soap11.Soap11Body;
                 import org.springframework.ws.soap.soap11.Soap11Fault;
                 
                 /**
                - * SAAJ-specific implementation of the Soap11Body interface. Wraps a {@link javax.xml.soap.SOAPBody}.
                + * SAAJ-specific implementation of the {@code Soap11Body} interface. Wraps a {@link javax.xml.soap.SOAPBody}.
                  *
                  * @author Arjen Poutsma
                  * @since 1.0.0
                diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/saaj/SaajSoap11Fault.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/saaj/SaajSoap11Fault.java
                index 12d89b1a..3635f5e7 100644
                --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/saaj/SaajSoap11Fault.java
                +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/saaj/SaajSoap11Fault.java
                @@ -23,7 +23,7 @@ import javax.xml.soap.SOAPFault;
                 import org.springframework.ws.soap.soap11.Soap11Fault;
                 
                 /**
                - * SAAJ-specific implementation of the Soap11Fault interface. Wraps a {@link javax.xml.soap.SOAPFault}.
                + * SAAJ-specific implementation of the {@code Soap11Fault} interface. Wraps a {@link javax.xml.soap.SOAPFault}.
                  *
                  * @author Arjen Poutsma
                  * @since 1.0.0
                diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/saaj/SaajSoap11Header.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/saaj/SaajSoap11Header.java
                index ad2d0ada..e4973c14 100644
                --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/saaj/SaajSoap11Header.java
                +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/saaj/SaajSoap11Header.java
                @@ -29,7 +29,7 @@ import org.springframework.ws.soap.SoapHeaderElement;
                 import org.springframework.ws.soap.soap11.Soap11Header;
                 
                 /**
                - * SAAJ-specific implementation of the Soap11Header interface. Wraps a {@link javax.xml.soap.SOAPHeader}.
                + * SAAJ-specific implementation of the {@code Soap11Header} interface. Wraps a {@link javax.xml.soap.SOAPHeader}.
                  *
                  * @author Arjen Poutsma
                  * @since 1.0.0
                diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/saaj/SaajSoap12Body.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/saaj/SaajSoap12Body.java
                index b0508471..7487489c 100644
                --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/saaj/SaajSoap12Body.java
                +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/saaj/SaajSoap12Body.java
                @@ -28,7 +28,7 @@ import org.springframework.ws.soap.soap12.Soap12Body;
                 import org.springframework.ws.soap.soap12.Soap12Fault;
                 
                 /**
                - * SAAJ-specific implementation of the Soap12Body interface. Wraps a {@link javax.xml.soap.SOAPBody}.
                + * SAAJ-specific implementation of the {@code Soap12Body} interface. Wraps a {@link javax.xml.soap.SOAPBody}.
                  *
                  * @author Arjen Poutsma
                  * @since 1.0.0
                diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/saaj/SaajSoap12Header.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/saaj/SaajSoap12Header.java
                index 6660c4cc..3b3c04ea 100644
                --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/saaj/SaajSoap12Header.java
                +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/saaj/SaajSoap12Header.java
                @@ -32,7 +32,7 @@ import org.springframework.ws.soap.SoapHeaderException;
                 import org.springframework.ws.soap.soap12.Soap12Header;
                 
                 /**
                - * SAAJ-specific implementation of the Soap12Header interface. Wraps a {@link javax.xml.soap.SOAPHeader}.
                + * SAAJ-specific implementation of the {@code Soap12Header} interface. Wraps a {@link javax.xml.soap.SOAPHeader}.
                  *
                  * @author Arjen Poutsma
                  * @since 1.0.0
                diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/saaj/SaajSoapBody.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/saaj/SaajSoapBody.java
                index 3d3e8cc9..a0c5c39b 100644
                --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/saaj/SaajSoapBody.java
                +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/saaj/SaajSoapBody.java
                @@ -27,7 +27,7 @@ import org.springframework.ws.soap.SoapBody;
                 import org.springframework.ws.soap.saaj.support.SaajUtils;
                 
                 /**
                - * SAAJ-specific abstract base class of the SoapBody interface. Wraps a {@link javax.xml.soap.SOAPBody}.
                + * SAAJ-specific abstract base class of the {@code SoapBody} interface. Wraps a {@link javax.xml.soap.SOAPBody}.
                  *
                  * @author Arjen Poutsma
                  * @since 1.0.0
                diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/saaj/SaajSoapElement.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/saaj/SaajSoapElement.java
                index 73a4d848..454ed636 100644
                --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/saaj/SaajSoapElement.java
                +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/saaj/SaajSoapElement.java
                @@ -27,7 +27,7 @@ import org.springframework.util.Assert;
                 import org.springframework.ws.soap.SoapElement;
                 
                 /**
                - * SAAJ-specific implementation of the SoapElement interface. Wraps a {@link javax.xml.soap.SOAPElement}.
                + * SAAJ-specific implementation of the {@code SoapElement} interface. Wraps a {@link javax.xml.soap.SOAPElement}.
                  *
                  * @author Arjen Poutsma
                  * @since 1.0.0
                diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/saaj/SaajSoapEnvelope.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/saaj/SaajSoapEnvelope.java
                index e6fc0ff9..44331510 100644
                --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/saaj/SaajSoapEnvelope.java
                +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/saaj/SaajSoapEnvelope.java
                @@ -27,7 +27,7 @@ import org.springframework.ws.soap.SoapHeader;
                 import org.springframework.ws.soap.SoapVersion;
                 
                 /**
                - * SAAJ-specific implementation of the SoapEnvelope interface. Wraps a {@link
                + * SAAJ-specific implementation of the {@code SoapEnvelope} interface. Wraps a {@link
                  * javax.xml.soap.SOAPEnvelope}.
                  *
                  * @author Arjen Poutsma
                diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/saaj/SaajSoapFault.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/saaj/SaajSoapFault.java
                index 405e1b99..e6ce9bf0 100644
                --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/saaj/SaajSoapFault.java
                +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/saaj/SaajSoapFault.java
                @@ -25,7 +25,7 @@ import org.springframework.ws.soap.SoapFault;
                 import org.springframework.ws.soap.SoapFaultDetail;
                 
                 /**
                - * SAAJ-specific abstract base class of the SoapFault interface. Wraps a {@link javax.xml.soap.SOAPFault}.
                + * SAAJ-specific abstract base class of the {@code SoapFault} interface. Wraps a {@link javax.xml.soap.SOAPFault}.
                  *
                  * @author Arjen Poutsma
                  * @since 1.0.0
                diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/saaj/SaajSoapFaultDetail.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/saaj/SaajSoapFaultDetail.java
                index dca90a9d..1d3cf7cb 100644
                --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/saaj/SaajSoapFaultDetail.java
                +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/saaj/SaajSoapFaultDetail.java
                @@ -30,7 +30,7 @@ import org.springframework.ws.soap.SoapFaultDetail;
                 import org.springframework.ws.soap.SoapFaultDetailElement;
                 
                 /**
                - * SAAJ-specific implementation of the SoapFaultDetail interface. Wraps a {@link
                + * SAAJ-specific implementation of the {@code SoapFaultDetail} interface. Wraps a {@link
                  * javax.xml.soap.SOAPFaultElement}.
                  *
                  * @author Arjen Poutsma
                diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/saaj/SaajSoapFaultDetailElement.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/saaj/SaajSoapFaultDetailElement.java
                index 1fbff0b6..db3320ed 100644
                --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/saaj/SaajSoapFaultDetailElement.java
                +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/saaj/SaajSoapFaultDetailElement.java
                @@ -24,7 +24,7 @@ import javax.xml.transform.dom.DOMResult;
                 import org.springframework.ws.soap.SoapFaultDetailElement;
                 
                 /**
                - * SAAJ-specific implementation of the SoapFaultDetailElement interface. Wraps a {@link
                + * SAAJ-specific implementation of the {@code SoapFaultDetailElement} interface. Wraps a {@link
                  * javax.xml.soap.DetailEntry}.
                  *
                  * @author Arjen Poutsma
                diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/saaj/SaajSoapHeader.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/saaj/SaajSoapHeader.java
                index 9731bf2e..8b64bb2b 100644
                --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/saaj/SaajSoapHeader.java
                +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/saaj/SaajSoapHeader.java
                @@ -31,7 +31,7 @@ import org.springframework.ws.soap.SoapHeaderElement;
                 import org.springframework.ws.soap.SoapHeaderException;
                 
                 /**
                - * SAAJ-specific implementation of the SoapHeader interface. Wraps a {@link javax.xml.soap.SOAPHeader}.
                + * SAAJ-specific implementation of the {@code SoapHeader} interface. Wraps a {@link javax.xml.soap.SOAPHeader}.
                  *
                  * @author Arjen Poutsma
                  * @since 1.0.0
                diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/saaj/SaajSoapHeaderElement.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/saaj/SaajSoapHeaderElement.java
                index 272cb53a..74ce4a01 100644
                --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/saaj/SaajSoapHeaderElement.java
                +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/saaj/SaajSoapHeaderElement.java
                @@ -24,7 +24,7 @@ import org.springframework.ws.soap.SoapHeaderElement;
                 import org.springframework.ws.soap.SoapHeaderException;
                 
                 /**
                - * SAAJ-specific implementation of the SoapHeaderElement interface. Wraps a {@link
                + * SAAJ-specific implementation of the {@code SoapHeaderElement} interface. Wraps a {@link
                  * javax.xml.soap.SOAPHeaderElement}.
                  *
                  * @author Arjen Poutsma
                diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/saaj/SaajSoapMessage.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/saaj/SaajSoapMessage.java
                index 17206717..43cbec6f 100644
                --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/saaj/SaajSoapMessage.java
                +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/saaj/SaajSoapMessage.java
                @@ -73,7 +73,7 @@ public class SaajSoapMessage extends AbstractSoapMessage {
                     private final boolean langAttributeOnSoap11FaultString;
                 
                     /**
                -     * Create a new SaajSoapMessage based on the given SAAJ SOAPMessage.
                +     * Create a new {@code SaajSoapMessage} based on the given SAAJ {@code SOAPMessage}.
                      *
                      * @param soapMessage the SAAJ SOAPMessage
                      */
                @@ -82,7 +82,7 @@ public class SaajSoapMessage extends AbstractSoapMessage {
                     }
                 
                     /**
                -     * Create a new SaajSoapMessage based on the given SAAJ SOAPMessage.
                +     * Create a new {@code SaajSoapMessage} based on the given SAAJ {@code SOAPMessage}.
                      *
                      * @param soapMessage the SAAJ SOAPMessage
                      * @param messageFactory the SAAJ message factory
                @@ -92,7 +92,7 @@ public class SaajSoapMessage extends AbstractSoapMessage {
                     }
                 
                     /**
                -     * Create a new SaajSoapMessage based on the given SAAJ SOAPMessage.
                +     * Create a new {@code SaajSoapMessage} based on the given SAAJ {@code SOAPMessage}.
                      *
                      * @param soapMessage the SAAJ SOAPMessage
                      * @param langAttributeOnSoap11FaultString
                @@ -103,7 +103,7 @@ public class SaajSoapMessage extends AbstractSoapMessage {
                     }
                 
                     /**
                -     * Create a new SaajSoapMessage based on the given SAAJ SOAPMessage.
                +     * Create a new {@code SaajSoapMessage} based on the given SAAJ {@code SOAPMessage}.
                      *
                      * @param soapMessage the SAAJ SOAPMessage
                      * @param langAttributeOnSoap11FaultString
                @@ -121,12 +121,12 @@ public class SaajSoapMessage extends AbstractSoapMessage {
                         this.messageFactory = messageFactory;
                     }
                 
                -    /** Return the SAAJ SOAPMessage that this SaajSoapMessage is based on. */
                +    /** Return the SAAJ {@code SOAPMessage} that this {@code SaajSoapMessage} is based on. */
                     public SOAPMessage getSaajMessage() {
                         return saajMessage;
                     }
                 
                -    /** Sets the SAAJ SOAPMessage that this SaajSoapMessage is based on. */
                +    /** Sets the SAAJ {@code SOAPMessage} that this {@code SaajSoapMessage} is based on. */
                     public void setSaajMessage(SOAPMessage soapMessage) {
                         Assert.notNull(soapMessage, "soapMessage must not be null");
                         saajMessage = soapMessage;
                diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/saaj/SaajSoapMessageFactory.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/saaj/SaajSoapMessageFactory.java
                index 1b5742df..7962bf10 100644
                --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/saaj/SaajSoapMessageFactory.java
                +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/saaj/SaajSoapMessageFactory.java
                @@ -48,8 +48,8 @@ import org.springframework.ws.transport.TransportInputStream;
                  * SAAJ-specific implementation of the {@link org.springframework.ws.WebServiceMessageFactory WebServiceMessageFactory}.
                  * Wraps a SAAJ {@link MessageFactory}. This factory will use SAAJ 1.3 when found, or fall back to SAAJ 1.2 or even
                  * 1.1.
                - * 

                - * A SAAJ {@link MessageFactory} can be injected to the {@link #SaajSoapMessageFactory(javax.xml.soap.MessageFactory) + * + *

                A SAAJ {@link MessageFactory} can be injected to the {@link #SaajSoapMessageFactory(javax.xml.soap.MessageFactory) * constructor}, or by the {@link #setMessageFactory(javax.xml.soap.MessageFactory)} property. When a SAAJ message * factory is injected, the {@link #setSoapVersion(org.springframework.ws.soap.SoapVersion)} property is ignored. * @@ -78,12 +78,12 @@ public class SaajSoapMessageFactory implements SoapMessageFactory, InitializingB this.messageFactory = messageFactory; } - /** Returns the SAAJ MessageFactory used. */ + /** Returns the SAAJ {@code MessageFactory} used. */ public MessageFactory getMessageFactory() { return messageFactory; } - /** Sets the SAAJ MessageFactory. */ + /** Sets the SAAJ {@code MessageFactory}. */ public void setMessageFactory(MessageFactory messageFactory) { this.messageFactory = messageFactory; } @@ -98,8 +98,8 @@ public class SaajSoapMessageFactory implements SoapMessageFactory, InitializingB /** * Defines whether a {@code xml:lang} attribute should be set on SOAP 1.1 {@code } elements. - *

                - * The default is {@code true}, to comply with WS-I, but this flag can be set to {@code false} to the older W3C SOAP + * + *

                The default is {@code true}, to comply with WS-I, but this flag can be set to {@code false} to the older W3C SOAP * 1.1 specification. * * @see WS-I Basic Profile 1.1 diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/saaj/support/SaajContentHandler.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/saaj/support/SaajContentHandler.java index b6dc66e4..a1f3c84d 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/saaj/support/SaajContentHandler.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/saaj/support/SaajContentHandler.java @@ -32,8 +32,8 @@ import org.springframework.util.Assert; import org.springframework.util.StringUtils; /** - * SAX ContentHandler that transforms callback calls to the creation of SAAJ Nodes and - * SOAPElements. + * SAX {@code ContentHandler} that transforms callback calls to the creation of SAAJ {@code Node}s and + * {@code SOAPElement}s. * * @author Arjen Poutsma * @see javax.xml.soap.Node @@ -49,8 +49,8 @@ public class SaajContentHandler implements ContentHandler { private Map namespaces = new LinkedHashMap(); /** - * Constructs a new instance of the SaajContentHandler that creates children of the given - * SOAPElement. + * Constructs a new instance of the {@code SaajContentHandler} that creates children of the given + * {@code SOAPElement}. * * @param element the element to write to */ diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/saaj/support/SaajUtils.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/saaj/support/SaajUtils.java index 4735a51b..5d3627c5 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/saaj/support/SaajUtils.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/saaj/support/SaajUtils.java @@ -93,8 +93,8 @@ public abstract class SaajUtils { } /** - * Returns the SAAJ version as a String. The returned string will be "SAAJ 1.3", "SAAJ - * 1.2", or "SAAJ 1.1". + * Returns the SAAJ version as a String. The returned string will be "{@code SAAJ 1.3}", "{@code SAAJ + * 1.2}", or "{@code SAAJ 1.1}". * * @return a string representation of the SAAJ version * @see #getSaajVersion() @@ -121,11 +121,11 @@ public abstract class SaajUtils { /** * Converts a {@link QName} to a {@link Name}. A {@link SOAPElement} is required to resolve namespaces. * - * @param qName the QName to convert - * @param resolveElement a SOAPElement used to resolve namespaces to prefixes + * @param qName the {@code QName} to convert + * @param resolveElement a {@code SOAPElement} used to resolve namespaces to prefixes * @return the converted SAAJ Name * @throws SOAPException if conversion is unsuccessful - * @throws IllegalArgumentException if qName is not fully qualified + * @throws IllegalArgumentException if {@code qName} is not fully qualified */ public static Name toName(QName qName, SOAPElement resolveElement) throws SOAPException { String qNamePrefix = QNameUtils.getPrefix(qName); @@ -155,10 +155,10 @@ public abstract class SaajUtils { } /** - * Converts a javax.xml.soap.Name to a javax.xml.namespace.QName. + * Converts a {@code javax.xml.soap.Name} to a {@code javax.xml.namespace.QName}. * - * @param name the Name to convert - * @return the converted QName + * @param name the {@code Name} to convert + * @return the converted {@code QName} */ public static QName toQName(Name name) { if (StringUtils.hasLength(name.getURI()) && StringUtils.hasLength(name.getPrefix())) { @@ -173,7 +173,7 @@ public abstract class SaajUtils { } /** - * Loads a SAAJ SOAPMessage from the given resource with a given message factory. + * Loads a SAAJ {@code SOAPMessage} from the given resource with a given message factory. * * @param resource the resource to read from * @param messageFactory SAAJ message factory used to construct the message @@ -196,10 +196,10 @@ public abstract class SaajUtils { } /** - * Returns the SAAJ SOAPEnvelope for the given element. + * Returns the SAAJ {@code SOAPEnvelope} for the given element. * * @param element the element to return the envelope from - * @return the envelope, or null if not found + * @return the envelope, or {@code null} if not found */ public static SOAPEnvelope getEnvelope(SOAPElement element) { Assert.notNull(element, "Element should not be null"); diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/saaj/support/SaajXmlReader.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/saaj/support/SaajXmlReader.java index 5fbbb522..4b8b703a 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/saaj/support/SaajXmlReader.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/saaj/support/SaajXmlReader.java @@ -33,8 +33,8 @@ import org.springframework.util.StringUtils; import org.springframework.xml.sax.AbstractXmlReader; /** - * SAX XMLReader that reads from a SAAJ Node. Consumes XMLEvents from an - * XMLEventReader, and calls the corresponding methods on the SAX callback interfaces. + * SAX {@code XMLReader} that reads from a SAAJ {@code Node}. Consumes {@code XMLEvents} from an + * {@code XMLEventReader}, and calls the corresponding methods on the SAX callback interfaces. * * @author Arjen Poutsma * @see javax.xml.soap.Node @@ -54,9 +54,9 @@ public class SaajXmlReader extends AbstractXmlReader { private boolean namespacePrefixesFeature = false; /** - * Constructs a new instance of the SaajXmlReader that reads from the given Node. + * Constructs a new instance of the {@code SaajXmlReader} that reads from the given {@code Node}. * - * @param startNode the SAAJ Node to read from + * @param startNode the SAAJ {@code Node} to read from */ public SaajXmlReader(Node startNode) { this.startNode = startNode; @@ -90,11 +90,11 @@ public class SaajXmlReader extends AbstractXmlReader { /** * Parses the StAX XML reader passed at construction-time. - *

                - * Note that the given InputSource is not read, but ignored. + * + *

                Note that the given {@code InputSource} is not read, but ignored. * * @param ignored is ignored - * @throws org.xml.sax.SAXException A SAX exception, possibly wrapping a XMLStreamException + * @throws org.xml.sax.SAXException A SAX exception, possibly wrapping a {@code XMLStreamException} */ @Override public final void parse(InputSource ignored) throws SAXException { @@ -103,11 +103,11 @@ public class SaajXmlReader extends AbstractXmlReader { /** * Parses the StAX XML reader passed at construction-time. - *

                - * Note that the given system identifier is not read, but ignored. + * + *

                Note that the given system identifier is not read, but ignored. * * @param ignored is ignored - * @throws SAXException A SAX exception, possibly wrapping a XMLStreamException + * @throws SAXException A SAX exception, possibly wrapping a {@code XMLStreamException} */ @Override public final void parse(String ignored) throws SAXException { diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/server/SoapEndpointInterceptor.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/server/SoapEndpointInterceptor.java index 3bab8f47..741d4574 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/server/SoapEndpointInterceptor.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/server/SoapEndpointInterceptor.java @@ -32,7 +32,7 @@ public interface SoapEndpointInterceptor extends EndpointInterceptor { * Given a {@link SoapHeaderElement}, return whether or not this {@link SoapEndpointInterceptor} understands it. * * @param header the header - * @return true if understood, false otherwise + * @return {@code true} if understood, {@code false} otherwise */ boolean understands(SoapHeaderElement header); diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/server/SoapEndpointInvocationChain.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/server/SoapEndpointInvocationChain.java index 1b2d1944..2031e5a7 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/server/SoapEndpointInvocationChain.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/server/SoapEndpointInvocationChain.java @@ -20,8 +20,8 @@ import org.springframework.ws.server.EndpointInterceptor; import org.springframework.ws.server.EndpointInvocationChain; /** - * SOAP-specific subclass of the EndpointInvocationChain. Adds associated actors (SOAP 1.1) or roles (SOAP - * 1.2). Used by the SoapMessageDispatcher to determine the MustUnderstand headers for particular + * SOAP-specific subclass of the {@code EndpointInvocationChain}. Adds associated actors (SOAP 1.1) or roles (SOAP + * 1.2). Used by the {@code SoapMessageDispatcher} to determine the MustUnderstand headers for particular * endpoint. * * @author Arjen Poutsma @@ -36,7 +36,7 @@ public class SoapEndpointInvocationChain extends EndpointInvocationChain { private boolean isUltimateReceiver = true; /** - * Create new SoapEndpointInvocationChain. + * Create new {@code SoapEndpointInvocationChain}. * * @param endpoint the endpoint object to invoke */ @@ -45,7 +45,7 @@ public class SoapEndpointInvocationChain extends EndpointInvocationChain { } /** - * Create new SoapEndpointInvocationChain. + * Create new {@code SoapEndpointInvocationChain}. * * @param endpoint the endpoint object to invoke * @param interceptors the array of interceptors to apply @@ -55,7 +55,7 @@ public class SoapEndpointInvocationChain extends EndpointInvocationChain { } /** - * Create new EndpointInvocationChain. + * Create new {@code EndpointInvocationChain}. * * @param endpoint the endpoint object to invoke * @param interceptors the array of interceptors to apply @@ -81,7 +81,7 @@ public class SoapEndpointInvocationChain extends EndpointInvocationChain { return actorsOrRoles; } - /** Indicates whether this chain fulfills the SOAP 1.2 Ultimate Receiver role. Default is true. */ + /** Indicates whether this chain fulfills the SOAP 1.2 Ultimate Receiver role. Default is {@code true}. */ public boolean isUltimateReceiver() { return isUltimateReceiver; } diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/server/SoapEndpointMapping.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/server/SoapEndpointMapping.java index 983a451f..408746e8 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/server/SoapEndpointMapping.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/server/SoapEndpointMapping.java @@ -19,12 +19,12 @@ package org.springframework.ws.soap.server; import org.springframework.ws.server.EndpointMapping; /** - * SOAP-specific sub-interface of the EndpointMapping. Adds associated actors (SOAP 1.1) or roles (SOAP - * 1.2). Used by the SoapMessageDispatcher to determine the MustUnderstand headers for particular + * SOAP-specific sub-interface of the {@code EndpointMapping}. Adds associated actors (SOAP 1.1) or roles (SOAP + * 1.2). Used by the {@code SoapMessageDispatcher} to determine the MustUnderstand headers for particular * endpoint. - *

                - * The main purpose for this interface is to add consitency between all SOAP-specific EndpointMappings. The - * SoapMessageDispatcher does not require all endpoint mappings to implement this interface. + * + *

                The main purpose for this interface is to add consitency between all SOAP-specific {@code EndpointMappings}. The + * {@code SoapMessageDispatcher} does not require all endpoint mappings to implement this interface. * * @author Arjen Poutsma * @since 1.0.0 diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/server/SoapMessageDispatcher.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/server/SoapMessageDispatcher.java index f5c76b77..dc92550a 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/server/SoapMessageDispatcher.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/server/SoapMessageDispatcher.java @@ -56,27 +56,27 @@ public class SoapMessageDispatcher extends MessageDispatcher { private Locale mustUnderstandFaultStringLocale = Locale.ENGLISH; /** - * Sets the message used for MustUnderstand fault. Default to {@link + * Sets the message used for {@code MustUnderstand} fault. Default to {@link * #DEFAULT_MUST_UNDERSTAND_FAULT_STRING}. */ public void setMustUnderstandFaultString(String mustUnderstandFaultString) { this.mustUnderstandFaultString = mustUnderstandFaultString; } - /** Sets the locale of the message used for MustUnderstand fault. Default to {@link Locale#ENGLISH}. */ + /** Sets the locale of the message used for {@code MustUnderstand} fault. Default to {@link Locale#ENGLISH}. */ public void setMustUnderstandFaultStringLocale(Locale mustUnderstandFaultStringLocale) { this.mustUnderstandFaultStringLocale = mustUnderstandFaultStringLocale; } /** * Process the headers targeted at the actor or role fullfilled by the endpoint. Also processed the - * MustUnderstand headers in the incoming SOAP request message. Iterates over all SOAP headers which + * {@code MustUnderstand} headers in the incoming SOAP request message. Iterates over all SOAP headers which * should be understood for this role, and determines whether these are supported. Generates a SOAP MustUnderstand * fault if a header is not understood. * * @param mappedEndpoint the mapped EndpointInvocationChain * @param messageContext the message context - * @return true if all necessary headers are understood; false otherwise + * @return {@code true} if all necessary headers are understood; {@code false} otherwise * @see SoapEndpointInvocationChain#getActorsOrRoles() * @see org.springframework.ws.soap.SoapHeader#examineMustUnderstandHeaderElements(String) */ @@ -134,9 +134,9 @@ public class SoapMessageDispatcher extends MessageDispatcher { } /** - * Handles the request for a single SOAP actor/role. Iterates over all MustUnderstand headers for a + * Handles the request for a single SOAP actor/role. Iterates over all {@code MustUnderstand} headers for a * specific SOAP 1.1 actor or SOAP 1.2 role, and determines whether these are understood by any of the registered - * SoapEndpointInterceptor. If they are, returns true. If they are not, a SOAP fault is + * {@code SoapEndpointInterceptor}. If they are, returns {@code true}. If they are not, a SOAP fault is * created, and false is returned. * * @see SoapEndpointInterceptor#understands(org.springframework.ws.soap.SoapHeaderElement) diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/server/endpoint/AbstractFaultCreatingValidatingMarshallingPayloadEndpoint.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/server/endpoint/AbstractFaultCreatingValidatingMarshallingPayloadEndpoint.java index a8e75f8b..84c7e1c4 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/server/endpoint/AbstractFaultCreatingValidatingMarshallingPayloadEndpoint.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/server/endpoint/AbstractFaultCreatingValidatingMarshallingPayloadEndpoint.java @@ -37,8 +37,8 @@ import org.springframework.xml.namespace.QNameUtils; * Extension of the {@link AbstractValidatingMarshallingPayloadEndpoint} which validates the request payload with {@link * Validator}(s), and creates a SOAP Fault whenever the request message cannot be validated. The desired validators can * be set using properties, and must {@link Validator#supports(Class) support} the request object. - *

                - * The contents of the SOAP Fault can be specified by setting the {@link #setAddValidationErrorDetail(boolean) + * + *

                The contents of the SOAP Fault can be specified by setting the {@link #setAddValidationErrorDetail(boolean) * addValidationErrorDetail}, {@link #setFaultStringOrReason(String) faultStringOrReason}, or {@link * #setDetailElementName(QName) detailElementName} properties. * @@ -76,7 +76,7 @@ public abstract class AbstractFaultCreatingValidatingMarshallingPayloadEndpoint /** * Returns whether a SOAP Fault detail element should be created when a validation error occurs. This detail element * will contain the exact validation errors. It is only added when the underlying message is a - * SoapMessage. Defaults to true. + * {@code SoapMessage}. Defaults to {@code true}. * * @see org.springframework.ws.soap.SoapFault#addFaultDetail() */ @@ -87,7 +87,7 @@ public abstract class AbstractFaultCreatingValidatingMarshallingPayloadEndpoint /** * Indicates whether a SOAP Fault detail element should be created when a validation error occurs. This detail * element will contain the exact validation errors. It is only added when the underlying message is a - * SoapMessage. Defaults to true. + * {@code SoapMessage}. Defaults to {@code true}. * * @see org.springframework.ws.soap.SoapFault#addFaultDetail() */ @@ -102,7 +102,7 @@ public abstract class AbstractFaultCreatingValidatingMarshallingPayloadEndpoint /** * Sets the fault detail element name when validation errors occur on the request. Defaults to - * DEFAULT_DETAIL_ELEMENT_NAME. + * {@code DEFAULT_DETAIL_ELEMENT_NAME}. * * @see #DEFAULT_DETAIL_ELEMENT_NAME */ @@ -110,15 +110,15 @@ public abstract class AbstractFaultCreatingValidatingMarshallingPayloadEndpoint this.detailElementName = detailElementName; } - /** Sets the SOAP faultstring or Reason used when validation errors occur on the request. */ + /** Sets the SOAP {@code faultstring} or {@code Reason} used when validation errors occur on the request. */ public String getFaultStringOrReason() { return faultStringOrReason; } /** - * Sets the SOAP faultstring or Reason used when validation errors occur on the request. - * It is only added when the underlying message is a SoapMessage. Defaults to - * DEFAULT_FAULTSTRING_OR_REASON. + * Sets the SOAP {@code faultstring} or {@code Reason} used when validation errors occur on the request. + * It is only added when the underlying message is a {@code SoapMessage}. Defaults to + * {@code DEFAULT_FAULTSTRING_OR_REASON}. * * @see #DEFAULT_FAULTSTRING_OR_REASON */ @@ -133,7 +133,7 @@ public abstract class AbstractFaultCreatingValidatingMarshallingPayloadEndpoint /** * Sets the locale for SOAP fault reason and validation messages. It is only added when the underlying message is a - * SoapMessage. Defaults to English. + * {@code SoapMessage}. Defaults to English. * * @see java.util.Locale#ENGLISH */ @@ -147,13 +147,13 @@ public abstract class AbstractFaultCreatingValidatingMarshallingPayloadEndpoint } /** - * This implementation logs all errors, returns false, and creates a {@link + * This implementation logs all errors, returns {@code false}, and creates a {@link * SoapBody#addClientOrSenderFault(String,Locale) client or sender} {@link SoapFault}, adding a {@link - * SoapFaultDetail} with all errors if the addValidationErrorDetail property is true. + * SoapFaultDetail} with all errors if the {@code addValidationErrorDetail} property is {@code true}. * * @param messageContext the message context * @param errors the validation errors - * @return true to continue processing the request, false (the default) otherwise + * @return {@code true} to continue processing the request, {@code false} (the default) otherwise * @see Errors#getAllErrors() */ @Override diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/server/endpoint/AbstractSoapFaultDefinitionExceptionResolver.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/server/endpoint/AbstractSoapFaultDefinitionExceptionResolver.java index 5c6c1621..4a6d061e 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/server/endpoint/AbstractSoapFaultDefinitionExceptionResolver.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/server/endpoint/AbstractSoapFaultDefinitionExceptionResolver.java @@ -50,9 +50,9 @@ public abstract class AbstractSoapFaultDefinitionExceptionResolver extends Abstr /** * Template method that returns the {@link SoapFaultDefinition} for the given exception. * - * @param endpoint the executed endpoint, or null if none chosen at the time of the exception + * @param endpoint the executed endpoint, or {@code null} if none chosen at the time of the exception * @param ex the exception to be handled - * @return the definition mapped to the exception, or null if none is found. + * @return the definition mapped to the exception, or {@code null} if none is found. */ protected abstract SoapFaultDefinition getFaultDefinition(Object endpoint, Exception ex); @@ -109,11 +109,11 @@ public abstract class AbstractSoapFaultDefinitionExceptionResolver extends Abstr /** * Customize the {@link SoapFault} created by this resolver. Called for each created fault - *

                - * The default implementation is empty. Can be overridden in subclasses to customize the properties of the fault, + * + *

                The default implementation is empty. Can be overridden in subclasses to customize the properties of the fault, * such as adding details, etc. * - * @param endpoint the executed endpoint, or null if none chosen at the time of the exception + * @param endpoint the executed endpoint, or {@code null} if none chosen at the time of the exception * @param ex the exception to be handled * @param fault the created fault */ diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/server/endpoint/SimpleSoapExceptionResolver.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/server/endpoint/SimpleSoapExceptionResolver.java index aff7b3cd..131345b9 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/server/endpoint/SimpleSoapExceptionResolver.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/server/endpoint/SimpleSoapExceptionResolver.java @@ -29,8 +29,8 @@ import org.springframework.ws.soap.SoapMessage; /** * Simple, SOAP-specific {@link org.springframework.ws.server.EndpointExceptionResolver EndpointExceptionResolver} * implementation that stores the exception's message as the fault string. - *

                - * The fault code is always set to a Server (in SOAP 1.1) or Receiver (SOAP 1.2). + * + *

                The fault code is always set to a Server (in SOAP 1.1) or Receiver (SOAP 1.2). * * @author Arjen Poutsma * @since 1.0.0 @@ -41,8 +41,8 @@ public class SimpleSoapExceptionResolver extends AbstractEndpointExceptionResolv /** * Returns the locale for the faultstring or reason of the SOAP Fault. - *

                - * Defaults to {@link Locale#ENGLISH}. + * + *

                Defaults to {@link Locale#ENGLISH}. */ public Locale getLocale() { return locale; @@ -50,8 +50,8 @@ public class SimpleSoapExceptionResolver extends AbstractEndpointExceptionResolv /** * Sets the locale for the faultstring or reason of the SOAP Fault. - *

                - * Defaults to {@link Locale#ENGLISH}. + * + *

                Defaults to {@link Locale#ENGLISH}. */ public void setLocale(Locale locale) { Assert.notNull(locale, "locale must not be null"); @@ -75,7 +75,7 @@ public class SimpleSoapExceptionResolver extends AbstractEndpointExceptionResolv * {@link #resolveExceptionInternal(MessageContext,Object,Exception)}. * * @param messageContext current message context - * @param endpoint the executed endpoint, or null if none chosen at the time of the exception + * @param endpoint the executed endpoint, or {@code null} if none chosen at the time of the exception * @param ex the exception that got thrown during endpoint execution * @param fault the SOAP fault to be customized. */ diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/server/endpoint/SoapFaultDefinition.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/server/endpoint/SoapFaultDefinition.java index a852eae3..58915201 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/server/endpoint/SoapFaultDefinition.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/server/endpoint/SoapFaultDefinition.java @@ -20,8 +20,8 @@ import java.util.Locale; import javax.xml.namespace.QName; /** - * Defines properties for a SOAP Fault. Used by the SoapFaultDefinitionEditor and the - * SoapFaultMappingExceptionResolver. + * Defines properties for a SOAP Fault. Used by the {@code SoapFaultDefinitionEditor} and the + * {@code SoapFaultMappingExceptionResolver}. * * @author Arjen Poutsma * @see SoapFaultDefinitionEditor @@ -31,28 +31,28 @@ import javax.xml.namespace.QName; public class SoapFaultDefinition { /** - * Constant QName used to indicate that a Client fault must be created. + * Constant {@code QName} used to indicate that a {@code Client} fault must be created. * * @see org.springframework.ws.soap.SoapBody#addClientOrSenderFault(String,java.util.Locale) */ public static final QName CLIENT = new QName("CLIENT"); /** - * Constant QName used to indicate that a Receiver fault must be created. + * Constant {@code QName} used to indicate that a {@code Receiver} fault must be created. * * @see org.springframework.ws.soap.SoapBody#addServerOrReceiverFault(String,java.util.Locale) */ public static final QName RECEIVER = new QName("RECEIVER"); /** - * Constant QName used to indicate that a Sender fault must be created. + * Constant {@code QName} used to indicate that a {@code Sender} fault must be created. * * @see org.springframework.ws.soap.SoapBody#addServerOrReceiverFault(String,java.util.Locale) */ public static final QName SENDER = new QName("SENDER"); /** - * Constant QName used to indicate that a Server fault must be created. + * Constant {@code QName} used to indicate that a {@code Server} fault must be created. * * @see org.springframework.ws.soap.SoapBody#addClientOrSenderFault(String,java.util.Locale) */ diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/server/endpoint/SoapFaultDefinitionEditor.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/server/endpoint/SoapFaultDefinitionEditor.java index 5bca8dcb..6a100cfe 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/server/endpoint/SoapFaultDefinitionEditor.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/server/endpoint/SoapFaultDefinitionEditor.java @@ -25,20 +25,20 @@ import org.springframework.util.StringUtils; import org.springframework.xml.namespace.QNameEditor; /** - * PropertyEditor for SoapFaultDefinition objects. Takes strings of form + * PropertyEditor for {@code SoapFaultDefinition} objects. Takes strings of form *

                  * faultCode,faultString,locale
                  * 
                - * where faultCode is the string representation of a QName, faultStringOrReason - * is the optional fault string, and locale is the optional string representations for the - * faultStringOrReasonlanguage. By default, the language is set to English, and the fault string set to the + * 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 default, the language is set to English, and the fault string set to the * exception message. - *

                - * Instead of supplying a custom fault code, you can use the constants SERVER or RECEIVER - * indicate a Server/Receiver fault, or CLIENT or SENDER - * toClient/Sender fault respectively. - *

                - * For example: + * + *

                Instead of supplying a custom fault code, you can use the constants {@code SERVER} or {@code RECEIVER} + * indicate a {@code Server}/{@code Receiver} fault, or {@code CLIENT} or {@code SENDER} + * to{@code Client}/{@code Sender} fault respectively. + * + *

                For example: *

                  * RECEIVER,Server error
                  * 
                diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/server/endpoint/SoapFaultMappingExceptionResolver.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/server/endpoint/SoapFaultMappingExceptionResolver.java index ee08513f..2c3949c2 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/server/endpoint/SoapFaultMappingExceptionResolver.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/server/endpoint/SoapFaultMappingExceptionResolver.java @@ -24,7 +24,7 @@ import org.springframework.util.CollectionUtils; /** * Exception resolver that allows for mapping exception class names to SOAP Faults. The mappings are set using the - * exceptionMappings property, the format of which is documented in {@link SoapFaultDefinitionEditor}. + * {@code exceptionMappings} property, the format of which is documented in {@link SoapFaultDefinitionEditor}. * * @author Arjen Poutsma * @since 1.0.0 @@ -36,11 +36,11 @@ public class SoapFaultMappingExceptionResolver extends AbstractSoapFaultDefiniti /** * Set the mappings between exception class names and SOAP Faults. The exception class name can be a substring, with * no wildcard support at present. - *

                - * The values of the given properties object should use the format described in - * SoapFaultDefinitionEditor. - *

                - * Follows the same matching algorithm as SimpleMappingExceptionResolver. + * + *

                The values of the given properties object should use the format described in + * {@code SoapFaultDefinitionEditor}. + * + *

                Follows the same matching algorithm as {@code SimpleMappingExceptionResolver}. * * @param mappings exception patterns (can also be fully qualified class names) as keys, fault definition texts as * values @@ -76,10 +76,10 @@ public class SoapFaultMappingExceptionResolver extends AbstractSoapFaultDefiniti } /** - * Return the depth to the superclass matching. 0 means ex matches exactly. Returns -1 if + * Return the depth to the superclass matching. {@code 0} means ex matches exactly. Returns {@code -1} if * there's no match. Otherwise, returns depth. Lowest depth wins. - *

                - * Follows the same algorithm as RollbackRuleAttribute, and SimpleMappingExceptionResolver + * + *

                Follows the same algorithm as RollbackRuleAttribute, and SimpleMappingExceptionResolver */ protected int getDepth(String exceptionMapping, Exception ex) { return getDepth(exceptionMapping, ex.getClass(), 0); diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/server/endpoint/adapter/method/SoapHeaderElementMethodArgumentResolver.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/server/endpoint/adapter/method/SoapHeaderElementMethodArgumentResolver.java index 7b0df037..160b2950 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/server/endpoint/adapter/method/SoapHeaderElementMethodArgumentResolver.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/server/endpoint/adapter/method/SoapHeaderElementMethodArgumentResolver.java @@ -40,8 +40,8 @@ import org.springframework.xml.namespace.QNameUtils; *

                  * {@code
                  * public void soapHeaderElement(@SoapHeader("{http://springframework.org/ws}header") SoapHeaderElement element)
                - * 

                - * public void soapHeaderElementList(@SoapHeader("{http://springframework.org/ws}header") List + * + *

                public void soapHeaderElementList(@SoapHeader("{http://springframework.org/ws}header") List * elements) *

                * diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/server/endpoint/annotation/FaultCode.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/server/endpoint/annotation/FaultCode.java index d5e2de58..b7c83297 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/server/endpoint/annotation/FaultCode.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/server/endpoint/annotation/FaultCode.java @@ -31,9 +31,9 @@ public enum FaultCode { /** * Constant used to indicate that a fault must be created with a custom fault code. When this value is used, the - * customFaultCode string property must be used on {@link SoapFault}. - *

                - * Note that custom Fault Codes are only supported on SOAP 1.1. + * {@code customFaultCode} string property must be used on {@link SoapFault}. + * + *

                Note that custom Fault Codes are only supported on SOAP 1.1. * * @see SoapFault#customFaultCode() * @see Soap11Body#addFault(javax.xml.namespace.QName,String,java.util.Locale) @@ -41,28 +41,28 @@ public enum FaultCode { CUSTOM(new QName("CUSTOM")), /** - * Constant used to indicate that a Client fault must be created. + * Constant used to indicate that a {@code Client} fault must be created. * * @see SoapBody#addClientOrSenderFault(String,java.util.Locale) */ CLIENT(new QName("CLIENT")), /** - * Constant QName used to indicate that a Receiver fault must be created. + * Constant {@code QName} used to indicate that a {@code Receiver} fault must be created. * * @see SoapBody#addServerOrReceiverFault(String,java.util.Locale) */ RECEIVER(new QName("RECEIVER")), /** - * Constant QName used to indicate that a Sender fault must be created. + * Constant {@code QName} used to indicate that a {@code Sender} fault must be created. * * @see SoapBody#addServerOrReceiverFault(String,java.util.Locale) */ SENDER(new QName("SENDER")), /** - * Constant QName used to indicate that a Server fault must be created. + * Constant {@code QName} used to indicate that a {@code Server} fault must be created. * * @see SoapBody#addClientOrSenderFault(String,java.util.Locale) */ diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/server/endpoint/annotation/SoapAction.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/server/endpoint/annotation/SoapAction.java index 45c8e88a..e7da24bd 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/server/endpoint/annotation/SoapAction.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/server/endpoint/annotation/SoapAction.java @@ -24,7 +24,7 @@ import java.lang.annotation.Target; /** * Marks an endpoint method as the handler for an incoming request. The annotation value signifies the value for the - * request SOAPAction header that is handled by the method. + * request {@code SOAPAction} header that is handled by the method. * * @author Arjen Poutsma * @see org.springframework.ws.soap.server.endpoint.mapping.SoapActionAnnotationMethodEndpointMapping @@ -35,7 +35,7 @@ import java.lang.annotation.Target; @Documented public @interface SoapAction { - /** Signifies the value for the request SOAPAction header that is handled by the method. */ + /** Signifies the value for the request {@code SOAPAction} header that is handled by the method. */ String value(); } diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/server/endpoint/annotation/SoapFault.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/server/endpoint/annotation/SoapFault.java index 8fc0bc45..e236529c 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/server/endpoint/annotation/SoapFault.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/server/endpoint/annotation/SoapFault.java @@ -42,11 +42,11 @@ public @interface SoapFault { /** * The custom fault code, to be used if {@link #faultCode()} is set to {@link FaultCode#CUSTOM}. - *

                - * The format used is that of {@link QName#toString()}, i.e. "{" + Namespace URI + "}" + local part, where the + * + *

                The format used is that of {@link QName#toString()}, i.e. "{" + Namespace URI + "}" + local part, where the * namespace is optional. - *

                - * Note that custom Fault Codes are only supported on SOAP 1.1. + * + *

                Note that custom Fault Codes are only supported on SOAP 1.1. */ String customFaultCode() default ""; diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/server/endpoint/interceptor/AbstractFaultCreatingValidatingInterceptor.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/server/endpoint/interceptor/AbstractFaultCreatingValidatingInterceptor.java index 58a806a8..dc817061 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/server/endpoint/interceptor/AbstractFaultCreatingValidatingInterceptor.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/server/endpoint/interceptor/AbstractFaultCreatingValidatingInterceptor.java @@ -32,10 +32,10 @@ import org.springframework.xml.namespace.QNameUtils; import org.xml.sax.SAXParseException; /** - * Subclass of AbstractValidatingInterceptor that creates a SOAP Fault whenever the request message cannot - * be validated. The contents of the SOAP Fault can be specified by setting the addValidationErrorDetail, - * faultStringOrReason, or detailElementName properties. Further customizing can be - * accomplished by overriding handleRequestValidationErrors. + * Subclass of {@code AbstractValidatingInterceptor} that creates a SOAP Fault whenever the request message cannot + * be validated. The contents of the SOAP Fault can be specified by setting the {@code addValidationErrorDetail}, + * {@code faultStringOrReason}, or {@code detailElementName} properties. Further customizing can be + * accomplished by overriding {@code handleRequestValidationErrors}. * * @author Arjen Poutsma * @see #setAddValidationErrorDetail(boolean) @@ -74,7 +74,7 @@ public abstract class AbstractFaultCreatingValidatingInterceptor extends Abstrac /** * Returns whether a SOAP Fault detail element should be created when a validation error occurs. This detail element * will contain the exact validation errors. It is only added when the underlying message is a - * SoapMessage. Defaults to true. + * {@code SoapMessage}. Defaults to {@code true}. * * @see org.springframework.ws.soap.SoapFault#addFaultDetail() */ @@ -85,7 +85,7 @@ public abstract class AbstractFaultCreatingValidatingInterceptor extends Abstrac /** * Indicates whether a SOAP Fault detail element should be created when a validation error occurs. This detail * element will contain the exact validation errors. It is only added when the underlying message is a - * SoapMessage. Defaults to true. + * {@code SoapMessage}. Defaults to {@code true}. * * @see org.springframework.ws.soap.SoapFault#addFaultDetail() */ @@ -100,7 +100,7 @@ public abstract class AbstractFaultCreatingValidatingInterceptor extends Abstrac /** * Sets the fault detail element name when validation errors occur on the request. Defaults to - * DEFAULT_DETAIL_ELEMENT_NAME. + * {@code DEFAULT_DETAIL_ELEMENT_NAME}. * * @see #DEFAULT_DETAIL_ELEMENT_NAME */ @@ -108,15 +108,15 @@ public abstract class AbstractFaultCreatingValidatingInterceptor extends Abstrac this.detailElementName = detailElementName; } - /** Sets the SOAP faultstring or Reason used when validation errors occur on the request. */ + /** Sets the SOAP {@code faultstring} or {@code Reason} used when validation errors occur on the request. */ public String getFaultStringOrReason() { return faultStringOrReason; } /** - * Sets the SOAP faultstring or Reason used when validation errors occur on the request. - * It is only added when the underlying message is a SoapMessage. Defaults to - * DEFAULT_FAULTSTRING_OR_REASON. + * Sets the SOAP {@code faultstring} or {@code Reason} used when validation errors occur on the request. + * It is only added when the underlying message is a {@code SoapMessage}. Defaults to + * {@code DEFAULT_FAULTSTRING_OR_REASON}. * * @see #DEFAULT_FAULTSTRING_OR_REASON */ @@ -131,7 +131,7 @@ public abstract class AbstractFaultCreatingValidatingInterceptor extends Abstrac /** * Sets the SOAP fault reason locale used when validation errors occur on the request. It is only added when the - * underlying message is a SoapMessage. Defaults to English. + * underlying message is a {@code SoapMessage}. Defaults to English. * * @see java.util.Locale#ENGLISH */ @@ -141,13 +141,13 @@ public abstract class AbstractFaultCreatingValidatingInterceptor extends Abstrac /** * Template method that is called when the request message contains validation errors. This implementation logs all - * errors, returns false, and creates a {@link SoapBody#addClientOrSenderFault(String,Locale) client or + * errors, returns {@code false}, and creates a {@link SoapBody#addClientOrSenderFault(String,Locale) client or * sender} {@link SoapFault}, adding a {@link SoapFaultDetail} with all errors if the - * addValidationErrorDetail property is true. + * {@code addValidationErrorDetail} property is {@code true}. * * @param messageContext the message context * @param errors the validation errors - * @return true to continue processing the request, false (the default) otherwise + * @return {@code true} to continue processing the request, {@code false} (the default) otherwise */ @Override protected boolean handleRequestValidationErrors(MessageContext messageContext, SAXParseException[] errors) diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/server/endpoint/interceptor/PayloadValidatingInterceptor.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/server/endpoint/interceptor/PayloadValidatingInterceptor.java index b27d7b3c..2bdf1ac7 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/server/endpoint/interceptor/PayloadValidatingInterceptor.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/server/endpoint/interceptor/PayloadValidatingInterceptor.java @@ -21,15 +21,15 @@ import javax.xml.transform.Source; import org.springframework.ws.WebServiceMessage; /** - * Interceptor that validates the contents of WebServiceMessages using a schema. Allows for both W3C XML + * Interceptor that validates the contents of {@code WebServiceMessage}s using a schema. Allows for both W3C XML * and RELAX NG schemas. - *

                - * When the payload is invalid, this interceptor stops processing of the interceptor chain. Additionally, if the message + * + *

                When the payload is invalid, this interceptor stops processing of the interceptor chain. Additionally, if the message * is a SOAP request message, a SOAP Fault is created as reply. Invalid SOAP responses do not result in a fault. - *

                - * The schema to validate against is set with the schema property or schemas property. By + * + *

                The schema to validate against is set with the {@code schema} property or {@code schemas} property. By * default, only the request message is validated, but this behaviour can be changed using the - * validateRequest and validateResponse properties. Responses that contains faults are not + * {@code validateRequest} and {@code validateResponse} properties. Responses that contains faults are not * validated. * * @author Arjen Poutsma diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/server/endpoint/interceptor/SoapEnvelopeLoggingInterceptor.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/server/endpoint/interceptor/SoapEnvelopeLoggingInterceptor.java index e9facfdd..9aaeb85e 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/server/endpoint/interceptor/SoapEnvelopeLoggingInterceptor.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/server/endpoint/interceptor/SoapEnvelopeLoggingInterceptor.java @@ -26,9 +26,9 @@ import org.springframework.ws.soap.SoapMessage; import org.springframework.ws.soap.server.SoapEndpointInterceptor; /** - * SOAP-specific EndpointInterceptor that logs the complete request and response envelope of - * SoapMessage messages. By default, request, response and fault messages are logged, but this behaviour - * can be changed using the logRequest, logResponse, logFault properties. + * SOAP-specific {@code EndpointInterceptor} that logs the complete request and response envelope of + * {@code SoapMessage} messages. By default, request, response and fault messages are logged, but this behaviour + * can be changed using the {@code logRequest}, {@code logResponse}, {@code logFault} properties. * * @author Arjen Poutsma * @see #setLogRequest(boolean) @@ -40,7 +40,7 @@ public class SoapEnvelopeLoggingInterceptor extends AbstractLoggingInterceptor i private boolean logFault = true; - /** Indicates whether a SOAP Fault should be logged. Default is true. */ + /** Indicates whether a SOAP Fault should be logged. Default is {@code true}. */ public void setLogFault(boolean logFault) { this.logFault = logFault; } diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/server/endpoint/mapping/DelegatingSoapEndpointMapping.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/server/endpoint/mapping/DelegatingSoapEndpointMapping.java index 2d674fdc..3d4765d6 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/server/endpoint/mapping/DelegatingSoapEndpointMapping.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/server/endpoint/mapping/DelegatingSoapEndpointMapping.java @@ -25,15 +25,15 @@ import org.springframework.ws.soap.server.SoapEndpointInvocationChain; import org.springframework.ws.soap.server.SoapEndpointMapping; /** - * EndpointMapping implement that adds SOAP actors or roles to a delegate endpoint. Delegates to another - * EndpointMapping, set by delegate, and adds the actors or roles specified by - * actorsOrRoles. - *

                - * This endpoint mapping makes it possible to set actors/roles on a specific endpoint, without making the all endpoint + * {@code EndpointMapping} implement that adds SOAP actors or roles to a delegate endpoint. Delegates to another + * {@code EndpointMapping}, set by {@code delegate}, and adds the actors or roles specified by + * {@code actorsOrRoles}. + * + *

                This endpoint mapping makes it possible to set actors/roles on a specific endpoint, without making the all endpoint * mappings depend on SOAP-specific functionality. For normal use, setting an actor or role on an endpoint is not * required, the default 'next' role is sufficient. - *

                - * It is only in a scenario when a certain endpoint act as a SOAP intermediary for another endpoint, as described in the + * + *

                It is only in a scenario when a certain endpoint act as a SOAP intermediary for another endpoint, as described in the * SOAP specificication, this mapping is useful. * * @author Arjen Poutsma @@ -49,7 +49,7 @@ public class DelegatingSoapEndpointMapping implements InitializingBean, SoapEndp private boolean isUltimateReceiver = true; - /** Sets the delegate EndpointMapping to resolve the endpoint with. */ + /** Sets the delegate {@code EndpointMapping} to resolve the endpoint with. */ public void setDelegate(EndpointMapping delegate) { this.delegate = delegate; } @@ -72,7 +72,7 @@ public class DelegatingSoapEndpointMapping implements InitializingBean, SoapEndp } /** - * Creates a new SoapEndpointInvocationChain based on the delegate endpoint, the delegate interceptors, + * Creates a new {@code SoapEndpointInvocationChain} based on the delegate endpoint, the delegate interceptors, * and set actors/roles. * * @see #setActorsOrRoles(String[]) diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/server/endpoint/mapping/SoapActionAnnotationMethodEndpointMapping.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/server/endpoint/mapping/SoapActionAnnotationMethodEndpointMapping.java index 9aa32738..ff181773 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/server/endpoint/mapping/SoapActionAnnotationMethodEndpointMapping.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/server/endpoint/mapping/SoapActionAnnotationMethodEndpointMapping.java @@ -33,8 +33,8 @@ import org.springframework.ws.soap.server.endpoint.annotation.SoapAction; /** * Implementation of the {@link org.springframework.ws.server.EndpointMapping} interface that uses the {@link * SoapAction} annotation to map methods to the request SOAPAction header. - *

                - * Endpoints typically have the following form: + * + *

                Endpoints typically have the following form: *

                  * @Endpoint
                  * public class MyEndpoint{
                @@ -73,7 +73,7 @@ public class SoapActionAnnotationMethodEndpointMapping extends AbstractAnnotatio
                     }
                 
                     /**
                -     * Creates a new SoapEndpointInvocationChain based on the given endpoint, and the set interceptors, and
                +     * Creates a new {@code SoapEndpointInvocationChain} based on the given endpoint, and the set interceptors, and
                      * actors/roles.
                      *
                      * @param endpoint     the endpoint
                diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/server/endpoint/mapping/SoapActionEndpointMapping.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/server/endpoint/mapping/SoapActionEndpointMapping.java
                index b28dc16a..84a5bf3c 100644
                --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/server/endpoint/mapping/SoapActionEndpointMapping.java
                +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/server/endpoint/mapping/SoapActionEndpointMapping.java
                @@ -28,24 +28,24 @@ import org.springframework.ws.soap.server.SoapEndpointInvocationChain;
                 import org.springframework.ws.soap.server.SoapEndpointMapping;
                 
                 /**
                - * Implementation of the EndpointMapping interface to map from SOAPAction headers to endpoint
                + * Implementation of the {@code EndpointMapping} interface to map from {@code SOAPAction} headers to endpoint
                  * beans. Supports both mapping to bean instances and mapping to bean names: the latter is required for prototype
                  * handlers.
                - * 

                - * The endpointMap property is suitable for populating the endpoint map with bean references, e.g. via the + * + *

                The {@code endpointMap} property is suitable for populating the endpoint map with bean references, e.g. via the * map element in XML bean definitions. - *

                - * Mappings to bean names can be set via the mappings property, in a form accepted by the - * java.util.Properties class, like as follows: + * + *

                Mappings to bean names can be set via the {@code mappings} property, in a form accepted by the + * {@code java.util.Properties} class, like as follows: *

                  * http://www.springframework.org/spring-ws/samples/airline/BookFlight=bookFlightEndpoint
                  * http://www.springframework.org/spring-ws/samples/airline/GetFlights=getFlightsEndpoint
                  * 
                * The syntax is SOAP_ACTION=ENDPOINT_BEAN_NAME. - *

                - * This endpoint mapping does not read from the request message, and therefore is more suitable for message factories + * + *

                This endpoint mapping does not read from the request message, and therefore is more suitable for message factories * which directly read from the transport request (such as the {@link AxiomSoapMessageFactory} with the - * payloadCaching disabled). + * {@code payloadCaching} disabled). * * @author Arjen Poutsma * @since 1.0.0 @@ -76,7 +76,7 @@ public class SoapActionEndpointMapping extends AbstractMapBasedEndpointMapping i } /** - * Creates a new SoapEndpointInvocationChain based on the given endpoint, and the set interceptors, and + * Creates a new {@code SoapEndpointInvocationChain} based on the given endpoint, and the set interceptors, and * actors/roles. * * @param endpoint the endpoint diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/soap11/Soap11Body.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/soap11/Soap11Body.java index 6bb10389..157283dc 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/soap11/Soap11Body.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/soap11/Soap11Body.java @@ -23,7 +23,7 @@ import org.springframework.ws.soap.SoapBody; import org.springframework.ws.soap.SoapFaultException; /** - * Subinterface of SoapBody that exposes SOAP 1.1 functionality. Necessary because SOAP 1.1 differs from + * Subinterface of {@code SoapBody} that exposes SOAP 1.1 functionality. Necessary because SOAP 1.1 differs from * SOAP 1.2 with respect to SOAP Faults. * * @author Arjen Poutsma @@ -38,7 +38,7 @@ public interface Soap11Body extends SoapBody { * * @param faultCode the fully qualified fault faultCode * @param faultString the faultString - * @param faultStringLocale the faultString locale. May be null + * @param faultStringLocale the faultString locale. May be {@code null} * @return the added Soap11Fault * @throws IllegalArgumentException if the fault faultCode is not fully qualified */ diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/soap11/Soap11Fault.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/soap11/Soap11Fault.java index 64256e9b..1f06d44c 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/soap11/Soap11Fault.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/soap11/Soap11Fault.java @@ -21,7 +21,7 @@ import java.util.Locale; import org.springframework.ws.soap.SoapFault; /** - * Subinterface of SoapFault that exposes SOAP 1.1 functionality. Necessary because SOAP 1.1 differs from + * Subinterface of {@code SoapFault} that exposes SOAP 1.1 functionality. Necessary because SOAP 1.1 differs from * SOAP 1.2 with respect to SOAP Faults. * * @author Arjen Poutsma diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/soap11/Soap11Header.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/soap11/Soap11Header.java index c240ac4d..99bbbf82 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/soap11/Soap11Header.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/soap11/Soap11Header.java @@ -23,7 +23,7 @@ import org.springframework.ws.soap.SoapHeaderElement; import org.springframework.ws.soap.SoapHeaderException; /** - * Subinterface of SoapHeader that exposes SOAP 1.1 functionality. + * Subinterface of {@code SoapHeader} that exposes SOAP 1.1 functionality. * * @author Arjen Poutsma * @since 1.0.0 @@ -31,7 +31,7 @@ import org.springframework.ws.soap.SoapHeaderException; public interface Soap11Header extends SoapHeader { /** - * Returns an Iterator over all the {@link SoapHeaderElement header elements} that should be processed + * Returns an {@code Iterator} over all the {@link SoapHeaderElement header elements} that should be processed * for the given actors. Headers target to the "next" actor or role will always be included. * * @param actors an array of actors to search for diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/soap12/Soap12Body.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/soap12/Soap12Body.java index 857e4911..ced6225b 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/soap12/Soap12Body.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/soap12/Soap12Body.java @@ -23,7 +23,7 @@ import org.springframework.ws.soap.SoapBody; import org.springframework.ws.soap.SoapFaultException; /** - * Subinterface of SoapBody that exposes SOAP 1.2 functionality. Necessary because SOAP 1.1 differs from + * Subinterface of {@code SoapBody} that exposes SOAP 1.2 functionality. Necessary because SOAP 1.1 differs from * SOAP 1.2 with respect to SOAP Faults. * * @author Arjen Poutsma @@ -32,14 +32,14 @@ import org.springframework.ws.soap.SoapFaultException; public interface Soap12Body extends SoapBody { /** - * Adds a DataEncodingUnknown fault to the body. - *

                - * Adding a fault removes the current content of the body. + * Adds a {@code DataEncodingUnknown} fault to the body. + * + *

                Adding a fault removes the current content of the body. * * @param subcodes the optional fully qualified fault subcodes * @param reason the fault reason * @param locale the language of the fault reason - * @return the created SoapFault + * @return the created {@code SoapFault} */ Soap12Fault addDataEncodingUnknownFault(QName[] subcodes, String reason, Locale locale) throws SoapFaultException; diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/soap12/Soap12Fault.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/soap12/Soap12Fault.java index 535cdaaa..a656f12e 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/soap12/Soap12Fault.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/soap12/Soap12Fault.java @@ -23,7 +23,7 @@ import javax.xml.namespace.QName; import org.springframework.ws.soap.SoapFault; /** - * Subinterface of SoapFault that exposes SOAP 1.2 functionality. Necessary because SOAP 1.1 differs from + * Subinterface of {@code SoapFault} that exposes SOAP 1.2 functionality. Necessary because SOAP 1.1 differs from * SOAP 1.2 with respect to SOAP Faults. * * @author Arjen Poutsma @@ -34,7 +34,7 @@ public interface Soap12Fault extends SoapFault { /** * Returns an iteration over the fault subcodes. The subcodes are returned in order: from top to bottom. * - * @return an Iterator that contains QNames representing the fault subcodes + * @return an Iterator that contains {@code QNames} representing the fault subcodes */ Iterator getFaultSubcodes(); diff --git a/spring-ws-core/src/main/java/org/springframework/ws/soap/soap12/Soap12Header.java b/spring-ws-core/src/main/java/org/springframework/ws/soap/soap12/Soap12Header.java index 5508d5df..5d2305aa 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/soap/soap12/Soap12Header.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/soap/soap12/Soap12Header.java @@ -24,7 +24,7 @@ import org.springframework.ws.soap.SoapHeaderElement; import org.springframework.ws.soap.SoapHeaderException; /** - * Subinterface of SoapHeader that exposes SOAP 1.2 functionality. + * Subinterface of {@code SoapHeader} that exposes SOAP 1.2 functionality. * * @author Arjen Poutsma * @since 1.0.0 @@ -32,27 +32,27 @@ import org.springframework.ws.soap.SoapHeaderException; public interface Soap12Header extends SoapHeader { /** - * Adds a new NotUnderstood SoapHeaderElement this header. + * Adds a new NotUnderstood {@code SoapHeaderElement} this header. * * @param headerName the qualified name of the header that was not understood - * @return the created SoapHeaderElement + * @return the created {@code SoapHeaderElement} * @throws org.springframework.ws.soap.SoapHeaderException * if the header cannot be created */ SoapHeaderElement addNotUnderstoodHeaderElement(QName headerName); /** - * Adds a new Upgrade SoapHeaderElement this header. + * Adds a new Upgrade {@code SoapHeaderElement} this header. * * @param supportedSoapUris an array of the URIs of SOAP versions supported - * @return the created SoapHeaderElement + * @return the created {@code SoapHeaderElement} * @throws org.springframework.ws.soap.SoapHeaderException * if the header cannot be created */ SoapHeaderElement addUpgradeHeaderElement(java.lang.String[] supportedSoapUris); /** - * Returns an Iterator over all the {@link SoapHeaderElement header elements} that should be processed + * Returns an {@code Iterator} over all the {@link SoapHeaderElement header elements} that should be processed * for the given roles. Headers target to the "next" role will always be included, and those targeted to "none" will * never be included. * diff --git a/spring-ws-core/src/main/java/org/springframework/ws/support/DefaultStrategiesHelper.java b/spring-ws-core/src/main/java/org/springframework/ws/support/DefaultStrategiesHelper.java index 712b9ca1..bd8ea024 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/support/DefaultStrategiesHelper.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/support/DefaultStrategiesHelper.java @@ -50,8 +50,8 @@ import org.springframework.web.context.WebApplicationContext; /** * Helper class for for loading default implementations of an interface. Encapsulates a properties object, which * contains strategy interface names as keys, and comma-separated class names as values. - *

                - * Simulates the {@link BeanFactory normal lifecycle} for beans, by calling {@link + * + *

                Simulates the {@link BeanFactory normal lifecycle} for beans, by calling {@link * BeanFactoryAware#setBeanFactory(BeanFactory)}, {@link ApplicationContextAware#setApplicationContext(ApplicationContext)}, * etc. * @@ -63,13 +63,13 @@ public class DefaultStrategiesHelper { /** Keys are strategy interface names, values are implementation class names. */ private Properties defaultStrategies; - /** Initializes a new instance of the DefaultStrategiesHelper based on the given set of properties. */ + /** Initializes a new instance of the {@code DefaultStrategiesHelper} based on the given set of properties. */ public DefaultStrategiesHelper(Properties defaultStrategies) { Assert.notNull(defaultStrategies, "defaultStrategies must not be null"); this.defaultStrategies = defaultStrategies; } - /** Initializes a new instance of the DefaultStrategiesHelper based on the given resource. */ + /** Initializes a new instance of the {@code DefaultStrategiesHelper} based on the given resource. */ public DefaultStrategiesHelper(Resource resource) throws IllegalStateException { try { defaultStrategies = PropertiesLoaderUtils.loadProperties(resource); @@ -80,9 +80,9 @@ public class DefaultStrategiesHelper { } /** - * Initializes a new instance of the DefaultStrategiesHelper based on the given type. - *

                - * This constructor will attempt to load a 'typeName'.properties file in the same package as the given type. + * Initializes a new instance of the {@code DefaultStrategiesHelper} based on the given type. + * + *

                This constructor will attempt to load a 'typeName'.properties file in the same package as the given type. */ public DefaultStrategiesHelper(Class type) { this(new ClassPathResource(ClassUtils.getShortName(type) + ".properties", type)); @@ -90,7 +90,7 @@ public class DefaultStrategiesHelper { /** * Create a list of strategy objects for the given strategy interface. Strategies are retrieved from the - * Properties object given at construction-time. + * {@code Properties} object given at construction-time. * * @param strategyInterface the strategy interface * @return a list of corresponding strategy objects @@ -102,12 +102,12 @@ public class DefaultStrategiesHelper { /** * Create a list of strategy objects for the given strategy interface. Strategies are retrieved from the - * Properties object given at construction-time. It instantiates the strategy objects and satisfies - * ApplicationContextAware with the supplied context if necessary. + * {@code Properties} object given at construction-time. It instantiates the strategy objects and satisfies + * {@code ApplicationContextAware} with the supplied context if necessary. * * @param strategyInterface the strategy interface * @param applicationContext used to satisfy strategies that are application context aware, may be - * null + * {@code null} * @return a list of corresponding strategy objects * @throws BeansException if initialization failed */ @@ -205,12 +205,12 @@ public class DefaultStrategiesHelper { /** * Return the default strategy object for the given strategy interface. - *

                - * Delegates to {@link #getDefaultStrategies(Class,ApplicationContext)}, expecting a single object in the list. + * + *

                Delegates to {@link #getDefaultStrategies(Class,ApplicationContext)}, expecting a single object in the list. * * @param strategyInterface the strategy interface * @param applicationContext used to satisfy strategies that are application context aware, may be - * null + * {@code null} * @return the corresponding strategy object * @throws BeansException if initialization failed */ diff --git a/spring-ws-core/src/main/java/org/springframework/ws/support/MarshallingUtils.java b/spring-ws-core/src/main/java/org/springframework/ws/support/MarshallingUtils.java index a9f37ad4..7cbf6d17 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/support/MarshallingUtils.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/support/MarshallingUtils.java @@ -42,9 +42,9 @@ public abstract class MarshallingUtils { /** * Unmarshals the payload of the given message using the provided {@link Unmarshaller}. - *

                - * If the request message has no payload (i.e. {@link WebServiceMessage#getPayloadSource()} returns - * null), this method will return null. + * + *

                If the request message has no payload (i.e. {@link WebServiceMessage#getPayloadSource()} returns + * {@code null}), this method will return {@code null}. * * @param unmarshaller the unmarshaller * @param message the message of which the payload is to be unmarshalled diff --git a/spring-ws-core/src/main/java/org/springframework/ws/transport/AbstractReceiverConnection.java b/spring-ws-core/src/main/java/org/springframework/ws/transport/AbstractReceiverConnection.java index 7596c0bf..eccc6659 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/transport/AbstractReceiverConnection.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/transport/AbstractReceiverConnection.java @@ -59,13 +59,13 @@ public abstract class AbstractReceiverConnection extends AbstractWebServiceConne } /** - * Returns an iteration over all the header names this request contains. Returns an empty Iterator if + * Returns an iteration over all the header names this request contains. Returns an empty {@code Iterator} if * there are no headers. */ protected abstract Iterator getRequestHeaderNames() throws IOException; /** - * Returns an iteration over all the string values of the specified header. Returns an empty Iterator + * Returns an iteration over all the string values of the specified header. Returns an empty {@code Iterator} * if there are no headers of the specified name. */ protected abstract Iterator getRequestHeaders(String name) throws IOException; @@ -85,7 +85,7 @@ public abstract class AbstractReceiverConnection extends AbstractWebServiceConne /** Returns the output stream to write the request to. */ protected abstract OutputStream getResponseOutputStream() throws IOException; - /** Implementation of TransportInputStream for receiving-side connections. */ + /** Implementation of {@code TransportInputStream} for receiving-side connections. */ private class RequestTransportInputStream extends TransportInputStream { @Override @@ -105,7 +105,7 @@ public abstract class AbstractReceiverConnection extends AbstractWebServiceConne } - /** Implementation of TransportOutputStream for sending-side connections. */ + /** Implementation of {@code TransportOutputStream} for sending-side connections. */ private class ResponseTransportOutputStream extends TransportOutputStream { @Override diff --git a/spring-ws-core/src/main/java/org/springframework/ws/transport/AbstractSenderConnection.java b/spring-ws-core/src/main/java/org/springframework/ws/transport/AbstractSenderConnection.java index 9eb9a087..bb6b51e9 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/transport/AbstractSenderConnection.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/transport/AbstractSenderConnection.java @@ -79,13 +79,13 @@ public abstract class AbstractSenderConnection extends AbstractWebServiceConnect protected abstract OutputStream getRequestOutputStream() throws IOException; /** - * Returns an iteration over all the header names this request contains. Returns an empty Iterator if + * Returns an iteration over all the header names this request contains. Returns an empty {@code Iterator} if * there are no headers. */ protected abstract Iterator getResponseHeaderNames() throws IOException; /** - * Returns an iteration over all the string values of the specified header. Returns an empty Iterator + * Returns an iteration over all the string values of the specified header. Returns an empty {@code Iterator} * if there are no headers of the specified name. */ protected abstract Iterator getResponseHeaders(String name) throws IOException; @@ -93,7 +93,7 @@ public abstract class AbstractSenderConnection extends AbstractWebServiceConnect /** Returns the input stream to read the response from. */ protected abstract InputStream getResponseInputStream() throws IOException; - /** Implementation of TransportInputStream for receiving-side connections. */ + /** Implementation of {@code TransportInputStream} for receiving-side connections. */ class RequestTransportOutputStream extends TransportOutputStream { @Override diff --git a/spring-ws-core/src/main/java/org/springframework/ws/transport/AbstractWebServiceConnection.java b/spring-ws-core/src/main/java/org/springframework/ws/transport/AbstractWebServiceConnection.java index b7dbc7b9..ecee1b49 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/transport/AbstractWebServiceConnection.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/transport/AbstractWebServiceConnection.java @@ -49,10 +49,10 @@ public abstract class AbstractWebServiceConnection implements WebServiceConnecti } /** - * Called before the given message has been written to the TransportOutputStream. Called from {@link + * Called before the given message has been written to the {@code TransportOutputStream}. Called from {@link * #send(WebServiceMessage)}. - *

                - * Default implementation does nothing. + * + *

                Default implementation does nothing. * * @param message the message * @throws IOException when an I/O exception occurs @@ -61,7 +61,7 @@ public abstract class AbstractWebServiceConnection implements WebServiceConnecti } /** - * Returns a TransportOutputStream for the given message. Called from {@link + * Returns a {@code TransportOutputStream} for the given message. Called from {@link * #send(WebServiceMessage)}. * * @return the output stream @@ -70,10 +70,10 @@ public abstract class AbstractWebServiceConnection implements WebServiceConnecti protected abstract TransportOutputStream createTransportOutputStream() throws IOException; /** - * Called after the given message has been written to the TransportOutputStream. Called from {@link + * Called after the given message has been written to the {@code TransportOutputStream}. Called from {@link * #send(WebServiceMessage)}. - *

                - * Default implementation does nothing. + * + *

                Default implementation does nothing. * * @param message the message * @throws IOException when an I/O exception occurs @@ -95,10 +95,10 @@ public abstract class AbstractWebServiceConnection implements WebServiceConnecti } /** - * Called before a message has been read from the TransportInputStream. Called from {@link + * Called before a message has been read from the {@code TransportInputStream}. Called from {@link * #receive(WebServiceMessageFactory)}. - *

                - * Default implementation does nothing. + * + *

                Default implementation does nothing. * * @throws IOException when an I/O exception occurs */ @@ -106,18 +106,18 @@ public abstract class AbstractWebServiceConnection implements WebServiceConnecti } /** - * Returns a TransportInputStream. Called from {@link #receive(WebServiceMessageFactory)}. + * Returns a {@code TransportInputStream}. Called from {@link #receive(WebServiceMessageFactory)}. * - * @return the input stream, or null if no response can be read + * @return the input stream, or {@code null} if no response can be read * @throws IOException when an I/O exception occurs */ protected abstract TransportInputStream createTransportInputStream() throws IOException; /** - * Called when the given message has been read from the TransportInputStream. Called from {@link + * Called when the given message has been read from the {@code TransportInputStream}. Called from {@link * #receive(WebServiceMessageFactory)}. - *

                - * Default implementation does nothing. + * + *

                Default implementation does nothing. * * @param message the message * @throws IOException when an I/O exception occurs diff --git a/spring-ws-core/src/main/java/org/springframework/ws/transport/FaultAwareWebServiceConnection.java b/spring-ws-core/src/main/java/org/springframework/ws/transport/FaultAwareWebServiceConnection.java index 10ac3c23..fe7cd28b 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/transport/FaultAwareWebServiceConnection.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/transport/FaultAwareWebServiceConnection.java @@ -32,20 +32,20 @@ public interface FaultAwareWebServiceConnection extends WebServiceConnection { /** * Indicates whether this connection received a fault. - *

                - * Typically implemented by looking at an HTTP status code. * - * @return true if this connection received a fault; false otherwise. + *

                Typically implemented by looking at an HTTP status code. + * + * @return {@code true} if this connection received a fault; {@code false} otherwise. * @throws IOException in case of I/O errors */ boolean hasFault() throws IOException; /** * Sets whether this connection will send a fault. - *

                - * Typically implemented by setting an HTTP status code. * - * @param fault true if this will send a fault; false otherwise. + *

                Typically implemented by setting an HTTP status code. + * + * @param fault {@code true} if this will send a fault; {@code false} otherwise. * @throws IOException in case of I/O errors */ void setFault(boolean fault) throws IOException; diff --git a/spring-ws-core/src/main/java/org/springframework/ws/transport/TransportInputStream.java b/spring-ws-core/src/main/java/org/springframework/ws/transport/TransportInputStream.java index f383a31a..87b666c7 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/transport/TransportInputStream.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/transport/TransportInputStream.java @@ -23,7 +23,7 @@ import java.util.Iterator; import org.springframework.util.Assert; /** - * A TransportInputStream is an input stream with MIME input headers. It is used to construct {@link + * A {@code TransportInputStream} is an input stream with MIME input headers. It is used to construct {@link * org.springframework.ws.WebServiceMessage WebServiceMessages} from a transport. * * @author Arjen Poutsma @@ -105,13 +105,13 @@ public abstract class TransportInputStream extends InputStream { protected abstract InputStream createInputStream() throws IOException; /** - * Returns an iteration over all the header names this stream contains. Returns an empty Iterator if + * Returns an iteration over all the header names this stream contains. Returns an empty {@code Iterator} if * there are no headers. */ public abstract Iterator getHeaderNames() throws IOException; /** - * Returns an iteration over all the string values of the specified header. Returns an empty Iterator + * Returns an iteration over all the string values of the specified header. Returns an empty {@code Iterator} * if there are no headers of the specified name. */ public abstract Iterator getHeaders(String name) throws IOException; diff --git a/spring-ws-core/src/main/java/org/springframework/ws/transport/TransportOutputStream.java b/spring-ws-core/src/main/java/org/springframework/ws/transport/TransportOutputStream.java index ddb2dfe0..9b2709c2 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/transport/TransportOutputStream.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/transport/TransportOutputStream.java @@ -22,7 +22,7 @@ import java.io.OutputStream; import org.springframework.util.Assert; /** - * A TransportOutputStream is an output stream with MIME input headers. It is used to write {@link + * A {@code TransportOutputStream} is an output stream with MIME input headers. It is used to write {@link * org.springframework.ws.WebServiceMessage WebServiceMessages} to a transport. * * @author Arjen Poutsma diff --git a/spring-ws-core/src/main/java/org/springframework/ws/transport/WebServiceConnection.java b/spring-ws-core/src/main/java/org/springframework/ws/transport/WebServiceConnection.java index 5b65cf41..9e55e48b 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/transport/WebServiceConnection.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/transport/WebServiceConnection.java @@ -26,8 +26,8 @@ import org.springframework.ws.WebServiceMessageFactory; /** * Represents a point-to-point connection that a client can use for sending {@link WebServiceMessage} objects directly * to a remote party. - *

                - * A WebServiceConnection can be obtained using a {@link WebServiceMessageSender}. + * + *

                A {@code WebServiceConnection} can be obtained using a {@link WebServiceMessageSender}. * * @author Arjen Poutsma * @see WebServiceMessageSender#createConnection(URI) @@ -45,10 +45,10 @@ public interface WebServiceConnection { /** * Receives a message using the given {@link WebServiceMessageFactory}. This method blocks until it receives, or - * returns null when no message is received. + * returns {@code null} when no message is received. * * @param messageFactory the message factory used for reading messages - * @return the read message, or null if no message received + * @return the read message, or {@code null} if no message received * @throws IOException in case of I/O errors */ WebServiceMessage receive(WebServiceMessageFactory messageFactory) throws IOException; @@ -60,22 +60,22 @@ public interface WebServiceConnection { * Indicates whether this connection has an error. Typically, error detection is done by inspecting connection error * codes, etc. * - * @return true if this connection has an error; false otherwise. + * @return {@code true} if this connection has an error; {@code false} otherwise. */ boolean hasError() throws IOException; /** * Returns the error message. * - * @return the connection error message, if any; returns null when no error is present + * @return the connection error message, if any; returns {@code null} when no error is present * @see #hasError() */ String getErrorMessage() throws IOException; /** * Closes this connection. - *

                - * Once a connection has been closed, it is not available for further use. A new connection needs to be created. + * + *

                Once a connection has been closed, it is not available for further use. A new connection needs to be created. * * @throws IOException if an I/O error occurs when closing this connection */ diff --git a/spring-ws-core/src/main/java/org/springframework/ws/transport/WebServiceMessageSender.java b/spring-ws-core/src/main/java/org/springframework/ws/transport/WebServiceMessageSender.java index 49df55be..35335a89 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/transport/WebServiceMessageSender.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/transport/WebServiceMessageSender.java @@ -24,8 +24,8 @@ import org.springframework.ws.WebServiceMessage; /** * Defines the methods for classes capable of sending and receiving {@link WebServiceMessage} instances across a * transport. - *

                - * The WebServiceMessageSender is basically a factory for {@link WebServiceConnection} objects. + * + *

                The {@code WebServiceMessageSender} is basically a factory for {@link WebServiceConnection} objects. * * @author Arjen Poutsma * @see WebServiceConnection @@ -46,7 +46,7 @@ public interface WebServiceMessageSender { * Does this {@link WebServiceMessageSender} support the supplied URI? * * @param uri the URI to be checked - * @return true if this WebServiceMessageSender supports the supplied URI + * @return {@code true} if this {@code WebServiceMessageSender} supports the supplied URI */ boolean supports(URI uri); diff --git a/spring-ws-core/src/main/java/org/springframework/ws/transport/context/DefaultTransportContext.java b/spring-ws-core/src/main/java/org/springframework/ws/transport/context/DefaultTransportContext.java index e401c547..1de51800 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/transport/context/DefaultTransportContext.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/transport/context/DefaultTransportContext.java @@ -20,7 +20,7 @@ import org.springframework.util.Assert; import org.springframework.ws.transport.WebServiceConnection; /** - * Default implementation of the TransportContext interface. + * Default implementation of the {@code TransportContext} interface. * * @author Arjen Poutsma * @since 1.0.0 @@ -29,7 +29,7 @@ public class DefaultTransportContext implements TransportContext { private final WebServiceConnection connection; - /** Creates a new DefaultTransportContext that exposes the given connection. */ + /** Creates a new {@code DefaultTransportContext} that exposes the given connection. */ public DefaultTransportContext(WebServiceConnection connection) { Assert.notNull(connection, "'connection' must not be null"); this.connection = connection; diff --git a/spring-ws-core/src/main/java/org/springframework/ws/transport/context/TransportContext.java b/spring-ws-core/src/main/java/org/springframework/ws/transport/context/TransportContext.java index 35213c6d..a54deca6 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/transport/context/TransportContext.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/transport/context/TransportContext.java @@ -4,14 +4,14 @@ import org.springframework.ws.transport.WebServiceConnection; /** * Strategy interface for determining the current {@link org.springframework.ws.transport.WebServiceConnection}. - *

                - * An instance of this class can be associated with a thread via the {@link TransportContextHolder} class. + * + *

                An instance of this class can be associated with a thread via the {@link TransportContextHolder} class. * * @author Arjen Poutsma * @since 1.0.0 */ public interface TransportContext { - /** Returns the current WebServiceConnection. */ + /** Returns the current {@code WebServiceConnection}. */ WebServiceConnection getConnection(); } diff --git a/spring-ws-core/src/main/java/org/springframework/ws/transport/context/TransportContextHolder.java b/spring-ws-core/src/main/java/org/springframework/ws/transport/context/TransportContextHolder.java index 22ac833c..39fa7e66 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/transport/context/TransportContextHolder.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/transport/context/TransportContextHolder.java @@ -17,8 +17,8 @@ package org.springframework.ws.transport.context; /** - * Simple holder class that associates a TransportContext instance with the current thread. The - * TransportContext will be inherited by any child threads spawned by the current thread. + * Simple holder class that associates a {@code TransportContext} instance with the current thread. The + * {@code TransportContext} will be inherited by any child threads spawned by the current thread. * * @author Arjen Poutsma * @see TransportContext @@ -29,18 +29,18 @@ public abstract class TransportContextHolder { private static final ThreadLocal transportContextHolder = new TransportThreadLocal(); /** - * Associate the given TransportContext with the current thread. + * Associate the given {@code TransportContext} with the current thread. * - * @param transportContext the current transport context, or null to reset the thread-bound context + * @param transportContext the current transport context, or {@code null} to reset the thread-bound context */ public static void setTransportContext(TransportContext transportContext) { transportContextHolder.set(transportContext); } /** - * Return the TransportContext associated with the current thread, if any. + * Return the {@code TransportContext} associated with the current thread, if any. * - * @return the current transport context, or null if none + * @return the current transport context, or {@code null} if none */ public static TransportContext getTransportContext() { return transportContextHolder.get(); diff --git a/spring-ws-core/src/main/java/org/springframework/ws/transport/http/AbstractHttpWebServiceMessageSender.java b/spring-ws-core/src/main/java/org/springframework/ws/transport/http/AbstractHttpWebServiceMessageSender.java index 139b2951..b5da3545 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/transport/http/AbstractHttpWebServiceMessageSender.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/transport/http/AbstractHttpWebServiceMessageSender.java @@ -40,18 +40,18 @@ public abstract class AbstractHttpWebServiceMessageSender implements WebServiceM private boolean acceptGzipEncoding = true; /** - * Return whether to accept GZIP encoding, that is, whether to send the HTTP Accept-Encoding header - * with gzip as value. + * Return whether to accept GZIP encoding, that is, whether to send the HTTP {@code Accept-Encoding} header + * with {@code gzip} as value. */ public boolean isAcceptGzipEncoding() { return acceptGzipEncoding; } /** - * Set whether to accept GZIP encoding, that is, whether to send the HTTP Accept-Encoding header with - * gzip as value. - *

                - * Default is true. Turn this flag off if you do not want GZIP response compression even if enabled on + * Set whether to accept GZIP encoding, that is, whether to send the HTTP {@code Accept-Encoding} header with + * {@code gzip} as value. + * + *

                Default is {@code true}. Turn this flag off if you do not want GZIP response compression even if enabled on * the HTTP server. */ public void setAcceptGzipEncoding(boolean acceptGzipEncoding) { diff --git a/spring-ws-core/src/main/java/org/springframework/ws/transport/http/CommonsHttpMessageSender.java b/spring-ws-core/src/main/java/org/springframework/ws/transport/http/CommonsHttpMessageSender.java index b13b3c52..6347822a 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/transport/http/CommonsHttpMessageSender.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/transport/http/CommonsHttpMessageSender.java @@ -39,10 +39,10 @@ import org.springframework.util.Assert; import org.springframework.ws.transport.WebServiceConnection; /** - * WebServiceMessageSender implementation that uses Jakarta + * {@code WebServiceMessageSender} implementation that uses Jakarta * Commons HttpClient to execute POST requests. - *

                - * Allows to use a preconfigured HttpClient instance, potentially with authentication, HTTP connection pooling, etc. + * + *

                Allows to use a preconfigured HttpClient instance, potentially with authentication, HTTP connection pooling, etc. * Authentication can also be set by injecting a {@link Credentials} instance (such as the {@link * UsernamePasswordCredentials}). * @@ -68,7 +68,7 @@ public class CommonsHttpMessageSender extends AbstractHttpWebServiceMessageSende private AuthScope authScope; /** - * Create a new instance of the CommonsHttpMessageSender with a default {@link HttpClient} that uses a + * Create a new instance of the {@code CommonsHttpMessageSender} with a default {@link HttpClient} that uses a * default {@link MultiThreadedHttpConnectionManager}. */ public CommonsHttpMessageSender() { @@ -78,7 +78,7 @@ public class CommonsHttpMessageSender extends AbstractHttpWebServiceMessageSende } /** - * Create a new instance of the CommonsHttpMessageSender with the given {@link HttpClient} instance. + * Create a new instance of the {@code CommonsHttpMessageSender} with the given {@link HttpClient} instance. * * @param httpClient the HttpClient instance to use for this sender */ @@ -87,12 +87,12 @@ public class CommonsHttpMessageSender extends AbstractHttpWebServiceMessageSende this.httpClient = httpClient; } - /** Returns the HttpClient used by this message sender. */ + /** Returns the {@code HttpClient} used by this message sender. */ public HttpClient getHttpClient() { return httpClient; } - /** Set the HttpClient used by this message sender. */ + /** Set the {@code HttpClient} used by this message sender. */ public void setHttpClient(HttpClient httpClient) { this.httpClient = httpClient; } @@ -191,18 +191,18 @@ public class CommonsHttpMessageSender extends AbstractHttpWebServiceMessageSende } /** - * Returns the authentication scope to be used. Only used when the credentials property has been set. - *

                - * By default, the {@link AuthScope#ANY} is returned. + * Returns the authentication scope to be used. Only used when the {@code credentials} property has been set. + * + *

                By default, the {@link AuthScope#ANY} is returned. */ public AuthScope getAuthScope() { return authScope != null ? authScope : AuthScope.ANY; } /** - * Sets the authentication scope to be used. Only used when the credentials property has been set. - *

                - * By default, the {@link AuthScope#ANY} is used. + * Sets the authentication scope to be used. Only used when the {@code credentials} property has been set. + * + *

                By default, the {@link AuthScope#ANY} is used. * * @see #setCredentials(Credentials) */ diff --git a/spring-ws-core/src/main/java/org/springframework/ws/transport/http/HttpComponentsMessageSender.java b/spring-ws-core/src/main/java/org/springframework/ws/transport/http/HttpComponentsMessageSender.java index d21ae253..16e9fcf6 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/transport/http/HttpComponentsMessageSender.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/transport/http/HttpComponentsMessageSender.java @@ -47,8 +47,8 @@ import org.springframework.ws.transport.WebServiceConnection; /** * {@code WebServiceMessageSender} implementation that uses Apache * HttpClient to execute POST requests. - *

                - * Allows to use a pre-configured HttpClient instance, potentially with authentication, HTTP connection pooling, etc. + * + *

                Allows to use a pre-configured HttpClient instance, potentially with authentication, HTTP connection pooling, etc. * Authentication can also be set by injecting a {@link Credentials} instance (such as the {@link * UsernamePasswordCredentials}). * @@ -111,7 +111,7 @@ public class HttpComponentsMessageSender extends AbstractHttpWebServiceMessageSe } /** - * Returns the HttpClient used by this message sender. + * Returns the {@code HttpClient} used by this message sender. */ public HttpClient getHttpClient() { return httpClient; @@ -172,14 +172,14 @@ public class HttpComponentsMessageSender extends AbstractHttpWebServiceMessageSe /** * Sets the maximum number of connections per host for the underlying HttpClient. The maximum number of connections * per host can be set in a form accepted by the {@code java.util.Properties} class, like as follows: - *

                + * *

                      * https://www.example.com=1
                      * http://www.example.com:8080=7
                      * http://www.springframework.org=10
                      * 
                - *

                - * The host can be specified as a URI (with scheme and port). + * + *

                The host can be specified as a URI (with scheme and port). * * @param maxConnectionsPerHost a properties object specifying the maximum number of connection * @see PoolingClientConnectionManager#setMaxPerRoute(HttpRoute, int) @@ -206,9 +206,9 @@ public class HttpComponentsMessageSender extends AbstractHttpWebServiceMessageSe } /** - * Sets the authentication scope to be used. Only used when the credentials property has been set. - *

                - * By default, the {@link AuthScope#ANY} is used. + * Sets the authentication scope to be used. Only used when the {@code credentials} property has been set. + * + *

                By default, the {@link AuthScope#ANY} is used. * * @see #setCredentials(Credentials) */ diff --git a/spring-ws-core/src/main/java/org/springframework/ws/transport/http/HttpServletConnection.java b/spring-ws-core/src/main/java/org/springframework/ws/transport/http/HttpServletConnection.java index 2dbcd63d..00d2a66c 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/transport/http/HttpServletConnection.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/transport/http/HttpServletConnection.java @@ -48,20 +48,20 @@ public class HttpServletConnection extends AbstractReceiverConnection private boolean statusCodeSet = false; /** - * Constructs a new servlet connection with the given HttpServletRequest and - * HttpServletResponse. + * Constructs a new servlet connection with the given {@code HttpServletRequest} and + * {@code HttpServletResponse}. */ protected HttpServletConnection(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse) { this.httpServletRequest = httpServletRequest; this.httpServletResponse = httpServletResponse; } - /** Returns the HttpServletRequest for this connection. */ + /** Returns the {@code HttpServletRequest} for this connection. */ public HttpServletRequest getHttpServletRequest() { return httpServletRequest; } - /** Returns the HttpServletResponse for this connection. */ + /** Returns the {@code HttpServletResponse} for this connection. */ public HttpServletResponse getHttpServletResponse() { return httpServletResponse; } diff --git a/spring-ws-core/src/main/java/org/springframework/ws/transport/http/HttpUrlConnection.java b/spring-ws-core/src/main/java/org/springframework/ws/transport/http/HttpUrlConnection.java index 68885d8f..a8436c8c 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/transport/http/HttpUrlConnection.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/transport/http/HttpUrlConnection.java @@ -44,9 +44,9 @@ public class HttpUrlConnection extends AbstractHttpSenderConnection { private final HttpURLConnection connection; /** - * Creates a new instance of the HttpUrlConnection with the given HttpURLConnection. + * Creates a new instance of the {@code HttpUrlConnection} with the given {@code HttpURLConnection}. * - * @param connection the HttpURLConnection + * @param connection the {@code HttpURLConnection} */ protected HttpUrlConnection(HttpURLConnection connection) { Assert.notNull(connection, "connection must not be null"); diff --git a/spring-ws-core/src/main/java/org/springframework/ws/transport/http/HttpUrlConnectionMessageSender.java b/spring-ws-core/src/main/java/org/springframework/ws/transport/http/HttpUrlConnectionMessageSender.java index e38630b8..fca8ecfe 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/transport/http/HttpUrlConnectionMessageSender.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/transport/http/HttpUrlConnectionMessageSender.java @@ -28,8 +28,8 @@ import org.springframework.ws.transport.WebServiceConnection; * {@code WebServiceMessageSender} implementation that uses standard J2SE facilities to * execute POST requests, without support for HTTP authentication or advanced * configuration options. - *

                - * Consider {@link HttpComponentsMessageSender} for more sophisticated needs: this class + * + *

                Consider {@link HttpComponentsMessageSender} for more sophisticated needs: this class * is rather limited in its capabilities. * * @author Arjen Poutsma @@ -54,8 +54,8 @@ public class HttpUrlConnectionMessageSender extends AbstractHttpWebServiceMessag /** * Template method for preparing the given {@link java.net.HttpURLConnection}. - *

                - * The default implementation prepares the connection for input and output, sets the HTTP method to POST, disables + * + *

                The default implementation prepares the connection for input and output, sets the HTTP method to POST, disables * caching, and sets the {@code Accept-Encoding} header to gzip, if {@linkplain #setAcceptGzipEncoding(boolean) * applicable}. * diff --git a/spring-ws-core/src/main/java/org/springframework/ws/transport/http/LocationTransformerObjectSupport.java b/spring-ws-core/src/main/java/org/springframework/ws/transport/http/LocationTransformerObjectSupport.java index 868925c2..31478df2 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/transport/http/LocationTransformerObjectSupport.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/transport/http/LocationTransformerObjectSupport.java @@ -74,16 +74,16 @@ public abstract class LocationTransformerObjectSupport extends TransformerObject * Transform the given location string to reflect the given request. If the given location is a full url, the * scheme, server name, and port are changed. If it is a relative url, the scheme, server name, and port are * prepended. Can be overridden in subclasses to change this behavior. - *

                - * For instance, if the location attribute defined in the WSDL is {@code http://localhost:8080/context/services/myService}, + * + *

                For instance, if the location attribute defined in the WSDL is {@code http://localhost:8080/context/services/myService}, * and the request URI for the WSDL is {@code http://example.com:80/context/myService.wsdl}, the location * will be changed to {@code http://example.com:80/context/services/myService}. - *

                - * If the location attribute defined in the WSDL is {@code /services/myService}, and the request URI for the + * + *

                If the location attribute defined in the WSDL is {@code /services/myService}, and the request URI for the * WSDL is {@code http://example.com:8080/context/myService.wsdl}, the location will be changed to * {@code http://example.com:8080/context/services/myService}. - *

                - * This method is only called when the {@code transformLocations} property is true. + * + *

                This method is only called when the {@code transformLocations} property is true. */ protected String transformLocation(String location, HttpServletRequest request) { StringBuilder url = new StringBuilder(request.getScheme()); diff --git a/spring-ws-core/src/main/java/org/springframework/ws/transport/http/MessageDispatcherServlet.java b/spring-ws-core/src/main/java/org/springframework/ws/transport/http/MessageDispatcherServlet.java index b05cd0bf..c65501e3 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/transport/http/MessageDispatcherServlet.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/transport/http/MessageDispatcherServlet.java @@ -41,19 +41,19 @@ import org.springframework.xml.xsd.XsdSchema; /** * Servlet for simplified dispatching of Web service messages. - *

                - * This servlet is a convenient alternative to the standard Spring-MVC {@link DispatcherServlet} with separate {@link + * + *

                This servlet is a convenient alternative to the standard Spring-MVC {@link DispatcherServlet} with separate {@link * WebServiceMessageReceiverHandlerAdapter}, {@link MessageDispatcher}, and {@link WsdlDefinitionHandlerAdapter} * instances. - *

                - * This servlet automatically detects {@link EndpointAdapter EndpointAdapters}, {@link EndpointMapping + * + *

                This servlet automatically detects {@link EndpointAdapter EndpointAdapters}, {@link EndpointMapping * EndpointMappings}, and {@link EndpointExceptionResolver EndpointExceptionResolvers} by type. - *

                - * This servlet also automatically detects any {@link WsdlDefinition} defined in its application context. This WSDL is - * exposed under the bean name: for example, a WsdlDefinition bean named 'echo' will be - * exposed as echo.wsdl in this servlet's context: http://localhost:8080/spring-ws/echo.wsdl. - * When the transformWsdlLocations init-param is set to true in this servlet's configuration - * in web.xml, all location attributes in the WSDL definitions will reflect the URL of the + * + *

                This servlet also automatically detects any {@link WsdlDefinition} defined in its application context. This WSDL is + * exposed under the bean name: for example, a {@code WsdlDefinition} bean named '{@code echo}' will be + * exposed as {@code echo.wsdl} in this servlet's context: {@code http://localhost:8080/spring-ws/echo.wsdl}. + * When the {@code transformWsdlLocations} init-param is set to {@code true} in this servlet's configuration + * in {@code web.xml}, all {@code location} attributes in the WSDL definitions will reflect the URL of the * incoming request. * * @author Arjen Poutsma @@ -214,7 +214,7 @@ public class MessageDispatcherServlet extends FrameworkServlet { /** * Sets whether relative address locations in the WSDL are to be transformed using the request URI of the incoming - * {@link HttpServletRequest}. Defaults to false. + * {@link HttpServletRequest}. Defaults to {@code false}. */ public void setTransformWsdlLocations(boolean transformWsdlLocations) { this.transformWsdlLocations = transformWsdlLocations; @@ -230,7 +230,7 @@ public class MessageDispatcherServlet extends FrameworkServlet { /** * Sets whether relative address locations in the XSD are to be transformed using the request URI of the incoming - * {@link HttpServletRequest}. Defaults to false. + * {@link HttpServletRequest}. Defaults to {@code false}. */ public void setTransformSchemaLocations(boolean transformSchemaLocations) { this.transformSchemaLocations = transformSchemaLocations; @@ -319,14 +319,14 @@ public class MessageDispatcherServlet extends FrameworkServlet { } /** - * Determines the {@link WsdlDefinition} for a given request, or null if none is found. - *

                - * Default implementation checks whether the request method is GET, whether the request uri ends with - * ".wsdl", and if there is a WsdlDefinition with the same name as the filename in the + * Determines the {@link WsdlDefinition} for a given request, or {@code null} if none is found. + * + *

                Default implementation checks whether the request method is {@code GET}, whether the request uri ends with + * {@code ".wsdl"}, and if there is a {@code WsdlDefinition} with the same name as the filename in the * request uri. * - * @param request the HttpServletRequest - * @return a definition, or null + * @param request the {@code HttpServletRequest} + * @return a definition, or {@code null} */ protected WsdlDefinition getWsdlDefinition(HttpServletRequest request) { if (HttpTransportConstants.METHOD_GET.equals(request.getMethod()) && @@ -340,14 +340,14 @@ public class MessageDispatcherServlet extends FrameworkServlet { } /** - * Determines the {@link XsdSchema} for a given request, or null if none is found. - *

                - * Default implementation checks whether the request method is GET, whether the request uri ends with - * ".xsd", and if there is a XsdSchema with the same name as the filename in the request + * Determines the {@link XsdSchema} for a given request, or {@code null} if none is found. + * + *

                Default implementation checks whether the request method is {@code GET}, whether the request uri ends with + * {@code ".xsd"}, and if there is a {@code XsdSchema} with the same name as the filename in the request * uri. * - * @param request the HttpServletRequest - * @return a schema, or null + * @param request the {@code HttpServletRequest} + * @return a schema, or {@code null} */ protected XsdSchema getXsdSchema(HttpServletRequest request) { if (HttpTransportConstants.METHOD_GET.equals(request.getMethod()) && diff --git a/spring-ws-core/src/main/java/org/springframework/ws/transport/http/WebServiceMessageReceiverHandlerAdapter.java b/spring-ws-core/src/main/java/org/springframework/ws/transport/http/WebServiceMessageReceiverHandlerAdapter.java index a8b09283..dde213a5 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/transport/http/WebServiceMessageReceiverHandlerAdapter.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/transport/http/WebServiceMessageReceiverHandlerAdapter.java @@ -29,11 +29,11 @@ import org.springframework.ws.transport.support.WebServiceMessageReceiverObjectS /** * Adapter to use the {@link WebServiceMessageReceiver} interface with the generic {@link * org.springframework.web.servlet.DispatcherServlet}. Requires a {@link org.springframework.ws.WebServiceMessageFactory} - * which is used to convert the incoming HttpServletRequest into a WebServiceMessage, and - * passes that context to the mapped WebServiceMessageReceiver. If a response is created, that is sent via - * the HttpServletResponse. - *

                - * Note that the MessageDispatcher implements the WebServiceMessageReceiver interface, + * which is used to convert the incoming {@code HttpServletRequest} into a {@code WebServiceMessage}, and + * passes that context to the mapped {@code WebServiceMessageReceiver}. If a response is created, that is sent via + * the {@code HttpServletResponse}. + * + *

                Note that the {@code MessageDispatcher} implements the {@code WebServiceMessageReceiver} interface, * enabling this adapter to function as a gateway to further message handling logic. * * @author Arjen Poutsma @@ -78,8 +78,8 @@ public class WebServiceMessageReceiverHandlerAdapter extends WebServiceMessageRe /** * Template method that is invoked when the request method is not {@code POST}. Called from {@link * #handle(HttpServletRequest, HttpServletResponse, Object)}. - *

                - * Default implementation set the response status to 405: Method Not Allowed. Can be overridden in subclasses. + * + *

                Default implementation set the response status to 405: Method Not Allowed. Can be overridden in subclasses. * * @param httpServletRequest current HTTP request * @param httpServletResponse current HTTP response @@ -94,8 +94,8 @@ public class WebServiceMessageReceiverHandlerAdapter extends WebServiceMessageRe /** * Template method that is invoked when parsing the request results in a {@link InvalidXmlException}. Called from * {@link #handle(HttpServletRequest, HttpServletResponse, Object)}. - *

                - * Default implementation set the response status to 400: Bad Request. Can be overridden in subclasses. + * + *

                Default implementation set the response status to 400: Bad Request. Can be overridden in subclasses. * * @param httpServletRequest current HTTP request * @param httpServletResponse current HTTP response diff --git a/spring-ws-core/src/main/java/org/springframework/ws/transport/http/WsdlDefinitionHandlerAdapter.java b/spring-ws-core/src/main/java/org/springframework/ws/transport/http/WsdlDefinitionHandlerAdapter.java index 7dd68ece..b936b7b2 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/transport/http/WsdlDefinitionHandlerAdapter.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/transport/http/WsdlDefinitionHandlerAdapter.java @@ -37,25 +37,25 @@ import org.springframework.xml.xpath.XPathExpressionFactory; /** * Adapter to use the {@code WsdlDefinition} interface with the generic {@code DispatcherServlet}. - *

                - * Reads the source from the mapped {@code WsdlDefinition} implementation, and writes that as the result to the + * + *

                Reads the source from the mapped {@code WsdlDefinition} implementation, and writes that as the result to the * {@code HttpServletResponse}. - *

                - * If the property {@code transformLocations} is set to {@code true}, this adapter will change + * + *

                If the property {@code transformLocations} is set to {@code true}, this adapter will change * {@code location} attributes in the WSDL definition to reflect the URL of the incoming request. If the location * field in the original WSDL is an absolute path, the scheme, hostname, and port will be changed. If the location is a * relative path, the scheme, hostname, port, and context path will be prepended. This behavior can be customized by * overriding the {@code transformLocation()} method. - *

                - * For instance, if the location attribute defined in the WSDL is {@code http://localhost:8080/context/services/myService}, + * + *

                For instance, if the location attribute defined in the WSDL is {@code http://localhost:8080/context/services/myService}, * and the request URI for the WSDL is {@code http://example.com/context/myService.wsdl}, the location will be * changed to {@code http://example.com/context/services/myService}. - *

                - * If the location attribute defined in the WSDL is {@code /services/myService}, and the request URI for the WSDL + * + *

                If the location attribute defined in the WSDL is {@code /services/myService}, and the request URI for the WSDL * is {@code http://example.com:8080/context/myService.wsdl}, the location will be changed to * {@code http://example.com:8080/context/services/myService}. - *

                - * When {@code transformLocations} is enabled, all {@code location} attributes found in the WSDL definition + * + *

                When {@code transformLocations} is enabled, all {@code location} attributes found in the WSDL definition * are changed by default. This behavior can be customized by changing the {@code locationExpression} property, * which is an XPath expression that matches the attributes to change. * @@ -92,8 +92,8 @@ public class WsdlDefinitionHandlerAdapter extends LocationTransformerObjectSuppo /** * Sets the XPath expression used for extracting the {@code location} attributes from the WSDL 1.1 definition. - *

                - * Defaults to {@code DEFAULT_LOCATION_EXPRESSION}. + * + *

                Defaults to {@code DEFAULT_LOCATION_EXPRESSION}. */ public void setLocationExpression(String locationExpression) { this.locationExpression = locationExpression; @@ -101,8 +101,8 @@ public class WsdlDefinitionHandlerAdapter extends LocationTransformerObjectSuppo /** * Sets the XPath expression used for extracting the {@code schemaLocation} attributes from the WSDL 1.1 definition. - *

                - * Defaults to {@code DEFAULT_SCHEMA_LOCATION_EXPRESSION}. + * + *

                Defaults to {@code DEFAULT_SCHEMA_LOCATION_EXPRESSION}. */ public void setSchemaLocationExpression(String schemaLocationExpression) { this.schemaLocationExpression = schemaLocationExpression; @@ -179,8 +179,8 @@ public class WsdlDefinitionHandlerAdapter extends LocationTransformerObjectSuppo * Transforms all {@code location} attributes to reflect the server name given {@code HttpServletRequest}. * Determines the suitable attributes by evaluating the defined XPath expression, and delegates to * {@code transformLocation} to do the transformation for all attributes that match. - *

                - * This method is only called when the {@code transformLocations} property is true. + * + *

                This method is only called when the {@code transformLocations} property is true. * * @see #setLocationExpression(String) * @see #setTransformLocations(boolean) @@ -194,8 +194,8 @@ public class WsdlDefinitionHandlerAdapter extends LocationTransformerObjectSuppo * Transforms all {@code schemaLocation} attributes to reflect the server name given {@code HttpServletRequest}. * Determines the suitable attributes by evaluating the defined XPath expression, and delegates to * {@code transformLocation} to do the transformation for all attributes that match. - *

                - * This method is only called when the {@code transformSchemaLocations} property is true. + * + *

                This method is only called when the {@code transformSchemaLocations} property is true. * * @see #setSchemaLocationExpression(String) * @see #setTransformSchemaLocations(boolean) diff --git a/spring-ws-core/src/main/java/org/springframework/ws/transport/http/XsdSchemaHandlerAdapter.java b/spring-ws-core/src/main/java/org/springframework/ws/transport/http/XsdSchemaHandlerAdapter.java index 23ea3e50..5858c8e4 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/transport/http/XsdSchemaHandlerAdapter.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/transport/http/XsdSchemaHandlerAdapter.java @@ -36,10 +36,10 @@ import org.springframework.xml.xpath.XPathExpressionFactory; import org.springframework.xml.xsd.XsdSchema; /** - * Adapter to use the {@link XsdSchema} interface with the generic DispatcherServlet. - *

                - * Reads the source from the mapped {@link XsdSchema} implementation, and writes that as the result to the - * HttpServletResponse. Allows for post-processing the schema in subclasses. + * Adapter to use the {@link XsdSchema} interface with the generic {@code DispatcherServlet}. + * + *

                Reads the source from the mapped {@link XsdSchema} implementation, and writes that as the result to the + * {@code HttpServletResponse}. Allows for post-processing the schema in subclasses. * * @author Arjen Poutsma * @see XsdSchema @@ -66,8 +66,8 @@ public class XsdSchemaHandlerAdapter extends LocationTransformerObjectSupport /** * Sets the XPath expression used for extracting the {@code schemaLocation} attributes from the WSDL 1.1 definition. - *

                - * Defaults to {@code DEFAULT_SCHEMA_LOCATION_EXPRESSION}. + * + *

                Defaults to {@code DEFAULT_SCHEMA_LOCATION_EXPRESSION}. */ public void setSchemaLocationExpression(String schemaLocationExpression) { this.schemaLocationExpression = schemaLocationExpression; @@ -126,8 +126,8 @@ public class XsdSchemaHandlerAdapter extends LocationTransformerObjectSupport /** * Returns the {@link Source} of the given schema. Allows for post-processing and transformation of the schema in * sub-classes. - *

                - * Default implementation simply returns {@link XsdSchema#getSource()}. + * + *

                Default implementation simply returns {@link XsdSchema#getSource()}. * * @param schema the schema * @return the source of the given schema @@ -141,8 +141,8 @@ public class XsdSchemaHandlerAdapter extends LocationTransformerObjectSupport * Transforms all {@code schemaLocation} attributes to reflect the server name given {@code HttpServletRequest}. * Determines the suitable attributes by evaluating the defined XPath expression, and delegates to {@code * transformLocation} to do the transformation for all attributes that match. - *

                - * This method is only called when the {@code transformSchemaLocations} property is true. + * + *

                This method is only called when the {@code transformSchemaLocations} property is true. * * @see #setSchemaLocationExpression(String) * @see #transformLocation(String, javax.servlet.http.HttpServletRequest) diff --git a/spring-ws-core/src/main/java/org/springframework/ws/transport/support/TransportUtils.java b/spring-ws-core/src/main/java/org/springframework/ws/transport/support/TransportUtils.java index 36a35176..831a70a7 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/transport/support/TransportUtils.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/transport/support/TransportUtils.java @@ -35,9 +35,9 @@ public abstract class TransportUtils { /** * Close the given {@link WebServiceConnection} and ignore any thrown exception. This is useful for typical - * finally blocks. + * {@code finally} blocks. * - * @param connection the web service connection to close (may be null) + * @param connection the web service connection to close (may be {@code null}) */ public static void closeConnection(WebServiceConnection connection) { if (connection != null) { diff --git a/spring-ws-core/src/main/java/org/springframework/ws/transport/support/WebServiceMessageReceiverObjectSupport.java b/spring-ws-core/src/main/java/org/springframework/ws/transport/support/WebServiceMessageReceiverObjectSupport.java index 0afa7a2d..f93ea9a0 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/transport/support/WebServiceMessageReceiverObjectSupport.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/transport/support/WebServiceMessageReceiverObjectSupport.java @@ -52,12 +52,12 @@ public abstract class WebServiceMessageReceiverObjectSupport implements Initiali private WebServiceMessageFactory messageFactory; - /** Returns the WebServiceMessageFactory. */ + /** Returns the {@code WebServiceMessageFactory}. */ public WebServiceMessageFactory getMessageFactory() { return messageFactory; } - /** Sets the WebServiceMessageFactory. */ + /** Sets the {@code WebServiceMessageFactory}. */ public void setMessageFactory(WebServiceMessageFactory messageFactory) { this.messageFactory = messageFactory; } @@ -71,8 +71,8 @@ public abstract class WebServiceMessageReceiverObjectSupport implements Initiali * Handles an incoming connection by {@link WebServiceConnection#receive(WebServiceMessageFactory) receving} a * message from it, passing it to the {@link WebServiceMessageReceiver#receive(MessageContext) receiver}, and {@link * WebServiceConnection#send(WebServiceMessage) sending} the response (if any). - *

                - * Stores the given connection in the {@link TransportContext}. + * + *

                Stores the given connection in the {@link TransportContext}. * * @param connection the incoming connection * @param receiver the handler of the message, typically a {@link org.springframework.ws.server.MessageDispatcher} @@ -109,8 +109,8 @@ public abstract class WebServiceMessageReceiverObjectSupport implements Initiali /** * Template method for handling {@code NoEndpointFoundException}s. - *

                - * Default implementation calls + * + *

                Default implementation calls * {@link EndpointAwareWebServiceConnection#endpointNotFound()} on the given * connection, if possible. * diff --git a/spring-ws-core/src/main/java/org/springframework/ws/wsdl/WsdlDefinition.java b/spring-ws-core/src/main/java/org/springframework/ws/wsdl/WsdlDefinition.java index c1899e6e..4aac4ab5 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/wsdl/WsdlDefinition.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/wsdl/WsdlDefinition.java @@ -27,9 +27,9 @@ import javax.xml.transform.Source; public interface WsdlDefinition { /** - * Returns the Source of the definition. + * Returns the {@code Source} of the definition. * - * @return the Source of this WSDL definition + * @return the {@code Source} of this WSDL definition */ Source getSource(); diff --git a/spring-ws-core/src/main/java/org/springframework/ws/wsdl/wsdl11/DefaultWsdl11Definition.java b/spring-ws-core/src/main/java/org/springframework/ws/wsdl/wsdl11/DefaultWsdl11Definition.java index 26420cf3..c953f38f 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/wsdl/wsdl11/DefaultWsdl11Definition.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/wsdl/wsdl11/DefaultWsdl11Definition.java @@ -34,8 +34,8 @@ import org.springframework.xml.xsd.XsdSchemaCollection; * conventions in one or more inlined XSD schemas. Delegates to {@link InliningXsdSchemaTypesProvider}, {@link * DefaultMessagesProvider}, {@link SuffixBasedPortTypesProvider}, {@link SoapProvider} underneath; effectively * equivalent to using a {@link ProviderBasedWsdl4jDefinition} with all these providers. - *

                - * Example configuration: + * + *

                Example configuration: *

                  * <bean id="airline" class="org.springframework.ws.wsdl.wsdl11.DefaultWsdl11Definition">
                  *   <property name="schema">
                @@ -76,8 +76,8 @@ public class DefaultWsdl11Definition implements Wsdl11Definition, InitializingBe
                 
                     /**
                      * Sets the target namespace used for this definition.
                -     * 

                - * Defaults to the target namespace of the defined schema. + * + *

                Defaults to the target namespace of the defined schema. */ public void setTargetNamespace(String targetNamespace) { delegate.setTargetNamespace(targetNamespace); @@ -124,8 +124,8 @@ public class DefaultWsdl11Definition implements Wsdl11Definition, InitializingBe /** * Indicates whether a SOAP 1.1 binding should be created. - *

                - * Defaults to true. + * + *

                Defaults to {@code true}. */ public void setCreateSoap11Binding(boolean createSoap11Binding) { soapProvider.setCreateSoap11Binding(createSoap11Binding); @@ -133,8 +133,8 @@ public class DefaultWsdl11Definition implements Wsdl11Definition, InitializingBe /** * Indicates whether a SOAP 1.2 binding should be created. - *

                - * Defaults to false. + * + *

                Defaults to {@code false}. */ public void setCreateSoap12Binding(boolean createSoap12Binding) { soapProvider.setCreateSoap12Binding(createSoap12Binding); @@ -162,8 +162,8 @@ public class DefaultWsdl11Definition implements Wsdl11Definition, InitializingBe /** * Sets the service name. - *

                - * Defaults to the port type name, with the suffix {@code Service} appended to it. + * + *

                Defaults to the port type name, with the suffix {@code Service} appended to it. */ public void setServiceName(String serviceName) { soapProvider.setServiceName(serviceName); diff --git a/spring-ws-core/src/main/java/org/springframework/ws/wsdl/wsdl11/ProviderBasedWsdl4jDefinition.java b/spring-ws-core/src/main/java/org/springframework/ws/wsdl/wsdl11/ProviderBasedWsdl4jDefinition.java index c18efd16..2e374adf 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/wsdl/wsdl11/ProviderBasedWsdl4jDefinition.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/wsdl/wsdl11/ProviderBasedWsdl4jDefinition.java @@ -32,13 +32,13 @@ import org.springframework.ws.wsdl.wsdl11.provider.TypesProvider; /** * Implementation of the {@link Wsdl11Definition} that uses a provider-based mechanism to populate a WSDL4J {@link * Definition}. - *

                - * All providers are optional, indicating that a particular part of the WSDL will not be created. Providers can be set + * + *

                All providers are optional, indicating that a particular part of the WSDL will not be created. Providers can be set * via various properties. The providers are {@link #afterPropertiesSet() invoked} in the following order:

                  *
                1. {@link ImportsProvider}
                2. {@link TypesProvider}
                3. {@link MessagesProvider}
                4. {@link * PortTypesProvider}
                5. {@link BindingsProvider}
                6. {@link ServicesProvider}
                - *

                - * This definition requires the target namespace to be set via {@link #setTargetNamespace(String)} + * + *

                This definition requires the target namespace to be set via {@link #setTargetNamespace(String)} * * @author Arjen Poutsma * @see #setImportsProvider(ImportsProvider) @@ -70,10 +70,10 @@ public class ProviderBasedWsdl4jDefinition extends Wsdl4jDefinition implements I /** * Returns the {@link ImportsProvider} for this definition. - *

                - * Default is null, indicating that no <import> will be created * - * @return the import provider; or null + *

                Default is {@code null}, indicating that no {@code <import>} will be created + * + * @return the import provider; or {@code null} */ public ImportsProvider getImportsProvider() { return importsProvider; @@ -81,8 +81,8 @@ public class ProviderBasedWsdl4jDefinition extends Wsdl4jDefinition implements I /** * Sets the {@link ImportsProvider} for this definition. - *

                - * Default is null, indicating that no <import> will be created + * + *

                Default is {@code null}, indicating that no {@code <import>} will be created * * @param importsProvider the import provider */ @@ -92,10 +92,10 @@ public class ProviderBasedWsdl4jDefinition extends Wsdl4jDefinition implements I /** * Returns the {@link TypesProvider} for this definition. - *

                - * Defaults to null, indicating that no <types> will be created * - * @return the types provider; or null + *

                Defaults to {@code null}, indicating that no {@code <types>} will be created + * + * @return the types provider; or {@code null} */ public TypesProvider getTypesProvider() { return typesProvider; @@ -103,10 +103,10 @@ public class ProviderBasedWsdl4jDefinition extends Wsdl4jDefinition implements I /** * Sets the {@link TypesProvider} for this definition. - *

                - * Defaults to null, indicating that no <types> will be created * - * @param typesProvider the types provider; or null + *

                Defaults to {@code null}, indicating that no {@code <types>} will be created + * + * @param typesProvider the types provider; or {@code null} */ public void setTypesProvider(TypesProvider typesProvider) { this.typesProvider = typesProvider; @@ -114,10 +114,10 @@ public class ProviderBasedWsdl4jDefinition extends Wsdl4jDefinition implements I /** * Returns the {@link MessagesProvider} for this definition. - *

                - * Defaults to null, indicating that no <message> will be created * - * @return the messages provider; or null + *

                Defaults to {@code null}, indicating that no {@code <message>} will be created + * + * @return the messages provider; or {@code null} */ public MessagesProvider getMessagesProvider() { return messagesProvider; @@ -125,10 +125,10 @@ public class ProviderBasedWsdl4jDefinition extends Wsdl4jDefinition implements I /** * Sets the {@link MessagesProvider} for this definition. - *

                - * Defaults to null, indicating that no <message> will be created * - * @param messagesProvider the messages provider; or null + *

                Defaults to {@code null}, indicating that no {@code <message>} will be created + * + * @param messagesProvider the messages provider; or {@code null} */ public void setMessagesProvider(MessagesProvider messagesProvider) { this.messagesProvider = messagesProvider; @@ -136,10 +136,10 @@ public class ProviderBasedWsdl4jDefinition extends Wsdl4jDefinition implements I /** * Returns the {@link PortTypesProvider} for this definition. - *

                - * Defaults to null, indicating that no <portType> will be created * - * @return the port types provider; or null + *

                Defaults to {@code null}, indicating that no {@code <portType>} will be created + * + * @return the port types provider; or {@code null} */ public PortTypesProvider getPortTypesProvider() { return portTypesProvider; @@ -147,10 +147,10 @@ public class ProviderBasedWsdl4jDefinition extends Wsdl4jDefinition implements I /** * Sets the {@link PortTypesProvider} for this definition. - *

                - * Defaults to null, indicating that no <portType> will be created * - * @param portTypesProvider the port types provider; or null + *

                Defaults to {@code null}, indicating that no {@code <portType>} will be created + * + * @param portTypesProvider the port types provider; or {@code null} */ public void setPortTypesProvider(PortTypesProvider portTypesProvider) { this.portTypesProvider = portTypesProvider; @@ -158,10 +158,10 @@ public class ProviderBasedWsdl4jDefinition extends Wsdl4jDefinition implements I /** * Returns the {@link BindingsProvider} for this definition. - *

                - * Defaults to null, indicating that no <binding> will be created * - * @return the binding provider; or null + *

                Defaults to {@code null}, indicating that no {@code <binding>} will be created + * + * @return the binding provider; or {@code null} */ public BindingsProvider getBindingsProvider() { return bindingsProvider; @@ -169,10 +169,10 @@ public class ProviderBasedWsdl4jDefinition extends Wsdl4jDefinition implements I /** * Sets the {@link BindingsProvider} for this definition. - *

                - * Defaults to null, indicating that no <binding> will be created * - * @param bindingsProvider the bindings provider; or null + *

                Defaults to {@code null}, indicating that no {@code <binding>} will be created + * + * @param bindingsProvider the bindings provider; or {@code null} */ public void setBindingsProvider(BindingsProvider bindingsProvider) { this.bindingsProvider = bindingsProvider; @@ -180,10 +180,10 @@ public class ProviderBasedWsdl4jDefinition extends Wsdl4jDefinition implements I /** * Returns the {@link ServicesProvider} for this definition. - *

                - * Defaults to null, indicating that no <service> will be created * - * @return the services provider; or null + *

                Defaults to {@code null}, indicating that no {@code <service>} will be created + * + * @return the services provider; or {@code null} */ public ServicesProvider getServicesProvider() { return servicesProvider; @@ -191,10 +191,10 @@ public class ProviderBasedWsdl4jDefinition extends Wsdl4jDefinition implements I /** * Sets the {@link ServicesProvider} for this definition. - *

                - * Defaults to null, indicating that no <service> will be created * - * @param servicesProvider the services provider; or null + *

                Defaults to {@code null}, indicating that no {@code <service>} will be created + * + * @param servicesProvider the services provider; or {@code null} */ public void setServicesProvider(ServicesProvider servicesProvider) { this.servicesProvider = servicesProvider; diff --git a/spring-ws-core/src/main/java/org/springframework/ws/wsdl/wsdl11/SimpleWsdl11Definition.java b/spring-ws-core/src/main/java/org/springframework/ws/wsdl/wsdl11/SimpleWsdl11Definition.java index 057a89d0..156e9312 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/wsdl/wsdl11/SimpleWsdl11Definition.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/wsdl/wsdl11/SimpleWsdl11Definition.java @@ -31,8 +31,8 @@ import org.springframework.xml.transform.ResourceSource; /** * The default {@link Wsdl11Definition} implementation. - *

                - * Allows a WSDL to be set by the {@link #setWsdl wsdl} property, or directly in the {@link + * + *

                Allows a WSDL to be set by the {@link #setWsdl wsdl} property, or directly in the {@link * #SimpleWsdl11Definition(Resource) constructor}. * * @author Arjen Poutsma @@ -44,8 +44,8 @@ public class SimpleWsdl11Definition implements Wsdl11Definition, InitializingBea /** * Create a new instance of the {@link SimpleWsdl11Definition} class. - *

                - * A subsequent call to the {@link #setWsdl(Resource)} method is required. + * + *

                A subsequent call to the {@link #setWsdl(Resource)} method is required. */ public SimpleWsdl11Definition() { } @@ -53,8 +53,8 @@ public class SimpleWsdl11Definition implements Wsdl11Definition, InitializingBea /** * Create a new instance of the {@link SimpleWsdl11Definition} class with the specified resource. * - * @param wsdlResource the WSDL resource; must not be null - * @throws IllegalArgumentException if the supplied wsdlResource is null + * @param wsdlResource the WSDL resource; must not be {@code null} + * @throws IllegalArgumentException if the supplied {@code wsdlResource} is {@code null} */ public SimpleWsdl11Definition(Resource wsdlResource) { Assert.notNull(wsdlResource, "wsdlResource must not be null"); diff --git a/spring-ws-core/src/main/java/org/springframework/ws/wsdl/wsdl11/Wsdl11Definition.java b/spring-ws-core/src/main/java/org/springframework/ws/wsdl/wsdl11/Wsdl11Definition.java index 10dc1d12..b32511bb 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/wsdl/wsdl11/Wsdl11Definition.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/wsdl/wsdl11/Wsdl11Definition.java @@ -20,8 +20,8 @@ import org.springframework.ws.wsdl.WsdlDefinition; /** * Models a WSDL 1.1-specific {@link WsdlDefinition}. - *

                - * Just a marker interface at the moment. + * + *

                Just a marker interface at the moment. * * @author Arjen Poutsma * @see Wsdl11DefinitionBuilder diff --git a/spring-ws-core/src/main/java/org/springframework/ws/wsdl/wsdl11/Wsdl4jDefinition.java b/spring-ws-core/src/main/java/org/springframework/ws/wsdl/wsdl11/Wsdl4jDefinition.java index 5f4f9184..3f91d839 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/wsdl/wsdl11/Wsdl4jDefinition.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/wsdl/wsdl11/Wsdl4jDefinition.java @@ -30,7 +30,7 @@ import org.springframework.util.StringUtils; import org.springframework.ws.wsdl.WsdlDefinitionException; /** - * Implementation of the Wsdl11Definition based on WSDL4J. A {@link javax.wsdl.Definition} can be given as + * Implementation of the {@code Wsdl11Definition} based on WSDL4J. A {@link javax.wsdl.Definition} can be given as * as constructor argument, or set using a property. * * @author Arjen Poutsma @@ -49,7 +49,7 @@ public class Wsdl4jDefinition implements Wsdl11Definition { private final Object monitor = new Object(); /** - * Constructs a new, empty Wsdl4jDefinition. + * Constructs a new, empty {@code Wsdl4jDefinition}. * * @see #setDefinition(javax.wsdl.Definition) */ @@ -57,7 +57,7 @@ public class Wsdl4jDefinition implements Wsdl11Definition { } /** - * Constructs a new Wsdl4jDefinition based on the given Definition. + * Constructs a new {@code Wsdl4jDefinition} based on the given {@code Definition}. * * @param definition the WSDL4J definition */ @@ -65,14 +65,14 @@ public class Wsdl4jDefinition implements Wsdl11Definition { setDefinition(definition); } - /** Returns the WSDL4J Definition. */ + /** Returns the WSDL4J {@code Definition}. */ public Definition getDefinition() { synchronized (monitor) { return definition; } } - /** Set the WSDL4J Definition. */ + /** Set the WSDL4J {@code Definition}. */ public void setDefinition(Definition definition) { synchronized (monitor) { this.definition = definition; diff --git a/spring-ws-core/src/main/java/org/springframework/ws/wsdl/wsdl11/Wsdl4jDefinitionException.java b/spring-ws-core/src/main/java/org/springframework/ws/wsdl/wsdl11/Wsdl4jDefinitionException.java index 389e9a9e..01a38c1c 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/wsdl/wsdl11/Wsdl4jDefinitionException.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/wsdl/wsdl11/Wsdl4jDefinitionException.java @@ -21,7 +21,7 @@ import javax.wsdl.WSDLException; import org.springframework.ws.wsdl.WsdlDefinitionException; /** - * Subclass of WsdlDefinitionException that wraps WSDLExceptions. + * Subclass of {@code WsdlDefinitionException} that wraps {@code WSDLException}s. * * @author Arjen Poutsma * @since 1.0.0 diff --git a/spring-ws-core/src/main/java/org/springframework/ws/wsdl/wsdl11/provider/AbstractPortTypesProvider.java b/spring-ws-core/src/main/java/org/springframework/ws/wsdl/wsdl11/provider/AbstractPortTypesProvider.java index 21f527bc..0486ebb6 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/wsdl/wsdl11/provider/AbstractPortTypesProvider.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/wsdl/wsdl11/provider/AbstractPortTypesProvider.java @@ -63,7 +63,7 @@ public abstract class AbstractPortTypesProvider implements PortTypesProvider { /** * Creates a single {@link PortType}, and calls {@link #populatePortType(Definition, PortType)} with it. * - * @param definition the WSDL4J Definition + * @param definition the WSDL4J {@code Definition} * @throws WSDLException in case of errors */ @Override @@ -78,10 +78,10 @@ public abstract class AbstractPortTypesProvider implements PortTypesProvider { /** * Called after the {@link PortType} has been created. - *

                - * Default implementation sets the name of the port type to the defined value. * - * @param portType the WSDL4J PortType + *

                Default implementation sets the name of the port type to the defined value. + * + * @param portType the WSDL4J {@code PortType} * @throws WSDLException in case of errors * @see #setPortTypeName(String) */ @@ -141,10 +141,10 @@ public abstract class AbstractPortTypesProvider implements PortTypesProvider { /** * Template method that returns the name of the operation coupled to the given {@link Message}. Subclasses can - * return null to indicate that a message should not be coupled to an operation. + * return {@code null} to indicate that a message should not be coupled to an operation. * - * @param message the WSDL4J Message - * @return the operation name; or null + * @param message the WSDL4J {@code Message} + * @return the operation name; or {@code null} */ protected abstract String getOperationName(Message message); @@ -152,18 +152,18 @@ public abstract class AbstractPortTypesProvider implements PortTypesProvider { * Indicates whether the given name name should be included as {@link Input} message in the definition. * * @param message the message - * @return true if to be included as input; false otherwise + * @return {@code true} if to be included as input; {@code false} otherwise */ protected abstract boolean isInputMessage(Message message); /** * Called after the {@link javax.wsdl.Input} has been created, but it's added to the operation. Subclasses can * override this method to define the input name. - *

                - * Default implementation sets the input name to the message name. * - * @param definition the WSDL4J Definition - * @param input the WSDL4J Input + *

                Default implementation sets the input name to the message name. + * + * @param definition the WSDL4J {@code Definition} + * @param input the WSDL4J {@code Input} */ protected void populateInput(Definition definition, Input input) { input.setName(input.getMessage().getQName().getLocalPart()); @@ -173,18 +173,18 @@ public abstract class AbstractPortTypesProvider implements PortTypesProvider { * Indicates whether the given name name should be included as {@link Output} message in the definition. * * @param message the message - * @return true if to be included as output; false otherwise + * @return {@code true} if to be included as output; {@code false} otherwise */ protected abstract boolean isOutputMessage(Message message); /** * Called after the {@link javax.wsdl.Output} has been created, but it's added to the operation. Subclasses can * override this method to define the output name. - *

                - * Default implementation sets the output name to the message name. * - * @param definition the WSDL4J Definition - * @param output the WSDL4J Output + *

                Default implementation sets the output name to the message name. + * + * @param definition the WSDL4J {@code Definition} + * @param output the WSDL4J {@code Output} */ protected void populateOutput(Definition definition, Output output) { output.setName(output.getMessage().getQName().getLocalPart()); @@ -194,18 +194,18 @@ public abstract class AbstractPortTypesProvider implements PortTypesProvider { * Indicates whether the given name name should be included as {@link Fault} message in the definition. * * @param message the message - * @return true if to be included as fault; false otherwise + * @return {@code true} if to be included as fault; {@code false} otherwise */ protected abstract boolean isFaultMessage(Message message); /** * Called after the {@link javax.wsdl.Fault} has been created, but it's added to the operation. Subclasses can * override this method to define the fault name. - *

                - * Default implementation sets the fault name to the message name. * - * @param definition the WSDL4J Definition - * @param fault the WSDL4J Fault + *

                Default implementation sets the fault name to the message name. + * + * @param definition the WSDL4J {@code Definition} + * @param fault the WSDL4J {@code Fault} */ protected void populateFault(Definition definition, Fault fault) { fault.setName(fault.getMessage().getQName().getLocalPart()); @@ -213,11 +213,11 @@ public abstract class AbstractPortTypesProvider implements PortTypesProvider { /** * Returns the {@link OperationType} for the given operation. - *

                - * Default implementation returns {@link OperationType#REQUEST_RESPONSE} if both input and output are set; {@link + * + *

                Default implementation returns {@link OperationType#REQUEST_RESPONSE} if both input and output are set; {@link * OperationType#ONE_WAY} if only input is set, or {@link OperationType#NOTIFICATION} if only output is set. * - * @param operation the WSDL4J Operation + * @param operation the WSDL4J {@code Operation} * @return the operation type for the operation */ protected OperationType getOperationType(Operation operation) { diff --git a/spring-ws-core/src/main/java/org/springframework/ws/wsdl/wsdl11/provider/BindingsProvider.java b/spring-ws-core/src/main/java/org/springframework/ws/wsdl/wsdl11/provider/BindingsProvider.java index 3a5e704c..236e3230 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/wsdl/wsdl11/provider/BindingsProvider.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/wsdl/wsdl11/provider/BindingsProvider.java @@ -21,8 +21,8 @@ import javax.wsdl.WSDLException; /** * Strategy for adding {@link javax.wsdl.Binding}s to a {@link javax.wsdl.Definition}. - *

                - * Used by {@link org.springframework.ws.wsdl.wsdl11.ProviderBasedWsdl4jDefinition}. + * + *

                Used by {@link org.springframework.ws.wsdl.wsdl11.ProviderBasedWsdl4jDefinition}. * * @author Arjen Poutsma * @since 1.5.0 diff --git a/spring-ws-core/src/main/java/org/springframework/ws/wsdl/wsdl11/provider/DefaultConcretePartProvider.java b/spring-ws-core/src/main/java/org/springframework/ws/wsdl/wsdl11/provider/DefaultConcretePartProvider.java index 7e60f18e..96b5c550 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/wsdl/wsdl11/provider/DefaultConcretePartProvider.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/wsdl/wsdl11/provider/DefaultConcretePartProvider.java @@ -42,9 +42,9 @@ import org.springframework.util.StringUtils; /** * Default implementation of the {@link BindingsProvider} and {@link ServicesProvider} interfaces. - *

                - * Creates a binding that matches any present portType, and a service containing - * ports that match the bindings. Lets subclasses populate these through template methods. * + * + *

                Creates a {@code binding} that matches any present {@code portType}, and a service containing + * {@code port}s that match the {@code binding}s. Lets subclasses populate these through template methods. * * * @author Arjen Poutsma * @since 1.5.0 @@ -84,10 +84,10 @@ public class DefaultConcretePartProvider implements BindingsProvider, ServicesPr * Creates a {@link Binding} for each {@link PortType} in the definition, and calls {@link * #populateBinding(Definition,javax.wsdl.Binding)} with it. Creates a {@link BindingOperation} for each {@link * Operation} in the port type, a {@link BindingInput} for each {@link Input} in the operation, etc. - *

                - * Calls the various populate methods with the created WSDL4J objects. * - * @param definition the WSDL4J Definition + *

                Calls the various {@code populate} methods with the created WSDL4J objects. + * + * @param definition the WSDL4J {@code Definition} * @throws WSDLException in case of errors * @see #populateBinding(Definition,javax.wsdl.Binding) * @see #populateBindingOperation(Definition,javax.wsdl.BindingOperation) @@ -116,12 +116,12 @@ public class DefaultConcretePartProvider implements BindingsProvider, ServicesPr /** * Called after the {@link Binding} has been created, but before any sub-elements are added. Subclasses can override * this method to define the binding name, or add extensions to it. - *

                - * Default implementation sets the binding name to the port type name with the {@link #getBindingSuffix() suffix} + * + *

                Default implementation sets the binding name to the port type name with the {@link #getBindingSuffix() suffix} * appended to it. * - * @param definition the WSDL4J Definition - * @param binding the WSDL4J Binding + * @param definition the WSDL4J {@code Definition} + * @param binding the WSDL4J {@code Binding} */ protected void populateBinding(Definition definition, Binding binding) throws WSDLException { QName portTypeName = binding.getPortType().getQName(); @@ -171,11 +171,11 @@ public class DefaultConcretePartProvider implements BindingsProvider, ServicesPr /** * Called after the {@link BindingOperation} has been created, but before any sub-elements are added. Subclasses can * override this method to define the binding name, or add extensions to it. - *

                - * Default implementation sets the name of the binding operation to the name of the operation. * - * @param definition the WSDL4J Definition - * @param bindingOperation the WSDL4J BindingOperation + *

                Default implementation sets the name of the binding operation to the name of the operation. + * + * @param definition the WSDL4J {@code Definition} + * @param bindingOperation the WSDL4J {@code BindingOperation} * @throws WSDLException in case of errors */ protected void populateBindingOperation(Definition definition, BindingOperation bindingOperation) @@ -200,12 +200,12 @@ public class DefaultConcretePartProvider implements BindingsProvider, ServicesPr /** * Called after the {@link BindingInput} has been created. Subclasses can override this method to define the name, * or add extensions to it. - *

                - * Default implementation set the name of the binding input to the name of the input. * - * @param definition the WSDL4J Definition - * @param bindingInput the WSDL4J BindingInput - * @param input the corresponding WSDL4J Input @throws WSDLException in case of errors + *

                Default implementation set the name of the binding input to the name of the input. + * + * @param definition the WSDL4J {@code Definition} + * @param bindingInput the WSDL4J {@code BindingInput} + * @param input the corresponding WSDL4J {@code Input} @throws WSDLException in case of errors */ protected void populateBindingInput(Definition definition, BindingInput bindingInput, Input input) throws WSDLException { @@ -215,12 +215,12 @@ public class DefaultConcretePartProvider implements BindingsProvider, ServicesPr /** * Called after the {@link BindingOutput} has been created. Subclasses can override this method to define the name, * or add extensions to it. - *

                - * Default implementation sets the name of the binding output to the name of the output. * - * @param definition the WSDL4J Definition - * @param bindingOutput the WSDL4J BindingOutput - * @param output the corresponding WSDL4J Output @throws WSDLException in case of errors + *

                Default implementation sets the name of the binding output to the name of the output. + * + * @param definition the WSDL4J {@code Definition} + * @param bindingOutput the WSDL4J {@code BindingOutput} + * @param output the corresponding WSDL4J {@code Output} @throws WSDLException in case of errors */ protected void populateBindingOutput(Definition definition, BindingOutput bindingOutput, Output output) throws WSDLException { @@ -230,11 +230,11 @@ public class DefaultConcretePartProvider implements BindingsProvider, ServicesPr /** * Called after the {@link BindingFault} has been created. Subclasses can implement this method to define the name, * or add extensions to it. - *

                - * Default implementation set the name of the binding fault to the name of the fault. * - * @param bindingFault the WSDL4J BindingFault - * @param fault the corresponding WSDL4J Fault @throws WSDLException in case of errors + *

                Default implementation set the name of the binding fault to the name of the fault. + * + * @param bindingFault the WSDL4J {@code BindingFault} + * @param fault the corresponding WSDL4J {@code Fault} @throws WSDLException in case of errors */ protected void populateBindingFault(Definition definition, BindingFault bindingFault, Fault fault) throws WSDLException { @@ -246,7 +246,7 @@ public class DefaultConcretePartProvider implements BindingsProvider, ServicesPr * Creates a corresponding {@link Port} for each {@link Binding}, which is passed to {@link * #populatePort(javax.wsdl.Definition,javax.wsdl.Port)}. * - * @param definition the WSDL4J Definition + * @param definition the WSDL4J {@code Definition} * @throws WSDLException in case of errors */ @Override @@ -269,10 +269,10 @@ public class DefaultConcretePartProvider implements BindingsProvider, ServicesPr /** * Called after the {@link Service} has been created, but before any sub-elements are added. Subclasses can * implement this method to define the service name, or add extensions to it. - *

                - * Default implementation sets the name to the {@link #setServiceName(String) serviceName} property. * - * @param service the WSDL4J Service + *

                Default implementation sets the name to the {@link #setServiceName(String) serviceName} property. + * + * @param service the WSDL4J {@code Service} * @throws WSDLException in case of errors */ protected void populateService(Definition definition, Service service) throws WSDLException { @@ -315,11 +315,11 @@ public class DefaultConcretePartProvider implements BindingsProvider, ServicesPr /** * Called after the {@link Port} has been created, but before any sub-elements are added. Subclasses can implement * this method to define the port name, or add extensions to it. - *

                - * Default implementation sets the port name to the binding name. * - * @param definition the WSDL4J Definition - * @param port the WSDL4J Port + *

                Default implementation sets the port name to the binding name. + * + * @param definition the WSDL4J {@code Definition} + * @param port the WSDL4J {@code Port} * @throws WSDLException in case of errors */ protected void populatePort(Definition definition, Port port) throws WSDLException { diff --git a/spring-ws-core/src/main/java/org/springframework/ws/wsdl/wsdl11/provider/DefaultMessagesProvider.java b/spring-ws-core/src/main/java/org/springframework/ws/wsdl/wsdl11/provider/DefaultMessagesProvider.java index 77f0a91a..f3efadb9 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/wsdl/wsdl11/provider/DefaultMessagesProvider.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/wsdl/wsdl11/provider/DefaultMessagesProvider.java @@ -36,8 +36,8 @@ import org.springframework.util.Assert; /** * Default implementation of the {@link MessagesProvider}. - *

                - * Simply adds all elements contained in the schema(s) as messages. + * + *

                Simply adds all elements contained in the schema(s) as messages. * * @author Arjen Poutsma * @since 1.5.0 @@ -101,12 +101,12 @@ public class DefaultMessagesProvider implements MessagesProvider { /** * Indicates whether the given element should be includes as {@link Message} in the definition. - *

                - * Default implementation checks whether the element has the XML Schema namespace, and if it has the local name + * + *

                Default implementation checks whether the element has the XML Schema namespace, and if it has the local name * "element". * * @param element the element elligable for being a message - * @return true if to be included as message; false otherwise + * @return {@code true} if to be included as message; {@code false} otherwise */ protected boolean isMessageElement(Element element) { return "element".equals(element.getLocalName()) && @@ -115,11 +115,11 @@ public class DefaultMessagesProvider implements MessagesProvider { /** * Called after the {@link Message} has been created. - *

                - * Default implementation sets the name of the message to the element name. * - * @param definition the WSDL4J Definition - * @param message the WSDL4J Message + *

                Default implementation sets the name of the message to the element name. + * + * @param definition the WSDL4J {@code Definition} + * @param message the WSDL4J {@code Message} * @param elementName the element name * @throws WSDLException in case of errors */ @@ -133,11 +133,11 @@ public class DefaultMessagesProvider implements MessagesProvider { /** * Called after the {@link Part} has been created. - *

                - * Default implementation sets the element name of the part. * - * @param definition the WSDL4J Definition - * @param part the WSDL4J Part + *

                Default implementation sets the element name of the part. + * + * @param definition the WSDL4J {@code Definition} + * @param part the WSDL4J {@code Part} * @param elementName the elementName @throws WSDLException in case of errors * @see Part#setElementName(javax.xml.namespace.QName) */ diff --git a/spring-ws-core/src/main/java/org/springframework/ws/wsdl/wsdl11/provider/ImportsProvider.java b/spring-ws-core/src/main/java/org/springframework/ws/wsdl/wsdl11/provider/ImportsProvider.java index 9680efda..6f127d46 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/wsdl/wsdl11/provider/ImportsProvider.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/wsdl/wsdl11/provider/ImportsProvider.java @@ -21,8 +21,8 @@ import javax.wsdl.WSDLException; /** * Strategy for adding {@link javax.wsdl.Import}s to a {@link javax.wsdl.Definition}. - *

                - * Used by {@link org.springframework.ws.wsdl.wsdl11.ProviderBasedWsdl4jDefinition}. + * + *

                Used by {@link org.springframework.ws.wsdl.wsdl11.ProviderBasedWsdl4jDefinition}. * * @author Arjen Poutsma * @since 1.5.0 diff --git a/spring-ws-core/src/main/java/org/springframework/ws/wsdl/wsdl11/provider/MessagesProvider.java b/spring-ws-core/src/main/java/org/springframework/ws/wsdl/wsdl11/provider/MessagesProvider.java index 9ede46a0..c195dbd6 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/wsdl/wsdl11/provider/MessagesProvider.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/wsdl/wsdl11/provider/MessagesProvider.java @@ -21,8 +21,8 @@ import javax.wsdl.WSDLException; /** * Strategy for adding {@link javax.wsdl.Message}s to a {@link javax.wsdl.Definition}. - *

                - * Used by {@link org.springframework.ws.wsdl.wsdl11.ProviderBasedWsdl4jDefinition}. + * + *

                Used by {@link org.springframework.ws.wsdl.wsdl11.ProviderBasedWsdl4jDefinition}. * * @author Arjen Poutsma * @since 1.5.0 diff --git a/spring-ws-core/src/main/java/org/springframework/ws/wsdl/wsdl11/provider/PortTypesProvider.java b/spring-ws-core/src/main/java/org/springframework/ws/wsdl/wsdl11/provider/PortTypesProvider.java index 1ec99c71..40b5c90f 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/wsdl/wsdl11/provider/PortTypesProvider.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/wsdl/wsdl11/provider/PortTypesProvider.java @@ -21,8 +21,8 @@ import javax.wsdl.WSDLException; /** * Strategy for adding {@link javax.wsdl.PortType}s to a {@link javax.wsdl.Definition}. - *

                - * Used by {@link org.springframework.ws.wsdl.wsdl11.ProviderBasedWsdl4jDefinition}. + * + *

                Used by {@link org.springframework.ws.wsdl.wsdl11.ProviderBasedWsdl4jDefinition}. * * @author Arjen Poutsma * @since 1.5.0 diff --git a/spring-ws-core/src/main/java/org/springframework/ws/wsdl/wsdl11/provider/ServicesProvider.java b/spring-ws-core/src/main/java/org/springframework/ws/wsdl/wsdl11/provider/ServicesProvider.java index 552caa40..69453154 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/wsdl/wsdl11/provider/ServicesProvider.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/wsdl/wsdl11/provider/ServicesProvider.java @@ -21,8 +21,8 @@ import javax.wsdl.WSDLException; /** * Strategy for adding {@link javax.wsdl.Service}s to a {@link javax.wsdl.Definition}. - *

                - * Used by {@link org.springframework.ws.wsdl.wsdl11.ProviderBasedWsdl4jDefinition}. + * + *

                Used by {@link org.springframework.ws.wsdl.wsdl11.ProviderBasedWsdl4jDefinition}. * * @author Arjen Poutsma * @since 1.5.0 diff --git a/spring-ws-core/src/main/java/org/springframework/ws/wsdl/wsdl11/provider/Soap11Provider.java b/spring-ws-core/src/main/java/org/springframework/ws/wsdl/wsdl11/provider/Soap11Provider.java index 5b31db1c..166db53d 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/wsdl/wsdl11/provider/Soap11Provider.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/wsdl/wsdl11/provider/Soap11Provider.java @@ -42,8 +42,8 @@ import org.springframework.util.Assert; /** * Implementation of the {@link BindingsProvider} and {@link ServicesProvider} interfaces that are SOAP 1.1 specific. - *

                - * By setting the {@link #setSoapActions(java.util.Properties) soapActions} property, the SOAP Actions defined in the + * + *

                By setting the {@link #setSoapActions(java.util.Properties) soapActions} property, the SOAP Actions defined in the * resulting WSDL can be set. Additionaly, the transport uri can be changed from the default HTTP transport by using the * {@link #setTransportUri(String) transportUri} property. * @@ -69,8 +69,8 @@ public class Soap11Provider extends DefaultConcretePartProvider { /** * Constructs a new version of the {@link Soap11Provider}. - *

                - * Sets the {@link #setBindingSuffix(String) binding suffix} to Soap11. + * + *

                Sets the {@link #setBindingSuffix(String) binding suffix} to {@code Soap11}. */ public Soap11Provider() { setBindingSuffix("Soap11"); @@ -129,13 +129,13 @@ public class Soap11Provider extends DefaultConcretePartProvider { /** * Called after the {@link Binding} has been created, but before any sub-elements are added. Subclasses can override * this method to define the binding name, or add extensions to it. - *

                - * Default implementation calls {@link DefaultConcretePartProvider#populateBinding(Definition, Binding)}, adds the + * + *

                Default implementation calls {@link DefaultConcretePartProvider#populateBinding(Definition, Binding)}, adds the * SOAP 1.1 namespace, creates a {@link SOAPBinding}, and calls {@link #populateSoapBinding(SOAPBinding, Binding)} * sets the binding name to the port type name with the {@link #getBindingSuffix() suffix} appended to it. * - * @param definition the WSDL4J Definition - * @param binding the WSDL4J Binding + * @param definition the WSDL4J {@code Definition} + * @param binding the WSDL4J {@code Binding} */ @Override protected void populateBinding(Definition definition, Binding binding) throws WSDLException { @@ -148,11 +148,11 @@ public class Soap11Provider extends DefaultConcretePartProvider { /** * Called after the {@link SOAPBinding} has been created. - *

                - * Default implementation sets the binding style to "document", and set the transport URI to the {@link + * + *

                Default implementation sets the binding style to {@code "document"}, and set the transport URI to the {@link * #setTransportUri(String) transportUri} property value. Subclasses can override this behavior. * - * @param soapBinding the WSDL4J SOAPBinding + * @param soapBinding the WSDL4J {@code SOAPBinding} * @throws WSDLException in case of errors * @see SOAPBinding#setStyle(String) * @see SOAPBinding#setTransportURI(String) @@ -167,13 +167,13 @@ public class Soap11Provider extends DefaultConcretePartProvider { /** * Called after the {@link BindingFault} has been created. Subclasses can override this method to define the name, * or add extensions to it. - *

                - * Default implementation calls {@link DefaultConcretePartProvider#populateBindingFault(Definition, BindingFault, + * + *

                Default implementation calls {@link DefaultConcretePartProvider#populateBindingFault(Definition, BindingFault, * Fault)}, creates a {@link SOAPFault}, and calls {@link #populateSoapFault(BindingFault, SOAPFault)}. * - * @param definition the WSDL4J Definition - * @param bindingFault the WSDL4J BindingFault - * @param fault the corresponding WSDL4J Fault @throws WSDLException in case of errors + * @param definition the WSDL4J {@code Definition} + * @param bindingFault the WSDL4J {@code BindingFault} + * @param fault the corresponding WSDL4J {@code Fault} @throws WSDLException in case of errors */ @Override protected void populateBindingFault(Definition definition, BindingFault bindingFault, Fault fault) @@ -186,12 +186,12 @@ public class Soap11Provider extends DefaultConcretePartProvider { /** * Called after the {@link SOAPFault} has been created. - *

                - * Default implementation sets the use style to "literal", and sets the name equal to the binding + * + *

                Default implementation sets the use style to {@code "literal"}, and sets the name equal to the binding * fault. Subclasses can override this behavior. * - * @param bindingFault the WSDL4J BindingFault - * @param soapFault the WSDL4J SOAPFault + * @param bindingFault the WSDL4J {@code BindingFault} + * @param soapFault the WSDL4J {@code SOAPFault} * @throws WSDLException in case of errors * @see SOAPFault#setUse(String) */ @@ -203,14 +203,14 @@ public class Soap11Provider extends DefaultConcretePartProvider { /** * Called after the {@link BindingInput} has been created. Subclasses can implement this method to define the name, * or add extensions to it. - *

                - * Default implementation calls {@link DefaultConcretePartProvider#populateBindingInput(Definition, + * + *

                Default implementation calls {@link DefaultConcretePartProvider#populateBindingInput(Definition, * javax.wsdl.BindingInput, javax.wsdl.Input)}, creates a {@link SOAPBody}, and calls {@link * #populateSoapBody(SOAPBody)}. * - * @param definition the WSDL4J Definition - * @param bindingInput the WSDL4J BindingInput - * @param input the corresponding WSDL4J Input @throws WSDLException in case of errors + * @param definition the WSDL4J {@code Definition} + * @param bindingInput the WSDL4J {@code BindingInput} + * @param input the corresponding WSDL4J {@code Input} @throws WSDLException in case of errors */ @Override protected void populateBindingInput(Definition definition, BindingInput bindingInput, Input input) @@ -223,10 +223,10 @@ public class Soap11Provider extends DefaultConcretePartProvider { /** * Called after the {@link SOAPBody} has been created. - *

                - * Default implementation sets the use style to "literal". Subclasses can override this behavior. * - * @param soapBody the WSDL4J SOAPBody + *

                Default implementation sets the use style to {@code "literal"}. Subclasses can override this behavior. + * + * @param soapBody the WSDL4J {@code SOAPBody} * @throws WSDLException in case of errors * @see SOAPBody#setUse(String) */ @@ -237,13 +237,13 @@ public class Soap11Provider extends DefaultConcretePartProvider { /** * Called after the {@link BindingOperation} has been created, but before any sub-elements are added. Subclasses can * implement this method to define the binding name, or add extensions to it. - *

                - * Default implementation calls {@link DefaultConcretePartProvider#populateBindingOperation(Definition, + * + *

                Default implementation calls {@link DefaultConcretePartProvider#populateBindingOperation(Definition, * BindingOperation)}, creates a {@link SOAPOperation}, and calls {@link #populateSoapOperation} sets the name of * the binding operation to the name of the operation. * - * @param definition the WSDL4J Definition - * @param bindingOperation the WSDL4J BindingOperation + * @param definition the WSDL4J {@code Definition} + * @param bindingOperation the WSDL4J {@code BindingOperation} * @throws WSDLException in case of errors */ @Override @@ -258,12 +258,12 @@ public class Soap11Provider extends DefaultConcretePartProvider { /** * Called after the {@link SOAPOperation} has been created. - *

                - * Default implementation sets SOAPAction to the corresponding {@link + * + *

                Default implementation sets {@code SOAPAction} to the corresponding {@link * #setSoapActions(java.util.Properties) soapActions} property, and defaults to "". * - * @param soapOperation the WSDL4J SOAPOperation - * @param bindingOperation the WSDL4J BindingOperation + * @param soapOperation the WSDL4J {@code SOAPOperation} + * @param bindingOperation the WSDL4J {@code BindingOperation} * @throws WSDLException in case of errors * @see SOAPOperation#setSoapActionURI(String) * @see #setSoapActions(java.util.Properties) @@ -278,13 +278,13 @@ public class Soap11Provider extends DefaultConcretePartProvider { /** * Called after the {@link BindingInput} has been created. Subclasses can implement this method to define the name, * or add extensions to it. - *

                - * Default implementation calls {@link DefaultConcretePartProvider#populateBindingOutput(Definition, BindingOutput, + * + *

                Default implementation calls {@link DefaultConcretePartProvider#populateBindingOutput(Definition, BindingOutput, * Output)}, creates a {@link SOAPBody}, and calls {@link #populateSoapBody(SOAPBody)}. * - * @param definition the WSDL4J Definition - * @param bindingOutput the WSDL4J BindingOutput - * @param output the corresponding WSDL4J Output @throws WSDLException in case of errors + * @param definition the WSDL4J {@code Definition} + * @param bindingOutput the WSDL4J {@code BindingOutput} + * @param output the corresponding WSDL4J {@code Output} @throws WSDLException in case of errors */ @Override protected void populateBindingOutput(Definition definition, BindingOutput bindingOutput, Output output) @@ -298,11 +298,11 @@ public class Soap11Provider extends DefaultConcretePartProvider { /** * Called after the {@link Port} has been created, but before any sub-elements are added. Subclasses can implement * this method to define the port name, or add extensions to it. - *

                - * Default implementation calls {@link DefaultConcretePartProvider#populatePort(javax.wsdl.Definition,javax.wsdl.Port)}, + * + *

                Default implementation calls {@link DefaultConcretePartProvider#populatePort(javax.wsdl.Definition,javax.wsdl.Port)}, * creates a {@link SOAPAddress}, and calls {@link #populateSoapAddress(SOAPAddress)}. * - * @param port the WSDL4J Port + * @param port the WSDL4J {@code Port} * @throws WSDLException in case of errors */ @Override @@ -323,7 +323,7 @@ public class Soap11Provider extends DefaultConcretePartProvider { * Called after the {@link SOAPAddress} has been created. Default implementation sets the location URI to the value * set on this builder. Subclasses can override this behavior. * - * @param soapAddress the WSDL4J SOAPAddress + * @param soapAddress the WSDL4J {@code SOAPAddress} * @throws WSDLException in case of errors * @see SOAPAddress#setLocationURI(String) * @see #setLocationUri(String) @@ -335,7 +335,7 @@ public class Soap11Provider extends DefaultConcretePartProvider { /** * Creates a SOAP extensibility element. * - * @param definition the WSDL4J Definition + * @param definition the WSDL4J {@code Definition} * @param parentType a class object indicating where in the WSDL definition this extension will exist * @param localName the local name of the extensibility element * @return the extensibility element diff --git a/spring-ws-core/src/main/java/org/springframework/ws/wsdl/wsdl11/provider/Soap12Provider.java b/spring-ws-core/src/main/java/org/springframework/ws/wsdl/wsdl11/provider/Soap12Provider.java index 2d5a75c7..60bfc2e6 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/wsdl/wsdl11/provider/Soap12Provider.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/wsdl/wsdl11/provider/Soap12Provider.java @@ -41,8 +41,8 @@ import org.springframework.util.Assert; /** * Implementation of the {@link BindingsProvider} and {@link ServicesProvider} interfaces that are SOAP 1.2 specific. - *

                - * By setting the {@link #setSoapActions(java.util.Properties) soapActions} property, the SOAP Actions defined in the + * + *

                By setting the {@link #setSoapActions(java.util.Properties) soapActions} property, the SOAP Actions defined in the * resulting WSDL can be set. Additionaly, the transport uri can be changed from the default HTTP transport by using the * {@link #setTransportUri(String) transportUri} property. * @@ -68,8 +68,8 @@ public class Soap12Provider extends DefaultConcretePartProvider { /** * Constructs a new version of the {@link Soap12Provider}. - *

                - * Sets the {@link #setBindingSuffix(String) binding suffix} to Soap12. + * + *

                Sets the {@link #setBindingSuffix(String) binding suffix} to {@code Soap12}. */ public Soap12Provider() { setBindingSuffix("Soap12"); @@ -129,14 +129,14 @@ public class Soap12Provider extends DefaultConcretePartProvider { /** * Called after the {@link javax.wsdl.Binding} has been created, but before any sub-elements are added. Subclasses * can override this method to define the binding name, or add extensions to it. - *

                - * Default implementation calls {@link DefaultConcretePartProvider#populateBinding(javax.wsdl.Definition, + * + *

                Default implementation calls {@link DefaultConcretePartProvider#populateBinding(javax.wsdl.Definition, * javax.wsdl.Binding)}, adds the SOAP 1.1 namespace, creates a {@link javax.wsdl.extensions.soap.SOAPBinding}, and * calls {@link #populateSoapBinding(javax.wsdl.extensions.soap12.SOAP12Binding, javax.wsdl.Binding)} sets the * binding name to the port type name with the {@link #getBindingSuffix() suffix} appended to it. * - * @param definition the WSDL4J Definition - * @param binding the WSDL4J Binding + * @param definition the WSDL4J {@code Definition} + * @param binding the WSDL4J {@code Binding} */ @Override protected void populateBinding(Definition definition, Binding binding) throws WSDLException { @@ -149,11 +149,11 @@ public class Soap12Provider extends DefaultConcretePartProvider { /** * Called after the {@link javax.wsdl.extensions.soap.SOAPBinding} has been created. - *

                - * Default implementation sets the binding style to "document", and set the transport URI to the {@link + * + *

                Default implementation sets the binding style to {@code "document"}, and set the transport URI to the {@link * #setTransportUri(String) transportUri} property value. Subclasses can override this behavior. * - * @param soapBinding the WSDL4J SOAPBinding + * @param soapBinding the WSDL4J {@code SOAPBinding} * @throws javax.wsdl.WSDLException in case of errors * @see javax.wsdl.extensions.soap.SOAPBinding#setStyle(String) * @see javax.wsdl.extensions.soap.SOAPBinding#setTransportURI(String) @@ -168,14 +168,14 @@ public class Soap12Provider extends DefaultConcretePartProvider { /** * Called after the {@link javax.wsdl.BindingFault} has been created. Subclasses can override this method to define * the name, or add extensions to it. - *

                - * Default implementation calls {@link DefaultConcretePartProvider#populateBindingFault(javax.wsdl.Definition, + * + *

                Default implementation calls {@link DefaultConcretePartProvider#populateBindingFault(javax.wsdl.Definition, * javax.wsdl.BindingFault, javax.wsdl.Fault)}, creates a {@link javax.wsdl.extensions.soap.SOAPFault}, and calls * {@link #populateSoapFault(javax.wsdl.BindingFault, javax.wsdl.extensions.soap12.SOAP12Fault)}. * - * @param definition the WSDL4J Definition - * @param bindingFault the WSDL4J BindingFault - * @param fault the corresponding WSDL4J Fault @throws WSDLException in case of errors + * @param definition the WSDL4J {@code Definition} + * @param bindingFault the WSDL4J {@code BindingFault} + * @param fault the corresponding WSDL4J {@code Fault} @throws WSDLException in case of errors */ @Override protected void populateBindingFault(Definition definition, BindingFault bindingFault, Fault fault) @@ -188,12 +188,12 @@ public class Soap12Provider extends DefaultConcretePartProvider { /** * Called after the {@link javax.wsdl.extensions.soap.SOAPFault} has been created. - *

                - * Default implementation sets the use style to "literal", and sets the name equal to the binding + * + *

                Default implementation sets the use style to {@code "literal"}, and sets the name equal to the binding * fault. Subclasses can override this behavior. * - * @param bindingFault the WSDL4J BindingFault - * @param soapFault the WSDL4J SOAPFault + * @param bindingFault the WSDL4J {@code BindingFault} + * @param soapFault the WSDL4J {@code SOAPFault} * @throws javax.wsdl.WSDLException in case of errors * @see javax.wsdl.extensions.soap.SOAPFault#setUse(String) */ @@ -205,14 +205,14 @@ public class Soap12Provider extends DefaultConcretePartProvider { /** * Called after the {@link javax.wsdl.BindingInput} has been created. Subclasses can implement this method to define * the name, or add extensions to it. - *

                - * Default implementation calls {@link DefaultConcretePartProvider#populateBindingInput(javax.wsdl.Definition, + * + *

                Default implementation calls {@link DefaultConcretePartProvider#populateBindingInput(javax.wsdl.Definition, * javax.wsdl.BindingInput, javax.wsdl.Input)}, creates a {@link javax.wsdl.extensions.soap.SOAPBody}, and calls * {@link #populateSoapBody(javax.wsdl.extensions.soap12.SOAP12Body)}. 2 * - * @param definition the WSDL4J Definition - * @param bindingInput the WSDL4J BindingInput - * @param input the corresponding WSDL4J Input @throws WSDLException in case of errors + * @param definition the WSDL4J {@code Definition} + * @param bindingInput the WSDL4J {@code BindingInput} + * @param input the corresponding WSDL4J {@code Input} @throws WSDLException in case of errors */ @Override protected void populateBindingInput(Definition definition, BindingInput bindingInput, Input input) @@ -225,10 +225,10 @@ public class Soap12Provider extends DefaultConcretePartProvider { /** * Called after the {@link javax.wsdl.extensions.soap.SOAPBody} has been created. - *

                - * Default implementation sets the use style to "literal". Subclasses can override this behavior. * - * @param soapBody the WSDL4J SOAPBody + *

                Default implementation sets the use style to {@code "literal"}. Subclasses can override this behavior. + * + * @param soapBody the WSDL4J {@code SOAPBody} * @throws javax.wsdl.WSDLException in case of errors * @see javax.wsdl.extensions.soap.SOAPBody#setUse(String) */ @@ -239,13 +239,13 @@ public class Soap12Provider extends DefaultConcretePartProvider { /** * Called after the {@link javax.wsdl.BindingOperation} has been created, but before any sub-elements are added. * Subclasses can implement this method to define the binding name, or add extensions to it. - *

                - * Default implementation calls {@link DefaultConcretePartProvider#populateBindingOperation(javax.wsdl.Definition, + * + *

                Default implementation calls {@link DefaultConcretePartProvider#populateBindingOperation(javax.wsdl.Definition, * javax.wsdl.BindingOperation)}, creates a {@link javax.wsdl.extensions.soap.SOAPOperation}, and calls {@link * #populateSoapOperation} sets the name of the binding operation to the name of the operation. * - * @param definition the WSDL4J Definition - * @param bindingOperation the WSDL4J BindingOperation + * @param definition the WSDL4J {@code Definition} + * @param bindingOperation the WSDL4J {@code BindingOperation} * @throws javax.wsdl.WSDLException in case of errors */ @Override @@ -260,12 +260,12 @@ public class Soap12Provider extends DefaultConcretePartProvider { /** * Called after the {@link javax.wsdl.extensions.soap.SOAPOperation} has been created. - *

                - * Default implementation sets SOAPAction to the corresponding {@link + * + *

                Default implementation sets {@code SOAPAction} to the corresponding {@link * #setSoapActions(java.util.Properties) soapActions} property, and defaults to "". * - * @param soapOperation the WSDL4J SOAPOperation - * @param bindingOperation the WSDL4J BindingOperation + * @param soapOperation the WSDL4J {@code SOAPOperation} + * @param bindingOperation the WSDL4J {@code BindingOperation} * @throws javax.wsdl.WSDLException in case of errors * @see javax.wsdl.extensions.soap.SOAPOperation#setSoapActionURI(String) * @see #setSoapActions(java.util.Properties) @@ -280,14 +280,14 @@ public class Soap12Provider extends DefaultConcretePartProvider { /** * Called after the {@link javax.wsdl.BindingInput} has been created. Subclasses can implement this method to define * the name, or add extensions to it. - *

                - * Default implementation calls {@link DefaultConcretePartProvider#populateBindingOutput(javax.wsdl.Definition, + * + *

                Default implementation calls {@link DefaultConcretePartProvider#populateBindingOutput(javax.wsdl.Definition, * javax.wsdl.BindingOutput, javax.wsdl.Output)}, creates a {@link javax.wsdl.extensions.soap.SOAPBody}, and calls * {@link #populateSoapBody(javax.wsdl.extensions.soap12.SOAP12Body)}. * - * @param definition the WSDL4J Definition - * @param bindingOutput the WSDL4J BindingOutput - * @param output the corresponding WSDL4J Output @throws WSDLException in case of errors + * @param definition the WSDL4J {@code Definition} + * @param bindingOutput the WSDL4J {@code BindingOutput} + * @param output the corresponding WSDL4J {@code Output} @throws WSDLException in case of errors */ @Override protected void populateBindingOutput(Definition definition, BindingOutput bindingOutput, Output output) @@ -301,11 +301,11 @@ public class Soap12Provider extends DefaultConcretePartProvider { /** * Called after the {@link javax.wsdl.Port} has been created, but before any sub-elements are added. Subclasses can * implement this method to define the port name, or add extensions to it. - *

                - * Default implementation calls {@link DefaultConcretePartProvider#populatePort(javax.wsdl.Definition,javax.wsdl.Port)}, + * + *

                Default implementation calls {@link DefaultConcretePartProvider#populatePort(javax.wsdl.Definition,javax.wsdl.Port)}, * creates a {@link javax.wsdl.extensions.soap.SOAPAddress}, and calls {@link #populateSoapAddress(SOAP12Address)}. * - * @param port the WSDL4J Port + * @param port the WSDL4J {@code Port} * @throws WSDLException in case of errors */ @Override @@ -326,7 +326,7 @@ public class Soap12Provider extends DefaultConcretePartProvider { * Called after the {@link SOAP12Address} has been created. Default implementation sets the location URI to the * value set on this builder. Subclasses can override this behavior. * - * @param soapAddress the WSDL4J SOAPAddress + * @param soapAddress the WSDL4J {@code SOAPAddress} * @throws WSDLException in case of errors * @see SOAP12Address#setLocationURI(String) * @see #setLocationUri(String) @@ -338,7 +338,7 @@ public class Soap12Provider extends DefaultConcretePartProvider { /** * Creates a SOAP extensibility element. * - * @param definition the WSDL4J Definition + * @param definition the WSDL4J {@code Definition} * @param parentType a class object indicating where in the WSDL definition this extension will exist * @param localName the local name of the extensibility element * @return the extensibility element diff --git a/spring-ws-core/src/main/java/org/springframework/ws/wsdl/wsdl11/provider/SoapProvider.java b/spring-ws-core/src/main/java/org/springframework/ws/wsdl/wsdl11/provider/SoapProvider.java index c49cb80c..f7b8955b 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/wsdl/wsdl11/provider/SoapProvider.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/wsdl/wsdl11/provider/SoapProvider.java @@ -23,14 +23,14 @@ import javax.wsdl.WSDLException; /** * Implementation of the {@link BindingsProvider} and {@link ServicesProvider} interfaces that supports SOAP 1.1 and * SOAP 1.2. Delegates to {@link Soap11Provider} and {@link Soap12Provider}. - *

                - * By setting the {@link #setSoapActions(java.util.Properties) soapActions} property, the SOAP Actions defined in the + * + *

                By setting the {@link #setSoapActions(java.util.Properties) soapActions} property, the SOAP Actions defined in the * resulting WSDL can be set. Additionally, the transport uri can be changed from the default HTTP transport by using the * {@link #setTransportUri(String) transportUri} property. - *

                - * The {@link #setCreateSoap11Binding(boolean) createSoap11} and {@link #setCreateSoap12Binding(boolean) createSoap12} + * + *

                The {@link #setCreateSoap11Binding(boolean) createSoap11} and {@link #setCreateSoap12Binding(boolean) createSoap12} * properties indicate whether a SOAP 1.1 or SOAP 1.2 binding should be created. These properties default to - * true and false respectively. + * {@code true} and {@code false} respectively. * * @author Arjen Poutsma * @since 1.5.0 @@ -47,8 +47,8 @@ public class SoapProvider implements BindingsProvider, ServicesProvider { /** * Indicates whether a SOAP 1.1 binding should be created. - *

                - * Defaults to true. + * + *

                Defaults to {@code true}. */ public void setCreateSoap11Binding(boolean createSoap11Binding) { this.createSoap11Binding = createSoap11Binding; @@ -56,8 +56,8 @@ public class SoapProvider implements BindingsProvider, ServicesProvider { /** * Indicates whether a SOAP 1.2 binding should be created. - *

                - * Defaults to false. + * + *

                Defaults to {@code false}. */ public void setCreateSoap12Binding(boolean createSoap12Binding) { this.createSoap12Binding = createSoap12Binding; diff --git a/spring-ws-core/src/main/java/org/springframework/ws/wsdl/wsdl11/provider/SuffixBasedPortTypesProvider.java b/spring-ws-core/src/main/java/org/springframework/ws/wsdl/wsdl11/provider/SuffixBasedPortTypesProvider.java index 75fd763c..aad6c0dd 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/wsdl/wsdl11/provider/SuffixBasedPortTypesProvider.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/wsdl/wsdl11/provider/SuffixBasedPortTypesProvider.java @@ -119,12 +119,12 @@ public class SuffixBasedPortTypesProvider extends AbstractPortTypesProvider { /** * Indicates whether the given name name should be included as {@link javax.wsdl.Input} message in the definition. - *

                - * This implementation checks whether the message name ends with the {@link #setRequestSuffix(String) + * + *

                This implementation checks whether the message name ends with the {@link #setRequestSuffix(String) * requestSuffix}. * * @param message the message - * @return true if to be included as input; false otherwise + * @return {@code true} if to be included as input; {@code false} otherwise */ @Override protected boolean isInputMessage(Message message) { @@ -134,12 +134,12 @@ public class SuffixBasedPortTypesProvider extends AbstractPortTypesProvider { /** * Indicates whether the given name name should be included as {@link javax.wsdl.Output} message in the definition. - *

                - * This implementation checks whether the message name ends with the {@link #setResponseSuffix(String) + * + *

                This implementation checks whether the message name ends with the {@link #setResponseSuffix(String) * responseSuffix}. * * @param message the message - * @return true if to be included as output; false otherwise + * @return {@code true} if to be included as output; {@code false} otherwise */ @Override protected boolean isOutputMessage(Message message) { @@ -149,11 +149,11 @@ public class SuffixBasedPortTypesProvider extends AbstractPortTypesProvider { /** * Indicates whether the given name name should be included as {@link javax.wsdl.Fault} message in the definition. - *

                - * This implementation checks whether the message name ends with the {@link #setFaultSuffix(String) faultSuffix}. + * + *

                This implementation checks whether the message name ends with the {@link #setFaultSuffix(String) faultSuffix}. * * @param message the message - * @return true if to be included as fault; false otherwise + * @return {@code true} if to be included as fault; {@code false} otherwise */ @Override protected boolean isFaultMessage(Message message) { diff --git a/spring-ws-core/src/main/java/org/springframework/ws/wsdl/wsdl11/provider/TypesProvider.java b/spring-ws-core/src/main/java/org/springframework/ws/wsdl/wsdl11/provider/TypesProvider.java index 67d3c6b5..1095e005 100644 --- a/spring-ws-core/src/main/java/org/springframework/ws/wsdl/wsdl11/provider/TypesProvider.java +++ b/spring-ws-core/src/main/java/org/springframework/ws/wsdl/wsdl11/provider/TypesProvider.java @@ -21,8 +21,8 @@ import javax.wsdl.WSDLException; /** * Strategy for adding {@link javax.wsdl.Types} to a {@link javax.wsdl.Definition}. - *

                - * Used by {@link org.springframework.ws.wsdl.wsdl11.ProviderBasedWsdl4jDefinition}. + * + *

                Used by {@link org.springframework.ws.wsdl.wsdl11.ProviderBasedWsdl4jDefinition}. * * @author Arjen Poutsma * @since 1.5.0 diff --git a/spring-ws-core/src/test/java/org/springframework/ws/MockWebServiceMessage.java b/spring-ws-core/src/test/java/org/springframework/ws/MockWebServiceMessage.java index 99f42810..db0de58c 100644 --- a/spring-ws-core/src/test/java/org/springframework/ws/MockWebServiceMessage.java +++ b/spring-ws-core/src/test/java/org/springframework/ws/MockWebServiceMessage.java @@ -38,7 +38,7 @@ import org.springframework.xml.sax.SaxUtils; import org.springframework.xml.transform.StringSource; /** - * Mock implementation of the WebServiceMessage interface. + * Mock implementation of the {@code WebServiceMessage} interface. * * @author Arjen Poutsma * @since 1.0.0 diff --git a/spring-ws-security/src/main/java/org/springframework/ws/soap/security/AbstractWsSecurityInterceptor.java b/spring-ws-security/src/main/java/org/springframework/ws/soap/security/AbstractWsSecurityInterceptor.java index 66fe8966..07940bed 100644 --- a/spring-ws-security/src/main/java/org/springframework/ws/soap/security/AbstractWsSecurityInterceptor.java +++ b/spring-ws-security/src/main/java/org/springframework/ws/soap/security/AbstractWsSecurityInterceptor.java @@ -41,8 +41,8 @@ import org.springframework.ws.soap.soap11.Soap11Body; * {@link org.springframework.ws.server.endpoint.mapping.AbstractEndpointMapping#setInterceptors(org.springframework.ws.server.EndpointInterceptor[]) * endpoint mapping}; or on the client side, on the {@link org.springframework.ws.client.core.WebServiceTemplate#setInterceptors(ClientInterceptor[]) * web service template}. - *

                - * Subclasses of this base class can be configured to secure incoming and secure outgoing messages. By default, both are + * + *

                Subclasses of this base class can be configured to secure incoming and secure outgoing messages. By default, both are * on. * * @author Arjen Poutsma @@ -68,22 +68,22 @@ public abstract class AbstractWsSecurityInterceptor implements SoapEndpointInter private EndpointExceptionResolver exceptionResolver; - /** Indicates whether server-side incoming request are to be validated. Defaults to true. */ + /** Indicates whether server-side incoming request are to be validated. Defaults to {@code true}. */ public void setValidateRequest(boolean validateRequest) { this.validateRequest = validateRequest; } - /** Indicates whether server-side outgoing responses are to be secured. Defaults to true. */ + /** Indicates whether server-side outgoing responses are to be secured. Defaults to {@code true}. */ public void setSecureResponse(boolean secureResponse) { this.secureResponse = secureResponse; } - /** Indicates whether client-side outgoing requests are to be secured. Defaults to true. */ + /** Indicates whether client-side outgoing requests are to be secured. Defaults to {@code true}. */ public void setSecureRequest(boolean secureRequest) { this.secureRequest = secureRequest; } - /** Indicates whether client-side incoming responses are to be validated. Defaults to true. */ + /** Indicates whether client-side incoming responses are to be validated. Defaults to {@code true}. */ public void setValidateResponse(boolean validateResponse) { this.validateResponse = validateResponse; } @@ -105,11 +105,11 @@ public abstract class AbstractWsSecurityInterceptor implements SoapEndpointInter /** * Validates a server-side incoming request. Delegates to {@link #validateMessage(org.springframework.ws.soap.SoapMessage,org.springframework.ws.context.MessageContext)} - * if the {@link #setValidateRequest(boolean) validateRequest} property is true. + * if the {@link #setValidateRequest(boolean) validateRequest} property is {@code true}. * * @param messageContext the message context, containing the request to be validated * @param endpoint chosen endpoint to invoke - * @return true if the request was valid; false otherwise. + * @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) */ @@ -138,11 +138,11 @@ public abstract class AbstractWsSecurityInterceptor implements SoapEndpointInter /** * Secures a server-side outgoing response. Delegates to {@link #secureMessage(org.springframework.ws.soap.SoapMessage,org.springframework.ws.context.MessageContext)} - * if the {@link #setSecureResponse(boolean) secureResponse} property is true. + * if the {@link #setSecureResponse(boolean) secureResponse} property is {@code true}. * * @param messageContext the message context, containing the response to be secured * @param endpoint chosen endpoint to invoke - * @return true if the response was secured; false otherwise. + * @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) */ @@ -172,7 +172,7 @@ public abstract class AbstractWsSecurityInterceptor implements SoapEndpointInter return result; } - /** Returns true, i.e. fault responses are not secured. */ + /** Returns {@code true}, i.e. fault responses are not secured. */ @Override public boolean handleFault(MessageContext messageContext, Object endpoint) throws Exception { return true; @@ -195,10 +195,10 @@ public abstract class AbstractWsSecurityInterceptor implements SoapEndpointInter /** * Secures a client-side outgoing request. Delegates to {@link #secureMessage(org.springframework.ws.soap.SoapMessage,org.springframework.ws.context.MessageContext)} - * if the {@link #setSecureRequest(boolean) secureRequest} property is true. + * if the {@link #setSecureRequest(boolean) secureRequest} property is {@code true}. * * @param messageContext the message context, containing the request to be secured - * @return true if the response was secured; false otherwise. + * @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) */ @@ -224,10 +224,10 @@ public abstract class AbstractWsSecurityInterceptor implements SoapEndpointInter /** * Validates a client-side incoming response. Delegates to {@link #validateMessage(org.springframework.ws.soap.SoapMessage,org.springframework.ws.context.MessageContext)} - * if the {@link #setValidateResponse(boolean) validateResponse} property is true. + * if the {@link #setValidateResponse(boolean) validateResponse} property is {@code true}. * * @param messageContext the message context, containing the response to be validated - * @return true if the request was valid; false otherwise. + * @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) */ @@ -255,7 +255,7 @@ public abstract class AbstractWsSecurityInterceptor implements SoapEndpointInter } } - /** Returns true, i.e. fault responses are not validated. */ + /** Returns {@code true}, i.e. fault responses are not validated. */ @Override public boolean handleFault(MessageContext messageContext) throws WebServiceClientException { return true; @@ -269,11 +269,11 @@ public abstract class AbstractWsSecurityInterceptor implements SoapEndpointInter /** * Handles an securement exception. Default implementation logs the given exception, and returns - * false. + * {@code false}. * * @param ex the validation exception * @param messageContext the message context - * @return true to continue processing the message, false (the default) otherwise + * @return {@code true} to continue processing the message, {@code false} (the default) otherwise */ protected boolean handleSecurementException(WsSecuritySecurementException ex, MessageContext messageContext) { if (logger.isErrorEnabled()) { @@ -285,11 +285,11 @@ public abstract class AbstractWsSecurityInterceptor implements SoapEndpointInter /** * Handles an invalid SOAP message. Default implementation logs the given exception, delegates to the set {@link * #setExceptionResolver(EndpointExceptionResolver) exceptionResolver} if any, or creates a SOAP 1.1 Client or SOAP - * 1.2 Sender Fault with the exception message as fault string, and returns false. + * 1.2 Sender Fault with the exception message as fault string, and returns {@code false}. * * @param ex the validation exception * @param messageContext the message context - * @return true to continue processing the message, false (the default) otherwise + * @return {@code true} to continue processing the message, {@code false} (the default) otherwise */ protected boolean handleValidationException(WsSecurityValidationException ex, MessageContext messageContext) { if (logger.isWarnEnabled()) { @@ -310,11 +310,11 @@ public abstract class AbstractWsSecurityInterceptor implements SoapEndpointInter /** * Handles a fault exception.Default implementation logs the given exception, and creates a SOAP Fault with the - * properties of the given exception, and returns false. + * properties of the given exception, and returns {@code false}. * * @param ex the validation exception * @param messageContext the message context - * @return true to continue processing the message, false (the default) otherwise + * @return {@code true} to continue processing the message, {@code false} (the default) otherwise */ protected boolean handleFaultException(WsSecurityFaultException ex, MessageContext messageContext) { if (logger.isWarnEnabled()) { diff --git a/spring-ws-security/src/main/java/org/springframework/ws/soap/security/WsSecurityFaultException.java b/spring-ws-security/src/main/java/org/springframework/ws/soap/security/WsSecurityFaultException.java index b7335e13..21948d25 100644 --- a/spring-ws-security/src/main/java/org/springframework/ws/soap/security/WsSecurityFaultException.java +++ b/spring-ws-security/src/main/java/org/springframework/ws/soap/security/WsSecurityFaultException.java @@ -32,7 +32,7 @@ public abstract class WsSecurityFaultException extends WsSecurityException { private String faultActor; - /** Construct a new WsSecurityFaultException with the given fault code, string, and actor. */ + /** Construct a new {@code WsSecurityFaultException} with the given fault code, string, and actor. */ public WsSecurityFaultException(QName faultCode, String faultString, String faultActor) { super(faultString); this.faultCode = faultCode; diff --git a/spring-ws-security/src/main/java/org/springframework/ws/soap/security/WsSecuritySecurementException.java b/spring-ws-security/src/main/java/org/springframework/ws/soap/security/WsSecuritySecurementException.java index b5d73d99..f8f09c8a 100644 --- a/spring-ws-security/src/main/java/org/springframework/ws/soap/security/WsSecuritySecurementException.java +++ b/spring-ws-security/src/main/java/org/springframework/ws/soap/security/WsSecuritySecurementException.java @@ -18,8 +18,8 @@ package org.springframework.ws.soap.security; /** * Exception indicating that something went wrong during the securement of a message. - *

                - * This is a checked exception since we want it to be caught, logged and handled rather than cause the application to + * + *

                This is a checked exception since we want it to be caught, logged and handled rather than cause the application to * fail. Failure to secure a message is usually not a fatal problem. * * @author Arjen Poutsma diff --git a/spring-ws-security/src/main/java/org/springframework/ws/soap/security/WsSecurityValidationException.java b/spring-ws-security/src/main/java/org/springframework/ws/soap/security/WsSecurityValidationException.java index 26bb13b5..b2815d66 100644 --- a/spring-ws-security/src/main/java/org/springframework/ws/soap/security/WsSecurityValidationException.java +++ b/spring-ws-security/src/main/java/org/springframework/ws/soap/security/WsSecurityValidationException.java @@ -18,8 +18,8 @@ package org.springframework.ws.soap.security; /** * Exception indicating that something went wrong during the validation of a message. - *

                - * This is a checked exception since we want it to be caught, logged and handled rather than cause the application to + * + *

                This is a checked exception since we want it to be caught, logged and handled rather than cause the application to * fail. Failure to validate a message is usually not a fatal problem. * * @author Arjen Poutsma diff --git a/spring-ws-security/src/main/java/org/springframework/ws/soap/security/callback/AbstractCallbackHandler.java b/spring-ws-security/src/main/java/org/springframework/ws/soap/security/callback/AbstractCallbackHandler.java index 8de9805c..7ace1cff 100644 --- a/spring-ws-security/src/main/java/org/springframework/ws/soap/security/callback/AbstractCallbackHandler.java +++ b/spring-ws-security/src/main/java/org/springframework/ws/soap/security/callback/AbstractCallbackHandler.java @@ -25,7 +25,7 @@ import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; /** - * Abstract implementation of a CallbackHandler. + * Abstract implementation of a {@code CallbackHandler}. * * @author Arjen Poutsma * @since 1.0.0 @@ -39,7 +39,7 @@ public abstract class AbstractCallbackHandler implements CallbackHandler { } /** - * Iterates over the given callbacks, and calls handleInternal for each of them. + * Iterates over the given callbacks, and calls {@code handleInternal} for each of them. * * @param callbacks the callbacks * @see #handleInternal(javax.security.auth.callback.Callback) diff --git a/spring-ws-security/src/main/java/org/springframework/ws/soap/security/callback/CallbackHandlerChain.java b/spring-ws-security/src/main/java/org/springframework/ws/soap/security/callback/CallbackHandlerChain.java index d32f974e..7ed9c38b 100644 --- a/spring-ws-security/src/main/java/org/springframework/ws/soap/security/callback/CallbackHandlerChain.java +++ b/spring-ws-security/src/main/java/org/springframework/ws/soap/security/callback/CallbackHandlerChain.java @@ -22,8 +22,8 @@ import javax.security.auth.callback.CallbackHandler; import javax.security.auth.callback.UnsupportedCallbackException; /** - * Represents a chain of CallbackHandlers. For each callback, each of the handlers is called in term. If a - * handler throws a UnsupportedCallbackException, the next handler is tried. + * Represents a chain of {@code CallbackHandler}s. For each callback, each of the handlers is called in term. If a + * handler throws a {@code UnsupportedCallbackException}, the next handler is tried. * * @author Arjen Poutsma * @since 1.5.0 diff --git a/spring-ws-security/src/main/java/org/springframework/ws/soap/security/callback/CleanupCallback.java b/spring-ws-security/src/main/java/org/springframework/ws/soap/security/callback/CleanupCallback.java index ce8aa068..32a84a27 100644 --- a/spring-ws-security/src/main/java/org/springframework/ws/soap/security/callback/CleanupCallback.java +++ b/spring-ws-security/src/main/java/org/springframework/ws/soap/security/callback/CleanupCallback.java @@ -20,8 +20,8 @@ import java.io.Serializable; import javax.security.auth.callback.Callback; /** - * Underlying security services instantiate and pass a CleanupCallback to the handle method of - * a CallbackHandler to clean up security state. + * Underlying security services instantiate and pass a {@code CleanupCallback} to the {@code handle} method of + * a {@code CallbackHandler} to clean up security state. * * @author Arjen Poutsma * @since 1.0.4 diff --git a/spring-ws-security/src/main/java/org/springframework/ws/soap/security/support/KeyManagersFactoryBean.java b/spring-ws-security/src/main/java/org/springframework/ws/soap/security/support/KeyManagersFactoryBean.java index a5bab3bf..4e3ac9f3 100644 --- a/spring-ws-security/src/main/java/org/springframework/ws/soap/security/support/KeyManagersFactoryBean.java +++ b/spring-ws-security/src/main/java/org/springframework/ws/soap/security/support/KeyManagersFactoryBean.java @@ -26,8 +26,8 @@ import org.springframework.util.StringUtils; /** * Spring factory bean for an array of {@link KeyManager}s. - *

                - * Uses the {@link KeyManagerFactory} to create the {@code KeyManager}s. + * + *

                Uses the {@link KeyManagerFactory} to create the {@code KeyManager}s. * * @author Stephen More * @author Arjen Poutsma diff --git a/spring-ws-security/src/main/java/org/springframework/ws/soap/security/support/KeyStoreFactoryBean.java b/spring-ws-security/src/main/java/org/springframework/ws/soap/security/support/KeyStoreFactoryBean.java index 0b81e364..479ed5ea 100644 --- a/spring-ws-security/src/main/java/org/springframework/ws/soap/security/support/KeyStoreFactoryBean.java +++ b/spring-ws-security/src/main/java/org/springframework/ws/soap/security/support/KeyStoreFactoryBean.java @@ -31,8 +31,8 @@ import org.springframework.util.StringUtils; /** * Spring factory bean for a {@link KeyStore}. - *

                - * To load an existing key store, you must set the location property. If this property is not set, a new, + * + *

                To load an existing key store, you must set the {@code location} property. If this property is not set, a new, * empty key store is created, which is most likely not what you want. * * @author Arjen Poutsma @@ -79,7 +79,7 @@ public class KeyStoreFactoryBean implements FactoryBean, InitializingB } /** - * Sets the type of the KeyStore to use. If this is not set, the default is used. + * Sets the type of the {@code KeyStore} to use. If this is not set, the default is used. * * @see KeyStore#getDefaultType() */ diff --git a/spring-ws-security/src/main/java/org/springframework/ws/soap/security/support/KeyStoreUtils.java b/spring-ws-security/src/main/java/org/springframework/ws/soap/security/support/KeyStoreUtils.java index 4370ac34..b33a749a 100644 --- a/spring-ws-security/src/main/java/org/springframework/ws/soap/security/support/KeyStoreUtils.java +++ b/spring-ws-security/src/main/java/org/springframework/ws/soap/security/support/KeyStoreUtils.java @@ -35,13 +35,13 @@ public abstract class KeyStoreUtils { /** * Loads the key store indicated by system properties. This method tries to load a key store by consulting the - * following system properties:javax.net.ssl.keyStore, javax.net.ssl.keyStorePassword, and - * javax.net.ssl.keyStoreType. - *

                - * If these properties specify a file with an appropriate password, the factory uses this file for the key store. If + * following system properties:{@code javax.net.ssl.keyStore}, {@code javax.net.ssl.keyStorePassword}, and + * {@code javax.net.ssl.keyStoreType}. + * + *

                If these properties specify a file with an appropriate password, the factory uses this file for the key store. If * that file does not exist, then a default, empty keystore is created. - *

                - * This behavior corresponds to the standard J2SDK behavior for SSL key stores. + * + *

                This behavior corresponds to the standard J2SDK behavior for SSL key stores. * * @see The * standard J2SDK SSL key store mechanism @@ -73,17 +73,17 @@ public abstract class KeyStoreUtils { /** * Loads a default trust store. This method uses the following algorithm:

                1. If the system property - * javax.net.ssl.trustStore is defined, its value is loaded. If the - * javax.net.ssl.trustStorePassword system property is also defined, its value is used as a password. - * If the javax.net.ssl.trustStoreType system property is defined, its value is used as a key store + * {@code javax.net.ssl.trustStore} is defined, its value is loaded. If the + * {@code javax.net.ssl.trustStorePassword} system property is also defined, its value is used as a password. + * If the {@code javax.net.ssl.trustStoreType} system property is defined, its value is used as a key store * type. - *

                  - * If javax.net.ssl.trustStore is defined but the specified file does not exist, then a default, empty - * trust store is created.

                2. If the javax.net.ssl.trustStore system property was not - * specified, but if the file $JAVA_HOME/lib/security/jssecacerts exists, that file is used.
                3. - * Otherwise,
                4. If the file $JAVA_HOME/lib/security/cacerts exists, that file is used.
                - *

                - * This behavior corresponds to the standard J2SDK behavior for SSL trust stores. + * + *

                If {@code javax.net.ssl.trustStore} is defined but the specified file does not exist, then a default, empty + * trust store is created.

              • 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.
              • + * Otherwise,
              • If the file {@code $JAVA_HOME/lib/security/cacerts} exists, that file is used.
    + * + *

    This behavior corresponds to the standard J2SDK behavior for SSL trust stores. * * @see The * standard J2SDK SSL trust store mechanism diff --git a/spring-ws-security/src/main/java/org/springframework/ws/soap/security/support/TrustManagersFactoryBean.java b/spring-ws-security/src/main/java/org/springframework/ws/soap/security/support/TrustManagersFactoryBean.java index 2a1ca27d..6085d695 100644 --- a/spring-ws-security/src/main/java/org/springframework/ws/soap/security/support/TrustManagersFactoryBean.java +++ b/spring-ws-security/src/main/java/org/springframework/ws/soap/security/support/TrustManagersFactoryBean.java @@ -26,8 +26,8 @@ import org.springframework.util.StringUtils; /** * Spring factory bean for an array of {@link TrustManager}s. - *

    - * Uses the {@link TrustManagerFactory} to create the {@code TrustManager}s. + * + *

    Uses the {@link TrustManagerFactory} to create the {@code TrustManager}s. * * @author Arjen Poutsma * @see TrustManager diff --git a/spring-ws-security/src/main/java/org/springframework/ws/soap/security/wss4j/Wss4jSecurityInterceptor.java b/spring-ws-security/src/main/java/org/springframework/ws/soap/security/wss4j/Wss4jSecurityInterceptor.java index 1952e4ce..962be2f9 100755 --- a/spring-ws-security/src/main/java/org/springframework/ws/soap/security/wss4j/Wss4jSecurityInterceptor.java +++ b/spring-ws-security/src/main/java/org/springframework/ws/soap/security/wss4j/Wss4jSecurityInterceptor.java @@ -58,25 +58,25 @@ import org.springframework.ws.soap.security.wss4j.callback.UsernameTokenPrincipa /** * 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}. - *

    - * The validation and securement actions executed by this interceptor are configured via validationActions - * and securementActions properties, respectively. Actions should be passed as a space-separated strings. - *

    - * Valid validation actions are: - *

    - *

    - *
    Validation actionDescription
    UsernameTokenValidates - * username token
    TimestampValidates the timestamp
    EncryptDecrypts the message
    SignatureValidates - * the signature
    NoSecurityNo action performed
    - *

    + * + *

    The validation and securement actions executed by this interceptor are configured via {@code validationActions} + * and {@code securementActions} properties, respectively. Actions should be passed as a space-separated strings. + * + *

    Valid validation actions are: + * + *

    + *
    Validation actionDescription
    {@code UsernameToken}Validates + * username token
    {@code Timestamp}Validates the timestamp
    {@code Encrypt}Decrypts the message
    {@code Signature}Validates + * the signature
    {@code NoSecurity}No action performed
    + *

    * Securement actions are:

    - * - * }}}} + * }}
    Securement actionDescription
    UsernameTokenAdds a username token
    UsernameTokenSignatureAdds - * a username token and a signature username token secret key
    TimestampAdds a - * timestamp
    EncryptEncrypts the response
    SignatureSigns the response
    NoSecurityNo action + *
    {@code UsernameTokenAdds a username token
    {@code UsernameTokenSignatureAdds + * a username token and a signature username token secret key
    {@code TimestampAdds a + * timestamp
    {@code EncryptEncrypts the response
    {@code SignatureSigns the response
    {@code NoSecurityNo action * performed
    - *

    - * The order of the actions that the client performed to secure the messages is significant and is enforced by the + * + *

    The order of the actions that the client performed to secure the messages is significant and is enforced by the * interceptor. * * @author Tareq Abed Rabbo @@ -144,11 +144,11 @@ public class Wss4jSecurityInterceptor extends AbstractWsSecurityInterceptor impl } /** - * The actor name of the wsse:Security header. - *

    - * If this parameter is omitted, the actor name is not set. - *

    - * The value of the actor or role has to match the receiver's setting or may contain standard values. + * The actor name of the {@code wsse:Security} header. + * + *

    If this parameter is omitted, the actor name is not set. + * + *

    The value of the actor or role has to match the receiver's setting or may contain standard values. */ public void setSecurementActor(String securementActor) { handler.setOption(WSHandlerConstants.ACTOR, securementActor); @@ -165,10 +165,10 @@ public class Wss4jSecurityInterceptor extends AbstractWsSecurityInterceptor impl /** * Defines which key identifier type to use. The WS-Security specifications recommends to use the identifier type - * IssuerSerial. For possible encryption key identifier types refer to {@link - * org.apache.ws.security.handler.WSHandlerConstants#keyIdentifier}. For encryption IssuerSerial, - * X509KeyIdentifier, DirectReference, Thumbprint, - * SKIKeyIdentifier, and EmbeddedKeyName are valid only. + * {@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. */ public void setSecurementEncryptionKeyIdentifier(String securementEncryptionKeyIdentifier) { handler.setOption(WSHandlerConstants.ENC_KEY_ID, securementEncryptionKeyIdentifier); @@ -184,34 +184,34 @@ public class Wss4jSecurityInterceptor extends AbstractWsSecurityInterceptor impl /** * Property to define which parts of the request shall be encrypted. - *

    - * The value of this property is a list of semi-colon separated element names that identify the elements to encrypt. + * + *

    The value of this property is a list of semi-colon separated element names that identify the elements to encrypt. * An encryption mode specifier and a namespace identification, each inside a pair of curly brackets, may precede * each element name. - *

    - * The encryption mode specifier is either {Content} or {Element}. Please refer to the W3C + * + *

    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 Content if it is omitted. Example of a list: + * defaults to {@code Content} if it is omitted. Example of a list: *

          * <property name="securementEncryptionParts"
          *   value="{Content}{http://example.org/paymentv2}CreditCard;
          *             {Element}{}UserName" />
          * 
    - * The the first entry of the list identifies the element CreditCard in the namespace - * http://example.org/paymentv2, and will encrypt its content. Be aware that the element name, the + * The 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. - *

    - * The encryption modifier and the namespace identifier can be omitted. In this case the encryption mode defaults to - * Content and the namespace is set to the SOAP namespace. - *

    - * An empty encryption mode defaults to Content, an empty namespace identifier defaults to the SOAP - * namespace. The second line of the example defines Element as encryption mode for an - * UserName element in the SOAP namespace. - *

    - * To specify an element without a namespace use the string Null as the namespace name (this is a case + * + *

    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 SOAP namespace. + * + *

    An empty encryption mode defaults to {@code Content}, an empty namespace identifier defaults to the SOAP + * namespace. The second line of the example defines {@code Element} as encryption mode for an + * {@code UserName} element in the SOAP namespace. + * + *

    To specify an element without a namespace use the string {@code Null} as the namespace name (this is a case * sensitive string) - *

    - * If no list is specified, the handler encrypts the SOAP Body in Content mode by default. + * + *

    If no list is specified, the handler encrypts the SOAP Body in {@code Content} mode by default. */ public void setSecurementEncryptionParts(String securementEncryptionParts) { handler.setOption(WSHandlerConstants.ENCRYPTION_PARTS, securementEncryptionParts); @@ -229,21 +229,20 @@ public class Wss4jSecurityInterceptor extends AbstractWsSecurityInterceptor impl /** * The user's name for encryption. - *

    - * The encryption functions uses the public key of this user's certificate to encrypt the generated symmetric key. - *

    - * If this parameter is not set, then the encryption function falls back to the {@link + * + *

    The encryption functions uses the public key of this user's certificate to encrypt the generated symmetric key. + * + *

    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. - *

    - * If only encryption of the SOAP body data is requested, it is recommended to use this parameter to define + * + *

    If only 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. - *

    - * Encryption only does not authenticate a user / sender, therefore it does not need a password. - *

    - * Placing the username of the encryption certificate in the configuration file is not a security risk, because the + * + *

    Encryption only does not authenticate a user / sender, therefore it does not need a password. + * + *

    Placing the username of the encryption certificate in the configuration file is not a security risk, because the * public key of that certificate is used only. - *

    */ public void setSecurementEncryptionUser(String securementEncryptionUser) { handler.setOption(WSHandlerConstants.ENCRYPTION_USER, securementEncryptionUser); @@ -255,10 +254,10 @@ public class Wss4jSecurityInterceptor extends AbstractWsSecurityInterceptor impl /** * Specific parameter for UsernameToken action to define the encoding of the passowrd. - *

    - * The parameter can be set to either {@link WSConstants#PW_DIGEST} or to {@link WSConstants#PW_TEXT}. - *

    - * The default setting is PW_DIGEST. + * + *

    The parameter can be set to either {@link WSConstants#PW_DIGEST} or to {@link WSConstants#PW_TEXT}. + * + *

    The default setting is PW_DIGEST. */ public void setSecurementPasswordType(String securementUsernameTokenPasswordType) { handler.setOption(WSHandlerConstants.PASSWORD_TYPE, securementUsernameTokenPasswordType); @@ -286,9 +285,9 @@ public class Wss4jSecurityInterceptor extends AbstractWsSecurityInterceptor impl /** * Defines which key identifier type to use. The WS-Security specifications recommends to use the identifier type - * IssuerSerial. For possible signature key identifier types refer to {@link - * org.apache.ws.security.handler.WSHandlerConstants#keyIdentifier}. For signature IssuerSerial and - * DirectReference are valid only. + * {@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. */ public void setSecurementSignatureKeyIdentifier(String securementSignatureKeyIdentifier) { handler.setOption(WSHandlerConstants.SIG_KEY_ID, securementSignatureKeyIdentifier); @@ -296,26 +295,26 @@ public class Wss4jSecurityInterceptor extends AbstractWsSecurityInterceptor impl /** * Property to define which parts of the request shall be signed. - *

    - * Refer to {@link #setSecurementEncryptionParts(String)} for a detailed description of the format of the value + * + *

    Refer to {@link #setSecurementEncryptionParts(String)} for a detailed description of the format of the value * string. - *

    - * If this property is not specified the handler signs the SOAP Body by default. - *

    - * The WS Security specifications define several formats to transfer the signature tokens (certificates) or - * references to these tokens. Thus, the plain element name Token signs the token and takes care of the + * + *

    If this property is not specified the handler signs the SOAP Body by default. + * + *

    The WS Security specifications define several formats to transfer the signature tokens (certificates) or + * references to these tokens. Thus, the plain element name {@code Token} signs the token and takes care of the * different formats. - *

    - * To sign the SOAP body and the signature token the value of this parameter must contain: + * + *

    To sign the SOAP body and the signature token the value of this parameter must contain: *

          * <property name="securementSignatureParts"
          *   value="{}{http://schemas.xmlsoap.org/soap/envelope/}Body; Token" />
          * 
    - * To specify an element without a namespace use the string Null as the namespace name (this is a case + * To specify an element without a namespace use the string {@code Null} as the namespace name (this is a case * sensitive string) - *

    - * If there is no other element in the request with a local name of Body then the SOAP namespace - * identifier can be empty ({}). + * + *

    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{}}). */ public void setSecurementSignatureParts(String securementSignatureParts) { handler.setOption(WSHandlerConstants.SIGNATURE_PARTS, securementSignatureParts); @@ -323,13 +322,13 @@ public class Wss4jSecurityInterceptor extends AbstractWsSecurityInterceptor impl /** * The user's name for signature. - *

    - * This name is used as the alias name in the keystore to get user's + * + *

    This name is used as the alias name in the keystore to get user's * certificate and private key to perform signing. - *

    - * If this parameter is not set, then the signature + * + *

    If this parameter is not set, then the signature * function falls back to the alias specified by {@link #setSecurementUsername(String)}. - *

    + * */ public void setSecurementSignatureUser(String securementSignatureUser) { handler.setOption(WSHandlerConstants.SIGNATURE_USER, securementSignatureUser); @@ -424,22 +423,22 @@ public class Wss4jSecurityInterceptor extends AbstractWsSecurityInterceptor impl } /** - * Enables the mustUnderstand attribute on WS-Security headers on outgoing messages. Default is - * true. + * Enables the {@code mustUnderstand} attribute on WS-Security headers on outgoing messages. Default is + * {@code true}. */ public void setSecurementMustUnderstand(boolean securementMustUnderstand) { handler.setOption(WSHandlerConstants.MUST_UNDERSTAND, securementMustUnderstand); } /** - * Sets the additional elements in UsernameTokens. - *

    - * The value of this parameter is a list of element names that are added to the UsernameToken. The names of the list + * Sets the additional elements in {@code UsernameToken}s. + * + *

    The value of this parameter is a list of element names that are added to the UsernameToken. The names of the list * a separated by spaces. - *

    - * The list may contain the names Nonce and Created only (case sensitive). Use this option - * if the password type is passwordText and the handler shall add the Nonce and/or - * Created elements. + * + *

    The list may contain the names {@code Nonce} and {@code Created} only (case sensitive). Use this option + * if the password type is {@code passwordText} and the handler shall add the {@code Nonce} and/or + * {@code Created} elements. */ public void setSecurementUsernameTokenElements(String securementUsernameTokenElements) { handler.setOption(WSHandlerConstants.ADD_UT_ELEMENTS, securementUsernameTokenElements); diff --git a/spring-ws-security/src/main/java/org/springframework/ws/soap/security/wss4j/callback/AbstractWsPasswordCallbackHandler.java b/spring-ws-security/src/main/java/org/springframework/ws/soap/security/wss4j/callback/AbstractWsPasswordCallbackHandler.java index 99100575..c593cc98 100644 --- a/spring-ws-security/src/main/java/org/springframework/ws/soap/security/wss4j/callback/AbstractWsPasswordCallbackHandler.java +++ b/spring-ws-security/src/main/java/org/springframework/ws/soap/security/wss4j/callback/AbstractWsPasswordCallbackHandler.java @@ -36,7 +36,7 @@ public abstract class AbstractWsPasswordCallbackHandler extends AbstractCallback /** * Handles {@link WSPasswordCallback} callbacks. Inspects the callback {@link WSPasswordCallback#getUsage() usage} - * code, and calls the various handle* template methods. + * code, and calls the various {@code handle*} template methods. * * @param callback the callback * @throws IOException in case of I/O errors @@ -83,13 +83,13 @@ public abstract class AbstractWsPasswordCallbackHandler extends AbstractCallback /** * Invoked when the callback has a {@link WSPasswordCallback#DECRYPT} usage. - *

    - * This method is invoked when WSS4J needs a password to get the private key of the {@link + * + *

    This method is invoked when WSS4J needs a password to get the private key of the {@link * WSPasswordCallback#getIdentifier() identifier} (username) from the keystore. WSS4J uses this private key to * decrypt the session (symmetric) key. Because the encryption method uses the public key to encrypt the session key * it needs no password (a public key is usually not protected by a password). - *

    - * Default implementation throws an {@link UnsupportedCallbackException}. + * + *

    Default implementation throws an {@link UnsupportedCallbackException}. */ protected void handleDecrypt(WSPasswordCallback callback) throws IOException, UnsupportedCallbackException { throw new UnsupportedCallbackException(callback); @@ -97,10 +97,10 @@ public abstract class AbstractWsPasswordCallbackHandler extends AbstractCallback /** * Invoked when the callback has a {@link WSPasswordCallback#USERNAME_TOKEN} usage. - *

    - * This method is invoked when WSS4J needs the password to fill in or to verify a UsernameToken. - *

    - * Default implementation throws an {@link UnsupportedCallbackException}. + * + *

    This method is invoked when WSS4J needs the password to fill in or to verify a UsernameToken. + * + *

    Default implementation throws an {@link UnsupportedCallbackException}. */ protected void handleUsernameToken(WSPasswordCallback callback) throws IOException, UnsupportedCallbackException { throw new UnsupportedCallbackException(callback); @@ -108,12 +108,12 @@ public abstract class AbstractWsPasswordCallbackHandler extends AbstractCallback /** * Invoked when the callback has a {@link WSPasswordCallback#SIGNATURE} usage. - *

    - * This method is invoked when WSS4J needs the password to get the private key of the {@link + * + *

    This method is invoked when WSS4J needs the password to get the private key of the {@link * WSPasswordCallback#getIdentifier() identifier} (username) from the keystore. WSS4J uses this private key to * produce a signature. The signature verfication uses the public key to verfiy the signature. - *

    - * Default implementation throws an {@link UnsupportedCallbackException}. + * + *

    Default implementation throws an {@link UnsupportedCallbackException}. */ protected void handleSignature(WSPasswordCallback callback) throws IOException, UnsupportedCallbackException { throw new UnsupportedCallbackException(callback); @@ -121,10 +121,10 @@ public abstract class AbstractWsPasswordCallbackHandler extends AbstractCallback /** * Invoked when the callback has a {@link WSPasswordCallback#SECURITY_CONTEXT_TOKEN} usage. - *

    - * This method is invoked when WSS4J needs the key to to be associated with a SecurityContextToken. - *

    - * Default implementation throws an {@link UnsupportedCallbackException}. + * + *

    This method is invoked when WSS4J needs the key to to be associated with a SecurityContextToken. + * + *

    Default implementation throws an {@link UnsupportedCallbackException}. */ protected void handleSecurityContextToken(WSPasswordCallback callback) throws IOException, UnsupportedCallbackException { @@ -133,8 +133,8 @@ public abstract class AbstractWsPasswordCallbackHandler extends AbstractCallback /** * Invoked when the callback has a {@link WSPasswordCallback#CUSTOM_TOKEN} usage. - *

    - * Default implementation throws an {@link UnsupportedCallbackException}. + * + *

    Default implementation throws an {@link UnsupportedCallbackException}. */ protected void handleCustomToken(WSPasswordCallback callback) throws IOException, UnsupportedCallbackException { throw new UnsupportedCallbackException(callback); @@ -142,8 +142,8 @@ public abstract class AbstractWsPasswordCallbackHandler extends AbstractCallback /** * Invoked when the callback has a {@link WSPasswordCallback#SECRET_KEY} usage. - *

    - * Default implementation throws an {@link UnsupportedCallbackException}. + * + *

    Default implementation throws an {@link UnsupportedCallbackException}. */ protected void handleSecretKey(WSPasswordCallback callback) throws IOException, UnsupportedCallbackException { throw new UnsupportedCallbackException(callback); @@ -151,8 +151,8 @@ public abstract class AbstractWsPasswordCallbackHandler extends AbstractCallback /** * Invoked when a {@link CleanupCallback} is passed to {@link #handle(Callback[])}. - *

    - * Default implementation throws an {@link UnsupportedCallbackException}. + * + *

    Default implementation throws an {@link UnsupportedCallbackException}. */ protected void handleCleanup(CleanupCallback callback) throws IOException, UnsupportedCallbackException { throw new UnsupportedCallbackException(callback); @@ -160,8 +160,8 @@ public abstract class AbstractWsPasswordCallbackHandler extends AbstractCallback /** * Invoked when a {@link UsernameTokenPrincipalCallback} is passed to {@link #handle(Callback[])}. - *

    - * Default implementation throws an {@link UnsupportedCallbackException}. + * + *

    Default implementation throws an {@link UnsupportedCallbackException}. */ protected void handleUsernameTokenPrincipal(UsernameTokenPrincipalCallback callback) throws IOException, UnsupportedCallbackException { diff --git a/spring-ws-security/src/main/java/org/springframework/ws/soap/security/wss4j/callback/KeyStoreCallbackHandler.java b/spring-ws-security/src/main/java/org/springframework/ws/soap/security/wss4j/callback/KeyStoreCallbackHandler.java index f3e80927..cef0c73d 100644 --- a/spring-ws-security/src/main/java/org/springframework/ws/soap/security/wss4j/callback/KeyStoreCallbackHandler.java +++ b/spring-ws-security/src/main/java/org/springframework/ws/soap/security/wss4j/callback/KeyStoreCallbackHandler.java @@ -29,7 +29,7 @@ import org.springframework.beans.factory.InitializingBean; import org.springframework.ws.soap.security.support.KeyStoreUtils; /** - * Callback handler that uses Java Security KeyStores to handle cryptographic callbacks. Allows for + * Callback handler that uses Java Security {@code KeyStore}s to handle cryptographic callbacks. Allows for * specific key stores to be set for various cryptographic operations. * * @author Tareq Abed Rabbo diff --git a/spring-ws-security/src/main/java/org/springframework/ws/soap/security/wss4j/callback/SimplePasswordValidationCallbackHandler.java b/spring-ws-security/src/main/java/org/springframework/ws/soap/security/wss4j/callback/SimplePasswordValidationCallbackHandler.java index 95dec4b1..967496b7 100644 --- a/spring-ws-security/src/main/java/org/springframework/ws/soap/security/wss4j/callback/SimplePasswordValidationCallbackHandler.java +++ b/spring-ws-security/src/main/java/org/springframework/ws/soap/security/wss4j/callback/SimplePasswordValidationCallbackHandler.java @@ -28,7 +28,7 @@ import org.springframework.beans.factory.InitializingBean; import org.springframework.util.Assert; /** - * Simple callback handler that validates passwords against a in-memory Properties object. Password + * Simple callback handler that validates passwords against a in-memory {@code Properties} object. Password * validation is done on a case-sensitive basis. * * @author Tareq Abed Rabbo diff --git a/spring-ws-security/src/main/java/org/springframework/ws/soap/security/wss4j/callback/SpringSecurityPasswordValidationCallbackHandler.java b/spring-ws-security/src/main/java/org/springframework/ws/soap/security/wss4j/callback/SpringSecurityPasswordValidationCallbackHandler.java index 6aed24b7..ea41f044 100644 --- a/spring-ws-security/src/main/java/org/springframework/ws/soap/security/wss4j/callback/SpringSecurityPasswordValidationCallbackHandler.java +++ b/spring-ws-security/src/main/java/org/springframework/ws/soap/security/wss4j/callback/SpringSecurityPasswordValidationCallbackHandler.java @@ -37,8 +37,8 @@ import org.springframework.ws.soap.security.support.SpringSecurityUtils; /** * Callback handler that validates a plain text or digest password using an Spring Security {@code UserDetailsService}. - *

    - * An Spring Security {@link UserDetailsService} is used to load {@link UserDetails} from. The digest of the + * + *

    An Spring Security {@link UserDetailsService} is used to load {@link UserDetails} from. The digest of the * password contained in this details object is then compared with the digest in the message. * * @author Arjen Poutsma diff --git a/spring-ws-security/src/main/java/org/springframework/ws/soap/security/wss4j/callback/UsernameTokenPrincipalCallback.java b/spring-ws-security/src/main/java/org/springframework/ws/soap/security/wss4j/callback/UsernameTokenPrincipalCallback.java index e331d9cc..564ae602 100644 --- a/spring-ws-security/src/main/java/org/springframework/ws/soap/security/wss4j/callback/UsernameTokenPrincipalCallback.java +++ b/spring-ws-security/src/main/java/org/springframework/ws/soap/security/wss4j/callback/UsernameTokenPrincipalCallback.java @@ -22,9 +22,9 @@ import javax.security.auth.callback.Callback; import org.apache.ws.security.WSUsernameTokenPrincipal; /** - * Underlying security services instantiate and pass a UsernameTokenPrincipalCallback to the - * handle method of a CallbackHandler to pass a security - * WSUsernameTokenPrincipal. + * Underlying security services instantiate and pass a {@code UsernameTokenPrincipalCallback} to the + * {@code handle} method of a {@code CallbackHandler} to pass a security + * {@code WSUsernameTokenPrincipal}. * * @author Arjen Poutsma * @see WSUsernameTokenPrincipal @@ -36,12 +36,12 @@ public class UsernameTokenPrincipalCallback implements Callback, Serializable { private final WSUsernameTokenPrincipal principal; - /** Construct a UsernameTokenPrincipalCallback. */ + /** Construct a {@code UsernameTokenPrincipalCallback}. */ public UsernameTokenPrincipalCallback(WSUsernameTokenPrincipal principal) { this.principal = principal; } - /** Get the retrieved Principal. */ + /** Get the retrieved {@code Principal}. */ public WSUsernameTokenPrincipal getPrincipal() { return principal; } diff --git a/spring-ws-security/src/main/java/org/springframework/ws/soap/security/wss4j/support/CryptoFactoryBean.java b/spring-ws-security/src/main/java/org/springframework/ws/soap/security/wss4j/support/CryptoFactoryBean.java index fd8381b8..24c554d5 100755 --- a/spring-ws-security/src/main/java/org/springframework/ws/soap/security/wss4j/support/CryptoFactoryBean.java +++ b/spring-ws-security/src/main/java/org/springframework/ws/soap/security/wss4j/support/CryptoFactoryBean.java @@ -33,8 +33,8 @@ import org.springframework.util.Assert; /** * Spring factory bean for a WSS4J {@link Crypto}. Allows for strong-typed property configuration, or configuration * through {@link Properties}. - *

    - * Requires either individual properties, or the {@link #setConfiguration(java.util.Properties) configuration} property + * + *

    Requires either individual properties, or the {@link #setConfiguration(java.util.Properties) configuration} property * to be set. * * @author Tareq Abed Rabbo @@ -66,8 +66,8 @@ public class CryptoFactoryBean implements FactoryBean, BeanClassLoaderAw /** * Sets the {@link org.apache.ws.security.components.crypto.Crypto} provider name. Defaults to {@link * org.apache.ws.security.components.crypto.Merlin}. - *

    - * This property maps to the WSS4J {@code org.apache.ws.security.crypto.provider} property. + * + *

    This property maps to the WSS4J {@code org.apache.ws.security.crypto.provider} property. * * @param cryptoProviderClass the crypto provider class */ @@ -78,8 +78,8 @@ public class CryptoFactoryBean implements FactoryBean, BeanClassLoaderAw /** * Sets the location of the key store to be loaded in the {@link org.apache.ws.security.components.crypto.Crypto} * instance. - *

    - * This property maps to the WSS4J {@code org.apache.ws.security.crypto.merlin.file} property. + * + *

    This property maps to the WSS4J {@code org.apache.ws.security.crypto.merlin.file} property. * * @param location the key store location * @throws java.io.IOException when the resource cannot be opened @@ -106,8 +106,8 @@ public class CryptoFactoryBean implements FactoryBean, BeanClassLoaderAw /** * Sets the key store provider. - *

    - * This property maps to the WSS4J {@code org.apache.ws.security.crypto.merlin.keystore.provider} property. + * + *

    This property maps to the WSS4J {@code org.apache.ws.security.crypto.merlin.keystore.provider} property. * * @param provider the key store provider */ @@ -117,8 +117,8 @@ public class CryptoFactoryBean implements FactoryBean, BeanClassLoaderAw /** * Sets the key store password. Defaults to {@code security}. - *

    - * This property maps to the WSS4J {@code org.apache.ws.security.crypto.merlin.keystore.password} property. + * + *

    This property maps to the WSS4J {@code org.apache.ws.security.crypto.merlin.keystore.password} property. * * @param password the key store password */ @@ -128,8 +128,8 @@ public class CryptoFactoryBean implements FactoryBean, BeanClassLoaderAw /** * Sets the key store type. Defaults to {@link java.security.KeyStore#getDefaultType()}. - *

    - * This property maps to the WSS4J {@code org.apache.ws.security.crypto.merlin.keystore.type} property. + * + *

    This property maps to the WSS4J {@code org.apache.ws.security.crypto.merlin.keystore.type} property. * * @param type the key store type */ @@ -139,11 +139,10 @@ public class CryptoFactoryBean implements FactoryBean, BeanClassLoaderAw /** * Sets the trust store password. Defaults to {@code changeit}. - *

    - * WSS4J crypto uses the standard J2SE trust store, i.e. {@code $JAVA_HOME/lib/security/cacerts}. - *

    - *

    - * This property maps to the WSS4J {@code org.apache.ws.security.crypto.merlin.cacerts.password} property. + * + *

    WSS4J crypto uses the standard J2SE trust store, i.e. {@code $JAVA_HOME/lib/security/cacerts}. + * + *

    This property maps to the WSS4J {@code org.apache.ws.security.crypto.merlin.cacerts.password} property. * * @param password the trust store password */ @@ -155,8 +154,8 @@ public class CryptoFactoryBean implements FactoryBean, BeanClassLoaderAw * Sets the alias name of the default certificate which has been specified as a property. This should be the * certificate that is used for signature and encryption. This alias corresponds to the certificate that should be * used whenever KeyInfo is not present in a signed or an encrypted message. - *

    - * This property maps to the WSS4J {@code org.apache.ws.security.crypto.merlin.keystore.alias} property. + * + *

    This property maps to the WSS4J {@code org.apache.ws.security.crypto.merlin.keystore.alias} property. * * @param defaultX509Alias alias name of the default X509 certificate */ diff --git a/spring-ws-security/src/main/java/org/springframework/ws/soap/security/x509/X509AuthenticationToken.java b/spring-ws-security/src/main/java/org/springframework/ws/soap/security/x509/X509AuthenticationToken.java index d58810aa..b5421d9d 100644 --- a/spring-ws-security/src/main/java/org/springframework/ws/soap/security/x509/X509AuthenticationToken.java +++ b/spring-ws-security/src/main/java/org/springframework/ws/soap/security/x509/X509AuthenticationToken.java @@ -24,7 +24,7 @@ import org.springframework.security.core.GrantedAuthority; /** - * Authentication implementation for X.509 client-certificate authentication. + * {@code Authentication} implementation for X.509 client-certificate authentication. *

    Migrated from Spring Security 2 since it has been removed in Spring Security 3.

    * * @author Luke Taylor @@ -40,7 +40,7 @@ public class X509AuthenticationToken extends AbstractAuthenticationToken { /** * Used for an authentication request. The {@link org.springframework.security.core.Authentication#isAuthenticated()} will return - * false. + * {@code false}. * * @param credentials the certificate */ @@ -51,10 +51,10 @@ public class X509AuthenticationToken extends AbstractAuthenticationToken { /** * Used for an authentication response object. The {@link org.springframework.security.core.Authentication#isAuthenticated()} - * will return true. + * will return {@code true}. * * @param principal the principal, which is generally a - * UserDetails + * {@code UserDetails} * @param credentials the certificate * @param authorities the authorities */ diff --git a/spring-ws-security/src/main/java/org/springframework/ws/soap/security/x509/X509AuthoritiesPopulator.java b/spring-ws-security/src/main/java/org/springframework/ws/soap/security/x509/X509AuthoritiesPopulator.java index 20c872fe..c646efd5 100644 --- a/spring-ws-security/src/main/java/org/springframework/ws/soap/security/x509/X509AuthoritiesPopulator.java +++ b/spring-ws-security/src/main/java/org/springframework/ws/soap/security/x509/X509AuthoritiesPopulator.java @@ -23,7 +23,7 @@ import org.springframework.security.core.userdetails.UserDetails; /** - * Populates the UserDetails associated with the X.509 + * Populates the {@code UserDetails} associated with the X.509 * certificate presented by a client. *

    * Although the certificate will already have been validated by the web container, @@ -40,7 +40,7 @@ public interface X509AuthoritiesPopulator { /** * Obtains the granted authorities for the specified user.

    May throw any - * AuthenticationException or return null if the authorities are unavailable.

    + * {@code AuthenticationException} or return {@code null} if the authorities are unavailable.

    * * @param userCertificate the X.509 certificate supplied * diff --git a/spring-ws-security/src/main/java/org/springframework/ws/soap/security/x509/cache/EhCacheBasedX509UserCache.java b/spring-ws-security/src/main/java/org/springframework/ws/soap/security/x509/cache/EhCacheBasedX509UserCache.java index edc8c038..d27b20d9 100644 --- a/spring-ws-security/src/main/java/org/springframework/ws/soap/security/x509/cache/EhCacheBasedX509UserCache.java +++ b/spring-ws-security/src/main/java/org/springframework/ws/soap/security/x509/cache/EhCacheBasedX509UserCache.java @@ -31,7 +31,7 @@ import org.springframework.util.Assert; /** - * Caches User objects using a Spring IoC defined EHCACHE. *

    Migrated from Spring Security 2 since it has been removed in Spring Security 3.

    * diff --git a/spring-ws-security/src/main/java/org/springframework/ws/soap/security/xwss/XwsSecurityInterceptor.java b/spring-ws-security/src/main/java/org/springframework/ws/soap/security/xwss/XwsSecurityInterceptor.java index d976862a..8ec8ed96 100644 --- a/spring-ws-security/src/main/java/org/springframework/ws/soap/security/xwss/XwsSecurityInterceptor.java +++ b/spring-ws-security/src/main/java/org/springframework/ws/soap/security/xwss/XwsSecurityInterceptor.java @@ -44,17 +44,17 @@ import org.springframework.ws.soap.security.xwss.callback.XwssCallbackHandlerCha /** * WS-Security endpoint interceptor that is based on Sun's XML and Web Services Security package (XWSS). This * WS-Security implementation is part of the Java Web Services Developer Pack (Java WSDP). - *

    - * This interceptor needs a CallbackHandler to operate. This handler is used to retrieve certificates, + * + *

    This interceptor needs a {@code CallbackHandler} to operate. This handler is used to retrieve certificates, * private keys, validate user credentials, etc. Refer to the XWSS Javadoc to learn more about the specific - * Callbacks fired by XWSS. You can also set multiple handlers, each of which will be used in turn. - *

    - * Additionally, you must define a XWSS policy file by setting policyConfiguration property. The format of + * {@code Callback}s fired by XWSS. You can also set multiple handlers, each of which will be used in turn. + * + *

    Additionally, you must define a XWSS policy file by setting {@code policyConfiguration} property. The format of * the policy file is documented in the Java * Web Services Tutorial. - *

    - * Note that this interceptor depends on SAAJ, and thus requires SaajSoapMessages to operate. This - * means that you must use a SaajSoapMessageFactory to create the SOAP messages. + * + *

    Note that this interceptor depends on SAAJ, and thus requires {@code SaajSoapMessage}s to operate. This + * means that you must use a {@code SaajSoapMessageFactory} to create the SOAP messages. * * @author Arjen Poutsma * @see #setCallbackHandler(javax.security.auth.callback.CallbackHandler) @@ -73,7 +73,7 @@ public class XwsSecurityInterceptor extends AbstractWsSecurityInterceptor implem private Resource policyConfiguration; /** - * Sets the handler to resolve XWSS callbacks. Setting either this propery, or callbackHandlers, is + * Sets the handler to resolve XWSS callbacks. Setting either this propery, or {@code callbackHandlers}, is * required. * * @see com.sun.xml.wss.impl.callback.XWSSCallback @@ -84,7 +84,7 @@ public class XwsSecurityInterceptor extends AbstractWsSecurityInterceptor implem } /** - * Sets the handlers to resolve XWSS callbacks. Setting either this propery, or callbackHandlers, is + * Sets the handlers to resolve XWSS callbacks. Setting either this propery, or {@code callbackHandlers}, is * required. * * @see com.sun.xml.wss.impl.callback.XWSSCallback @@ -125,7 +125,7 @@ public class XwsSecurityInterceptor extends AbstractWsSecurityInterceptor implem * * @param soapMessage the message to be secured * @throws XwsSecuritySecurementException in case of errors - * @throws IllegalArgumentException when soapMessage is not a SaajSoapMessage + * @throws IllegalArgumentException when soapMessage is not a {@code SaajSoapMessage} */ @Override protected void secureMessage(SoapMessage soapMessage, MessageContext messageContext) @@ -151,7 +151,7 @@ public class XwsSecurityInterceptor extends AbstractWsSecurityInterceptor implem * * @param soapMessage the message to be validated * @throws XwsSecurityValidationException in case of errors - * @throws IllegalArgumentException when soapMessage is not a SaajSoapMessage + * @throws IllegalArgumentException when soapMessage is not a {@code SaajSoapMessage} */ @Override protected void validateMessage(SoapMessage soapMessage, MessageContext messageContext) diff --git a/spring-ws-security/src/main/java/org/springframework/ws/soap/security/xwss/callback/CryptographyCallbackHandler.java b/spring-ws-security/src/main/java/org/springframework/ws/soap/security/xwss/callback/CryptographyCallbackHandler.java index fb8d118f..ecc246d9 100644 --- a/spring-ws-security/src/main/java/org/springframework/ws/soap/security/xwss/callback/CryptographyCallbackHandler.java +++ b/spring-ws-security/src/main/java/org/springframework/ws/soap/security/xwss/callback/CryptographyCallbackHandler.java @@ -30,7 +30,7 @@ import org.springframework.ws.soap.security.callback.AbstractCallbackHandler; /** * Default callback handler that handles cryptographic callback. This handler determines the exact callback passed, and - * calls a template method for it. By default, all template methods throw an UnsupportedCallbackException, + * calls a template method for it. By default, all template methods throw an {@code UnsupportedCallbackException}, * so you only need to override those you need. * * @author Arjen Poutsma @@ -66,8 +66,8 @@ public class CryptographyCallbackHandler extends AbstractCallbackHandler { // /** - * Template method that handles CertificateValidationCallbacks. Called from - * handleInternal(). Default implementation throws an UnsupportedCallbackException. + * Template method that handles {@code CertificateValidationCallback}s. Called from + * {@code handleInternal()}. Default implementation throws an {@code UnsupportedCallbackException}. */ protected void handleCertificateValidationCallback(CertificateValidationCallback callback) throws IOException, UnsupportedCallbackException { @@ -79,7 +79,7 @@ public class CryptographyCallbackHandler extends AbstractCallbackHandler { // /** - * Method that handles DecryptionKeyCallbacks. Called from handleInternal(). Default + * Method that handles {@code DecryptionKeyCallback}s. Called from {@code handleInternal()}. Default * implementation delegates to specific handling methods. * * @see #handlePrivateKeyRequest(com.sun.xml.wss.impl.callback.DecryptionKeyCallback, @@ -101,8 +101,8 @@ public class CryptographyCallbackHandler extends AbstractCallbackHandler { } /** - * Method that handles DecryptionKeyCallbacks with PrivateKeyRequest . Called from - * handleDecryptionKeyCallback(). Default implementation delegates to specific handling methods. + * Method that handles {@code DecryptionKeyCallback}s with {@code PrivateKeyRequest} . Called from + * {@code handleDecryptionKeyCallback()}. Default implementation delegates to specific handling methods. * * @see #handlePublicKeyBasedPrivKeyCertRequest(com.sun.xml.wss.impl.callback.SignatureKeyCallback, * com.sun.xml.wss.impl.callback.SignatureKeyCallback.PublicKeyBasedPrivKeyCertRequest) @@ -135,9 +135,9 @@ public class CryptographyCallbackHandler extends AbstractCallbackHandler { } /** - * Template method that handles DecryptionKeyCallbacks with PublicKeyBasedPrivKeyRequests. - * Called from handlePrivateKeyRequest(). Default implementation throws an - * UnsupportedCallbackException. + * Template method that handles {@code DecryptionKeyCallback}s with {@code PublicKeyBasedPrivKeyRequest}s. + * Called from {@code handlePrivateKeyRequest()}. Default implementation throws an + * {@code UnsupportedCallbackException}. */ protected void handlePublicKeyBasedPrivKeyRequest(DecryptionKeyCallback callback, DecryptionKeyCallback.PublicKeyBasedPrivKeyRequest request) @@ -146,9 +146,9 @@ public class CryptographyCallbackHandler extends AbstractCallbackHandler { } /** - * Template method that handles DecryptionKeyCallbacks with X509CertificateBasedRequests. - * Called from handlePrivateKeyRequest(). Default implementation throws an - * UnsupportedCallbackException. + * Template method that handles {@code DecryptionKeyCallback}s with {@code X509CertificateBasedRequest}s. + * Called from {@code handlePrivateKeyRequest()}. Default implementation throws an + * {@code UnsupportedCallbackException}. */ protected void handleX509CertificateBasedRequest(DecryptionKeyCallback callback, DecryptionKeyCallback.X509CertificateBasedRequest request) @@ -157,9 +157,9 @@ public class CryptographyCallbackHandler extends AbstractCallbackHandler { } /** - * Template method that handles DecryptionKeyCallbacks with X509IssuerSerialBasedRequests. - * Called from handlePrivateKeyRequest(). Default implementation throws an - * UnsupportedCallbackException. + * Template method that handles {@code DecryptionKeyCallback}s with {@code X509IssuerSerialBasedRequest}s. + * Called from {@code handlePrivateKeyRequest()}. Default implementation throws an + * {@code UnsupportedCallbackException}. */ protected void handleX509IssuerSerialBasedRequest(DecryptionKeyCallback callback, DecryptionKeyCallback.X509IssuerSerialBasedRequest request) @@ -168,9 +168,9 @@ public class CryptographyCallbackHandler extends AbstractCallbackHandler { } /** - * Template method that handles DecryptionKeyCallbacks with X509SubjectKeyIdentifierBasedRequests. - * Called from handlePrivateKeyRequest(). Default implementation throws an - * UnsupportedCallbackException. + * Template method that handles {@code DecryptionKeyCallback}s with {@code X509SubjectKeyIdentifierBasedRequest}s. + * Called from {@code handlePrivateKeyRequest()}. Default implementation throws an + * {@code UnsupportedCallbackException}. */ protected void handleX509SubjectKeyIdentifierBasedRequest(DecryptionKeyCallback callback, DecryptionKeyCallback.X509SubjectKeyIdentifierBasedRequest request) @@ -179,8 +179,8 @@ public class CryptographyCallbackHandler extends AbstractCallbackHandler { } /** - * Method that handles DecryptionKeyCallbacks with SymmetricKeyRequest . Called from - * handleDecryptionKeyCallback(). Default implementation delegates to specific handling methods. + * Method that handles {@code DecryptionKeyCallback}s with {@code SymmetricKeyRequest} . Called from + * {@code handleDecryptionKeyCallback()}. Default implementation delegates to specific handling methods. * * @see #handleAliasSymmetricKeyRequest(com.sun.xml.wss.impl.callback.DecryptionKeyCallback, * com.sun.xml.wss.impl.callback.DecryptionKeyCallback.AliasSymmetricKeyRequest) @@ -199,9 +199,9 @@ public class CryptographyCallbackHandler extends AbstractCallbackHandler { } /** - * Template method that handles DecryptionKeyCallbacks with AliasSymmetricKeyRequests. - * Called from handleSymmetricKeyRequest(). Default implementation throws an - * UnsupportedCallbackException. + * Template method that handles {@code DecryptionKeyCallback}s with {@code AliasSymmetricKeyRequest}s. + * Called from {@code handleSymmetricKeyRequest()}. Default implementation throws an + * {@code UnsupportedCallbackException}. */ protected void handleAliasSymmetricKeyRequest(DecryptionKeyCallback callback, DecryptionKeyCallback.AliasSymmetricKeyRequest request) @@ -214,7 +214,7 @@ public class CryptographyCallbackHandler extends AbstractCallbackHandler { // /** - * Method that handles EncryptionKeyCallbacks. Called from handleInternal(). Default + * Method that handles {@code EncryptionKeyCallback}s. Called from {@code handleInternal()}. Default * implementation delegates to specific handling methods. * * @see #handleSymmetricKeyRequest(com.sun.xml.wss.impl.callback.EncryptionKeyCallback, @@ -238,8 +238,8 @@ public class CryptographyCallbackHandler extends AbstractCallbackHandler { } /** - * Method that handles EncryptionKeyCallbacks with SymmetricKeyRequest . Called from - * handleEncryptionKeyCallback(). Default implementation delegates to specific handling methods. + * Method that handles {@code EncryptionKeyCallback}s with {@code SymmetricKeyRequest} . Called from + * {@code handleEncryptionKeyCallback()}. Default implementation delegates to specific handling methods. * * @see #handleAliasSymmetricKeyRequest(com.sun.xml.wss.impl.callback.EncryptionKeyCallback, * com.sun.xml.wss.impl.callback.EncryptionKeyCallback.AliasSymmetricKeyRequest) @@ -253,9 +253,9 @@ public class CryptographyCallbackHandler extends AbstractCallbackHandler { } /** - * Template method that handles EncryptionKeyCallbacks with AliasSymmetricKeyRequests. - * Called from handleSymmetricKeyRequest(). Default implementation throws an - * UnsupportedCallbackException. + * Template method that handles {@code EncryptionKeyCallback}s with {@code AliasSymmetricKeyRequest}s. + * Called from {@code handleSymmetricKeyRequest()}. Default implementation throws an + * {@code UnsupportedCallbackException}. */ protected void handleAliasSymmetricKeyRequest(EncryptionKeyCallback callback, EncryptionKeyCallback.AliasSymmetricKeyRequest request) @@ -264,8 +264,8 @@ public class CryptographyCallbackHandler extends AbstractCallbackHandler { } /** - * Method that handles EncryptionKeyCallbacks with X509CertificateRequest . Called from - * handleEncryptionKeyCallback(). Default implementation delegates to specific handling methods. + * Method that handles {@code EncryptionKeyCallback}s with {@code X509CertificateRequest} . Called from + * {@code handleEncryptionKeyCallback()}. Default implementation delegates to specific handling methods. * * @see #handleAliasX509CertificateRequest(com.sun.xml.wss.impl.callback.EncryptionKeyCallback, * com.sun.xml.wss.impl.callback.EncryptionKeyCallback.AliasX509CertificateRequest) @@ -293,9 +293,9 @@ public class CryptographyCallbackHandler extends AbstractCallbackHandler { } /** - * Template method that handles EncryptionKeyCallbacks with AliasX509CertificateRequests. - * Called from handleX509CertificateRequest(). Default implementation throws an - * UnsupportedCallbackException. + * Template method that handles {@code EncryptionKeyCallback}s with {@code AliasX509CertificateRequest}s. + * Called from {@code handleX509CertificateRequest()}. Default implementation throws an + * {@code UnsupportedCallbackException}. */ protected void handleAliasX509CertificateRequest(EncryptionKeyCallback callback, EncryptionKeyCallback.AliasX509CertificateRequest request) @@ -304,9 +304,9 @@ public class CryptographyCallbackHandler extends AbstractCallbackHandler { } /** - * Template method that handles EncryptionKeyCallbacks with DefaultX509CertificateRequests. - * Called from handleX509CertificateRequest(). Default implementation throws an - * UnsupportedCallbackException. + * Template method that handles {@code EncryptionKeyCallback}s with {@code DefaultX509CertificateRequest}s. + * Called from {@code handleX509CertificateRequest()}. Default implementation throws an + * {@code UnsupportedCallbackException}. */ protected void handleDefaultX509CertificateRequest(EncryptionKeyCallback callback, EncryptionKeyCallback.DefaultX509CertificateRequest request) @@ -315,9 +315,9 @@ public class CryptographyCallbackHandler extends AbstractCallbackHandler { } /** - * Template method that handles EncryptionKeyCallbacks with PublicKeyBasedRequests. Called - * from handleX509CertificateRequest(). Default implementation throws an - * UnsupportedCallbackException. + * Template method that handles {@code EncryptionKeyCallback}s with {@code PublicKeyBasedRequest}s. Called + * from {@code handleX509CertificateRequest()}. Default implementation throws an + * {@code UnsupportedCallbackException}. */ protected void handlePublicKeyBasedRequest(EncryptionKeyCallback callback, EncryptionKeyCallback.PublicKeyBasedRequest request) @@ -330,7 +330,7 @@ public class CryptographyCallbackHandler extends AbstractCallbackHandler { // /** - * Method that handles SignatureKeyCallbacks. Called from handleInternal(). Default + * Method that handles {@code SignatureKeyCallback}s. Called from {@code handleInternal()}. Default * implementation delegates to specific handling methods. * * @see #handlePrivKeyCertRequest(com.sun.xml.wss.impl.callback.SignatureKeyCallback, @@ -347,8 +347,8 @@ public class CryptographyCallbackHandler extends AbstractCallbackHandler { } /** - * Method that handles SignatureKeyCallbacks with PrivKeyCertRequests. Called from - * handleSignatureKeyCallback(). Default implementation delegates to specific handling methods. + * Method that handles {@code SignatureKeyCallback}s with {@code PrivKeyCertRequest}s. Called from + * {@code handleSignatureKeyCallback()}. Default implementation delegates to specific handling methods. * * @see #handleDefaultPrivKeyCertRequest(com.sun.xml.wss.impl.callback.SignatureKeyCallback, * com.sun.xml.wss.impl.callback.SignatureKeyCallback.DefaultPrivKeyCertRequest) @@ -375,9 +375,9 @@ public class CryptographyCallbackHandler extends AbstractCallbackHandler { } /** - * Template method that handles SignatureKeyCallbacks with DefaultPrivKeyCertRequests. - * Called from handlePrivKeyCertRequest(). Default implementation throws an - * UnsupportedCallbackException. + * Template method that handles {@code SignatureKeyCallback}s with {@code DefaultPrivKeyCertRequest}s. + * Called from {@code handlePrivKeyCertRequest()}. Default implementation throws an + * {@code UnsupportedCallbackException}. */ protected void handleDefaultPrivKeyCertRequest(SignatureKeyCallback callback, SignatureKeyCallback.DefaultPrivKeyCertRequest request) @@ -386,9 +386,9 @@ public class CryptographyCallbackHandler extends AbstractCallbackHandler { } /** - * Template method that handles SignatureKeyCallbacks with AliasPrivKeyCertRequests. - * Called from handlePrivKeyCertRequest(). Default implementation throws an - * UnsupportedCallbackException. + * Template method that handles {@code SignatureKeyCallback}s with {@code AliasPrivKeyCertRequest}s. + * Called from {@code handlePrivKeyCertRequest()}. Default implementation throws an + * {@code UnsupportedCallbackException}. */ protected void handleAliasPrivKeyCertRequest(SignatureKeyCallback callback, SignatureKeyCallback.AliasPrivKeyCertRequest request) @@ -397,9 +397,9 @@ public class CryptographyCallbackHandler extends AbstractCallbackHandler { } /** - * Template method that handles SignatureKeyCallbacks with PublicKeyBasedPrivKeyCertRequests. - * Called from handlePrivKeyCertRequest(). Default implementation throws an - * UnsupportedCallbackException. + * Template method that handles {@code SignatureKeyCallback}s with {@code PublicKeyBasedPrivKeyCertRequest}s. + * Called from {@code handlePrivKeyCertRequest()}. Default implementation throws an + * {@code UnsupportedCallbackException}. */ protected void handlePublicKeyBasedPrivKeyCertRequest(SignatureKeyCallback callback, SignatureKeyCallback.PublicKeyBasedPrivKeyCertRequest request) @@ -412,7 +412,7 @@ public class CryptographyCallbackHandler extends AbstractCallbackHandler { // /** - * Method that handles SignatureVerificationKeyCallbacks. Called from handleInternal(). + * Method that handles {@code SignatureVerificationKeyCallback}s. Called from {@code handleInternal()}. * Default implementation delegates to specific handling methods. * * @see #handleX509CertificateRequest(com.sun.xml.wss.impl.callback.SignatureVerificationKeyCallback, @@ -430,8 +430,8 @@ public class CryptographyCallbackHandler extends AbstractCallbackHandler { } /** - * Method that handles SignatureVerificationKeyCallbacks with X509CertificateRequests. - * Called from handleSignatureVerificationKeyCallback(). Default implementation delegates to specific + * Method that handles {@code SignatureVerificationKeyCallback}s with {@code X509CertificateRequest}s. + * Called from {@code handleSignatureVerificationKeyCallback()}. Default implementation delegates to specific * handling methods. * * @see #handlePublicKeyBasedRequest(com.sun.xml.wss.impl.callback.SignatureVerificationKeyCallback, @@ -461,9 +461,9 @@ public class CryptographyCallbackHandler extends AbstractCallbackHandler { } /** - * Template method that handles SignatureKeyCallbacks with PublicKeyBasedPrivKeyCertRequests. - * Called from handlePrivKeyCertRequest(). Default implementation throws an - * UnsupportedCallbackException. + * Template method that handles {@code SignatureKeyCallback}s with {@code PublicKeyBasedPrivKeyCertRequest}s. + * Called from {@code handlePrivKeyCertRequest()}. Default implementation throws an + * {@code UnsupportedCallbackException}. */ protected void handleX509SubjectKeyIdentifierBasedRequest(SignatureVerificationKeyCallback callback, SignatureVerificationKeyCallback.X509SubjectKeyIdentifierBasedRequest request) @@ -472,9 +472,9 @@ public class CryptographyCallbackHandler extends AbstractCallbackHandler { } /** - * Template method that handles SignatureKeyCallbacks with X509IssuerSerialBasedRequests. - * Called from handlePrivKeyCertRequest(). Default implementation throws an - * UnsupportedCallbackException. + * Template method that handles {@code SignatureKeyCallback}s with {@code X509IssuerSerialBasedRequest}s. + * Called from {@code handlePrivKeyCertRequest()}. Default implementation throws an + * {@code UnsupportedCallbackException}. */ protected void handleX509IssuerSerialBasedRequest(SignatureVerificationKeyCallback callback, SignatureVerificationKeyCallback.X509IssuerSerialBasedRequest request) @@ -483,9 +483,9 @@ public class CryptographyCallbackHandler extends AbstractCallbackHandler { } /** - * Template method that handles SignatureKeyCallbacks with PublicKeyBasedRequests. Called - * from handlePrivKeyCertRequest(). Default implementation throws an - * UnsupportedCallbackException. + * Template method that handles {@code SignatureKeyCallback}s with {@code PublicKeyBasedRequest}s. Called + * from {@code handlePrivKeyCertRequest()}. Default implementation throws an + * {@code UnsupportedCallbackException}. */ protected void handlePublicKeyBasedRequest(SignatureVerificationKeyCallback callback, SignatureVerificationKeyCallback.PublicKeyBasedRequest request) diff --git a/spring-ws-security/src/main/java/org/springframework/ws/soap/security/xwss/callback/DefaultTimestampValidator.java b/spring-ws-security/src/main/java/org/springframework/ws/soap/security/xwss/callback/DefaultTimestampValidator.java index fd79d6a9..4ae641a7 100644 --- a/spring-ws-security/src/main/java/org/springframework/ws/soap/security/xwss/callback/DefaultTimestampValidator.java +++ b/spring-ws-security/src/main/java/org/springframework/ws/soap/security/xwss/callback/DefaultTimestampValidator.java @@ -25,7 +25,7 @@ import java.util.GregorianCalendar; import com.sun.xml.wss.impl.callback.TimestampValidationCallback; /** - * A default implementation of a TimestampValidationCallback.TimestampValidator. Based on a version found + * A default implementation of a {@code TimestampValidationCallback.TimestampValidator}. Based on a version found * in the JWSDP samples. * * @author Arjen Poutsma diff --git a/spring-ws-security/src/main/java/org/springframework/ws/soap/security/xwss/callback/KeyStoreCallbackHandler.java b/spring-ws-security/src/main/java/org/springframework/ws/soap/security/xwss/callback/KeyStoreCallbackHandler.java index 6a1bece6..9386a2ee 100644 --- a/spring-ws-security/src/main/java/org/springframework/ws/soap/security/xwss/callback/KeyStoreCallbackHandler.java +++ b/spring-ws-security/src/main/java/org/springframework/ws/soap/security/xwss/callback/KeyStoreCallbackHandler.java @@ -46,31 +46,31 @@ import org.springframework.beans.factory.InitializingBean; import org.springframework.ws.soap.security.support.KeyStoreUtils; /** - * Callback handler that uses Java Security KeyStores to handle cryptographic callbacks. Allows for + * Callback handler that uses Java Security {@code KeyStore}s to handle cryptographic callbacks. Allows for * specific key stores to be set for various cryptographic operations. - *

    - * This handler requires one or more key stores to be set. You can configure them in your application context by using a - * KeyStoreFactoryBean. The exact stores to be set depends on the cryptographic operations that are to be + * + *

    This handler requires one or more key stores to be set. You can configure them in your application context by using a + * {@code KeyStoreFactoryBean}. The exact stores to be set depends on the cryptographic operations that are to be * performed by this handler. The table underneath show the key store to be used for each operation: * - * - * - * - * - *
    Cryptographic operation Key store used
    Certificate validation first keyStore, then trustStore
    Decryption based on private key keyStore
    Decryption based on symmetric - * key symmetricStore
    Encryption based on certificatetrustStore
    Encryption based on symmetric keysymmetricStore
    Signing keyStore
    Signature verification trustStore
    - *

    - *

    Default key stores

    If the symmetricStore is not set, it will default to the - * keyStore. If the key or trust store is not set, this handler will use the standard Java mechanism to + * Certificate validation first {@code keyStore}, then {@code trustStore} + * Decryption based on private key {@code keyStore} Decryption based on symmetric + * key {@code symmetricStore} Encryption based on certificate + * {@code trustStore} Encryption based on symmetric key + * {@code symmetricStore} Signing {@code keyStore} + * Signature verification {@code trustStore} + * + *

    Default key stores

    If the {@code symmetricStore} is not set, it will default to the + * {@code keyStore}. If the key or trust store is not set, this handler will use the standard Java mechanism to * load or create it. See {@link #loadDefaultKeyStore()} and {@link #loadDefaultTrustStore()}. - *

    - *

    Examples

    For instance, if you want to use the KeyStoreCallbackHandler to validate incoming + * + *

    Examples

    For instance, if you want to use the {@code KeyStoreCallbackHandler} to validate incoming * certificates or signatures, you would use a trust store, like so: *
      * <bean id="keyStoreHandler" class="org.springframework.ws.soap.security.xwss.callback.KeyStoreCallbackHandler">
      *     <property name="trustStore" ref="trustStore"/>
      * </bean>
    - * 

    + * * <bean id="trustStore" class="org.springframework.ws.soap.security.support.KeyStoreFactoryBean"> * <property name="location" value="classpath:truststore.jks"/> * <property name="password" value="changeit"/> @@ -83,16 +83,16 @@ import org.springframework.ws.soap.security.support.KeyStoreUtils; * <property name="keyStore" ref="keyStore"/> * <property name="privateKeyPassword" value="changeit"/> * </bean> - *

    + * * <bean id="keyStore" class="org.springframework.ws.soap.security.support.KeyStoreFactoryBean"> * <property name="location" value="classpath:keystore.jks"/> * <property name="password" value="changeit"/> * </bean> *

    - *

    - *

    Handled callbacks

    This class handles CertificateValidationCallbacks, - * DecryptionKeyCallbacks, EncryptionKeyCallbacks, SignatureKeyCallbacks, and - * SignatureVerificationKeyCallbacks. It throws an UnsupportedCallbackException for others. + * + *

    Handled callbacks

    This class handles {@code CertificateValidationCallback}s, + * {@code DecryptionKeyCallback}s, {@code EncryptionKeyCallback}s, {@code SignatureKeyCallback}s, and + * {@code SignatureVerificationKeyCallback}s. It throws an {@code UnsupportedCallbackException} for others. * * @author Arjen Poutsma * @see KeyStore @@ -196,7 +196,7 @@ public class KeyStoreCallbackHandler extends CryptographyCallbackHandler impleme /** * Sets the key store used for encryption and decryption using symmetric keys. If this property is not set, it - * defaults to the keyStore property. + * defaults to the {@code keyStore} property. * * @see org.springframework.ws.soap.security.support.KeyStoreFactoryBean * @see #setKeyStore(java.security.KeyStore) diff --git a/spring-ws-security/src/main/java/org/springframework/ws/soap/security/xwss/callback/MockValidationCallbackHandler.java b/spring-ws-security/src/main/java/org/springframework/ws/soap/security/xwss/callback/MockValidationCallbackHandler.java index 720c22c4..0de880ec 100644 --- a/spring-ws-security/src/main/java/org/springframework/ws/soap/security/xwss/callback/MockValidationCallbackHandler.java +++ b/spring-ws-security/src/main/java/org/springframework/ws/soap/security/xwss/callback/MockValidationCallbackHandler.java @@ -28,12 +28,12 @@ import org.springframework.ws.soap.security.callback.AbstractCallbackHandler; /** * Mock implementation of of callback handler that accepts all password and certificate validation callbacks. - *

    - * If the valid property is set to true (the default), this handler simply accepts and + * + *

    If the {@code valid} property is set to {@code true} (the default), this handler simply accepts and * validates every password or certificate validation callback that is passed to it. - *

    - * This class handles CertificateValidationCallbacks and PasswordValidationCallbacks, and - * throws an UnsupportedCallbackException for others + * + *

    This class handles {@code CertificateValidationCallback}s and {@code PasswordValidationCallback}s, and + * throws an {@code UnsupportedCallbackException} for others * * @author Arjen Poutsma * @since 1.0.0 diff --git a/spring-ws-security/src/main/java/org/springframework/ws/soap/security/xwss/callback/SimplePasswordValidationCallbackHandler.java b/spring-ws-security/src/main/java/org/springframework/ws/soap/security/xwss/callback/SimplePasswordValidationCallbackHandler.java index cde9f753..0ae25338 100644 --- a/spring-ws-security/src/main/java/org/springframework/ws/soap/security/xwss/callback/SimplePasswordValidationCallbackHandler.java +++ b/spring-ws-security/src/main/java/org/springframework/ws/soap/security/xwss/callback/SimplePasswordValidationCallbackHandler.java @@ -31,11 +31,11 @@ import org.springframework.util.Assert; import org.springframework.ws.soap.security.callback.AbstractCallbackHandler; /** - * Simple callback handler that validates passwords agains a in-memory Properties object. Password + * Simple callback handler that validates passwords agains a in-memory {@code Properties} object. Password * validation is done on a case-sensitive basis. - *

    - * This class only handles PasswordValidationCallbacks, and throws an - * UnsupportedCallbackException for others + * + *

    This class only handles {@code PasswordValidationCallback}s, and throws an + * {@code UnsupportedCallbackException} for others * * @author Arjen Poutsma * @see #setUsers(java.util.Properties) diff --git a/spring-ws-security/src/main/java/org/springframework/ws/soap/security/xwss/callback/SimpleUsernamePasswordCallbackHandler.java b/spring-ws-security/src/main/java/org/springframework/ws/soap/security/xwss/callback/SimpleUsernamePasswordCallbackHandler.java index 7623b838..fb0ac073 100644 --- a/spring-ws-security/src/main/java/org/springframework/ws/soap/security/xwss/callback/SimpleUsernamePasswordCallbackHandler.java +++ b/spring-ws-security/src/main/java/org/springframework/ws/soap/security/xwss/callback/SimpleUsernamePasswordCallbackHandler.java @@ -29,9 +29,9 @@ import org.springframework.ws.soap.security.callback.AbstractCallbackHandler; /** * Simple callback handler that supplies a username and password to a username token at runtime. - *

    - * This class handles UsernameCallbacks and PasswordCallbacks, and throws an - * UnsupportedCallbackException for others + * + *

    This class handles {@code UsernameCallback}s and {@code PasswordCallback}s, and throws an + * {@code UnsupportedCallbackException} for others * * @author Arjen Poutsma * @see #setUsername(String) diff --git a/spring-ws-security/src/main/java/org/springframework/ws/soap/security/xwss/callback/SpringCertificateValidationCallbackHandler.java b/spring-ws-security/src/main/java/org/springframework/ws/soap/security/xwss/callback/SpringCertificateValidationCallbackHandler.java index bfcd7fae..a6490454 100644 --- a/spring-ws-security/src/main/java/org/springframework/ws/soap/security/xwss/callback/SpringCertificateValidationCallbackHandler.java +++ b/spring-ws-security/src/main/java/org/springframework/ws/soap/security/xwss/callback/SpringCertificateValidationCallbackHandler.java @@ -34,14 +34,16 @@ import org.springframework.ws.soap.security.callback.CleanupCallback; import org.springframework.ws.soap.security.x509.X509AuthenticationToken; /** - * Callback handler that validates a certificate using an Spring Security AuthenticationManager. Logic - * based on Spring Security's X509ProcessingFilter.

    Spring Security - * X509AuthenticationToken is created with the certificate as the credentials.

    The configured - * authentication manager is expected to supply a provider which can handle this token (usually an instance of - * X509AuthenticationProvider).

    - *

    - * This class only handles CertificateValidationCallbacks, and throws an - * UnsupportedCallbackException for others. + * Callback handler that validates a certificate using an Spring Security {@code AuthenticationManager}. Logic + * based on Spring Security's {@code X509ProcessingFilter}. + * + *

    Spring Security {@code X509AuthenticationToken} is created with the certificate as the credentials. + * + *

    The configured authentication manager is expected to supply a provider which can handle this token (usually an instance of + * {@code X509AuthenticationProvider}).

    + * + *

    This class only handles {@code CertificateValidationCallback}s, and throws an + * {@code UnsupportedCallbackException} for others. * * @author Arjen Poutsma * @see org.springframework.ws.soap.security.x509.X509AuthenticationToken @@ -70,7 +72,7 @@ public class SpringCertificateValidationCallbackHandler extends AbstractCallback } /** - * Handles CertificateValidationCallbacks, and throws an UnsupportedCallbackException for + * Handles {@code CertificateValidationCallback}s, and throws an {@code UnsupportedCallbackException} for * others * * @throws javax.security.auth.callback.UnsupportedCallbackException diff --git a/spring-ws-security/src/main/java/org/springframework/ws/soap/security/xwss/callback/SpringDigestPasswordValidationCallbackHandler.java b/spring-ws-security/src/main/java/org/springframework/ws/soap/security/xwss/callback/SpringDigestPasswordValidationCallbackHandler.java index b4e44f96..9c028444 100644 --- a/spring-ws-security/src/main/java/org/springframework/ws/soap/security/xwss/callback/SpringDigestPasswordValidationCallbackHandler.java +++ b/spring-ws-security/src/main/java/org/springframework/ws/soap/security/xwss/callback/SpringDigestPasswordValidationCallbackHandler.java @@ -38,14 +38,14 @@ import org.springframework.ws.soap.security.callback.CleanupCallback; import org.springframework.ws.soap.security.support.SpringSecurityUtils; /** - * Callback handler that validates a password digest using an Spring Security UserDetailsService. Logic - * based on Spring Security's DigestProcessingFilter. - *

    - * An Spring Security UserDetailService is used to load UserDetails from. The digest of the + * Callback handler that validates a password digest using an Spring Security {@code UserDetailsService}. Logic + * based on Spring Security's {@code DigestProcessingFilter}. + * + *

    An Spring Security {@code UserDetailService} is used to load {@code UserDetails} from. The digest of the * password contained in this details object is then compared with the digest in the message. - *

    - * This class only handles PasswordValidationCallbacks that contain a DigestPasswordRequest, - * and throws an UnsupportedCallbackException for others. + * + *

    This class only handles {@code PasswordValidationCallback}s that contain a {@code DigestPasswordRequest}, + * and throws an {@code UnsupportedCallbackException} for others. * * @author Arjen Poutsma * @see org.springframework.security.core.userdetails.UserDetailsService @@ -75,8 +75,8 @@ public class SpringDigestPasswordValidationCallbackHandler extends AbstractCallb } /** - * Handles PasswordValidationCallbacks that contain a DigestPasswordRequest, and throws an - * UnsupportedCallbackException for others + * Handles {@code PasswordValidationCallback}s that contain a {@code DigestPasswordRequest}, and throws an + * {@code UnsupportedCallbackException} for others * * @throws javax.security.auth.callback.UnsupportedCallbackException * when the callback is not supported diff --git a/spring-ws-security/src/main/java/org/springframework/ws/soap/security/xwss/callback/SpringPlainTextPasswordValidationCallbackHandler.java b/spring-ws-security/src/main/java/org/springframework/ws/soap/security/xwss/callback/SpringPlainTextPasswordValidationCallbackHandler.java index 76bfc1b4..0bca6a82 100644 --- a/spring-ws-security/src/main/java/org/springframework/ws/soap/security/xwss/callback/SpringPlainTextPasswordValidationCallbackHandler.java +++ b/spring-ws-security/src/main/java/org/springframework/ws/soap/security/xwss/callback/SpringPlainTextPasswordValidationCallbackHandler.java @@ -33,15 +33,15 @@ import org.springframework.ws.soap.security.callback.AbstractCallbackHandler; import org.springframework.ws.soap.security.callback.CleanupCallback; /** - * Callback handler that validates a certificate uses an Spring Security AuthenticationManager. Logic based - * on Spring Security's BasicProcessingFilter. - *

    - * This handler requires an Spring Security AuthenticationManager to operate. It can be set using the - * authenticationManager property. An Spring Security UsernamePasswordAuthenticationToken is + * Callback handler that validates a certificate uses an Spring Security {@code AuthenticationManager}. Logic based + * on Spring Security's {@code BasicProcessingFilter}. + * + *

    This handler requires an Spring Security {@code AuthenticationManager} to operate. It can be set using the + * {@code authenticationManager} property. An Spring Security {@code UsernamePasswordAuthenticationToken} is * created with the username as principal and password as credentials. - *

    - * This class only handles PasswordValidationCallbacks that contain a - * PlainTextPasswordRequest, and throws an UnsupportedCallbackException for others. + * + *

    This class only handles {@code PasswordValidationCallback}s that contain a + * {@code PlainTextPasswordRequest}, and throws an {@code UnsupportedCallbackException} for others. * * @author Arjen Poutsma * @see org.springframework.security.authentication.UsernamePasswordAuthenticationToken @@ -71,8 +71,8 @@ public class SpringPlainTextPasswordValidationCallbackHandler extends AbstractCa } /** - * Handles PasswordValidationCallbacks that contain a PlainTextPasswordRequest, and throws - * an UnsupportedCallbackException for others. + * Handles {@code PasswordValidationCallback}s that contain a {@code PlainTextPasswordRequest}, and throws + * an {@code UnsupportedCallbackException} for others. * * @throws javax.security.auth.callback.UnsupportedCallbackException * when the callback is not supported diff --git a/spring-ws-security/src/main/java/org/springframework/ws/soap/security/xwss/callback/SpringUsernamePasswordCallbackHandler.java b/spring-ws-security/src/main/java/org/springframework/ws/soap/security/xwss/callback/SpringUsernamePasswordCallbackHandler.java index 9e8a47ad..f821d05e 100644 --- a/spring-ws-security/src/main/java/org/springframework/ws/soap/security/xwss/callback/SpringUsernamePasswordCallbackHandler.java +++ b/spring-ws-security/src/main/java/org/springframework/ws/soap/security/xwss/callback/SpringUsernamePasswordCallbackHandler.java @@ -30,9 +30,9 @@ import org.springframework.ws.soap.security.callback.AbstractCallbackHandler; /** * Callback handler that adds username/password information to a mesage using an Spring Security {@link * org.springframework.security.core.context.SecurityContext}. - *

    - * This class handles UsernameCallbacks and PasswordCallbacks, and throws an - * UnsupportedCallbackException for others + * + *

    This class handles {@code UsernameCallback}s and {@code PasswordCallback}s, and throws an + * {@code UnsupportedCallbackException} for others * * @author Arjen Poutsma * @since 1.5.0 diff --git a/spring-ws-security/src/main/java/org/springframework/ws/soap/security/xwss/callback/XwssCallbackHandlerChain.java b/spring-ws-security/src/main/java/org/springframework/ws/soap/security/xwss/callback/XwssCallbackHandlerChain.java index a567b6ec..4938bda3 100644 --- a/spring-ws-security/src/main/java/org/springframework/ws/soap/security/xwss/callback/XwssCallbackHandlerChain.java +++ b/spring-ws-security/src/main/java/org/springframework/ws/soap/security/xwss/callback/XwssCallbackHandlerChain.java @@ -29,8 +29,8 @@ import com.sun.xml.wss.impl.callback.TimestampValidationCallback; import org.springframework.ws.soap.security.callback.CallbackHandlerChain; /** - * Represents a chain of CallbackHandlers. For each callback, each of the handlers is called in term. If a - * handler throws a UnsupportedCallbackException, the next handler is tried. + * Represents a chain of {@code CallbackHandler}s. For each callback, each of the handlers is called in term. If a + * handler throws a {@code UnsupportedCallbackException}, the next handler is tried. * * @author Arjen Poutsma * @since 1.0.0 diff --git a/spring-ws-security/src/main/java/org/springframework/ws/soap/security/xwss/callback/jaas/JaasCertificateValidationCallbackHandler.java b/spring-ws-security/src/main/java/org/springframework/ws/soap/security/xwss/callback/jaas/JaasCertificateValidationCallbackHandler.java index 57945550..4cc2d617 100644 --- a/spring-ws-security/src/main/java/org/springframework/ws/soap/security/xwss/callback/jaas/JaasCertificateValidationCallbackHandler.java +++ b/spring-ws-security/src/main/java/org/springframework/ws/soap/security/xwss/callback/jaas/JaasCertificateValidationCallbackHandler.java @@ -26,11 +26,11 @@ import javax.security.auth.login.LoginException; import com.sun.xml.wss.impl.callback.CertificateValidationCallback; /** - * Provides basic support for integrating with JAAS and certificates. Requires the loginContextName to be - * set.Requires a LoginContext which handles X500Principals. - *

    - * This class only handles CertificateValidationCallbacks, and throws an - * UnsupportedCallbackException for others. + * Provides basic support for integrating with JAAS and certificates. Requires the {@code loginContextName} to be + * set.Requires a {@code LoginContext} which handles {@code X500Principal}s. + * + *

    This class only handles {@code CertificateValidationCallback}s, and throws an + * {@code UnsupportedCallbackException} for others. * * @author Arjen Poutsma * @see javax.security.auth.x500.X500Principal @@ -40,7 +40,7 @@ import com.sun.xml.wss.impl.callback.CertificateValidationCallback; public class JaasCertificateValidationCallbackHandler extends AbstractJaasValidationCallbackHandler { /** - * Handles CertificateValidationCallbacks, and throws an UnsupportedCallbackException for + * Handles {@code CertificateValidationCallback}s, and throws an {@code UnsupportedCallbackException} for * others * * @throws UnsupportedCallbackException when the callback is not supported diff --git a/spring-ws-security/src/main/java/org/springframework/ws/soap/security/xwss/callback/jaas/JaasPlainTextPasswordValidationCallbackHandler.java b/spring-ws-security/src/main/java/org/springframework/ws/soap/security/xwss/callback/jaas/JaasPlainTextPasswordValidationCallbackHandler.java index 1597591c..23e4e5ae 100644 --- a/spring-ws-security/src/main/java/org/springframework/ws/soap/security/xwss/callback/jaas/JaasPlainTextPasswordValidationCallbackHandler.java +++ b/spring-ws-security/src/main/java/org/springframework/ws/soap/security/xwss/callback/jaas/JaasPlainTextPasswordValidationCallbackHandler.java @@ -30,9 +30,9 @@ import org.springframework.ws.soap.security.callback.AbstractCallbackHandler; /** * Provides basic support for integrating with JAAS and plain text passwords. - *

    - * This class only handles PasswordValidationCallbacks that contain a - * PlainTextPasswordRequest, and throws an UnsupportedCallbackException for others. + * + *

    This class only handles {@code PasswordValidationCallback}s that contain a + * {@code PlainTextPasswordRequest}, and throws an {@code UnsupportedCallbackException} for others. * * @author Arjen Poutsma * @see #getLoginContextName() @@ -41,8 +41,8 @@ import org.springframework.ws.soap.security.callback.AbstractCallbackHandler; public class JaasPlainTextPasswordValidationCallbackHandler extends AbstractJaasValidationCallbackHandler { /** - * Handles PasswordValidationCallbacks that contain a PlainTextPasswordRequest, and throws - * an UnsupportedCallbackException for others. + * Handles {@code PasswordValidationCallback}s that contain a {@code PlainTextPasswordRequest}, and throws + * an {@code UnsupportedCallbackException} for others. * * @throws UnsupportedCallbackException when the callback is not supported */ diff --git a/spring-ws-support/src/main/java/org/springframework/ws/transport/http/HttpExchangeConnection.java b/spring-ws-support/src/main/java/org/springframework/ws/transport/http/HttpExchangeConnection.java index dfd0f109..d2b75e2c 100644 --- a/spring-ws-support/src/main/java/org/springframework/ws/transport/http/HttpExchangeConnection.java +++ b/spring-ws-support/src/main/java/org/springframework/ws/transport/http/HttpExchangeConnection.java @@ -53,13 +53,13 @@ public class HttpExchangeConnection extends AbstractReceiverConnection private boolean chunkedEncoding; - /** Constructs a new exchange connection with the given HttpExchange. */ + /** Constructs a new exchange connection with the given {@code HttpExchange}. */ protected HttpExchangeConnection(HttpExchange httpExchange) { Assert.notNull(httpExchange, "'httpExchange' must not be null"); this.httpExchange = httpExchange; } - /** Returns the HttpExchange for this connection. */ + /** Returns the {@code HttpExchange} for this connection. */ public HttpExchange getHttpExchange() { return httpExchange; } diff --git a/spring-ws-support/src/main/java/org/springframework/ws/transport/http/HttpsUrlConnectionMessageSender.java b/spring-ws-support/src/main/java/org/springframework/ws/transport/http/HttpsUrlConnectionMessageSender.java index 416cee43..27bcb704 100644 --- a/spring-ws-support/src/main/java/org/springframework/ws/transport/http/HttpsUrlConnectionMessageSender.java +++ b/spring-ws-support/src/main/java/org/springframework/ws/transport/http/HttpsUrlConnectionMessageSender.java @@ -81,8 +81,8 @@ public class HttpsUrlConnectionMessageSender extends HttpUrlConnectionMessageSen /** * Specifies the key managers to use for this message sender. - *

    - * Setting either this property or {@link #setTrustManagers(TrustManager[]) trustManagers} is required. + * + *

    Setting either this property or {@link #setTrustManagers(TrustManager[]) trustManagers} is required. * * @see SSLContext#init(KeyManager[], TrustManager[], SecureRandom) */ @@ -92,8 +92,8 @@ public class HttpsUrlConnectionMessageSender extends HttpUrlConnectionMessageSen /** * Specifies the trust managers to use for this message sender. - *

    - * Setting either this property or {@link #setKeyManagers(KeyManager[]) keyManagers} is required. + * + *

    Setting either this property or {@link #setKeyManagers(KeyManager[]) keyManagers} is required. * * @see SSLContext#init(KeyManager[], TrustManager[], SecureRandom) */ diff --git a/spring-ws-support/src/main/java/org/springframework/ws/transport/http/WebServiceMessageReceiverHttpHandler.java b/spring-ws-support/src/main/java/org/springframework/ws/transport/http/WebServiceMessageReceiverHttpHandler.java index 6a769703..b57ece85 100644 --- a/spring-ws-support/src/main/java/org/springframework/ws/transport/http/WebServiceMessageReceiverHttpHandler.java +++ b/spring-ws-support/src/main/java/org/springframework/ws/transport/http/WebServiceMessageReceiverHttpHandler.java @@ -26,8 +26,8 @@ import org.springframework.ws.transport.support.SimpleWebServiceMessageReceiverO /** * {@link HttpHandler} that can be used to handle incoming {@link HttpExchange} service requests. Designed for Sun's JRE * 1.6 HTTP server. - *

    - * Requires a {@link org.springframework.ws.WebServiceMessageFactory} which is used to convert the incoming {@link + * + *

    Requires a {@link org.springframework.ws.WebServiceMessageFactory} which is used to convert the incoming {@link * HttpExchange} into a {@link org.springframework.ws.WebServiceMessage}, and passes that to the {@link * org.springframework.ws.transport.WebServiceMessageReceiver} {@link #setMessageReceiver(org.springframework.ws.transport.WebServiceMessageReceiver) * registered}. @@ -41,7 +41,7 @@ public class WebServiceMessageReceiverHttpHandler extends SimpleWebServiceMessag private boolean chunkedEncoding = false; - /** Enables chunked encoding on response bodies. Defaults to false. */ + /** Enables chunked encoding on response bodies. Defaults to {@code false}. */ public void setChunkedEncoding(boolean chunkedEncoding) { this.chunkedEncoding = chunkedEncoding; } diff --git a/spring-ws-support/src/main/java/org/springframework/ws/transport/jms/JmsMessageReceiver.java b/spring-ws-support/src/main/java/org/springframework/ws/transport/jms/JmsMessageReceiver.java index 0f89ee39..9352c159 100644 --- a/spring-ws-support/src/main/java/org/springframework/ws/transport/jms/JmsMessageReceiver.java +++ b/spring-ws-support/src/main/java/org/springframework/ws/transport/jms/JmsMessageReceiver.java @@ -28,10 +28,10 @@ import org.springframework.ws.transport.support.SimpleWebServiceMessageReceiverO /** * Convenience base class for JMS server-side transport objects. Contains a {@link WebServiceMessageReceiver}, and has * methods for handling incoming JMS {@link BytesMessage} and {@link TextMessage} requests. Also contains a - * textMessageEncoding property, which determines the encoding used to read from and write to - * TextMessages. This property defaults to UTF-8. - *

    - * Used by {@link WebServiceMessageListener}. + * {@code textMessageEncoding} property, which determines the encoding used to read from and write to + * {@code TextMessages}. This property defaults to {@code UTF-8}. + * + *

    Used by {@link WebServiceMessageListener}. * * @author Arjen Poutsma * @since 1.5.0 @@ -45,7 +45,7 @@ public class JmsMessageReceiver extends SimpleWebServiceMessageReceiverObjectSup private MessagePostProcessor postProcessor; - /** Sets the encoding used to read from and write to {@link TextMessage} messages. Defaults to UTF-8. */ + /** Sets the encoding used to read from and write to {@link TextMessage} messages. Defaults to {@code UTF-8}. */ public void setTextMessageEncoding(String textMessageEncoding) { this.textMessageEncoding = textMessageEncoding; } diff --git a/spring-ws-support/src/main/java/org/springframework/ws/transport/jms/JmsMessageSender.java b/spring-ws-support/src/main/java/org/springframework/ws/transport/jms/JmsMessageSender.java index dedf9a01..f8414e9a 100644 --- a/spring-ws-support/src/main/java/org/springframework/ws/transport/jms/JmsMessageSender.java +++ b/spring-ws-support/src/main/java/org/springframework/ws/transport/jms/JmsMessageSender.java @@ -43,12 +43,12 @@ import org.springframework.ws.transport.jms.support.JmsTransportUtils; /** * {@link WebServiceMessageSender} implementation that uses JMS {@link Message}s. Requires a JMS {@link * ConnectionFactory} to operate. - *

    - * This message sender supports URI's of the following format:

    jms:destination[?param-name=param-value][&param-name=param-value]* + * + *

    This message sender supports URI's of the following format:

    jms:destination[?param-name=param-value][&param-name=param-value]* *
    where the characters :, ?, and & stand for * themselves. The destination represents the name of the {@link Queue} or {@link Topic} that will be resolved by * the {@link #getDestinationResolver() destination resolver}. Valid param-name include: - *

    + * *

    * * @@ -78,15 +78,15 @@ import org.springframework.ws.transport.jms.support.JmsTransportUtils; * *
    param-nameDescription
    *
    - *

    - * If the replyToName is not set, a {@link Session#createTemporaryQueue() temporary queue} is used. - *

    - * This class uses {@link BytesMessage} messages by default, but can be configured to send {@link TextMessage} messages - * instead. Note that BytesMessages are preferred, since TextMessages do not support + * + *

    If the replyToName is not set, a {@link Session#createTemporaryQueue() temporary queue} is used. + * + *

    This class uses {@link BytesMessage} messages by default, but can be configured to send {@link TextMessage} messages + * instead. Note that {@code BytesMessages} are preferred, since {@code TextMessages} do not support * attachments and character encodings reliably. - *

    - * Some examples of JMS URIs are: - *

    + * + *

    Some examples of JMS URIs are: + * *

    jms:SomeQueue
    jms:SomeTopic?priority=3&deliveryMode=NON_PERSISTENT
    * jms:RequestQueue?replyToName=ResponseQueueName
    jms:Queue?messageType=TEXT_MESSAGE
    * @@ -109,9 +109,9 @@ public class JmsMessageSender extends JmsDestinationAccessor implements WebServi private MessagePostProcessor postProcessor; /** - * Create a new JmsMessageSender - *

    - * Note: The ConnectionFactory has to be set before using the instance. This constructor can be used to + * Create a new {@code JmsMessageSender} + * + *

    Note: The ConnectionFactory has to be set before using the instance. This constructor can be used to * prepare a JmsTemplate via a BeanFactory, typically setting the ConnectionFactory via {@link * #setConnectionFactory(ConnectionFactory)}. * @@ -121,7 +121,7 @@ public class JmsMessageSender extends JmsDestinationAccessor implements WebServi } /** - * Create a new JmsMessageSender, given a ConnectionFactory. + * Create a new {@code JmsMessageSender}, given a ConnectionFactory. * * @param connectionFactory the ConnectionFactory to obtain Connections from */ @@ -138,7 +138,7 @@ public class JmsMessageSender extends JmsDestinationAccessor implements WebServi this.receiveTimeout = receiveTimeout; } - /** Sets the encoding used to read from {@link TextMessage} messages. Defaults to UTF-8. */ + /** Sets the encoding used to read from {@link TextMessage} messages. Defaults to {@code UTF-8}. */ public void setTextMessageEncoding(String textMessageEncoding) { this.textMessageEncoding = textMessageEncoding; } diff --git a/spring-ws-support/src/main/java/org/springframework/ws/transport/jms/JmsReceiverConnection.java b/spring-ws-support/src/main/java/org/springframework/ws/transport/jms/JmsReceiverConnection.java index 03431c81..1695b877 100644 --- a/spring-ws-support/src/main/java/org/springframework/ws/transport/jms/JmsReceiverConnection.java +++ b/spring-ws-support/src/main/java/org/springframework/ws/transport/jms/JmsReceiverConnection.java @@ -40,10 +40,10 @@ import org.springframework.ws.transport.jms.support.JmsTransportUtils; /** * Implementation of {@link WebServiceConnection} that is used for server-side JMS access. Exposes a {@link * BytesMessage} or {@link TextMessage} request and response message. - *

    - * The response message type is equal to the request message type, i.e. if a BytesMessage is received as - * request, a BytesMessage is created as response, and if a TextMessage is received, a - * TextMessage response is created. + * + *

    The response message type is equal to the request message type, i.e. if a {@code BytesMessage} is received as + * request, a {@code BytesMessage} is created as response, and if a {@code TextMessage} is received, a + * {@code TextMessage} response is created. * * @author Arjen Poutsma * @since 1.5.0 diff --git a/spring-ws-support/src/main/java/org/springframework/ws/transport/jms/WebServiceMessageListener.java b/spring-ws-support/src/main/java/org/springframework/ws/transport/jms/WebServiceMessageListener.java index a6532e8c..b2e3476a 100644 --- a/spring-ws-support/src/main/java/org/springframework/ws/transport/jms/WebServiceMessageListener.java +++ b/spring-ws-support/src/main/java/org/springframework/ws/transport/jms/WebServiceMessageListener.java @@ -28,8 +28,8 @@ import org.springframework.ws.transport.WebServiceMessageReceiver; /** * Spring {@link SessionAwareMessageListener} that can be used to handle incoming {@link Message} service requests. - *

    - * Requires a {@link WebServiceMessageFactory} which is used to convert the incoming JMS {@link BytesMessage} into a + * + *

    Requires a {@link WebServiceMessageFactory} which is used to convert the incoming JMS {@link BytesMessage} into a * {@link WebServiceMessage}, and passes that to the {@link WebServiceMessageReceiver} {@link * #setMessageReceiver(WebServiceMessageReceiver) registered}. * diff --git a/spring-ws-support/src/main/java/org/springframework/ws/transport/jms/support/JmsTransportUtils.java b/spring-ws-support/src/main/java/org/springframework/ws/transport/jms/support/JmsTransportUtils.java index 11941746..167aafb3 100644 --- a/spring-ws-support/src/main/java/org/springframework/ws/transport/jms/support/JmsTransportUtils.java +++ b/spring-ws-support/src/main/java/org/springframework/ws/transport/jms/support/JmsTransportUtils.java @@ -96,7 +96,7 @@ public abstract class JmsTransportUtils { } /** - * Converts the given JMS destination into a jms URI. + * Converts the given JMS destination into a {@code jms} URI. * * @param destination the destination * @return a jms URI diff --git a/spring-ws-support/src/main/java/org/springframework/ws/transport/mail/MailMessageReceiver.java b/spring-ws-support/src/main/java/org/springframework/ws/transport/mail/MailMessageReceiver.java index fe8bcef3..24e6dde4 100644 --- a/spring-ws-support/src/main/java/org/springframework/ws/transport/mail/MailMessageReceiver.java +++ b/spring-ws-support/src/main/java/org/springframework/ws/transport/mail/MailMessageReceiver.java @@ -42,8 +42,8 @@ import org.springframework.ws.transport.support.AbstractAsyncStandaloneMessageRe * transport} URI, {@link #setStoreUri(String) store} URI, and {@link #setMonitoringStrategy(MonitoringStrategy) * monitoringStrategy} to be set, in addition to the {@link #setMessageFactory(WebServiceMessageFactory) messageFactory} * and {@link #setMessageReceiver(WebServiceMessageReceiver) messageReceiver} required by the base class. - *

    - * The {@link MonitoringStrategy} is used to detect new incoming email request. If the monitoringStrategy + * + *

    The {@link MonitoringStrategy} is used to detect new incoming email request. If the {@code monitoringStrategy} * is not explicitly set, this receiver will use the {@link Pop3PollingMonitoringStrategy} for POP3 servers, and the * {@link PollingMonitoringStrategy} for IMAP servers. * @@ -73,24 +73,24 @@ public class MailMessageReceiver extends AbstractAsyncStandaloneMessageReceiver /** * Set JavaMail properties for the {@link Session}. - *

    - * A new {@link Session} will be created with those properties. Use either this method or {@link #setSession}, but + * + *

    A new {@link Session} will be created with those properties. Use either this method or {@link #setSession}, but * not both. - *

    - * Non-default properties in this instance will override given JavaMail properties. + * + *

    Non-default properties in this instance will override given JavaMail properties. */ public void setJavaMailProperties(Properties javaMailProperties) { session = Session.getInstance(javaMailProperties, null); } /** - * Set the JavaMail Session, possibly pulled from JNDI. - *

    - * Default is a new Session without defaults, that is completely configured via this instance's + * Set the JavaMail {@code Session}, possibly pulled from JNDI. + * + *

    Default is a new {@code Session} without defaults, that is completely configured via this instance's * properties. - *

    - * If using a pre-configured Session, non-default properties in this instance will override the - * settings in the Session. + * + *

    If using a pre-configured {@code Session}, non-default properties in this instance will override the + * settings in the {@code Session}. * * @see #setJavaMailProperties */ @@ -101,9 +101,9 @@ public class MailMessageReceiver extends AbstractAsyncStandaloneMessageReceiver /** * Sets the JavaMail Store URI to be used for retrieving request messages. Typically takes the form of - * [imap|pop3]://user:password@host:port/INBOX. Setting this property is required. - *

    - * For example, imap://john:secret@imap.example.com/INBOX + * {@code [imap|pop3]://user:password@host:port/INBOX}. Setting this property is required. + * + *

    For example, {@code imap://john:secret@imap.example.com/INBOX} * * @see Session#getStore(URLName) */ @@ -113,9 +113,9 @@ public class MailMessageReceiver extends AbstractAsyncStandaloneMessageReceiver /** * Sets the JavaMail Transport URI to be used for sending response messages. Typically takes the form of - * smtp://user:password@host:port. Setting this property is required. - *

    - * For example, smtp://john:secret@smtp.example.com + * {@code smtp://user:password@host:port}. Setting this property is required. + * + *

    For example, {@code smtp://john:secret@smtp.example.com} * * @see Session#getTransport(URLName) */ diff --git a/spring-ws-support/src/main/java/org/springframework/ws/transport/mail/MailMessageSender.java b/spring-ws-support/src/main/java/org/springframework/ws/transport/mail/MailMessageSender.java index 239e2f74..c11ef205 100644 --- a/spring-ws-support/src/main/java/org/springframework/ws/transport/mail/MailMessageSender.java +++ b/spring-ws-support/src/main/java/org/springframework/ws/transport/mail/MailMessageSender.java @@ -36,23 +36,23 @@ import org.springframework.ws.transport.mail.support.MailTransportUtils; /** * {@link WebServiceMessageSender} implementation that uses Mail {@link MimeMessage}s. Requires a {@link * #setTransportUri(String) transport} and {@link #setStoreUri(String) store} URI to be set. - *

    - * Calling {@link WebServiceConnection#receive(WebServiceMessageFactory)} on connections created by this message sender + * + *

    Calling {@link WebServiceConnection#receive(WebServiceMessageFactory)} on connections 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 value must not be smaller the * {@link PollingMonitoringStrategy#setPollingInterval(long) pollingInterval} property of the server-side message * receiver polling strategy. - *

    - * This message sender supports URI's of the following format:

    mailto:to[?param-name=param-value][&param-name=param-value]* + * + *

    This message sender supports URI's of the following format:

    mailto:to[?param-name=param-value][&param-name=param-value]* *
    where the characters :, ?, and & stand for * themselves. The to represents a RFC 822 mailbox. Valid param-name include: - *

    + * *

    *
    param-nameDescription
    subjectThe subject of the request message.
    - *

    - * Some examples of email URIs are: - *

    + * + *

    Some examples of email URIs are: + * *

    mailto:john@example.com
    mailto:john@example.com@?subject=SOAP%20Test
    * * @author Arjen Poutsma @@ -85,11 +85,11 @@ public class MailMessageSender implements WebServiceMessageSender, InitializingB /** * Set JavaMail properties for the {@link Session}. - *

    - * A new {@link Session} will be created with those properties. Use either this method or {@link #setSession}, but + * + *

    A new {@link Session} will be created with those properties. Use either this method or {@link #setSession}, but * not both. - *

    - * Non-default properties in this instance will override given JavaMail properties. + * + *

    Non-default properties in this instance will override given JavaMail properties. */ public void setJavaMailProperties(Properties javaMailProperties) { session = Session.getInstance(javaMailProperties, null); @@ -104,13 +104,13 @@ public class MailMessageSender implements WebServiceMessageSender, InitializingB } /** - * Set the JavaMail Session, possibly pulled from JNDI. - *

    - * Default is a new Session without defaults, that is completely configured via this instance's + * Set the JavaMail {@code Session}, possibly pulled from JNDI. + * + *

    Default is a new {@code Session} without defaults, that is completely configured via this instance's * properties. - *

    - * If using a pre-configured Session, non-default properties in this instance will override the - * settings in the Session. + * + *

    If using a pre-configured {@code Session}, non-default properties in this instance will override the + * settings in the {@code Session}. * * @see #setJavaMailProperties */ @@ -121,9 +121,9 @@ public class MailMessageSender implements WebServiceMessageSender, InitializingB /** * Sets the JavaMail Store URI to be used for retrieving response messages. Typically takes the form of - * [imap|pop3]://user:password@host:port/INBOX. Setting this property is required. - *

    - * For example, imap://john:secret@imap.example.com/INBOX + * {@code [imap|pop3]://user:password@host:port/INBOX}. Setting this property is required. + * + *

    For example, {@code imap://john:secret@imap.example.com/INBOX} * * @see Session#getStore(URLName) */ @@ -133,9 +133,9 @@ public class MailMessageSender implements WebServiceMessageSender, InitializingB /** * Sets the JavaMail Transport URI to be used for sending response messages. Typically takes the form of - * smtp://user:password@host:port. Setting this property is required. - *

    - * For example, smtp://john:secret@smtp.example.com + * {@code smtp://user:password@host:port}. Setting this property is required. + * + *

    For example, {@code smtp://john:secret@smtp.example.com} * * @see Session#getTransport(URLName) */ diff --git a/spring-ws-support/src/main/java/org/springframework/ws/transport/mail/monitor/AbstractMonitoringStrategy.java b/spring-ws-support/src/main/java/org/springframework/ws/transport/mail/monitor/AbstractMonitoringStrategy.java index 8c76f6b0..e1c5eb4a 100644 --- a/spring-ws-support/src/main/java/org/springframework/ws/transport/mail/monitor/AbstractMonitoringStrategy.java +++ b/spring-ws-support/src/main/java/org/springframework/ws/transport/mail/monitor/AbstractMonitoringStrategy.java @@ -44,7 +44,7 @@ public abstract class AbstractMonitoringStrategy implements MonitoringStrategy { /** * Sets whether messages should be marked as {@link javax.mail.Flags.Flag#DELETED DELETED} after they have been - * read. Default is true. + * read. Default is {@code true}. */ public void setDeleteMessages(boolean deleteMessages) { this.deleteMessages = deleteMessages; @@ -59,7 +59,7 @@ public abstract class AbstractMonitoringStrategy implements MonitoringStrategy { * Monitors the given folder, and returns any new messages when they arrive. This implementation calls {@link * #waitForNewMessages(Folder)}, then searches for new messages using {@link #searchForNewMessages(Folder)}, fetches * the messages using {@link #fetchMessages(Folder, Message[])}, and finally {@link #setDeleteMessages(boolean) - * deletes} the messages, if {@link #setDeleteMessages(boolean) deleteMessages} is true. + * deletes} the messages, if {@link #setDeleteMessages(boolean) deleteMessages} is {@code true}. * * @param folder the folder to monitor * @return the new messages @@ -152,7 +152,7 @@ public abstract class AbstractMonitoringStrategy implements MonitoringStrategy { /** * Deletes the given messages from the given folder. Only invoked when {@link #setDeleteMessages(boolean)} is - * true. + * {@code true}. * * @param folder the folder to delete messages from * @param messages the messages to delete diff --git a/spring-ws-support/src/main/java/org/springframework/ws/transport/mail/monitor/ImapIdleMonitoringStrategy.java b/spring-ws-support/src/main/java/org/springframework/ws/transport/mail/monitor/ImapIdleMonitoringStrategy.java index 368f66ac..8e8fee05 100644 --- a/spring-ws-support/src/main/java/org/springframework/ws/transport/mail/monitor/ImapIdleMonitoringStrategy.java +++ b/spring-ws-support/src/main/java/org/springframework/ws/transport/mail/monitor/ImapIdleMonitoringStrategy.java @@ -30,8 +30,8 @@ import com.sun.mail.imap.IMAPFolder; /** * Implementation of the {@link MonitoringStrategy} interface that uses the IMAP IDLE command for asynchronous message * detection. - *

    - * Note that this implementation is only suitable for use with IMAP servers which support the IDLE command. + * + *

    Note that this implementation is only suitable for use with IMAP servers which support the IDLE command. * Additionally, this strategy requires JavaMail version 1.4.1. * * @author Arjen Poutsma diff --git a/spring-ws-support/src/main/java/org/springframework/ws/transport/mail/monitor/MonitoringStrategy.java b/spring-ws-support/src/main/java/org/springframework/ws/transport/mail/monitor/MonitoringStrategy.java index 0de64e54..e2ba35d5 100644 --- a/spring-ws-support/src/main/java/org/springframework/ws/transport/mail/monitor/MonitoringStrategy.java +++ b/spring-ws-support/src/main/java/org/springframework/ws/transport/mail/monitor/MonitoringStrategy.java @@ -22,7 +22,7 @@ import javax.mail.MessagingException; /** * Defines the contract for objects that monitor a given folder for new messages. Allows for multiple implementation - * strategies, including polling, or event-driven techniques such as IMAP's IDLE command. + * strategies, including polling, or event-driven techniques such as IMAP's {@code IDLE} command. * * @author Arjen Poutsma */ diff --git a/spring-ws-support/src/main/java/org/springframework/ws/transport/mail/monitor/PollingMonitoringStrategy.java b/spring-ws-support/src/main/java/org/springframework/ws/transport/mail/monitor/PollingMonitoringStrategy.java index 872102ac..51a58f53 100644 --- a/spring-ws-support/src/main/java/org/springframework/ws/transport/mail/monitor/PollingMonitoringStrategy.java +++ b/spring-ws-support/src/main/java/org/springframework/ws/transport/mail/monitor/PollingMonitoringStrategy.java @@ -22,8 +22,8 @@ import javax.mail.MessagingException; /** * Implementation of the {@link MonitoringStrategy} interface that uses a simple polling mechanism. Defines a {@link * #setPollingInterval(long) polling interval} property which defines the interval in between message polls. - *

    - * Note that this implementation is not suitable for use with POP3 servers. Use the {@link + * + *

    Note that this implementation is not suitable for use with POP3 servers. Use the {@link * Pop3PollingMonitoringStrategy} instead. * * @author Arjen Poutsma diff --git a/spring-ws-support/src/main/java/org/springframework/ws/transport/mail/monitor/Pop3PollingMonitoringStrategy.java b/spring-ws-support/src/main/java/org/springframework/ws/transport/mail/monitor/Pop3PollingMonitoringStrategy.java index db4929b3..1a5f7bf4 100644 --- a/spring-ws-support/src/main/java/org/springframework/ws/transport/mail/monitor/Pop3PollingMonitoringStrategy.java +++ b/spring-ws-support/src/main/java/org/springframework/ws/transport/mail/monitor/Pop3PollingMonitoringStrategy.java @@ -28,8 +28,8 @@ import org.springframework.ws.transport.mail.support.MailTransportUtils; * servers. Since POP3 does not have a native mechanism to determine which messages are "new", this implementation * simply retrieves all messages in the {@link Folder}, and delete them afterwards. All messages in the POP3 mailbox are * therefore, by definition, new. - *

    - * Setting the {@link #setDeleteMessages(boolean) deleteMessages} property is therefore ignored: messages are always + * + *

    Setting the {@link #setDeleteMessages(boolean) deleteMessages} property is therefore ignored: messages are always * deleted. * * @author Arjen Poutsma diff --git a/spring-ws-support/src/main/java/org/springframework/ws/transport/mail/support/MailTransportUtils.java b/spring-ws-support/src/main/java/org/springframework/ws/transport/mail/support/MailTransportUtils.java index d098606b..afa6c841 100644 --- a/spring-ws-support/src/main/java/org/springframework/ws/transport/mail/support/MailTransportUtils.java +++ b/spring-ws-support/src/main/java/org/springframework/ws/transport/mail/support/MailTransportUtils.java @@ -79,10 +79,10 @@ public abstract class MailTransportUtils { } /** - * Close the given JavaMail Service and ignore any thrown exception. This is useful for typical finally + * Close the given JavaMail Service and ignore any thrown exception. This is useful for typical {@code finally} * blocks in manual JavaMail code. * - * @param service the JavaMail Service to close (may be null) + * @param service the JavaMail Service to close (may be {@code null}) * @see Transport * @see Store */ @@ -98,10 +98,10 @@ public abstract class MailTransportUtils { } /** - * Close the given JavaMail Folder and ignore any thrown exception. This is useful for typical finally + * Close the given JavaMail Folder and ignore any thrown exception. This is useful for typical {@code finally} * blocks in manual JavaMail code. * - * @param folder the JavaMail Folder to close (may be null) + * @param folder the JavaMail Folder to close (may be {@code null}) */ public static void closeFolder(Folder folder) { @@ -109,10 +109,10 @@ public abstract class MailTransportUtils { } /** - * Close the given JavaMail Folder and ignore any thrown exception. This is useful for typical finally + * Close the given JavaMail Folder and ignore any thrown exception. This is useful for typical {@code finally} * blocks in manual JavaMail code. * - * @param folder the JavaMail Folder to close (may be null) + * @param folder the JavaMail Folder to close (may be {@code null}) * @param expunge whether all deleted messages should be expunged from the folder */ public static void closeFolder(Folder folder, boolean expunge) { @@ -169,10 +169,10 @@ public abstract class MailTransportUtils { } /** - * Converts the given internet address into a mailto URI. + * Converts the given internet address into a {@code mailto} URI. * * @param to the To: address - * @param subject the subject, may be null + * @param subject the subject, may be {@code null} * @return a mailto URI */ public static URI toUri(InternetAddress to, String subject) throws URISyntaxException { diff --git a/spring-ws-support/src/main/java/org/springframework/ws/transport/support/AbstractAsyncStandaloneMessageReceiver.java b/spring-ws-support/src/main/java/org/springframework/ws/transport/support/AbstractAsyncStandaloneMessageReceiver.java index b5af0941..0e19e07f 100644 --- a/spring-ws-support/src/main/java/org/springframework/ws/transport/support/AbstractAsyncStandaloneMessageReceiver.java +++ b/spring-ws-support/src/main/java/org/springframework/ws/transport/support/AbstractAsyncStandaloneMessageReceiver.java @@ -40,8 +40,8 @@ public abstract class AbstractAsyncStandaloneMessageReceiver extends AbstractSta /** * Set the Spring {@link TaskExecutor} to use for running the listener threads. Default is {@link * SimpleAsyncTaskExecutor}, starting up a number of new threads. - *

    - * Specify an alternative task executor for integration with an existing thread pool, such as the {@link + * + *

    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. */ public void setTaskExecutor(TaskExecutor taskExecutor) { @@ -63,8 +63,8 @@ public abstract class AbstractAsyncStandaloneMessageReceiver extends AbstractSta /** * Create a default TaskExecutor. Called if no explicit TaskExecutor has been specified. - *

    - * The default implementation builds a {@link org.springframework.core.task.SimpleAsyncTaskExecutor} with the + * + *

    The default implementation builds a {@link org.springframework.core.task.SimpleAsyncTaskExecutor} with the * specified bean name (or the class name, if no bean name specified) as thread name prefix. * * @see org.springframework.core.task.SimpleAsyncTaskExecutor#SimpleAsyncTaskExecutor(String) diff --git a/spring-ws-support/src/main/java/org/springframework/ws/transport/support/AbstractStandaloneMessageReceiver.java b/spring-ws-support/src/main/java/org/springframework/ws/transport/support/AbstractStandaloneMessageReceiver.java index 9120c490..2e72a069 100644 --- a/spring-ws-support/src/main/java/org/springframework/ws/transport/support/AbstractStandaloneMessageReceiver.java +++ b/spring-ws-support/src/main/java/org/springframework/ws/transport/support/AbstractStandaloneMessageReceiver.java @@ -54,8 +54,8 @@ public abstract class AbstractStandaloneMessageReceiver extends SimpleWebService /** * Set whether to automatically start the receiver after initialization. - *

    - * Default is true; set this to false to allow for manual startup. + * + *

    Default is {@code true}; set this to {@code false} to allow for manual startup. */ public void setAutoStartup(boolean autoStartup) { this.autoStartup = autoStartup; diff --git a/spring-ws-support/src/main/java/org/springframework/ws/transport/support/SimpleWebServiceMessageReceiverObjectSupport.java b/spring-ws-support/src/main/java/org/springframework/ws/transport/support/SimpleWebServiceMessageReceiverObjectSupport.java index 251f82a0..57522b86 100644 --- a/spring-ws-support/src/main/java/org/springframework/ws/transport/support/SimpleWebServiceMessageReceiverObjectSupport.java +++ b/spring-ws-support/src/main/java/org/springframework/ws/transport/support/SimpleWebServiceMessageReceiverObjectSupport.java @@ -34,14 +34,14 @@ public abstract class SimpleWebServiceMessageReceiverObjectSupport extends WebSe private WebServiceMessageReceiver messageReceiver; /** - * Returns the WebServiceMessageReceiver used by this listener. + * Returns the {@code WebServiceMessageReceiver} used by this listener. */ public WebServiceMessageReceiver getMessageReceiver() { return messageReceiver; } /** - * Sets the WebServiceMessageReceiver used by this listener. + * Sets the {@code WebServiceMessageReceiver} used by this listener. */ public void setMessageReceiver(WebServiceMessageReceiver messageReceiver) { this.messageReceiver = messageReceiver; diff --git a/spring-ws-support/src/main/java/org/springframework/ws/transport/xmpp/XmppMessageSender.java b/spring-ws-support/src/main/java/org/springframework/ws/transport/xmpp/XmppMessageSender.java index b9332c8a..4e6d549d 100644 --- a/spring-ws-support/src/main/java/org/springframework/ws/transport/xmpp/XmppMessageSender.java +++ b/spring-ws-support/src/main/java/org/springframework/ws/transport/xmpp/XmppMessageSender.java @@ -31,8 +31,8 @@ import org.springframework.ws.transport.xmpp.support.XmppTransportUtils; /** * {@link WebServiceMessageSender} implementation that uses XMPP {@link org.jivesoftware.smack.packet.Message}s. * Requires a {@link #setConnection(org.jivesoftware.smack.XMPPConnection) connection}to be set. - *

    - * This message sender supports URI's of the following format:

    xmpp:to
    + * + *

    This message sender supports URI's of the following format:

    xmpp:to
    * The to represents a Jabber ID. * * @author Gildas Cuisinier @@ -69,7 +69,7 @@ public class XmppMessageSender implements WebServiceMessageSender, InitializingB /** * Sets the encoding used to read from {@link org.jivesoftware.smack.packet.Message} object. Defaults to - * UTF-8. + * {@code UTF-8}. */ public void setMessageEncoding(String messageEncoding) { this.messageEncoding = messageEncoding; diff --git a/spring-ws-support/src/main/java/org/springframework/ws/transport/xmpp/support/XmppConnectionFactoryBean.java b/spring-ws-support/src/main/java/org/springframework/ws/transport/xmpp/support/XmppConnectionFactoryBean.java index 0b1fd848..412849d4 100644 --- a/spring-ws-support/src/main/java/org/springframework/ws/transport/xmpp/support/XmppConnectionFactoryBean.java +++ b/spring-ws-support/src/main/java/org/springframework/ws/transport/xmpp/support/XmppConnectionFactoryBean.java @@ -58,8 +58,8 @@ public class XmppConnectionFactoryBean implements FactoryBean, I /** * Sets the the server port to connect to. - *

    - * Defaults to {@code 5222}. + * + *

    Defaults to {@code 5222}. */ public void setPort(int port) { Assert.isTrue(port > 0, "'port' must be larger than 0"); diff --git a/spring-ws-support/src/main/java/org/springframework/ws/transport/xmpp/support/XmppTransportUtils.java b/spring-ws-support/src/main/java/org/springframework/ws/transport/xmpp/support/XmppTransportUtils.java index 8a0f0d27..8d49fdf4 100644 --- a/spring-ws-support/src/main/java/org/springframework/ws/transport/xmpp/support/XmppTransportUtils.java +++ b/spring-ws-support/src/main/java/org/springframework/ws/transport/xmpp/support/XmppTransportUtils.java @@ -38,7 +38,7 @@ public abstract class XmppTransportUtils { } /** - * Converts the given XMPP destination into a xmpp URI. + * Converts the given XMPP destination into a {@code xmpp} URI. */ public static URI toUri(Message requestMessage) throws URISyntaxException { return new URI(XmppTransportConstants.XMPP_URI_SCHEME, requestMessage.getTo(), null); diff --git a/spring-ws-test/src/main/java/org/springframework/ws/test/client/AbstractResponseCreator.java b/spring-ws-test/src/main/java/org/springframework/ws/test/client/AbstractResponseCreator.java index 43072a67..2574b478 100644 --- a/spring-ws-test/src/main/java/org/springframework/ws/test/client/AbstractResponseCreator.java +++ b/spring-ws-test/src/main/java/org/springframework/ws/test/client/AbstractResponseCreator.java @@ -24,8 +24,8 @@ import org.springframework.ws.WebServiceMessageFactory; /** * Abstract base class for the {@link ResponseCreator} interface. - *

    - * Creates a response using the given {@link WebServiceMessageFactory}, and passes it on to {@link #doWithResponse(URI, + * + *

    Creates a response using the given {@link WebServiceMessageFactory}, and passes it on to {@link #doWithResponse(URI, * WebServiceMessage, WebServiceMessage)}. * * @author Arjen Poutsma diff --git a/spring-ws-test/src/main/java/org/springframework/ws/test/client/MockWebServiceServer.java b/spring-ws-test/src/main/java/org/springframework/ws/test/client/MockWebServiceServer.java index 12ff1257..10e5ea6e 100644 --- a/spring-ws-test/src/main/java/org/springframework/ws/test/client/MockWebServiceServer.java +++ b/spring-ws-test/src/main/java/org/springframework/ws/test/client/MockWebServiceServer.java @@ -25,8 +25,8 @@ import org.springframework.ws.test.support.MockStrategiesHelper; /** * Main entry point for client-side Web service testing. Typically used to test a {@link * WebServiceTemplate}, set up expectations on request messages, and create response messages. - *

    - * The typical usage of this class is: + * + *

    The typical usage of this class is: *

      *
    1. Create a {@code MockWebServiceServer} instance by calling {@link #createServer(WebServiceTemplate)}, * {@link #createServer(WebServiceGatewaySupport)}, or {@link #createServer(ApplicationContext)}. @@ -40,8 +40,8 @@ import org.springframework.ws.test.support.MockStrategiesHelper; *
    2. Call {@link #verify()}.
    * Note that because of the 'fluent' API offered by this class (and related classes), you can typically use the Code * Completion features (i.e. ctrl-space) in your IDE to set up the mocks. - *

    - * For example: + * + *

    For example: *

      * import org.junit.*;
      * import org.springframework.beans.factory.annotation.Autowired;
    @@ -127,8 +127,8 @@ public class MockWebServiceServer {
     
         /**
          * Creates a {@code MockWebServiceServer} instance based on the given {@link ApplicationContext}.
    -     * 

    - * This factory method will try and find a configured {@link WebServiceTemplate} in the given application context. + * + *

    This factory method will try and find a configured {@link WebServiceTemplate} in the given application context. * If no template can be found, it will try and find a {@link WebServiceGatewaySupport}, and use its configured * template. If neither can be found, an exception is thrown. * diff --git a/spring-ws-test/src/main/java/org/springframework/ws/test/client/RequestXPathExpectations.java b/spring-ws-test/src/main/java/org/springframework/ws/test/client/RequestXPathExpectations.java index 3ea3a02f..a8e7ccc3 100644 --- a/spring-ws-test/src/main/java/org/springframework/ws/test/client/RequestXPathExpectations.java +++ b/spring-ws-test/src/main/java/org/springframework/ws/test/client/RequestXPathExpectations.java @@ -18,8 +18,8 @@ package org.springframework.ws.test.client; /** * Allows for setting up expectations on XPath expressions. - *

    - * Implementations of this interface are returned by {@link RequestMatchers#xpath(String)} and {@link + * + *

    Implementations of this interface are returned by {@link RequestMatchers#xpath(String)} and {@link * RequestMatchers#xpath(String, java.util.Map)}, as part of the fluent API. As such, it is not typical to implement this * interface yourself. * diff --git a/spring-ws-test/src/main/java/org/springframework/ws/test/server/MockWebServiceClient.java b/spring-ws-test/src/main/java/org/springframework/ws/test/server/MockWebServiceClient.java index 16240cb2..49706ce8 100644 --- a/spring-ws-test/src/main/java/org/springframework/ws/test/server/MockWebServiceClient.java +++ b/spring-ws-test/src/main/java/org/springframework/ws/test/server/MockWebServiceClient.java @@ -37,8 +37,8 @@ import org.springframework.ws.transport.WebServiceMessageReceiver; * Main entry point for server-side Web service testing. Typically used to test a {@link * org.springframework.ws.server.MessageDispatcher MessageDispatcher} (including its endpoints, mappings, etc) by * creating request messages, and setting up expectations about response messages. - *

    - * The typical usage of this class is: + * + *

    The typical usage of this class is: *

      *
    1. Create a {@code MockWebServiceClient} instance by using {@link #createClient(ApplicationContext)} or * {@link #createClient(WebServiceMessageReceiver, WebServiceMessageFactory)}
    2. @@ -50,8 +50,8 @@ import org.springframework.ws.transport.WebServiceMessageReceiver; *
    * Note that because of the 'fluent' API offered by this class (and related classes), you can typically use the Code * Completion features (i.e. ctrl-space) in your IDE to set up the mocks. - *

    - * For example: + * + *

    For example: *

      * import org.junit.*;
      * import org.springframework.beans.factory.annotation.Autowired;
    diff --git a/spring-ws-test/src/main/java/org/springframework/ws/test/server/ResponseXPathExpectations.java b/spring-ws-test/src/main/java/org/springframework/ws/test/server/ResponseXPathExpectations.java
    index 0ad008e1..00430e49 100644
    --- a/spring-ws-test/src/main/java/org/springframework/ws/test/server/ResponseXPathExpectations.java
    +++ b/spring-ws-test/src/main/java/org/springframework/ws/test/server/ResponseXPathExpectations.java
    @@ -18,8 +18,8 @@ package org.springframework.ws.test.server;
     
     /**
      * Allows for setting up expectations on XPath expressions.
    - * 

    - * Implementations of this interface are returned by {@link org.springframework.ws.test.client.RequestMatchers#xpath(String)} and {@link + * + *

    Implementations of this interface are returned by {@link org.springframework.ws.test.client.RequestMatchers#xpath(String)} and {@link * org.springframework.ws.test.client.RequestMatchers#xpath(String, java.util.Map)}, as part of the fluent API. As such, it is not typical to implement this * interface yourself. * diff --git a/spring-ws-test/src/main/java/org/springframework/ws/test/support/creator/AbstractMessageCreator.java b/spring-ws-test/src/main/java/org/springframework/ws/test/support/creator/AbstractMessageCreator.java index e4ba22ca..e8d0f9bc 100644 --- a/spring-ws-test/src/main/java/org/springframework/ws/test/support/creator/AbstractMessageCreator.java +++ b/spring-ws-test/src/main/java/org/springframework/ws/test/support/creator/AbstractMessageCreator.java @@ -23,8 +23,8 @@ import org.springframework.ws.WebServiceMessageFactory; /** * Abstract base class for the {@link WebServiceMessageCreator} interface. - *

    - * Creates a message using the given {@link WebServiceMessageFactory}, and passes it on to {@link + * + *

    Creates a message using the given {@link WebServiceMessageFactory}, and passes it on to {@link * #doWithMessage(WebServiceMessage)}. * * @author Arjen Poutsma diff --git a/spring-ws-test/src/main/java/org/springframework/ws/test/support/matcher/AbstractSoapMessageMatcher.java b/spring-ws-test/src/main/java/org/springframework/ws/test/support/matcher/AbstractSoapMessageMatcher.java index 895e7be9..064443f6 100644 --- a/spring-ws-test/src/main/java/org/springframework/ws/test/support/matcher/AbstractSoapMessageMatcher.java +++ b/spring-ws-test/src/main/java/org/springframework/ws/test/support/matcher/AbstractSoapMessageMatcher.java @@ -25,8 +25,8 @@ import org.springframework.ws.soap.SoapMessage; /** * Abstract base class for SOAP-specific {@link WebServiceMessageMatcher} implementations. - *

    - * Asserts that the message given to {@link #match(WebServiceMessage)} is a {@link SoapMessage}, and invokes {@link + * + *

    Asserts that the message given to {@link #match(WebServiceMessage)} is a {@link SoapMessage}, and invokes {@link * #match(SoapMessage)} with it if so. * * @author Arjen Poutsma diff --git a/spring-xml/src/main/java/org/springframework/xml/JaxpVersion.java b/spring-xml/src/main/java/org/springframework/xml/JaxpVersion.java index 7ac58e36..37c07fe2 100644 --- a/spring-xml/src/main/java/org/springframework/xml/JaxpVersion.java +++ b/spring-xml/src/main/java/org/springframework/xml/JaxpVersion.java @@ -21,11 +21,11 @@ import org.springframework.util.ClassUtils; /** * Helper class used to find the current version of JAXP. We cannot depend on the Java version, since JAXP can be * upgraded independently of the Java version. - *

    - * Only distinguishes between JAXP 1.0, 1.1, 1.3, and 1.4, since JAXP 1.2 was a maintenance release with no new + * + *

    Only distinguishes between JAXP 1.0, 1.1, 1.3, and 1.4, since JAXP 1.2 was a maintenance release with no new * classes. - *

    - * Note that Spring-WS requires JDK 1.5 as of Spring-WS 2.0, and therefore has at least JAXP 1.3 available. + * + *

    Note that Spring-WS requires JDK 1.5 as of Spring-WS 2.0, and therefore has at least JAXP 1.3 available. * * @author Arjen Poutsma * @since 1.0.0 @@ -69,7 +69,7 @@ public abstract class JaxpVersion { } /** - * Gets the JAXP version. This means we can do things like if (getJaxpVersion() < JAXP_13). + * Gets the JAXP version. This means we can do things like if {@code (getJaxpVersion() < JAXP_13)}. * * @return a code comparable to the JAXP_XX codes in this class * @see #JAXP_10 @@ -84,7 +84,7 @@ public abstract class JaxpVersion { /** * Convenience method to determine if the current JAXP version is at least 1.4 (packaged with JDK 1.6). * - * @return true if the current JAXP version is at least JAXP 1.4 + * @return {@code true} if the current JAXP version is at least JAXP 1.4 * @see #getJaxpVersion() * @see #JAXP_14 */ diff --git a/spring-xml/src/main/java/org/springframework/xml/XmlException.java b/spring-xml/src/main/java/org/springframework/xml/XmlException.java index 36c3e276..9636a255 100644 --- a/spring-xml/src/main/java/org/springframework/xml/XmlException.java +++ b/spring-xml/src/main/java/org/springframework/xml/XmlException.java @@ -27,7 +27,7 @@ import org.springframework.core.NestedRuntimeException; public abstract class XmlException extends NestedRuntimeException { /** - * Constructs a new instance of the XmlException with the specific detail message. + * Constructs a new instance of the {@code XmlException} with the specific detail message. * * @param message the detail message */ @@ -36,7 +36,7 @@ public abstract class XmlException extends NestedRuntimeException { } /** - * Constructs a new instance of the XmlException with the specific detail message and exception. + * Constructs a new instance of the {@code XmlException} with the specific detail message and exception. * * @param message the detail message * @param throwable the wrapped exception diff --git a/spring-xml/src/main/java/org/springframework/xml/dom/DomContentHandler.java b/spring-xml/src/main/java/org/springframework/xml/dom/DomContentHandler.java index 760a2293..5e355382 100644 --- a/spring-xml/src/main/java/org/springframework/xml/dom/DomContentHandler.java +++ b/spring-xml/src/main/java/org/springframework/xml/dom/DomContentHandler.java @@ -32,7 +32,7 @@ import org.xml.sax.SAXException; import org.springframework.util.Assert; /** - * SAX ContentHandler that transforms callback calls to DOM Nodes. + * SAX {@code ContentHandler} that transforms callback calls to DOM {@code Node}s. * * @author Arjen Poutsma * @see org.w3c.dom.Node @@ -47,7 +47,7 @@ public class DomContentHandler implements ContentHandler { private final Node node; /** - * Creates a new instance of the DomContentHandler with the given node. + * Creates a new instance of the {@code DomContentHandler} with the given node. * * @param node the node to publish events to */ diff --git a/spring-xml/src/main/java/org/springframework/xml/namespace/QNameEditor.java b/spring-xml/src/main/java/org/springframework/xml/namespace/QNameEditor.java index 79553d3a..9c7e5f54 100644 --- a/spring-xml/src/main/java/org/springframework/xml/namespace/QNameEditor.java +++ b/spring-xml/src/main/java/org/springframework/xml/namespace/QNameEditor.java @@ -22,9 +22,9 @@ import javax.xml.namespace.QName; import org.springframework.util.StringUtils; /** - * PropertyEditor for javax.xml.namespace.QName, to populate a property of type QName from a String value. - *

    - * Expects the syntax + * PropertyEditor for {@code javax.xml.namespace.QName}, to populate a property of type QName from a String value. + * + *

    Expects the syntax *

      * localPart
      * 
    @@ -36,7 +36,7 @@ import org.springframework.util.StringUtils; *
      * {namespace}prefix:localPart
      * 
    - * This resembles the toString() representation of QName itself, but allows for prefixes to be + * This resembles the {@code toString()} representation of {@code QName} itself, but allows for prefixes to be * specified as well. * * @author Arjen Poutsma diff --git a/spring-xml/src/main/java/org/springframework/xml/namespace/QNameUtils.java b/spring-xml/src/main/java/org/springframework/xml/namespace/QNameUtils.java index cbdb5bac..695e47c9 100644 --- a/spring-xml/src/main/java/org/springframework/xml/namespace/QNameUtils.java +++ b/spring-xml/src/main/java/org/springframework/xml/namespace/QNameUtils.java @@ -46,14 +46,14 @@ public abstract class QNameUtils { } /** - * Creates a new QName with the given parameters. Sets the prefix if possible, i.e. if the - * QName(String, String, String) constructor can be found. If this constructor is not available (as is + * Creates a new {@code QName} with the given parameters. Sets the prefix if possible, i.e. if the + * {@code QName(String, String, String)} constructor can be found. If this constructor is not available (as is * the case on older implementations of JAX-RPC), the prefix is ignored. * - * @param namespaceUri namespace URI of the QName - * @param localPart local part of the QName - * @param prefix prefix of the QName. May be ignored. - * @return the created QName + * @param namespaceUri namespace URI of the {@code QName} + * @param localPart local part of the {@code QName} + * @param prefix prefix of the {@code QName}. May be ignored. + * @return the created {@code QName} * @see QName#QName(String,String,String) */ public static QName createQName(String namespaceUri, String localPart, String prefix) { @@ -66,11 +66,11 @@ public abstract class QNameUtils { } /** - * Returns the prefix of the given QName. Returns the prefix if available, i.e. if the - * QName.getPrefix() method can be found. If this method is not available (as is the case on older + * Returns the prefix of the given {@code QName}. Returns the prefix if available, i.e. if the + * {@code QName.getPrefix()} method can be found. If this method is not available (as is the case on older * implementations of JAX-RPC), an empty string is returned. * - * @param qName the QName to return the prefix from + * @param qName the {@code QName} to return the prefix from * @return the prefix, if available, or an empty string * @see javax.xml.namespace.QName#getPrefix() */ @@ -82,7 +82,7 @@ public abstract class QNameUtils { * Validates the given String as a QName * * @param text the qualified name - * @return true if valid, false otherwise + * @return {@code true} if valid, {@code false} otherwise */ public static boolean validateQName(String text) { if (!StringUtils.hasLength(text)) { @@ -121,10 +121,10 @@ public abstract class QNameUtils { } /** - * Convert a QName to a qualified name, as used by DOM and SAX. The returned string has a format of - * prefix:localName if the prefix is set, or just localName if not. + * Convert a {@code QName} to a qualified name, as used by DOM and SAX. The returned string has a format of + * {@code prefix:localName} if the prefix is set, or just {@code localName} if not. * - * @param qName the QName + * @param qName the {@code QName} * @return the qualified name */ public static String toQualifiedName(QName qName) { @@ -138,8 +138,8 @@ public abstract class QNameUtils { } /** - * Convert a namespace URI and DOM or SAX qualified name to a QName. The qualified name can have the - * form prefix:localname or localName. + * Convert a namespace URI and DOM or SAX qualified name to a {@code QName}. The qualified name can have the + * form {@code prefix:localname} or {@code localName}. * * @param namespaceUri the namespace URI * @param qualifiedName the qualified name @@ -156,13 +156,13 @@ public abstract class QNameUtils { } /** - * Parse the given qualified name string into a QName. Expects the syntax localPart, - * {namespace}localPart, or {namespace}prefix:localPart. This format resembles the - * toString() representation of QName itself, but allows for prefixes to be specified as + * Parse the given qualified name string into a {@code QName}. Expects the syntax {@code localPart}, + * {@code{namespace}localPart}, or {@code{namespace}prefix:localPart}. This format resembles the + * {@code toString()} representation of {@code QName} itself, but allows for prefixes to be specified as * well. * * @return a corresponding QName instance - * @throws IllegalArgumentException when the given string is null or empty. + * @throws IllegalArgumentException when the given string is {@code null} or empty. */ public static QName parseQNameString(String qNameString) { Assert.hasLength(qNameString, "QName text may not be null or empty"); diff --git a/spring-xml/src/main/java/org/springframework/xml/namespace/SimpleNamespaceContext.java b/spring-xml/src/main/java/org/springframework/xml/namespace/SimpleNamespaceContext.java index 9f6cf93c..1a93ec6c 100644 --- a/spring-xml/src/main/java/org/springframework/xml/namespace/SimpleNamespaceContext.java +++ b/spring-xml/src/main/java/org/springframework/xml/namespace/SimpleNamespaceContext.java @@ -29,9 +29,9 @@ import javax.xml.namespace.NamespaceContext; import org.springframework.util.Assert; /** - * Simple javax.xml.namespace.NamespaceContext implementation. Follows the standard - * NamespaceContext contract, and is loadable via a java.util.Map or - * java.util.Properties object + * Simple {@code javax.xml.namespace.NamespaceContext} implementation. Follows the standard + * {@code NamespaceContext} contract, and is loadable via a {@code java.util.Map} or + * {@code java.util.Properties} object * * @author Arjen Poutsma * @since 1.0.0 diff --git a/spring-xml/src/main/java/org/springframework/xml/sax/AbstractXmlReader.java b/spring-xml/src/main/java/org/springframework/xml/sax/AbstractXmlReader.java index c1b1392b..968c9365 100644 --- a/spring-xml/src/main/java/org/springframework/xml/sax/AbstractXmlReader.java +++ b/spring-xml/src/main/java/org/springframework/xml/sax/AbstractXmlReader.java @@ -26,7 +26,7 @@ import org.xml.sax.XMLReader; import org.xml.sax.ext.LexicalHandler; /** - * Abstract base class for SAX XMLReader implementations. Contains properties as defined in {@link + * Abstract base class for SAX {@code XMLReader} implementations. Contains properties as defined in {@link * XMLReader}, and does not recognize any features * * @author Arjen Poutsma @@ -93,7 +93,7 @@ public abstract class AbstractXmlReader implements XMLReader { } /** - * Throws a SAXNotRecognizedException exception. + * Throws a {@code SAXNotRecognizedException} exception. * * @throws org.xml.sax.SAXNotRecognizedException * always @@ -104,7 +104,7 @@ public abstract class AbstractXmlReader implements XMLReader { } /** - * Throws a SAXNotRecognizedException exception. + * Throws a {@code SAXNotRecognizedException} exception. * * @throws SAXNotRecognizedException always */ @@ -114,8 +114,8 @@ public abstract class AbstractXmlReader implements XMLReader { } /** - * Throws a SAXNotRecognizedException exception when the given property does not signify a lexical - * handler. The property name for a lexical handler is http://xml.org/sax/properties/lexical-handler. + * Throws a {@code SAXNotRecognizedException} exception when the given property does not signify a lexical + * handler. The property name for a lexical handler is {@code http://xml.org/sax/properties/lexical-handler}. */ @Override public Object getProperty(String name) throws SAXNotRecognizedException, SAXNotSupportedException { @@ -128,8 +128,8 @@ public abstract class AbstractXmlReader implements XMLReader { } /** - * Throws a SAXNotRecognizedException exception when the given property does not signify a lexical - * handler. The property name for a lexical handler is http://xml.org/sax/properties/lexical-handler. + * Throws a {@code SAXNotRecognizedException} exception when the given property does not signify a lexical + * handler. The property name for a lexical handler is {@code http://xml.org/sax/properties/lexical-handler}. */ @Override public void setProperty(String name, Object value) throws SAXNotRecognizedException, SAXNotSupportedException { diff --git a/spring-xml/src/main/java/org/springframework/xml/sax/SaxUtils.java b/spring-xml/src/main/java/org/springframework/xml/sax/SaxUtils.java index f855c8b0..b278ee20 100644 --- a/spring-xml/src/main/java/org/springframework/xml/sax/SaxUtils.java +++ b/spring-xml/src/main/java/org/springframework/xml/sax/SaxUtils.java @@ -37,8 +37,8 @@ public abstract class SaxUtils { private static final Log logger = LogFactory.getLog(SaxUtils.class); /** - * Creates a SAX InputSource from the given resource. Sets the system identifier to the resource's - * URL, if available. + * Creates a SAX {@code InputSource} from the given resource. Sets the system identifier to the resource's + * {@code URL}, if available. * * @param resource the resource * @return the input source created from the resource @@ -52,7 +52,7 @@ public abstract class SaxUtils { return inputSource; } - /** Retrieves the URL from the given resource as System ID. Returns null if it cannot be opened. */ + /** Retrieves the URL from the given resource as System ID. Returns {@code null} if it cannot be opened. */ public static String getSystemId(Resource resource) { try { return new URI(resource.getURL().toExternalForm()).toString(); diff --git a/spring-xml/src/main/java/org/springframework/xml/transform/ResourceSource.java b/spring-xml/src/main/java/org/springframework/xml/transform/ResourceSource.java index 2630937e..0a68a0f5 100644 --- a/spring-xml/src/main/java/org/springframework/xml/transform/ResourceSource.java +++ b/spring-xml/src/main/java/org/springframework/xml/transform/ResourceSource.java @@ -34,7 +34,7 @@ import org.xml.sax.XMLReader; public class ResourceSource extends SAXSource { /** - * Initializes a new instance of the ResourceSource with the given resource. + * Initializes a new instance of the {@code ResourceSource} with the given resource. * * @param content the content */ @@ -43,7 +43,7 @@ public class ResourceSource extends SAXSource { } /** - * Initializes a new instance of the ResourceSource with the given {@link XMLReader} and resource. + * Initializes a new instance of the {@code ResourceSource} with the given {@link XMLReader} and resource. * * @param content the content */ diff --git a/spring-xml/src/main/java/org/springframework/xml/transform/StringResult.java b/spring-xml/src/main/java/org/springframework/xml/transform/StringResult.java index 86611c38..bb1e7147 100644 --- a/spring-xml/src/main/java/org/springframework/xml/transform/StringResult.java +++ b/spring-xml/src/main/java/org/springframework/xml/transform/StringResult.java @@ -20,8 +20,8 @@ import java.io.StringWriter; import javax.xml.transform.stream.StreamResult; /** - * Convenient subclass of StreamResult that writes to a StringWriter. The resulting string can - * be retrieved via toString(). + * Convenient subclass of {@code StreamResult} that writes to a {@code StringWriter}. The resulting string can + * be retrieved via {@code toString()}. * * @author Arjen Poutsma * @see #toString() diff --git a/spring-xml/src/main/java/org/springframework/xml/transform/StringSource.java b/spring-xml/src/main/java/org/springframework/xml/transform/StringSource.java index ec6a4d04..6b87da25 100644 --- a/spring-xml/src/main/java/org/springframework/xml/transform/StringSource.java +++ b/spring-xml/src/main/java/org/springframework/xml/transform/StringSource.java @@ -24,7 +24,7 @@ import javax.xml.transform.stream.StreamSource; import org.springframework.util.Assert; /** - * Convenient subclass of StreamSource that reads from a StringReader. The string to be read + * Convenient subclass of {@code StreamSource} that reads from a {@code StringReader}. The string to be read * can be set via the constructor. * * @author Arjen Poutsma @@ -35,7 +35,7 @@ public class StringSource extends StreamSource { private final String content; /** - * Initializes a new instance of the StringSource with the given string content. + * Initializes a new instance of the {@code StringSource} with the given string content. * * @param content the content */ diff --git a/spring-xml/src/main/java/org/springframework/xml/transform/TransformerHelper.java b/spring-xml/src/main/java/org/springframework/xml/transform/TransformerHelper.java index 7fe8bf1c..0898ee96 100644 --- a/spring-xml/src/main/java/org/springframework/xml/transform/TransformerHelper.java +++ b/spring-xml/src/main/java/org/springframework/xml/transform/TransformerHelper.java @@ -69,12 +69,12 @@ public class TransformerHelper { /** * Instantiate a new TransformerFactory. - *

    - * The default implementation simply calls {@link TransformerFactory#newInstance()}. If a {@link + * + *

    The default implementation simply calls {@link TransformerFactory#newInstance()}. If a {@link * #setTransformerFactoryClass transformerFactoryClass} has been specified explicitly, the default constructor of * the specified class will be called instead. - *

    - * Can be overridden in subclasses. + * + *

    Can be overridden in subclasses. * * @param transformerFactoryClass the specified factory class (if any) * @return the new TransactionFactory instance diff --git a/spring-xml/src/main/java/org/springframework/xml/transform/TransformerObjectSupport.java b/spring-xml/src/main/java/org/springframework/xml/transform/TransformerObjectSupport.java index 3f827430..1714ae25 100644 --- a/spring-xml/src/main/java/org/springframework/xml/transform/TransformerObjectSupport.java +++ b/spring-xml/src/main/java/org/springframework/xml/transform/TransformerObjectSupport.java @@ -27,9 +27,9 @@ import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; /** - * Convenient base class for objects that use a Transformer. Subclasses can call {@link + * Convenient base class for objects that use a {@code Transformer}. Subclasses can call {@link * #createTransformer()} or {@link #transform(Source, Result)}. This should be done per thread (i.e. per incoming - * request), because Transformer instances are not thread-safe. + * request), because {@code Transformer} instances are not thread-safe. * * @author Arjen Poutsma * @see Transformer @@ -67,14 +67,14 @@ public abstract class TransformerObjectSupport { } /** - * Returns the TransformerFactory. + * Returns the {@code TransformerFactory}. */ protected TransformerFactory getTransformerFactory() { return transformerHelper.getTransformerFactory(); } /** - * Creates a new Transformer. Must be called per request, as transformers are not thread-safe. + * Creates a new {@code Transformer}. Must be called per request, as transformers are not thread-safe. * * @return the created transformer * @throws TransformerConfigurationException diff --git a/spring-xml/src/main/java/org/springframework/xml/validation/Jaxp13ValidatorFactory.java b/spring-xml/src/main/java/org/springframework/xml/validation/Jaxp13ValidatorFactory.java index 409eefa5..f293eb3a 100644 --- a/spring-xml/src/main/java/org/springframework/xml/validation/Jaxp13ValidatorFactory.java +++ b/spring-xml/src/main/java/org/springframework/xml/validation/Jaxp13ValidatorFactory.java @@ -29,7 +29,7 @@ import org.xml.sax.SAXParseException; import org.springframework.core.io.Resource; /** - * Internal class that uses JAXP 1.0 features to create XmlValidator instances. + * Internal class that uses JAXP 1.0 features to create {@code XmlValidator} instances. * * @author Arjen Poutsma * @since 1.0.0 @@ -76,7 +76,7 @@ abstract class Jaxp13ValidatorFactory { } } - /** ErrorHandler implementation that stores errors and fatal errors in a list. */ + /** {@code ErrorHandler} implementation that stores errors and fatal errors in a list. */ private static class DefaultValidationErrorHandler implements ValidationErrorHandler { private List errors = new ArrayList(); diff --git a/spring-xml/src/main/java/org/springframework/xml/validation/SchemaLoaderUtils.java b/spring-xml/src/main/java/org/springframework/xml/validation/SchemaLoaderUtils.java index a101b1f1..ab737b28 100644 --- a/spring-xml/src/main/java/org/springframework/xml/validation/SchemaLoaderUtils.java +++ b/spring-xml/src/main/java/org/springframework/xml/validation/SchemaLoaderUtils.java @@ -41,8 +41,8 @@ public abstract class SchemaLoaderUtils { * Load schema from the given resource. * * @param resource the resource to load from - * @param schemaLanguage the language of the schema. Can be XMLConstants.W3C_XML_SCHEMA_NS_URI or - * XMLConstants.RELAXNG_NS_URI. + * @param schemaLanguage the language of the schema. Can be {@code XMLConstants.W3C_XML_SCHEMA_NS_URI} or + * {@code XMLConstants.RELAXNG_NS_URI}. * @throws IOException if loading failed * @throws SAXException if loading failed * @see javax.xml.XMLConstants#W3C_XML_SCHEMA_NS_URI @@ -56,8 +56,8 @@ public abstract class SchemaLoaderUtils { * Load schema from the given resource. * * @param resources the resources to load from - * @param schemaLanguage the language of the schema. Can be XMLConstants.W3C_XML_SCHEMA_NS_URI or - * XMLConstants.RELAXNG_NS_URI. + * @param schemaLanguage the language of the schema. Can be {@code XMLConstants.W3C_XML_SCHEMA_NS_URI} or + * {@code XMLConstants.RELAXNG_NS_URI}. * @throws IOException if loading failed * @throws SAXException if loading failed * @see javax.xml.XMLConstants#W3C_XML_SCHEMA_NS_URI @@ -78,7 +78,7 @@ public abstract class SchemaLoaderUtils { return schemaFactory.newSchema(schemaSources); } - /** Retrieves the URL from the given resource as System ID. Returns null if it cannot be opened. */ + /** Retrieves the URL from the given resource as System ID. Returns {@code null} if it cannot be opened. */ public static String getSystemId(Resource resource) { try { return resource.getURL().toString(); diff --git a/spring-xml/src/main/java/org/springframework/xml/validation/XmlValidator.java b/spring-xml/src/main/java/org/springframework/xml/validation/XmlValidator.java index 645da421..a314ec08 100644 --- a/spring-xml/src/main/java/org/springframework/xml/validation/XmlValidator.java +++ b/spring-xml/src/main/java/org/springframework/xml/validation/XmlValidator.java @@ -23,8 +23,8 @@ import org.xml.sax.SAXParseException; /** * Simple processor that validates a given {@link Source}. Can be created via the {@link XmlValidatorFactory}. - *

    - * Instances of this class are designed to be thread safe. + * + *

    Instances of this class are designed to be thread safe. * * @author Arjen Poutsma * @see XmlValidatorFactory#createValidator(org.springframework.core.io.Resource, String) @@ -37,9 +37,9 @@ public interface XmlValidator { * be empty if no validation errors are found. * * @param source the input document - * @return an array of SAXParseExceptions - * @throws IOException if the source cannot be read - * @throws XmlValidationException if the source cannot be validated + * @return an array of {@code SAXParseException}s + * @throws IOException if the {@code source} cannot be read + * @throws XmlValidationException if the {@code source} cannot be validated */ SAXParseException[] validate(Source source) throws IOException; @@ -49,9 +49,9 @@ public interface XmlValidator { * * @param source the input document * @param errorHandler the error handler to use. May be {@code null}, in which case a default will be used. - * @return an array of SAXParseExceptions - * @throws IOException if the source cannot be read - * @throws XmlValidationException if the source cannot be validated + * @return an array of {@code SAXParseException}s + * @throws IOException if the {@code source} cannot be read + * @throws XmlValidationException if the {@code source} cannot be validated */ SAXParseException[] validate(Source source, ValidationErrorHandler errorHandler) throws IOException; diff --git a/spring-xml/src/main/java/org/springframework/xml/validation/XmlValidatorFactory.java b/spring-xml/src/main/java/org/springframework/xml/validation/XmlValidatorFactory.java index be7b1e79..3b4185a9 100644 --- a/spring-xml/src/main/java/org/springframework/xml/validation/XmlValidatorFactory.java +++ b/spring-xml/src/main/java/org/springframework/xml/validation/XmlValidatorFactory.java @@ -28,9 +28,9 @@ import org.apache.commons.logging.LogFactory; /** * Factory for {@link XmlValidator} objects, being aware of JAXP 1.3 {@link Validator}s, and JAXP 1.0 parsing - * capababilities. Mainly for internal use within the framework. - *

    - * The goal of this class is to avoid runtime dependencies on JAXP 1.3 by using the best validation implementation that + * capabilities. Mainly for internal use within the framework. + * + *

    The goal of this class is to avoid runtime dependencies on JAXP 1.3 by using the best validation implementation that * is available. Prefers JAXP 1.3 {@link XmlValidator} implementations to a custom, SAX-based implementation. * * @author Arjen Poutsma @@ -49,7 +49,7 @@ public abstract class XmlValidatorFactory { /** * Create a {@link XmlValidator} with the given schema resource and schema language type. The schema language must - * be one of the SCHEMA_XXX constants. + * be one of the {@code SCHEMA_XXX} constants. * * @param schemaResource a resource that locates the schema to validate against * @param schemaLanguage the language of the schema @@ -57,7 +57,7 @@ public abstract class XmlValidatorFactory { * @throws IOException if the schema resource cannot be read * @throws IllegalArgumentException if the schema language is not supported * @throws IllegalStateException if JAXP 1.0 cannot be located - * @throws XmlValidationException if a XmlValidator cannot be created + * @throws XmlValidationException if a {@code XmlValidator} cannot be created * @see #SCHEMA_RELAX_NG * @see #SCHEMA_W3C_XML */ @@ -67,7 +67,7 @@ public abstract class XmlValidatorFactory { /** * Create a {@link XmlValidator} with the given schema resources and schema language type. The schema language must - * be one of the SCHEMA_XXX constants. + * be one of the {@code SCHEMA_XXX} constants. * * @param schemaResources an array of resource that locate the schemas to validate against * @param schemaLanguage the language of the schemas @@ -75,7 +75,7 @@ public abstract class XmlValidatorFactory { * @throws IOException if the schema resource cannot be read * @throws IllegalArgumentException if the schema language is not supported * @throws IllegalStateException if JAXP 1.0 cannot be located - * @throws XmlValidationException if a XmlValidator cannot be created + * @throws XmlValidationException if a {@code XmlValidator} cannot be created * @see #SCHEMA_RELAX_NG * @see #SCHEMA_W3C_XML */ diff --git a/spring-xml/src/main/java/org/springframework/xml/xpath/JaxenXPathExpressionFactory.java b/spring-xml/src/main/java/org/springframework/xml/xpath/JaxenXPathExpressionFactory.java index 845238fd..fa54996f 100644 --- a/spring-xml/src/main/java/org/springframework/xml/xpath/JaxenXPathExpressionFactory.java +++ b/spring-xml/src/main/java/org/springframework/xml/xpath/JaxenXPathExpressionFactory.java @@ -28,7 +28,7 @@ import org.w3c.dom.DOMException; import org.w3c.dom.Node; /** - * Jaxen-specific factory for creating XPathExpressions. + * Jaxen-specific factory for creating {@code XPathExpression}s. * * @author Arjen Poutsma * @see #createXPathExpression(String) @@ -37,10 +37,10 @@ import org.w3c.dom.Node; abstract class JaxenXPathExpressionFactory { /** - * Creates a Jaxen XPathExpression from the given string expression. + * Creates a Jaxen {@code XPathExpression} from the given string expression. * * @param expression the XPath expression - * @return the compiled XPathExpression + * @return the compiled {@code XPathExpression} * @throws XPathParseException when the given expression cannot be parsed */ static XPathExpression createXPathExpression(String expression) { @@ -55,11 +55,11 @@ abstract class JaxenXPathExpressionFactory { } /** - * Creates a Jaxen XPathExpression from the given string expression and prefixes. + * Creates a Jaxen {@code XPathExpression} from the given string expression and prefixes. * * @param expression the XPath expression * @param namespaces the namespaces - * @return the compiled XPathExpression + * @return the compiled {@code XPathExpression} * @throws XPathParseException when the given expression cannot be parsed */ public static XPathExpression createXPathExpression(String expression, Map namespaces) { @@ -74,7 +74,7 @@ abstract class JaxenXPathExpressionFactory { } } - /** Jaxen implementation of the XPathExpression interface. */ + /** Jaxen implementation of the {@code XPathExpression} interface. */ private static class JaxenXpathExpression implements XPathExpression { private XPath xpath; diff --git a/spring-xml/src/main/java/org/springframework/xml/xpath/JaxenXPathTemplate.java b/spring-xml/src/main/java/org/springframework/xml/xpath/JaxenXPathTemplate.java index 8ce66511..880bd9de 100644 --- a/spring-xml/src/main/java/org/springframework/xml/xpath/JaxenXPathTemplate.java +++ b/spring-xml/src/main/java/org/springframework/xml/xpath/JaxenXPathTemplate.java @@ -31,8 +31,8 @@ import org.w3c.dom.Node; /** * Implementation of {@link XPathOperations} that uses Jaxen. - *

    - * Namespaces can be set using the namespaces property. + * + *

    Namespaces can be set using the {@code namespaces} property. * * @author Arjen Poutsma * @see Jaxen diff --git a/spring-xml/src/main/java/org/springframework/xml/xpath/Jaxp13XPathExpressionFactory.java b/spring-xml/src/main/java/org/springframework/xml/xpath/Jaxp13XPathExpressionFactory.java index 51cb3987..357c2e35 100644 --- a/spring-xml/src/main/java/org/springframework/xml/xpath/Jaxp13XPathExpressionFactory.java +++ b/spring-xml/src/main/java/org/springframework/xml/xpath/Jaxp13XPathExpressionFactory.java @@ -43,10 +43,10 @@ abstract class Jaxp13XPathExpressionFactory { private static XPathFactory xpathFactory = XPathFactory.newInstance(); /** - * Creates a JAXP 1.3 XPathExpression from the given string expression. + * Creates a JAXP 1.3 {@code XPathExpression} from the given string expression. * * @param expression the XPath expression - * @return the compiled XPathExpression + * @return the compiled {@code XPathExpression} * @throws XPathParseException when the given expression cannot be parsed */ static XPathExpression createXPathExpression(String expression) { @@ -62,11 +62,11 @@ abstract class Jaxp13XPathExpressionFactory { } /** - * Creates a JAXP 1.3 XPathExpression from the given string expression and namespaces. + * Creates a JAXP 1.3 {@code XPathExpression} from the given string expression and namespaces. * * @param expression the XPath expression * @param namespaces the namespaces - * @return the compiled XPathExpression + * @return the compiled {@code XPathExpression} * @throws XPathParseException when the given expression cannot be parsed */ public static XPathExpression createXPathExpression(String expression, Map namespaces) { @@ -89,7 +89,7 @@ abstract class Jaxp13XPathExpressionFactory { } - /** JAXP 1.3 implementation of the XPathExpression interface. */ + /** JAXP 1.3 implementation of the {@code XPathExpression} interface. */ private static class Jaxp13XPathExpression implements XPathExpression { private final javax.xml.xpath.XPathExpression xpathExpression; diff --git a/spring-xml/src/main/java/org/springframework/xml/xpath/Jaxp13XPathTemplate.java b/spring-xml/src/main/java/org/springframework/xml/xpath/Jaxp13XPathTemplate.java index d96a5d8f..25734840 100644 --- a/spring-xml/src/main/java/org/springframework/xml/xpath/Jaxp13XPathTemplate.java +++ b/spring-xml/src/main/java/org/springframework/xml/xpath/Jaxp13XPathTemplate.java @@ -48,8 +48,8 @@ import org.springframework.xml.transform.TraxUtils; /** * Implementation of {@link XPathOperations} that uses JAXP 1.3. JAXP 1.3 is part of Java SE since 1.5. - *

    - * Namespaces can be set using the {@code namespaces} property. + * + *

    Namespaces can be set using the {@code namespaces} property. * * @author Arjen Poutsma * @see #setNamespaces(java.util.Map) diff --git a/spring-xml/src/main/java/org/springframework/xml/xpath/NodeCallbackHandler.java b/spring-xml/src/main/java/org/springframework/xml/xpath/NodeCallbackHandler.java index 2e077a6d..80984fe6 100644 --- a/spring-xml/src/main/java/org/springframework/xml/xpath/NodeCallbackHandler.java +++ b/spring-xml/src/main/java/org/springframework/xml/xpath/NodeCallbackHandler.java @@ -23,8 +23,8 @@ import org.w3c.dom.Node; * An interface used by {@link XPathOperations} implementations for processing {@link Node} objects on a per-node basis. * Implementations of this interface perform the actual work of processing nodes, but don't need to worry about * exception handling. - *

    - * Consider using a {@link NodeMapper} instead if you need to map exactly result object per node, assembling them in a + * + *

    Consider using a {@link NodeMapper} instead if you need to map exactly result object per node, assembling them in a * List. * * @author Arjen Poutsma diff --git a/spring-xml/src/main/java/org/springframework/xml/xpath/XPathException.java b/spring-xml/src/main/java/org/springframework/xml/xpath/XPathException.java index e5f7f57d..a8c033d9 100644 --- a/spring-xml/src/main/java/org/springframework/xml/xpath/XPathException.java +++ b/spring-xml/src/main/java/org/springframework/xml/xpath/XPathException.java @@ -27,7 +27,7 @@ import org.springframework.xml.XmlException; public class XPathException extends XmlException { /** - * Constructs a new instance of the XPathException with the specific detail message. + * Constructs a new instance of the {@code XPathException} with the specific detail message. * * @param message the detail message */ @@ -36,7 +36,7 @@ public class XPathException extends XmlException { } /** - * Constructs a new instance of the XPathException with the specific detail message and exception. + * Constructs a new instance of the {@code XPathException} with the specific detail message and exception. * * @param message the detail message * @param throwable the wrapped exception diff --git a/spring-xml/src/main/java/org/springframework/xml/xpath/XPathExpression.java b/spring-xml/src/main/java/org/springframework/xml/xpath/XPathExpression.java index e0d88ace..6d78c8bb 100644 --- a/spring-xml/src/main/java/org/springframework/xml/xpath/XPathExpression.java +++ b/spring-xml/src/main/java/org/springframework/xml/xpath/XPathExpression.java @@ -23,8 +23,8 @@ import org.w3c.dom.Node; /** * Defines the contract for a precompiled XPath expression. Concrete instances can be obtained through the {@link * XPathExpressionFactory}. - *

    - * Implementations of this interface are precompiled, and thus faster, but less flexible, than the XPath expressions + * + *

    Implementations of this interface are precompiled, and thus faster, but less flexible, than the XPath expressions * used by {@link XPathOperations} implementations. * * @author Arjen Poutsma @@ -33,10 +33,10 @@ import org.w3c.dom.Node; public interface XPathExpression { /** - * Evaluates the given expression as a boolean. Returns the boolean evaluation of the expression, or - * false if it is invalid. - *

    - * The return value is determined per the {@code boolean()} function defined in the XPath specification. + * Evaluates the given expression as a {@code boolean}. Returns the boolean evaluation of the expression, or + * {@code false} if it is invalid. + * + *

    The return value is determined per the {@code boolean()} function defined in the XPath specification. * This means that an expression that selects zero nodes will return {@code false}, while an expression that * selects one or more nodes will return {@code true}. * An expression that returns a string returns {@code false} for empty strings and {@code true} for all other @@ -51,7 +51,7 @@ public interface XPathExpression { boolean evaluateAsBoolean(Node node) throws XPathException; /** - * Evaluates the given expression as a {@link Node}. Returns the evaluation of the expression, or null + * Evaluates the given expression as a {@link Node}. Returns the evaluation of the expression, or {@code null} * if it is invalid. * * @param node the starting point @@ -66,17 +66,17 @@ public interface XPathExpression { * no result could be found. * * @param node the starting point - * @return a list of Nodes that are selected by the expression + * @return a list of {@code Node}s that are selected by the expression * @throws XPathException in case of XPath errors * @see XPath specification */ List evaluateAsNodeList(Node node) throws XPathException; /** - * Evaluates the given expression as a number (double). Returns the numeric evaluation of the + * Evaluates the given expression as a number ({@code double}). Returns the numeric evaluation of the * expression, or {@link Double#NaN} if it is invalid. - *

    - * The return value is determined per the {@code number()} function as defined in the XPath specification. + * + *

    The return value is determined per the {@code number()} function as defined in the XPath specification. * This means that if the expression selects multiple nodes, it will return the number value of the first node. * * @param node the starting point @@ -87,9 +87,9 @@ public interface XPathExpression { double evaluateAsNumber(Node node) throws XPathException; /** - * Evaluates the given expression as a String. Returns null if no result could be found. - *

    - * The return value is determined per the {@code string()} function as defined in the XPath specification. + * Evaluates the given expression as a String. Returns {@code null} if no result could be found. + * + *

    The return value is determined per the {@code string()} function as defined in the XPath specification. * This means that if the expression selects multiple nodes, it will return the string value of the first node. * * @param node the starting point diff --git a/spring-xml/src/main/java/org/springframework/xml/xpath/XPathExpressionFactory.java b/spring-xml/src/main/java/org/springframework/xml/xpath/XPathExpressionFactory.java index e5df68c1..522b7ecf 100644 --- a/spring-xml/src/main/java/org/springframework/xml/xpath/XPathExpressionFactory.java +++ b/spring-xml/src/main/java/org/springframework/xml/xpath/XPathExpressionFactory.java @@ -25,10 +25,10 @@ import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; /** - * Factory for compiled XPathExpressions, being aware of JAXP 1.3+ XPath functionality, and Jaxen. Mainly + * Factory for compiled {@code XPathExpression}s, being aware of JAXP 1.3+ XPath functionality, and Jaxen. Mainly * for internal use of the framework. - *

    - * The goal of this class is to avoid runtime dependencies a specific XPath engine, simply using the best XPath + * + *

    The goal of this class is to avoid runtime dependencies a specific XPath engine, simply using the best XPath * implementation that is available. Prefers JAXP 1.3+ XPath implementations to Jaxen. * * @author Arjen Poutsma diff --git a/spring-xml/src/main/java/org/springframework/xml/xpath/XPathExpressionFactoryBean.java b/spring-xml/src/main/java/org/springframework/xml/xpath/XPathExpressionFactoryBean.java index 1c2f5b52..fd7e6632 100644 --- a/spring-xml/src/main/java/org/springframework/xml/xpath/XPathExpressionFactoryBean.java +++ b/spring-xml/src/main/java/org/springframework/xml/xpath/XPathExpressionFactoryBean.java @@ -26,8 +26,8 @@ import org.springframework.util.CollectionUtils; /** * Spring {@link FactoryBean} for {@link XPathExpression} object. Facilitates injection of XPath expressions into * endpoint beans. - *

    - * Uses {@link XPathExpressionFactory} underneath, so support is provided for JAXP 1.3, and Jaxen XPaths. + * + *

    Uses {@link XPathExpressionFactory} underneath, so support is provided for JAXP 1.3, and Jaxen XPaths. * * @author Arjen Poutsma * @see #setExpression(String) diff --git a/spring-xml/src/main/java/org/springframework/xml/xpath/XPathOperations.java b/spring-xml/src/main/java/org/springframework/xml/xpath/XPathOperations.java index beadd7f2..9618a666 100644 --- a/spring-xml/src/main/java/org/springframework/xml/xpath/XPathOperations.java +++ b/spring-xml/src/main/java/org/springframework/xml/xpath/XPathOperations.java @@ -24,8 +24,8 @@ import org.w3c.dom.Node; /** * Interface that specifies a basic set of XPath operations, implemented by various XPathTemplates. Contains numerous * evaluation methods, - *

    - * The templates that implement this interface do not use precompiled XPath expressions. Consider using the {@link + * + *

    The templates that implement this interface do not use precompiled XPath expressions. Consider using the {@link * XPathExpressionFactory} or the {@link XPathExpressionFactoryBean} for optimal performance, but less flexibility. * * @author Arjen Poutsma @@ -36,10 +36,10 @@ import org.w3c.dom.Node; public interface XPathOperations { /** - * Evaluates the given expression as a boolean. Returns the boolean evaluation of the expression, or - * false if it is invalid. - *

    - * The return value is determined per the {@code boolean()} function defined in the XPath specification. + * Evaluates the given expression as a {@code boolean}. Returns the boolean evaluation of the expression, or + * {@code false} if it is invalid. + * + *

    The return value is determined per the {@code boolean()} function defined in the XPath specification. * This means that an expression that selects zero nodes will return {@code false}, while an expression that * selects one or more nodes will return {@code true}. * An expression that returns a string returns {@code false} for empty strings and {@code true} for all other @@ -55,7 +55,7 @@ public interface XPathOperations { boolean evaluateAsBoolean(String expression, Source context) throws XPathException; /** - * Evaluates the given expression as a {@link Node}. Returns the evaluation of the expression, or null + * Evaluates the given expression as a {@link Node}. Returns the evaluation of the expression, or {@code null} * if it is invalid. * * @param expression the XPath expression @@ -79,10 +79,10 @@ public interface XPathOperations { List evaluateAsNodeList(String expression, Source context) throws XPathException; /** - * Evaluates the given expression as a double. Returns the evaluation of the expression, or {@link + * Evaluates the given expression as a {@code double}. Returns the evaluation of the expression, or {@link * Double#NaN} if it is invalid. - *

    - * The return value is determined per the {@code number()} function as defined in the XPath specification. + * + *

    The return value is determined per the {@code number()} function as defined in the XPath specification. * This means that if the expression selects multiple nodes, it will return the number value of the first node. * * @param expression the XPath expression @@ -95,9 +95,9 @@ public interface XPathOperations { /** * Evaluates the given expression as a {@link String}. Returns the evaluation of the expression, or - * null if it is invalid. - *

    - * The return value is determined per the {@code string()} function as defined in the XPath specification. + * {@code null} if it is invalid. + * + *

    The return value is determined per the {@code string()} function as defined in the XPath specification. * This means that if the expression selects multiple nodes, it will return the string value of the first node. * * @param expression the XPath expression diff --git a/spring-xml/src/main/java/org/springframework/xml/xpath/XPathParseException.java b/spring-xml/src/main/java/org/springframework/xml/xpath/XPathParseException.java index 63964e61..4ad5be52 100644 --- a/spring-xml/src/main/java/org/springframework/xml/xpath/XPathParseException.java +++ b/spring-xml/src/main/java/org/springframework/xml/xpath/XPathParseException.java @@ -25,7 +25,7 @@ package org.springframework.xml.xpath; public class XPathParseException extends XPathException { /** - * Constructs a new instance of the XPathParseException with the specific detail message. + * Constructs a new instance of the {@code XPathParseException} with the specific detail message. * * @param message the detail message */ @@ -34,7 +34,7 @@ public class XPathParseException extends XPathException { } /** - * Constructs a new instance of the XPathParseException with the specific detail message and + * Constructs a new instance of the {@code XPathParseException} with the specific detail message and * exception. * * @param message the detail message diff --git a/spring-xml/src/main/java/org/springframework/xml/xsd/SimpleXsdSchema.java b/spring-xml/src/main/java/org/springframework/xml/xsd/SimpleXsdSchema.java index 15a3af64..7db10881 100644 --- a/spring-xml/src/main/java/org/springframework/xml/xsd/SimpleXsdSchema.java +++ b/spring-xml/src/main/java/org/springframework/xml/xsd/SimpleXsdSchema.java @@ -38,8 +38,8 @@ import org.springframework.xml.validation.XmlValidatorFactory; /** * The default {@link XsdSchema} implementation. - *

    - * Allows a XSD to be set by the {@link #setXsd(Resource)}, or directly in the {@link #SimpleXsdSchema(Resource) + * + *

    Allows a XSD to be set by the {@link #setXsd(Resource)}, or directly in the {@link #SimpleXsdSchema(Resource) * constructor}. * * @author Mark LaFond @@ -64,8 +64,8 @@ public class SimpleXsdSchema implements XsdSchema, InitializingBean { /** * Create a new instance of the {@link SimpleXsdSchema} class. - *

    - * A subsequent call to the {@link #setXsd(Resource)} method is required. + * + *

    A subsequent call to the {@link #setXsd(Resource)} method is required. */ public SimpleXsdSchema() { } @@ -73,8 +73,8 @@ public class SimpleXsdSchema implements XsdSchema, InitializingBean { /** * Create a new instance of the {@link SimpleXsdSchema} class with the specified resource. * - * @param xsdResource the XSD resource; must not be null - * @throws IllegalArgumentException if the supplied xsdResource is null + * @param xsdResource the XSD resource; must not be {@code null} + * @throws IllegalArgumentException if the supplied {@code xsdResource} is {@code null} */ public SimpleXsdSchema(Resource xsdResource) { Assert.notNull(xsdResource, "xsdResource must not be null"); diff --git a/spring-xml/src/main/java/org/springframework/xml/xsd/commons/CommonsXsdSchema.java b/spring-xml/src/main/java/org/springframework/xml/xsd/commons/CommonsXsdSchema.java index 70fa3405..fa89208c 100644 --- a/spring-xml/src/main/java/org/springframework/xml/xsd/commons/CommonsXsdSchema.java +++ b/spring-xml/src/main/java/org/springframework/xml/xsd/commons/CommonsXsdSchema.java @@ -57,8 +57,8 @@ public class CommonsXsdSchema implements XsdSchema { /** * Create a new instance of the {@code CommonsXsdSchema} class with the specified {@link XmlSchema} reference. * - * @param schema the Commons XmlSchema object; must not be null - * @throws IllegalArgumentException if the supplied schema is null + * @param schema the Commons {@code XmlSchema} object; must not be {@code null} + * @throws IllegalArgumentException if the supplied {@code schema} is {@code null} */ protected CommonsXsdSchema(XmlSchema schema) { this(schema, null); @@ -68,9 +68,9 @@ public class CommonsXsdSchema implements XsdSchema { * Create a new instance of the {@code CommonsXsdSchema} class with the specified {@link XmlSchema} and {@link * XmlSchemaCollection} reference. * - * @param schema the Commons XmlSchema object; must not be null - * @param collection the Commons XmlSchemaCollection object; can be null - * @throws IllegalArgumentException if the supplied schema is null + * @param schema the Commons {@code XmlSchema} object; must not be {@code null} + * @param collection the Commons {@code XmlSchemaCollection} object; can be {@code null} + * @throws IllegalArgumentException if the supplied {@code schema} is {@code null} */ protected CommonsXsdSchema(XmlSchema schema, XmlSchemaCollection collection) { Assert.notNull(schema, "'schema' must not be null"); @@ -128,7 +128,7 @@ public class CommonsXsdSchema implements XsdSchema { } } - /** Returns the wrapped Commons XmlSchema object. */ + /** Returns the wrapped Commons {@code XmlSchema} object. */ public XmlSchema getSchema() { return schema; } diff --git a/spring-xml/src/main/java/org/springframework/xml/xsd/commons/CommonsXsdSchemaCollection.java b/spring-xml/src/main/java/org/springframework/xml/xsd/commons/CommonsXsdSchemaCollection.java index dd0cc7b4..2a3335f5 100644 --- a/spring-xml/src/main/java/org/springframework/xml/xsd/commons/CommonsXsdSchemaCollection.java +++ b/spring-xml/src/main/java/org/springframework/xml/xsd/commons/CommonsXsdSchemaCollection.java @@ -49,8 +49,8 @@ import org.springframework.xml.xsd.XsdSchemaCollection; /** * Implementation of the {@link XsdSchemaCollection} that uses Apache WS-Commons XML Schema. - *

    - * Setting the {@link #setInline(boolean) inline} flag to true will result in all referenced schemas + * + *

    Setting the {@link #setInline(boolean) inline} flag to {@code true} will result in all referenced schemas * (included and imported) being merged into the referred schema. When including the schemas into a WSDL, this greatly * simplifies the deployment of the schemas. * @@ -75,15 +75,15 @@ public class CommonsXsdSchemaCollection implements XsdSchemaCollection, Initiali private ResourceLoader resourceLoader; /** - * Constructs a new, empty instance of the CommonsXsdSchemaCollection. - *

    - * A subsequent call to the {@link #setXsds(Resource[])} is required. + * Constructs a new, empty instance of the {@code CommonsXsdSchemaCollection}. + * + *

    A subsequent call to the {@link #setXsds(Resource[])} is required. */ public CommonsXsdSchemaCollection() { } /** - * Constructs a new instance of the CommonsXsdSchemaCollection based on the given resources. + * Constructs a new instance of the {@code CommonsXsdSchemaCollection} based on the given resources. * * @param resources the schema resources to load */ @@ -102,8 +102,8 @@ public class CommonsXsdSchemaCollection implements XsdSchemaCollection, Initiali /** * Defines whether included schemas should be inlined into the including schema. - *

    - * Defaults to false. + * + *

    Defaults to {@code false}. */ public void setInline(boolean inline) { this.inline = inline; @@ -111,8 +111,8 @@ public class CommonsXsdSchemaCollection implements XsdSchemaCollection, Initiali /** * Sets the WS-Commons uri resolver to use when resolving (relative) schemas. - *

    - * Default is an internal subclass of {@link DefaultURIResolver} which correctly handles schemas on the classpath. + * + *

    Default is an internal subclass of {@link DefaultURIResolver} which correctly handles schemas on the classpath. */ public void setUriResolver(URIResolver uriResolver) { Assert.notNull(uriResolver, "'uriResolver' must not be null"); diff --git a/src/api/stylesheet.css b/src/api/stylesheet.css new file mode 100644 index 00000000..029c89c9 --- /dev/null +++ b/src/api/stylesheet.css @@ -0,0 +1,599 @@ +/* Javadoc style sheet */ +/* +Overall document style +*/ + +@import url('resources/fonts/dejavu.css'); + +body { + background-color:#ffffff; + color:#353833; + font-family:'DejaVu Sans', Arial, Helvetica, sans-serif; + font-size:14px; + margin:0; +} +a:link, a:visited { + text-decoration:none; + color:#4A6782; +} +a:hover, a:focus { + text-decoration:none; + color:#bb7a2a; +} +a:active { + text-decoration:none; + color:#4A6782; +} +a[name] { + color:#353833; +} +a[name]:hover { + text-decoration:none; + color:#353833; +} +pre { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; +} +h1 { + font-size:20px; +} +h2 { + font-size:18px; +} +h3 { + font-size:16px; + font-style:italic; +} +h4 { + font-size:13px; +} +h5 { + font-size:12px; +} +h6 { + font-size:11px; +} +ul { + list-style-type:disc; +} +code, tt { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; + margin-top:8px; + line-height:1.4em; +} +dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; +} +table tr td dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + vertical-align:top; + padding-top:4px; +} +sup { + font-size:8px; +} +/* +Document title and Copyright styles +*/ +.clear { + clear:both; + height:0px; + overflow:hidden; +} +.aboutLanguage { + float:right; + padding:0px 21px; + font-size:11px; + z-index:200; + margin-top:-9px; +} +.legalCopy { + margin-left:.5em; +} +.bar a, .bar a:link, .bar a:visited, .bar a:active { + color:#FFFFFF; + text-decoration:none; +} +.bar a:hover, .bar a:focus { + color:#bb7a2a; +} +.tab { + background-color:#0066FF; + color:#ffffff; + padding:8px; + width:5em; + font-weight:bold; +} +/* +Navigation bar styles +*/ +.bar { + background-color:#4D7A97; + color:#FFFFFF; + padding:.8em .5em .4em .8em; + height:auto;/*height:1.8em;*/ + font-size:11px; + margin:0; +} +.topNav { + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.bottomNav { + margin-top:10px; + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.subNav { + background-color:#dee3e9; + float:left; + width:100%; + overflow:hidden; + font-size:12px; +} +.subNav div { + clear:left; + float:left; + padding:0 0 5px 6px; + text-transform:uppercase; +} +ul.navList, ul.subNavList { + float:left; + margin:0 25px 0 0; + padding:0; +} +ul.navList li{ + list-style:none; + float:left; + padding: 5px 6px; + text-transform:uppercase; +} +ul.subNavList li{ + list-style:none; + float:left; +} +.topNav a:link, .topNav a:active, .topNav a:visited, .bottomNav a:link, .bottomNav a:active, .bottomNav a:visited { + color:#FFFFFF; + text-decoration:none; + text-transform:uppercase; +} +.topNav a:hover, .bottomNav a:hover { + text-decoration:none; + color:#bb7a2a; + text-transform:uppercase; +} +.navBarCell1Rev { + background-color:#F8981D; + color:#253441; + margin: auto 5px; +} +.skipNav { + position:absolute; + top:auto; + left:-9999px; + overflow:hidden; +} +/* +Page header and footer styles +*/ +.header, .footer { + clear:both; + margin:0 20px; + padding:5px 0 0 0; +} +.indexHeader { + margin:10px; + position:relative; +} +.indexHeader span{ + margin-right:15px; +} +.indexHeader h1 { + font-size:13px; +} +.title { + color:#2c4557; + margin:10px 0; +} +.subTitle { + margin:5px 0 0 0; +} +.header ul { + margin:0 0 15px 0; + padding:0; +} +.footer ul { + margin:20px 0 5px 0; +} +.header ul li, .footer ul li { + list-style:none; + font-size:13px; +} +/* +Heading styles +*/ +div.details ul.blockList ul.blockList ul.blockList li.blockList h4, div.details ul.blockList ul.blockList ul.blockListLast li.blockList h4 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList ul.blockList li.blockList h3 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList li.blockList h3 { + padding:0; + margin:15px 0; +} +ul.blockList li.blockList h2 { + padding:0px 0 20px 0; +} +/* +Page layout container styles +*/ +.contentContainer, .sourceContainer, .classUseContainer, .serializedFormContainer, .constantValuesContainer { + clear:both; + padding:10px 20px; + position:relative; +} +.indexContainer { + margin:10px; + position:relative; + font-size:12px; +} +.indexContainer h2 { + font-size:13px; + padding:0 0 3px 0; +} +.indexContainer ul { + margin:0; + padding:0; +} +.indexContainer ul li { + list-style:none; + padding-top:2px; +} +.contentContainer .description dl dt, .contentContainer .details dl dt, .serializedFormContainer dl dt { + font-size:12px; + font-weight:bold; + margin:10px 0 0 0; + color:#4E4E4E; +} +.contentContainer .description dl dd, .contentContainer .details dl dd, .serializedFormContainer dl dd { + margin:5px 0 10px 0px; + font-size:14px; + font-family:'DejaVu Sans Mono',monospace; +} +.serializedFormContainer dl.nameValue dt { + margin-left:1px; + font-size:1.1em; + display:inline; + font-weight:bold; +} +.serializedFormContainer dl.nameValue dd { + margin:0 0 0 1px; + font-size:1.1em; + display:inline; +} +/* +List styles +*/ +ul.horizontal li { + display:inline; + font-size:0.9em; +} +ul.inheritance { + margin:0; + padding:0; +} +ul.inheritance li { + display:inline; + list-style:none; +} +ul.inheritance li ul.inheritance { + margin-left:15px; + padding-left:15px; + padding-top:1px; +} +ul.blockList, ul.blockListLast { + margin:10px 0 10px 0; + padding:0; +} +ul.blockList li.blockList, ul.blockListLast li.blockList { + list-style:none; + margin-bottom:15px; + line-height:1.4; +} +ul.blockList ul.blockList li.blockList, ul.blockList ul.blockListLast li.blockList { + padding:0px 20px 5px 10px; + border:1px solid #ededed; + background-color:#f8f8f8; +} +ul.blockList ul.blockList ul.blockList li.blockList, ul.blockList ul.blockList ul.blockListLast li.blockList { + padding:0 0 5px 8px; + background-color:#ffffff; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockList { + margin-left:0; + padding-left:0; + padding-bottom:15px; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockListLast { + list-style:none; + border-bottom:none; + padding-bottom:0; +} +table tr td dl, table tr td dl dt, table tr td dl dd { + margin-top:0; + margin-bottom:1px; +} +/* +Table styles +*/ +.overviewSummary, .memberSummary, .typeSummary, .useSummary, .constantsSummary, .deprecatedSummary { + width:100%; + border-left:1px solid #EEE; + border-right:1px solid #EEE; + border-bottom:1px solid #EEE; +} +.overviewSummary, .memberSummary { + padding:0px; +} +.overviewSummary caption, .memberSummary caption, .typeSummary caption, +.useSummary caption, .constantsSummary caption, .deprecatedSummary caption { + position:relative; + text-align:left; + background-repeat:no-repeat; + color:#253441; + font-weight:bold; + clear:none; + overflow:hidden; + padding:0px; + padding-top:10px; + padding-left:1px; + margin:0px; + white-space:pre; +} +.overviewSummary caption a:link, .memberSummary caption a:link, .typeSummary caption a:link, +.useSummary caption a:link, .constantsSummary caption a:link, .deprecatedSummary caption a:link, +.overviewSummary caption a:hover, .memberSummary caption a:hover, .typeSummary caption a:hover, +.useSummary caption a:hover, .constantsSummary caption a:hover, .deprecatedSummary caption a:hover, +.overviewSummary caption a:active, .memberSummary caption a:active, .typeSummary caption a:active, +.useSummary caption a:active, .constantsSummary caption a:active, .deprecatedSummary caption a:active, +.overviewSummary caption a:visited, .memberSummary caption a:visited, .typeSummary caption a:visited, +.useSummary caption a:visited, .constantsSummary caption a:visited, .deprecatedSummary caption a:visited { + color:#FFFFFF; +} +.overviewSummary caption span, .memberSummary caption span, .typeSummary caption span, +.useSummary caption span, .constantsSummary caption span, .deprecatedSummary caption span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + padding-bottom:7px; + display:inline-block; + float:left; + background-color:#F8981D; + border: none; + height:16px; +} +.memberSummary caption span.activeTableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#F8981D; + height:16px; +} +.memberSummary caption span.tableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#4D7A97; + height:16px; +} +.memberSummary caption span.tableTab, .memberSummary caption span.activeTableTab { + padding-top:0px; + padding-left:0px; + padding-right:0px; + background-image:none; + float:none; + display:inline; +} +.overviewSummary .tabEnd, .memberSummary .tabEnd, .typeSummary .tabEnd, +.useSummary .tabEnd, .constantsSummary .tabEnd, .deprecatedSummary .tabEnd { + display:none; + width:5px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .activeTableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .tableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + background-color:#4D7A97; + float:left; + +} +.overviewSummary td, .memberSummary td, .typeSummary td, +.useSummary td, .constantsSummary td, .deprecatedSummary td { + text-align:left; + padding:0px 0px 12px 10px; + width:100%; +} +th.colOne, th.colFirst, th.colLast, .useSummary th, .constantsSummary th, +td.colOne, td.colFirst, td.colLast, .useSummary td, .constantsSummary td{ + vertical-align:top; + padding-right:0px; + padding-top:8px; + padding-bottom:3px; +} +th.colFirst, th.colLast, th.colOne, .constantsSummary th { + background:#dee3e9; + text-align:left; + padding:8px 3px 3px 7px; +} +td.colFirst, th.colFirst { + white-space:nowrap; + font-size:13px; +} +td.colLast, th.colLast { + font-size:13px; +} +td.colOne, th.colOne { + font-size:13px; +} +.overviewSummary td.colFirst, .overviewSummary th.colFirst, +.overviewSummary td.colOne, .overviewSummary th.colOne, +.memberSummary td.colFirst, .memberSummary th.colFirst, +.memberSummary td.colOne, .memberSummary th.colOne, +.typeSummary td.colFirst{ + width:25%; + vertical-align:top; +} +td.colOne a:link, td.colOne a:active, td.colOne a:visited, td.colOne a:hover, td.colFirst a:link, td.colFirst a:active, td.colFirst a:visited, td.colFirst a:hover, td.colLast a:link, td.colLast a:active, td.colLast a:visited, td.colLast a:hover, .constantValuesContainer td a:link, .constantValuesContainer td a:active, .constantValuesContainer td a:visited, .constantValuesContainer td a:hover { + font-weight:bold; +} +.tableSubHeadingColor { + background-color:#EEEEFF; +} +.altColor { + background-color:#FFFFFF; +} +.rowColor { + background-color:#EEEEEF; +} +/* +Content styles +*/ +.description pre { + margin-top:0; +} +.deprecatedContent { + margin:0; + padding:10px 0; +} +.docSummary { + padding:0; +} + +ul.blockList ul.blockList ul.blockList li.blockList h3 { + font-style:normal; +} + +div.block { + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; +} + +td.colLast div { + padding-top:0px; +} + + +td.colLast a { + padding-bottom:3px; +} +/* +Formatting effect styles +*/ +.sourceLineNo { + color:green; + padding:0 30px 0 0; +} +h1.hidden { + visibility:hidden; + overflow:hidden; + font-size:10px; +} +.block { + display:block; + margin:3px 10px 2px 0px; + color:#474747; +} +.deprecatedLabel, .descfrmTypeLabel, .memberNameLabel, .memberNameLink, +.overrideSpecifyLabel, .packageHierarchyLabel, .paramLabel, .returnLabel, +.seeLabel, .simpleTagLabel, .throwsLabel, .typeNameLabel, .typeNameLink { + font-weight:bold; +} +.deprecationComment, .emphasizedPhrase, .interfaceName { + font-style:italic; +} + +div.block div.block span.deprecationComment, div.block div.block span.emphasizedPhrase, +div.block div.block span.interfaceName { + font-style:normal; +} + +div.contentContainer ul.blockList li.blockList h2{ + padding-bottom:0px; +} + + + +/* +Spring +*/ + +pre.code { + background-color: #F8F8F8; + border: 1px solid #CCCCCC; + border-radius: 3px 3px 3px 3px; + overflow: auto; + padding: 10px; + margin: 4px 20px 2px 0px; +} + +pre.code code, pre.code code * { + font-size: 1em; +} + +pre.code code, pre.code code * { + padding: 0 !important; + margin: 0 !important; +} +