javadoc fixes

This commit is contained in:
Brian Long 2021-10-27 14:54:22 -04:00
parent d62a941e64
commit eaa55fa48e
4 changed files with 36 additions and 7 deletions

View File

@ -1,7 +1,5 @@
package com.inteligr8.rs; package com.inteligr8.rs;
import java.io.UnsupportedEncodingException;
import javax.ws.rs.client.ClientRequestContext; import javax.ws.rs.client.ClientRequestContext;
import javax.ws.rs.core.HttpHeaders; 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}. * This method applies the 'Authorization' header to the {@link ClientRequestContext}.
* *
* @param requestContext A request context. * @param requestContext A request context.
* @throws UnsupportedEncodingException The 'utf-8' encoding is not supported.
*/ */
@Override @Override
public void filter(ClientRequestContext requestContext) { public void filter(ClientRequestContext requestContext) {

View File

@ -13,7 +13,7 @@ public interface ClientCxfConfiguration extends ClientConfiguration {
* wreck havoc on your implementation. This method allows you to * wreck havoc on your implementation. This method allows you to
* explicitly by-pass the default bus. * 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. * @return true to use the default bus; false otherwise.
*/ */

View File

@ -26,7 +26,11 @@ public abstract class ClientJerseyImpl extends Client implements InitializingBea
public void afterPropertiesSet() { public void afterPropertiesSet() {
this.register(); this.register();
} }
/**
* This method registers the Jersey library as the default provider for the
* JAX-RS specification.
*/
public void register() { public void register() {
if (RuntimeDelegate.getInstance() == null) { if (RuntimeDelegate.getInstance() == null) {
this.logger.info("Setting JAX-RS runtime delegate to the Jersey library"); this.logger.info("Setting JAX-RS runtime delegate to the Jersey library");

View File

@ -27,14 +27,42 @@ public abstract class OAuthAuthorizationFilter implements AuthorizationFilter {
private long expiration; private long expiration;
private String refreshToken; 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) { public OAuthAuthorizationFilter(String tokenUrl, String clientId) {
this(tokenUrl, clientId, null); 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) { public OAuthAuthorizationFilter(String tokenUrl, String clientId, String clientSecret) {
this(tokenUrl, clientId, clientSecret, null); 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) { public OAuthAuthorizationFilter(String tokenUrl, String clientId, String clientSecret, String scope) {
this.tokenUrl = tokenUrl; this.tokenUrl = tokenUrl;
this.clientId = clientId; this.clientId = clientId;