From eaa55fa48ea51307a8486b92e1844504897fed06 Mon Sep 17 00:00:00 2001
From: Brian Long <brian@inteligr8.com>
Date: Wed, 27 Oct 2021 14:54:22 -0400
Subject: [PATCH] javadoc fixes

---
 .../rs/BearerTokenAuthorizationFilter.java    |  3 --
 .../inteligr8/rs/ClientCxfConfiguration.java  |  2 +-
 .../com/inteligr8/rs/ClientJerseyImpl.java    |  6 +++-
 .../rs/OAuthAuthorizationFilter.java          | 32 +++++++++++++++++--
 4 files changed, 36 insertions(+), 7 deletions(-)

diff --git a/src/main/java/com/inteligr8/rs/BearerTokenAuthorizationFilter.java b/src/main/java/com/inteligr8/rs/BearerTokenAuthorizationFilter.java
index fdb666b..4b7b475 100755
--- a/src/main/java/com/inteligr8/rs/BearerTokenAuthorizationFilter.java
+++ b/src/main/java/com/inteligr8/rs/BearerTokenAuthorizationFilter.java
@@ -1,7 +1,5 @@
 package com.inteligr8.rs;
 
-import java.io.UnsupportedEncodingException;
-
 import javax.ws.rs.client.ClientRequestContext;
 import javax.ws.rs.core.HttpHeaders;
 
@@ -30,7 +28,6 @@ public class BearerTokenAuthorizationFilter implements AuthorizationFilter {
 	 * This method applies the 'Authorization' header to the {@link ClientRequestContext}.
 	 * 
 	 * @param requestContext A request context.
-	 * @throws UnsupportedEncodingException The 'utf-8' encoding is not supported.
 	 */
 	@Override
 	public void filter(ClientRequestContext requestContext) {
diff --git a/src/main/java/com/inteligr8/rs/ClientCxfConfiguration.java b/src/main/java/com/inteligr8/rs/ClientCxfConfiguration.java
index 292c31b..3ade952 100644
--- a/src/main/java/com/inteligr8/rs/ClientCxfConfiguration.java
+++ b/src/main/java/com/inteligr8/rs/ClientCxfConfiguration.java
@@ -13,7 +13,7 @@ public interface ClientCxfConfiguration extends ClientConfiguration {
 	 * wreck havoc on your implementation.  This method allows you to
 	 * explicitly by-pass the default bus.
 	 * 
-	 * @see https://cxf.apache.org/docs/bus-configuration.html
+	 * See https://cxf.apache.org/docs/bus-configuration.html.
 	 * 
 	 * @return true to use the default bus; false otherwise.
 	 */
diff --git a/src/main/java/com/inteligr8/rs/ClientJerseyImpl.java b/src/main/java/com/inteligr8/rs/ClientJerseyImpl.java
index 9f79203..c35f646 100644
--- a/src/main/java/com/inteligr8/rs/ClientJerseyImpl.java
+++ b/src/main/java/com/inteligr8/rs/ClientJerseyImpl.java
@@ -26,7 +26,11 @@ public abstract class ClientJerseyImpl extends Client implements InitializingBea
 	public void afterPropertiesSet() {
 		this.register();
 	}
-	
+
+	/**
+	 * This method registers the Jersey library as the default provider for the
+	 * JAX-RS specification.
+	 */
 	public void register() {
 		if (RuntimeDelegate.getInstance() == null) {
 			this.logger.info("Setting JAX-RS runtime delegate to the Jersey library");
diff --git a/src/main/java/com/inteligr8/rs/OAuthAuthorizationFilter.java b/src/main/java/com/inteligr8/rs/OAuthAuthorizationFilter.java
index 25ec89f..efab17c 100755
--- a/src/main/java/com/inteligr8/rs/OAuthAuthorizationFilter.java
+++ b/src/main/java/com/inteligr8/rs/OAuthAuthorizationFilter.java
@@ -27,14 +27,42 @@ public abstract class OAuthAuthorizationFilter implements AuthorizationFilter {
 	private long expiration;
 	private String refreshToken;
 	
+	/**
+	 * This constructor creates an OAuth-based authorization filter using the
+	 * OAuth identity provider token URL and a client ID registered with the
+	 * same OAuth identity provider.
+	 * 
+	 * @param tokenUrl An OAuth identity provider token URL.
+	 * @param clientId An OAuth identity provider client ID.
+	 */
 	public OAuthAuthorizationFilter(String tokenUrl, String clientId) {
 		this(tokenUrl, clientId, null);
 	}
-	
+
+	/**
+	 * This constructor creates an OAuth-based authorization filter using the
+	 * OAuth identity provider token URL, client ID registered with the
+	 * same OAuth identity provider, and the corresponding client secret.
+	 * 
+	 * @param tokenUrl An OAuth identity provider token URL.
+	 * @param clientId An OAuth identity provider client ID.
+	 * @param clientSecret A secret corresponding to the client ID.
+	 */
 	public OAuthAuthorizationFilter(String tokenUrl, String clientId, String clientSecret) {
 		this(tokenUrl, clientId, clientSecret, null);
 	}
-	
+
+	/**
+	 * This constructor creates an OAuth-based authorization filter using the
+	 * OAuth identity provider token URL, client ID registered with the
+	 * same OAuth identity provider, the corresponding client secret, and OAuth
+	 * scope.
+	 * 
+	 * @param tokenUrl An OAuth identity provider token URL.
+	 * @param clientId An OAuth identity provider client ID.
+	 * @param clientSecret A secret corresponding to the client ID.
+	 * @param scope An OAuth scope.
+	 */
 	public OAuthAuthorizationFilter(String tokenUrl, String clientId, String clientSecret, String scope) {
 		this.tokenUrl = tokenUrl;
 		this.clientId = clientId;