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 2018/06/25 14:11:28 UTC
[cxf-fediz] 02/02: Javadoc error 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-fediz.git
commit fcb562dd498526ffe96c63846ceec385b9484b3c
Author: Colm O hEigeartaigh <co...@apache.org>
AuthorDate: Mon Jun 25 15:11:14 2018 +0100
Javadoc error fixes
---
.../main/java/org/apache/cxf/fediz/core/ClaimTypes.java | 2 +-
.../org/apache/cxf/fediz/core/FederationConstants.java | 17 +++++++++--------
.../apache/cxf/fediz/core/util/ClassLoaderUtils.java | 10 ++++++----
3 files changed, 16 insertions(+), 13 deletions(-)
diff --git a/plugins/core/src/main/java/org/apache/cxf/fediz/core/ClaimTypes.java b/plugins/core/src/main/java/org/apache/cxf/fediz/core/ClaimTypes.java
index 6c5b736..5932000 100644
--- a/plugins/core/src/main/java/org/apache/cxf/fediz/core/ClaimTypes.java
+++ b/plugins/core/src/main/java/org/apache/cxf/fediz/core/ClaimTypes.java
@@ -50,7 +50,7 @@ public interface ClaimTypes {
/**
* (mail in inetOrgPerson) Preferred address for the "To:" field of email
- * to be sent to the Subject, usually of the form <user>@<domain>.
+ * to be sent to the Subject, usually of the form user@domain.
* According to inetOrgPerson using [RFC 1274]: This attribute type specifies
* an electronic mailbox attribute following the syntax specified in RFC 822.
*/
diff --git a/plugins/core/src/main/java/org/apache/cxf/fediz/core/FederationConstants.java b/plugins/core/src/main/java/org/apache/cxf/fediz/core/FederationConstants.java
index 88bd273..799c718 100644
--- a/plugins/core/src/main/java/org/apache/cxf/fediz/core/FederationConstants.java
+++ b/plugins/core/src/main/java/org/apache/cxf/fediz/core/FederationConstants.java
@@ -48,7 +48,7 @@ public final class FederationConstants extends FedizConstants {
/**
* This OPTIONAL parameter is the URL to which responses are directed. Note that this serves roughly the
- * same purpose as the WS-Addressing <wsa:ReplyTo> header for the WS-Trust SOAP RST messages.
+ * same purpose as the WS-Addressing <wsa:ReplyTo> header for the WS-Trust SOAP RST messages.
*/
public static final String PARAM_REPLY = "wreply";
@@ -74,7 +74,7 @@ public final class FederationConstants extends FedizConstants {
public static final String PARAM_AUTH_TYPE = "wauth";
/**
- * This OPTIONAL parameter specifies a token request using either a <wst:RequestSecurityToken> element or
+ * This OPTIONAL parameter specifies a token request using either a <wst:RequestSecurityToken> element or
* a full request message as described in WS-Trust. If this parameter is not specified, it is assumed that
* the responding service knows the correct type of token to return. Note that this can contain the same
* RST payload as used in WS-Trust RST messages.
@@ -118,9 +118,9 @@ public final class FederationConstants extends FedizConstants {
/**
* This REQUIRED parameter specifies the result of the token issuance. This can take the form of the
- * <wst:RequestSecurityTokenResponse> element or <wst:RequestSecurityTokenResponseCollection> element, a
- * SOAP security token request response (that is, a <S:Envelope>) as detailed in WS-Trust, or a SOAP
- * <S:Fault> element.
+ * <wst:RequestSecurityTokenResponse> element or <wst:RequestSecurityTokenResponseCollection> element, a
+ * SOAP security token request response (that is, a <S:Envelope>) as detailed in WS-Trust, or a SOAP
+ * <S:Fault> element.
*/
public static final String PARAM_RESULT = "wresult";
@@ -138,15 +138,16 @@ public final class FederationConstants extends FedizConstants {
/**
* This OPTIONAL parameter specifies a URL for where to find the request expressed as a
- * <wst:RequestSecurityToken> element. Note that this does not have a WS-Trust parallel. The wreqptr
+ * <wst:RequestSecurityToken> element. Note that this does not have a WS-Trust parallel. The wreqptr
* parameter MUST NOT be included in a token request if wreq is present.
*/
public static final String PARAM_REQUEST_PTR = "wreqptr";
/**
* This parameter specifies a URL to which an HTTP GET can be issued. The result is a document of type
- * text/xml that contains the issuance result. This can either be the <wst:RequestSecurityTokenResponse>
- * element, the <wst:RequestSecurityTokenResponseCollection> element, a SOAP response, or a SOAP <S:Fault>
+ * text/xml that contains the issuance result. This can either be the <wst:RequestSecurityTokenResponse>
+ * element, the <wst:RequestSecurityTokenResponseCollection> element,
+ * a SOAP response, or a SOAP <S:Fault>
* element.
*/
public static final String PARAM_RESULT_PTR = "wresultptr";
diff --git a/plugins/core/src/main/java/org/apache/cxf/fediz/core/util/ClassLoaderUtils.java b/plugins/core/src/main/java/org/apache/cxf/fediz/core/util/ClassLoaderUtils.java
index d2611f0..1c1fbfe 100644
--- a/plugins/core/src/main/java/org/apache/cxf/fediz/core/util/ClassLoaderUtils.java
+++ b/plugins/core/src/main/java/org/apache/cxf/fediz/core/util/ClassLoaderUtils.java
@@ -130,8 +130,9 @@ public final class ClassLoaderUtils {
}
/**
- * Load a given resources. <p/> This method will try to load the resources
+ * Load a given resources. <p> This method will try to load the resources
* using the following methods (in order):
+ * </p>
* <ul>
* <li>From Thread.currentThread().getContextClassLoader()
* <li>From ClassLoaderUtil.class.getClassLoader()
@@ -219,9 +220,9 @@ public final class ClassLoaderUtils {
/**
- * This is a convenience method to load a resource as a stream. <p/> The
+ * This is a convenience method to load a resource as a stream. <p> The
* algorithm used to find the resource is given in getResource()
- *
+ * </p>
* @param resourceName The name of the resource to load
* @param callingClass The Class object of the calling object
*/
@@ -236,8 +237,9 @@ public final class ClassLoaderUtils {
}
/**
- * Load a class with a given name. <p/> It will try to load the class in the
+ * Load a class with a given name. <p> It will try to load the class in the
* following order:
+ * </p>
* <ul>
* <li>From Thread.currentThread().getContextClassLoader()
* <li>Using the basic Class.forName()