This is an automated email from the ASF dual-hosted git repository. coheigea pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/cxf.git
commit 16c1d31b17b310d32d24676d3aca9c2b80c866ee Author: Colm O hEigeartaigh <[email protected]> AuthorDate: Mon Jan 13 18:06:58 2020 +0000 Finished javadoc cleanup --- .../src/main/java/org/apache/cxf/javascript/AttributeInfo.java | 2 +- .../org/apache/cxf/transport/http_jetty/JettyHTTPDestination.java | 2 +- .../java/org/apache/cxf/transport/http/auth/HttpAuthHeader.java | 1 - .../java/org/apache/cxf/transport/http/auth/HttpAuthSupplier.java | 2 +- .../main/java/org/apache/cxf/transport/jms/JMSConfigFactory.java | 5 ----- .../java/org/apache/cxf/transport/jms/JMSMessageHeadersType.java | 4 ---- .../java/org/apache/cxf/transport/websocket/WebSocketUtils.java | 1 - .../rm/src/main/java/org/apache/cxf/ws/rm/InternalContextUtils.java | 2 +- rt/ws/rm/src/main/java/org/apache/cxf/ws/rm/RMContextUtils.java | 1 - rt/ws/rm/src/main/java/org/apache/cxf/ws/rm/RMEndpoint.java | 1 - .../main/java/org/apache/cxf/ws/rm/policy/RMPolicyUtilities.java | 4 ++-- .../main/java/org/apache/cxf/ws/rm/soap/RedeliveryQueueImpl.java | 2 +- .../main/java/org/apache/cxf/ws/security/trust/TrustException.java | 3 ++- .../org/apache/cxf/ws/security/wss4j/AbstractTokenInterceptor.java | 3 --- .../java/org/apache/cxf/ws/security/wss4j/CryptoCoverageUtil.java | 2 +- .../org/apache/cxf/ws/security/wss4j/WSS4JStaxOutInterceptor.java | 2 +- .../policyvalidators/AbstractSupportingTokenPolicyValidator.java | 2 +- .../src/main/java/org/apache/cxf/sts/request/RequestParser.java | 2 +- .../main/java/org/apache/cxf/ws/discovery/WSDiscoveryClient.java | 1 - .../apache/cxf/xkms/x509/validator/TrustedAuthorityValidator.java | 4 ++-- .../java/org/apache/cxf/tools/common/AbstractCXFToolContainer.java | 2 +- .../tools/java2wsdl/processor/internal/ServiceBuilderFactory.java | 6 +++--- 22 files changed, 19 insertions(+), 35 deletions(-) diff --git a/rt/javascript/javascript-rt/src/main/java/org/apache/cxf/javascript/AttributeInfo.java b/rt/javascript/javascript-rt/src/main/java/org/apache/cxf/javascript/AttributeInfo.java index a7c2a00..a927958 100644 --- a/rt/javascript/javascript-rt/src/main/java/org/apache/cxf/javascript/AttributeInfo.java +++ b/rt/javascript/javascript-rt/src/main/java/org/apache/cxf/javascript/AttributeInfo.java @@ -80,7 +80,7 @@ public final class AttributeInfo implements ItemInfo { /** * Fill in an AttributeInfo for an attribute or anyAttribute from a sequence. * - * @param sequesequenceObjectnceElement + * @param sequenceObject * @param currentSchema * @param schemaCollection * @param prefixAccumulator diff --git a/rt/transports/http-jetty/src/main/java/org/apache/cxf/transport/http_jetty/JettyHTTPDestination.java b/rt/transports/http-jetty/src/main/java/org/apache/cxf/transport/http_jetty/JettyHTTPDestination.java index 9ca5b93..6592b80 100644 --- a/rt/transports/http-jetty/src/main/java/org/apache/cxf/transport/http_jetty/JettyHTTPDestination.java +++ b/rt/transports/http-jetty/src/main/java/org/apache/cxf/transport/http_jetty/JettyHTTPDestination.java @@ -79,7 +79,7 @@ public class JettyHTTPDestination extends ServletDestination { /** * Constructor * - * @param b the associated Bus + * @param bus the associated Bus * @param registry the associated destinationRegistry * @param ei the endpoint info of the destination * @param serverEngineFactory the serverEngineFactory which could be used to create ServerEngine diff --git a/rt/transports/http/src/main/java/org/apache/cxf/transport/http/auth/HttpAuthHeader.java b/rt/transports/http/src/main/java/org/apache/cxf/transport/http/auth/HttpAuthHeader.java index db7b02e..3b53c2e 100644 --- a/rt/transports/http/src/main/java/org/apache/cxf/transport/http/auth/HttpAuthHeader.java +++ b/rt/transports/http/src/main/java/org/apache/cxf/transport/http/auth/HttpAuthHeader.java @@ -140,7 +140,6 @@ public final class HttpAuthHeader { * Extracts the authorization realm from the * "WWW-Authenticate" Http response header. * - * @param authenticate content of the WWW-Authenticate header * @return The realm, or null if it is non-existent. */ public String getRealm() { diff --git a/rt/transports/http/src/main/java/org/apache/cxf/transport/http/auth/HttpAuthSupplier.java b/rt/transports/http/src/main/java/org/apache/cxf/transport/http/auth/HttpAuthSupplier.java index ebe1ada..7e33e47 100644 --- a/rt/transports/http/src/main/java/org/apache/cxf/transport/http/auth/HttpAuthSupplier.java +++ b/rt/transports/http/src/main/java/org/apache/cxf/transport/http/auth/HttpAuthSupplier.java @@ -57,7 +57,7 @@ public interface HttpAuthSupplier { */ String getAuthorization( AuthorizationPolicy authPolicy, - URI url, + URI uri, Message message, String fullHeader); } diff --git a/rt/transports/jms/src/main/java/org/apache/cxf/transport/jms/JMSConfigFactory.java b/rt/transports/jms/src/main/java/org/apache/cxf/transport/jms/JMSConfigFactory.java index b7866cf..226cf98 100644 --- a/rt/transports/jms/src/main/java/org/apache/cxf/transport/jms/JMSConfigFactory.java +++ b/rt/transports/jms/src/main/java/org/apache/cxf/transport/jms/JMSConfigFactory.java @@ -53,11 +53,6 @@ public final class JMSConfigFactory { return createFromEndpoint(bus, jmsEndpoint); } - /** - * @param bus - * @param endpointInfo - * @return - */ public static JMSConfiguration createFromEndpoint(Bus bus, JMSEndpoint endpoint) { JMSConfiguration jmsConfig = new JMSConfiguration(); diff --git a/rt/transports/jms/src/main/java/org/apache/cxf/transport/jms/JMSMessageHeadersType.java b/rt/transports/jms/src/main/java/org/apache/cxf/transport/jms/JMSMessageHeadersType.java index 3fb17dc..dd261fa 100644 --- a/rt/transports/jms/src/main/java/org/apache/cxf/transport/jms/JMSMessageHeadersType.java +++ b/rt/transports/jms/src/main/java/org/apache/cxf/transport/jms/JMSMessageHeadersType.java @@ -407,10 +407,6 @@ public class JMSMessageHeadersType { } } - /** - * @param jmsMessage - * @param messageProperties - */ public void writeTo(Message jmsMessage) throws JMSException { diff --git a/rt/transports/websocket/src/main/java/org/apache/cxf/transport/websocket/WebSocketUtils.java b/rt/transports/websocket/src/main/java/org/apache/cxf/transport/websocket/WebSocketUtils.java index 8bcc67d..85ce616 100644 --- a/rt/transports/websocket/src/main/java/org/apache/cxf/transport/websocket/WebSocketUtils.java +++ b/rt/transports/websocket/src/main/java/org/apache/cxf/transport/websocket/WebSocketUtils.java @@ -184,7 +184,6 @@ public final class WebSocketUtils { /** * Build response bytes without status and type information. * - * @param headers * @param data * @param offset * @param length diff --git a/rt/ws/rm/src/main/java/org/apache/cxf/ws/rm/InternalContextUtils.java b/rt/ws/rm/src/main/java/org/apache/cxf/ws/rm/InternalContextUtils.java index 5fd979f..55e1507 100644 --- a/rt/ws/rm/src/main/java/org/apache/cxf/ws/rm/InternalContextUtils.java +++ b/rt/ws/rm/src/main/java/org/apache/cxf/ws/rm/InternalContextUtils.java @@ -244,7 +244,7 @@ final class InternalContextUtils { /** * Get the Executor for this invocation. - * @param endpoint + * @param message * @return */ private static Executor getExecutor(final Message message) { diff --git a/rt/ws/rm/src/main/java/org/apache/cxf/ws/rm/RMContextUtils.java b/rt/ws/rm/src/main/java/org/apache/cxf/ws/rm/RMContextUtils.java index 53e2ac8..eaf5661 100644 --- a/rt/ws/rm/src/main/java/org/apache/cxf/ws/rm/RMContextUtils.java +++ b/rt/ws/rm/src/main/java/org/apache/cxf/ws/rm/RMContextUtils.java @@ -126,7 +126,6 @@ public final class RMContextUtils { * @param isOutbound true if the message is outbound * @param isRequestor true if the current messaging role is that of * requestor - * @param handler true if HANDLER scope, APPLICATION scope otherwise */ public static void storeMAPs(AddressingProperties maps, Message message, boolean isOutbound, boolean isRequestor) { diff --git a/rt/ws/rm/src/main/java/org/apache/cxf/ws/rm/RMEndpoint.java b/rt/ws/rm/src/main/java/org/apache/cxf/ws/rm/RMEndpoint.java index ae7ac9a..ee50720 100644 --- a/rt/ws/rm/src/main/java/org/apache/cxf/ws/rm/RMEndpoint.java +++ b/rt/ws/rm/src/main/java/org/apache/cxf/ws/rm/RMEndpoint.java @@ -122,7 +122,6 @@ public class RMEndpoint { * * @param m * @param ae - * @param pv */ public RMEndpoint(RMManager m, Endpoint ae) { manager = m; diff --git a/rt/ws/rm/src/main/java/org/apache/cxf/ws/rm/policy/RMPolicyUtilities.java b/rt/ws/rm/src/main/java/org/apache/cxf/ws/rm/policy/RMPolicyUtilities.java index b3c1d21..6d226c7 100644 --- a/rt/ws/rm/src/main/java/org/apache/cxf/ws/rm/policy/RMPolicyUtilities.java +++ b/rt/ws/rm/src/main/java/org/apache/cxf/ws/rm/policy/RMPolicyUtilities.java @@ -59,7 +59,7 @@ public final class RMPolicyUtilities { * Returns an RMAssertion that is compatible with the default value and all RMAssertions pertaining to the * message (can never be null). * - * @param rma the default value (non-<code>null</code>) + * @param defaultValue the default value (non-<code>null</code>) * @param message the message * @return the compatible RMAssertion */ @@ -349,4 +349,4 @@ public final class RMPolicyUtilities { } return compatible; } -} \ No newline at end of file +} diff --git a/rt/ws/rm/src/main/java/org/apache/cxf/ws/rm/soap/RedeliveryQueueImpl.java b/rt/ws/rm/src/main/java/org/apache/cxf/ws/rm/soap/RedeliveryQueueImpl.java index 5508a97..c117263 100644 --- a/rt/ws/rm/src/main/java/org/apache/cxf/ws/rm/soap/RedeliveryQueueImpl.java +++ b/rt/ws/rm/src/main/java/org/apache/cxf/ws/rm/soap/RedeliveryQueueImpl.java @@ -277,7 +277,7 @@ public class RedeliveryQueueImpl implements RedeliveryQueue { /** * Accepts a new resend candidate. * - * @param ctx the message context. + * @param message the message. * @return ResendCandidate */ protected RedeliverCandidate cacheUndelivered(Message message) { diff --git a/rt/ws/security/src/main/java/org/apache/cxf/ws/security/trust/TrustException.java b/rt/ws/security/src/main/java/org/apache/cxf/ws/security/trust/TrustException.java index 6809edb..f42f9d8 100644 --- a/rt/ws/security/src/main/java/org/apache/cxf/ws/security/trust/TrustException.java +++ b/rt/ws/security/src/main/java/org/apache/cxf/ws/security/trust/TrustException.java @@ -45,8 +45,9 @@ public class TrustException extends UncheckedException { super(msg, t); } /** + * @param log * @param msg - * @param t + * @param params */ public TrustException(Logger log, String msg, Object ... params) { super(log, msg, params); diff --git a/rt/ws/security/src/main/java/org/apache/cxf/ws/security/wss4j/AbstractTokenInterceptor.java b/rt/ws/security/src/main/java/org/apache/cxf/ws/security/wss4j/AbstractTokenInterceptor.java index 632dbe9..20a29a3 100644 --- a/rt/ws/security/src/main/java/org/apache/cxf/ws/security/wss4j/AbstractTokenInterceptor.java +++ b/rt/ws/security/src/main/java/org/apache/cxf/ws/security/wss4j/AbstractTokenInterceptor.java @@ -64,9 +64,6 @@ public abstract class AbstractTokenInterceptor extends AbstractSoapInterceptor { private static final Set<QName> HEADERS = Collections.singleton(new QName(WSConstants.WSSE_NS, "Security")); - /** - * @param p - */ public AbstractTokenInterceptor() { super(Phase.PRE_PROTOCOL); addAfter(PolicyBasedWSS4JOutInterceptor.class.getName()); diff --git a/rt/ws/security/src/main/java/org/apache/cxf/ws/security/wss4j/CryptoCoverageUtil.java b/rt/ws/security/src/main/java/org/apache/cxf/ws/security/wss4j/CryptoCoverageUtil.java index 57ec26c..0467717 100644 --- a/rt/ws/security/src/main/java/org/apache/cxf/ws/security/wss4j/CryptoCoverageUtil.java +++ b/rt/ws/security/src/main/java/org/apache/cxf/ws/security/wss4j/CryptoCoverageUtil.java @@ -186,7 +186,7 @@ public final class CryptoCoverageUtil { * the SOAP header element * @param refs * the refs to the data extracted from the signature/encryption - * @param namespaces + * @param namespace * the namespace of the header(s) to check for coverage * @param name * the local part of the header name to check for coverage, may be null diff --git a/rt/ws/security/src/main/java/org/apache/cxf/ws/security/wss4j/WSS4JStaxOutInterceptor.java b/rt/ws/security/src/main/java/org/apache/cxf/ws/security/wss4j/WSS4JStaxOutInterceptor.java index 890ff52..8bccbdd 100644 --- a/rt/ws/security/src/main/java/org/apache/cxf/ws/security/wss4j/WSS4JStaxOutInterceptor.java +++ b/rt/ws/security/src/main/java/org/apache/cxf/ws/security/wss4j/WSS4JStaxOutInterceptor.java @@ -106,7 +106,7 @@ public class WSS4JStaxOutInterceptor extends AbstractWSS4JStaxInterceptor { * Enable or disable mtom with WS-Security. MTOM is disabled if we are signing or * encrypting the message Body, as otherwise attachments would not get encrypted * or be part of the signature. - * @param mtomEnabled + * @param allowMTOM */ public void setAllowMTOM(boolean allowMTOM) { this.mtomEnabled = allowMTOM; diff --git a/rt/ws/security/src/main/java/org/apache/cxf/ws/security/wss4j/policyvalidators/AbstractSupportingTokenPolicyValidator.java b/rt/ws/security/src/main/java/org/apache/cxf/ws/security/wss4j/policyvalidators/AbstractSupportingTokenPolicyValidator.java index 44a9283..ee03c6b 100644 --- a/rt/ws/security/src/main/java/org/apache/cxf/ws/security/wss4j/policyvalidators/AbstractSupportingTokenPolicyValidator.java +++ b/rt/ws/security/src/main/java/org/apache/cxf/ws/security/wss4j/policyvalidators/AbstractSupportingTokenPolicyValidator.java @@ -569,7 +569,7 @@ public abstract class AbstractSupportingTokenPolicyValidator extends AbstractSec /** * Check that a WSSecurityEngineResult corresponding to a signature or encryption uses the same * signing/encrypting credential as one of the tokens. - * @param signatureResult a WSSecurityEngineResult corresponding to a signature or encryption + * @param result a WSSecurityEngineResult corresponding to a signature or encryption * @param tokenResult A list of WSSecurityEngineResults corresponding to tokens * @return */ diff --git a/services/sts/sts-core/src/main/java/org/apache/cxf/sts/request/RequestParser.java b/services/sts/sts-core/src/main/java/org/apache/cxf/sts/request/RequestParser.java index 5859845..f474d14 100644 --- a/services/sts/sts-core/src/main/java/org/apache/cxf/sts/request/RequestParser.java +++ b/services/sts/sts-core/src/main/java/org/apache/cxf/sts/request/RequestParser.java @@ -487,7 +487,7 @@ public class RequestParser { /** * Parse an Entropy object - * @param entropy an Entropy object + * @param entropyType an EntropyType object * @param stsProperties A STSPropertiesMBean object used to decrypt an EncryptedKey */ private static Entropy parseEntropy( diff --git a/services/ws-discovery/ws-discovery-api/src/main/java/org/apache/cxf/ws/discovery/WSDiscoveryClient.java b/services/ws-discovery/ws-discovery-api/src/main/java/org/apache/cxf/ws/discovery/WSDiscoveryClient.java index 0497fdf..4cfb292 100644 --- a/services/ws-discovery/ws-discovery-api/src/main/java/org/apache/cxf/ws/discovery/WSDiscoveryClient.java +++ b/services/ws-discovery/ws-discovery-api/src/main/java/org/apache/cxf/ws/discovery/WSDiscoveryClient.java @@ -146,7 +146,6 @@ public class WSDiscoveryClient implements Closeable { /** * WS-Discovery will use SOAP 1.2 by default. This allows forcing the use of SOAP 1.1. - * @param do11 */ public void setSoapVersion11() { setSoapVersion(true); diff --git a/services/xkms/xkms-x509-handlers/src/main/java/org/apache/cxf/xkms/x509/validator/TrustedAuthorityValidator.java b/services/xkms/xkms-x509-handlers/src/main/java/org/apache/cxf/xkms/x509/validator/TrustedAuthorityValidator.java index f7fe5bc..76a4314 100644 --- a/services/xkms/xkms-x509-handlers/src/main/java/org/apache/cxf/xkms/x509/validator/TrustedAuthorityValidator.java +++ b/services/xkms/xkms-x509-handlers/src/main/java/org/apache/cxf/xkms/x509/validator/TrustedAuthorityValidator.java @@ -60,9 +60,9 @@ public class TrustedAuthorityValidator implements Validator { } /** - * Checks if a certificate is signed by a trusted authority. + * Checks if a certificate chain is signed by a trusted authority. * - * @param x509Certificate to check + * @param certificates to check * @return the validity state of the certificate */ boolean isCertificateChainValid(List<X509Certificate> certificates) { diff --git a/tools/common/src/main/java/org/apache/cxf/tools/common/AbstractCXFToolContainer.java b/tools/common/src/main/java/org/apache/cxf/tools/common/AbstractCXFToolContainer.java index abb1e81..73914b3 100644 --- a/tools/common/src/main/java/org/apache/cxf/tools/common/AbstractCXFToolContainer.java +++ b/tools/common/src/main/java/org/apache/cxf/tools/common/AbstractCXFToolContainer.java @@ -258,7 +258,7 @@ public abstract class AbstractCXFToolContainer extends AbstractToolContainer { /** * get all parameters in a map - * @param stringArrayKeys, contains keys, whose value should be string array + * @param stringArrayKeys contains keys, whose value should be string array */ protected Map<String, Object> getParametersMap(Set<String> stringArrayKeys) { Map<String, Object> map = new HashMap<>(); diff --git a/tools/javato/ws/src/main/java/org/apache/cxf/tools/java2wsdl/processor/internal/ServiceBuilderFactory.java b/tools/javato/ws/src/main/java/org/apache/cxf/tools/java2wsdl/processor/internal/ServiceBuilderFactory.java index a2302ae..8652115 100644 --- a/tools/javato/ws/src/main/java/org/apache/cxf/tools/java2wsdl/processor/internal/ServiceBuilderFactory.java +++ b/tools/javato/ws/src/main/java/org/apache/cxf/tools/java2wsdl/processor/internal/ServiceBuilderFactory.java @@ -73,7 +73,7 @@ public abstract class ServiceBuilderFactory { /** * Return the databinding name. * - * @return + * @return the databinding name. */ public String getDatabindingName() { return databindingName; @@ -84,7 +84,7 @@ public abstract class ServiceBuilderFactory { * * @param databindingName */ - public void setDatabindingName(String arg) { - databindingName = arg; + public void setDatabindingName(String databindingName) { + this.databindingName = databindingName; } }
