You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cxf.apache.org by co...@apache.org on 2020/01/10 12:59:24 UTC
[cxf] branch master updated: Javadoc fixes
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
The following commit(s) were added to refs/heads/master by this push:
new 314b148 Javadoc fixes
314b148 is described below
commit 314b148a9b6e80d743d92cad4d56991623386980
Author: Colm O hEigeartaigh <co...@apache.org>
AuthorDate: Fri Jan 10 12:53:02 2020 +0000
Javadoc fixes
---
.../apache/cxf/transport/http_jaxws_spi/JAXWSHttpSpiDestination.java | 1 -
.../src/main/java/org/apache/cxf/frontend/ServerFactoryBean.java | 2 +-
.../src/main/java/org/apache/cxf/javascript/AttributeInfo.java | 3 ++-
.../src/main/java/org/apache/cxf/javascript/JavascriptUtils.java | 3 ++-
.../src/main/java/org/apache/cxf/javascript/ParticleInfo.java | 3 ++-
.../org/apache/cxf/javascript/service/ServiceJavascriptBuilder.java | 2 +-
.../java/org/apache/cxf/javascript/types/SchemaJavascriptBuilder.java | 2 +-
.../org/apache/cxf/rs/security/oauth/client/OAuthClientUtils.java | 2 +-
.../main/java/org/apache/cxf/rs/security/oauth/data/Permission.java | 2 +-
.../main/java/org/apache/cxf/rs/security/oauth/data/RequestToken.java | 2 +-
.../apache/cxf/rs/security/oauth2/common/OAuthAuthorizationData.java | 4 ++--
.../rs/security/oauth2/grants/code/AuthorizationCodeDataProvider.java | 2 +-
.../org/apache/cxf/rs/security/oauth2/provider/OAuthDataProvider.java | 3 ++-
.../rs/security/oauth2/provider/SessionAuthenticityTokenProvider.java | 2 +-
.../org/apache/cxf/rs/security/saml/sso/EHCacheTokenReplayCache.java | 2 +-
.../java/org/apache/cxf/rs/security/saml/AbstractSamlInHandler.java | 3 ++-
16 files changed, 21 insertions(+), 17 deletions(-)
diff --git a/rt/frontend/jaxws/src/main/java/org/apache/cxf/transport/http_jaxws_spi/JAXWSHttpSpiDestination.java b/rt/frontend/jaxws/src/main/java/org/apache/cxf/transport/http_jaxws_spi/JAXWSHttpSpiDestination.java
index cae4b09..973d2b7 100644
--- a/rt/frontend/jaxws/src/main/java/org/apache/cxf/transport/http_jaxws_spi/JAXWSHttpSpiDestination.java
+++ b/rt/frontend/jaxws/src/main/java/org/apache/cxf/transport/http_jaxws_spi/JAXWSHttpSpiDestination.java
@@ -56,7 +56,6 @@ public class JAXWSHttpSpiDestination extends AbstractHTTPDestination {
/**
* This is called by handlers for servicing requests
*
- * @param context
* @param req
* @param resp
* @throws IOException
diff --git a/rt/frontend/simple/src/main/java/org/apache/cxf/frontend/ServerFactoryBean.java b/rt/frontend/simple/src/main/java/org/apache/cxf/frontend/ServerFactoryBean.java
index a76c3ba..2d15c62 100644
--- a/rt/frontend/simple/src/main/java/org/apache/cxf/frontend/ServerFactoryBean.java
+++ b/rt/frontend/simple/src/main/java/org/apache/cxf/frontend/ServerFactoryBean.java
@@ -317,7 +317,7 @@ public class ServerFactoryBean extends AbstractWSDLBasedEndpointFactory {
* used by the factory to create services. Typically, the WSDL
* location is specified as a URL.
*
- * @param locaiton the URL of the WSDL defining the service interface
+ * @param location the URL of the WSDL defining the service interface
*/
public void setWsdlLocation(String location) {
setWsdlURL(location);
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 14179da..a7c2a00 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,10 +80,11 @@ public final class AttributeInfo implements ItemInfo {
/**
* Fill in an AttributeInfo for an attribute or anyAttribute from a sequence.
*
- * @param sequenceElement
+ * @param sequesequenceObjectnceElement
* @param currentSchema
* @param schemaCollection
* @param prefixAccumulator
+ * @param contextName
* @return
*/
public static AttributeInfo forLocalItem(XmlSchemaObject sequenceObject,
diff --git a/rt/javascript/javascript-rt/src/main/java/org/apache/cxf/javascript/JavascriptUtils.java b/rt/javascript/javascript-rt/src/main/java/org/apache/cxf/javascript/JavascriptUtils.java
index f23c07d..5ee06cf 100755
--- a/rt/javascript/javascript-rt/src/main/java/org/apache/cxf/javascript/JavascriptUtils.java
+++ b/rt/javascript/javascript-rt/src/main/java/org/apache/cxf/javascript/JavascriptUtils.java
@@ -454,7 +454,8 @@ public class JavascriptUtils {
* Generate code to serialize an xs:any. There is too much duplicate code
* with the element serializer; fix that some day.
*
- * @param elementInfo
+ * @param itemInfo
+ * @param prefix
* @param schemaCollection
*/
public void generateCodeToSerializeAny(ParticleInfo itemInfo, String prefix,
diff --git a/rt/javascript/javascript-rt/src/main/java/org/apache/cxf/javascript/ParticleInfo.java b/rt/javascript/javascript-rt/src/main/java/org/apache/cxf/javascript/ParticleInfo.java
index e6ba2cd..60fe8e7 100644
--- a/rt/javascript/javascript-rt/src/main/java/org/apache/cxf/javascript/ParticleInfo.java
+++ b/rt/javascript/javascript-rt/src/main/java/org/apache/cxf/javascript/ParticleInfo.java
@@ -131,10 +131,11 @@ public final class ParticleInfo implements ItemInfo {
/**
* Fill in an ElementInfo for an element or xs:any from a sequence.
*
- * @param sequenceElement
+ * @param sequenceObject
* @param currentSchema
* @param schemaCollection
* @param prefixAccumulator
+ * @param contextName
* @return
*/
public static ParticleInfo forLocalItem(XmlSchemaObject sequenceObject, XmlSchema currentSchema,
diff --git a/rt/javascript/javascript-rt/src/main/java/org/apache/cxf/javascript/service/ServiceJavascriptBuilder.java b/rt/javascript/javascript-rt/src/main/java/org/apache/cxf/javascript/service/ServiceJavascriptBuilder.java
index 38d6577..b4a10ee 100755
--- a/rt/javascript/javascript-rt/src/main/java/org/apache/cxf/javascript/service/ServiceJavascriptBuilder.java
+++ b/rt/javascript/javascript-rt/src/main/java/org/apache/cxf/javascript/service/ServiceJavascriptBuilder.java
@@ -686,7 +686,7 @@ public class ServiceJavascriptBuilder extends ServiceModelVisitor {
/**
* Collect information about the parts of an unwrapped message.
- * @param parts
+ * @param message
* @param elements
*/
private void getElementsForParts(MessageInfo message, List<ParticleInfo> elements) {
diff --git a/rt/javascript/javascript-rt/src/main/java/org/apache/cxf/javascript/types/SchemaJavascriptBuilder.java b/rt/javascript/javascript-rt/src/main/java/org/apache/cxf/javascript/types/SchemaJavascriptBuilder.java
index b0604d1..a53fb8d 100755
--- a/rt/javascript/javascript-rt/src/main/java/org/apache/cxf/javascript/types/SchemaJavascriptBuilder.java
+++ b/rt/javascript/javascript-rt/src/main/java/org/apache/cxf/javascript/types/SchemaJavascriptBuilder.java
@@ -344,7 +344,7 @@ public class SchemaJavascriptBuilder {
*
* @param type
* @param elementPrefix
- * @param bodyNamespaceURIs
+ * @param bodyUtils
* @return
*/
protected void complexTypeSerializerBody(XmlSchemaComplexType type, String elementPrefix,
diff --git a/rt/rs/security/oauth-parent/oauth/src/main/java/org/apache/cxf/rs/security/oauth/client/OAuthClientUtils.java b/rt/rs/security/oauth-parent/oauth/src/main/java/org/apache/cxf/rs/security/oauth/client/OAuthClientUtils.java
index a4a3919..567200e 100644
--- a/rt/rs/security/oauth-parent/oauth/src/main/java/org/apache/cxf/rs/security/oauth/client/OAuthClientUtils.java
+++ b/rt/rs/security/oauth-parent/oauth/src/main/java/org/apache/cxf/rs/security/oauth/client/OAuthClientUtils.java
@@ -150,7 +150,7 @@ public final class OAuthClientUtils {
/**
* Creates OAuth Authorization header
* @param consumer Consumer bean containing the consumer key and secret
- * @param token Access token representation
+ * @param accessToken Access token representation
* @param method HTTP method
* @param requestURI request URI
* @return the header value
diff --git a/rt/rs/security/oauth-parent/oauth/src/main/java/org/apache/cxf/rs/security/oauth/data/Permission.java b/rt/rs/security/oauth-parent/oauth/src/main/java/org/apache/cxf/rs/security/oauth/data/Permission.java
index 51f88b8..fe1fd6d 100644
--- a/rt/rs/security/oauth-parent/oauth/src/main/java/org/apache/cxf/rs/security/oauth/data/Permission.java
+++ b/rt/rs/security/oauth-parent/oauth/src/main/java/org/apache/cxf/rs/security/oauth/data/Permission.java
@@ -57,7 +57,7 @@ public class Permission {
* Indicates that this permission has been allocated by default.
* Authorization View handlers may use this property in order to restrict
* the list of scopes which may be refused to non-default scopes only
- * @param isDefault
+ * @param value
*/
public void setDefault(boolean value) {
this.isDefault = value;
diff --git a/rt/rs/security/oauth-parent/oauth/src/main/java/org/apache/cxf/rs/security/oauth/data/RequestToken.java b/rt/rs/security/oauth-parent/oauth/src/main/java/org/apache/cxf/rs/security/oauth/data/RequestToken.java
index 9d1c161..fc26252 100644
--- a/rt/rs/security/oauth-parent/oauth/src/main/java/org/apache/cxf/rs/security/oauth/data/RequestToken.java
+++ b/rt/rs/security/oauth-parent/oauth/src/main/java/org/apache/cxf/rs/security/oauth/data/RequestToken.java
@@ -41,7 +41,7 @@ public class RequestToken extends Token {
/**
* Sets the token verifier
- * @param oauthVerifier
+ * @param verifier
*/
public void setVerifier(String verifier) {
this.oauthVerifier = verifier;
diff --git a/rt/rs/security/oauth-parent/oauth2/src/main/java/org/apache/cxf/rs/security/oauth2/common/OAuthAuthorizationData.java b/rt/rs/security/oauth-parent/oauth2/src/main/java/org/apache/cxf/rs/security/oauth2/common/OAuthAuthorizationData.java
index 5e250e1..e13daa4 100644
--- a/rt/rs/security/oauth-parent/oauth2/src/main/java/org/apache/cxf/rs/security/oauth2/common/OAuthAuthorizationData.java
+++ b/rt/rs/security/oauth-parent/oauth2/src/main/java/org/apache/cxf/rs/security/oauth2/common/OAuthAuthorizationData.java
@@ -104,7 +104,7 @@ public class OAuthAuthorizationData extends OAuthRedirectionState implements Ser
/**
* Set the list of scopes already approved by a user
- * @param permissions the list of approved scopes
+ * @param perms the list of approved scopes
*/
public void setAlreadyAuthorizedPermissions(List<OAuthPermission> perms) {
this.alreadyAuthorizedPermissions = perms;
@@ -283,5 +283,5 @@ public class OAuthAuthorizationData extends OAuthRedirectionState implements Ser
public String getPreauthorizedTokenKey() {
return this.preauthorizedTokenKey;
}
-
+
}
diff --git a/rt/rs/security/oauth-parent/oauth2/src/main/java/org/apache/cxf/rs/security/oauth2/grants/code/AuthorizationCodeDataProvider.java b/rt/rs/security/oauth-parent/oauth2/src/main/java/org/apache/cxf/rs/security/oauth2/grants/code/AuthorizationCodeDataProvider.java
index bdab2e2..3afa003 100644
--- a/rt/rs/security/oauth-parent/oauth2/src/main/java/org/apache/cxf/rs/security/oauth2/grants/code/AuthorizationCodeDataProvider.java
+++ b/rt/rs/security/oauth-parent/oauth2/src/main/java/org/apache/cxf/rs/security/oauth2/grants/code/AuthorizationCodeDataProvider.java
@@ -62,5 +62,5 @@ public interface AuthorizationCodeDataProvider extends OAuthDataProvider {
* @throws OAuthServiceException
* @see ServerAuthorizationCodeGrant
*/
- List<ServerAuthorizationCodeGrant> getCodeGrants(Client c, UserSubject subject) throws OAuthServiceException;
+ List<ServerAuthorizationCodeGrant> getCodeGrants(Client client, UserSubject subject) throws OAuthServiceException;
}
diff --git a/rt/rs/security/oauth-parent/oauth2/src/main/java/org/apache/cxf/rs/security/oauth2/provider/OAuthDataProvider.java b/rt/rs/security/oauth-parent/oauth2/src/main/java/org/apache/cxf/rs/security/oauth2/provider/OAuthDataProvider.java
index 024dfb6..8178edd 100644
--- a/rt/rs/security/oauth-parent/oauth2/src/main/java/org/apache/cxf/rs/security/oauth2/provider/OAuthDataProvider.java
+++ b/rt/rs/security/oauth-parent/oauth2/src/main/java/org/apache/cxf/rs/security/oauth2/provider/OAuthDataProvider.java
@@ -106,7 +106,8 @@ public interface OAuthDataProvider {
/**
* Revokes a refresh or access token
- * @param token token identifier
+ * @param client the client
+ * @param tokenId token identifier
* @param tokenTypeHint can be access_token or refresh_token or null
* @throws OAuthServiceException
*/
diff --git a/rt/rs/security/oauth-parent/oauth2/src/main/java/org/apache/cxf/rs/security/oauth2/provider/SessionAuthenticityTokenProvider.java b/rt/rs/security/oauth-parent/oauth2/src/main/java/org/apache/cxf/rs/security/oauth2/provider/SessionAuthenticityTokenProvider.java
index 357eccd..e193d98 100644
--- a/rt/rs/security/oauth-parent/oauth2/src/main/java/org/apache/cxf/rs/security/oauth2/provider/SessionAuthenticityTokenProvider.java
+++ b/rt/rs/security/oauth-parent/oauth2/src/main/java/org/apache/cxf/rs/security/oauth2/provider/SessionAuthenticityTokenProvider.java
@@ -71,7 +71,7 @@ public interface SessionAuthenticityTokenProvider {
/**
* Expand the session token
*
- * @param mc the {@link MessageContext} of this request
+ * @param messageContext the {@link MessageContext} of this request
* @param sessionToken the token
* @param subject authenticated end user
* @return the expanded token or null
diff --git a/rt/rs/security/sso/saml/src/main/java/org/apache/cxf/rs/security/saml/sso/EHCacheTokenReplayCache.java b/rt/rs/security/sso/saml/src/main/java/org/apache/cxf/rs/security/saml/sso/EHCacheTokenReplayCache.java
index 4d9364b..61cc5dd 100644
--- a/rt/rs/security/sso/saml/src/main/java/org/apache/cxf/rs/security/saml/sso/EHCacheTokenReplayCache.java
+++ b/rt/rs/security/sso/saml/src/main/java/org/apache/cxf/rs/security/saml/sso/EHCacheTokenReplayCache.java
@@ -127,7 +127,7 @@ public class EHCacheTokenReplayCache implements TokenReplayCache<String> {
/**
* Add the given identifier to the cache.
- * @param identifier The identifier to be added
+ * @param id The identifier to be added
* @param timeToLive The length of time to cache the Identifier in seconds
*/
public void putId(String id, long timeToLive) {
diff --git a/rt/rs/security/xml/src/main/java/org/apache/cxf/rs/security/saml/AbstractSamlInHandler.java b/rt/rs/security/xml/src/main/java/org/apache/cxf/rs/security/saml/AbstractSamlInHandler.java
index 4fc4ff5..38e1c01 100644
--- a/rt/rs/security/xml/src/main/java/org/apache/cxf/rs/security/saml/AbstractSamlInHandler.java
+++ b/rt/rs/security/xml/src/main/java/org/apache/cxf/rs/security/saml/AbstractSamlInHandler.java
@@ -321,7 +321,8 @@ public abstract class AbstractSamlInHandler implements ContainerRequestFilter {
* used to verify signatures.
* Return true on a match
* @param subjectKeyInfo the SAMLKeyInfo object
- * @param signedResults a list of all of the signed results
+ * @param message the current Message
+ * @param tlsCerts the TLS client certificates
* @return true if the credentials of the assertion were used to verify a signature
*/
private boolean compareCredentials(