From 607d8bc9837b4e7f2400cecb09bdd6ab16f8bf6c Mon Sep 17 00:00:00 2001 From: Brad Nicholes Date: Thu, 20 Jul 2023 12:45:07 -0600 Subject: [PATCH] Fix the javadoc errors --- .../safeguardjava/ISafeguardA2AContext.java | 28 +++++++++---------- .../ISafeguardSessionsConnection.java | 6 ++-- .../safeguardjava/StreamResponse.java | 5 ++-- .../data/SafeguardEventListenerState.java | 2 +- 4 files changed, 21 insertions(+), 20 deletions(-) diff --git a/src/main/java/com/oneidentity/safeguard/safeguardjava/ISafeguardA2AContext.java b/src/main/java/com/oneidentity/safeguard/safeguardjava/ISafeguardA2AContext.java index 467a44c..1efc26b 100644 --- a/src/main/java/com/oneidentity/safeguard/safeguardjava/ISafeguardA2AContext.java +++ b/src/main/java/com/oneidentity/safeguard/safeguardjava/ISafeguardA2AContext.java @@ -36,13 +36,13 @@ public interface ISafeguardA2AContext char[] retrievePassword(char[] apiKey) throws ObjectDisposedException, SafeguardForJavaException, ArgumentException; /** - * Sets a password using Safeguard A2A. + * Sets a password using Safeguard A2A. * - * @param apiKey API key corresponding to the configured account. - * @param password Password to set. - * @throws com.oneidentity.safeguard.safeguardjava.exceptions.ObjectDisposedException - * @throws com.oneidentity.safeguard.safeguardjava.exceptions.SafeguardForJavaException - * @throws com.oneidentity.safeguard.safeguardjava.exceptions.ArgumentException + * @param apiKey API key corresponding to the configured account. + * @param password Password to set. + * @throws ObjectDisposedException Object has already been disposed. + * @throws SafeguardForJavaException General Safeguard for Java exception. + * @throws ArgumentException Invalid argument. */ void SetPassword(char[] apiKey, char[] password) throws ObjectDisposedException, SafeguardForJavaException, ArgumentException; @@ -70,15 +70,15 @@ public interface ISafeguardA2AContext List retrieveApiKeySecret(char[] apiKey) throws ObjectDisposedException, ArgumentException, SafeguardForJavaException; /** - * Sets an SSH private key using Safeguard A2A. + * Sets an SSH private key using Safeguard A2A. * - * @param apiKey API key corresponding to the configured account. - * @param privateKey Private key to set. - * @param password Password associated with the private key. - * @param keyFormat Format to use when returning private key. - * @throws com.oneidentity.safeguard.safeguardjava.exceptions.ObjectDisposedException - * @throws com.oneidentity.safeguard.safeguardjava.exceptions.ArgumentException - * @throws com.oneidentity.safeguard.safeguardjava.exceptions.SafeguardForJavaException + * @param apiKey API key corresponding to the configured account. + * @param privateKey Private key to set. + * @param password Password associated with the private key. + * @param keyFormat Format to use when returning private key. + * @throws ObjectDisposedException Object has already been disposed. + * @throws SafeguardForJavaException General Safeguard for Java exception. + * @throws ArgumentException Invalid argument. */ void SetPrivateKey(char[] apiKey, char[] privateKey, char[] password, KeyFormat keyFormat) throws ObjectDisposedException, ArgumentException, SafeguardForJavaException; diff --git a/src/main/java/com/oneidentity/safeguard/safeguardjava/ISafeguardSessionsConnection.java b/src/main/java/com/oneidentity/safeguard/safeguardjava/ISafeguardSessionsConnection.java index e7583f0..57631db 100644 --- a/src/main/java/com/oneidentity/safeguard/safeguardjava/ISafeguardSessionsConnection.java +++ b/src/main/java/com/oneidentity/safeguard/safeguardjava/ISafeguardSessionsConnection.java @@ -43,10 +43,10 @@ FullResponse invokeMethodFull(Method method, String relativeUrl, String body) throws ObjectDisposedException, SafeguardForJavaException, ArgumentException; /** - * Provides support for HTTP streaming requests + * Provides support for HTTP streaming requests * - * @return returns ISpsStreamingRequest - * @throws com.oneidentity.safeguard.safeguardjava.exceptions.ObjectDisposedException + * @return returns ISpsStreamingRequest + * @throws ObjectDisposedException Object has already been disposed. */ ISpsStreamingRequest getStreamingRequest() throws ObjectDisposedException; } diff --git a/src/main/java/com/oneidentity/safeguard/safeguardjava/StreamResponse.java b/src/main/java/com/oneidentity/safeguard/safeguardjava/StreamResponse.java index cfcc0c6..4575e95 100644 --- a/src/main/java/com/oneidentity/safeguard/safeguardjava/StreamResponse.java +++ b/src/main/java/com/oneidentity/safeguard/safeguardjava/StreamResponse.java @@ -20,9 +20,10 @@ public StreamResponse(CloseableHttpResponse resp) { private Long contentLength = 0L; /** - * Get the response stream object + * Get the response stream object * - * @return The HTTP response body content as an inputstream + * @return The HTTP response body content as an InputStream + * @throws SafeguardForJavaException General Safeguard for Java exception. */ public InputStream getStream() throws SafeguardForJavaException { diff --git a/src/main/java/com/oneidentity/safeguard/safeguardjava/data/SafeguardEventListenerState.java b/src/main/java/com/oneidentity/safeguard/safeguardjava/data/SafeguardEventListenerState.java index ad278a1..a0317d2 100644 --- a/src/main/java/com/oneidentity/safeguard/safeguardjava/data/SafeguardEventListenerState.java +++ b/src/main/java/com/oneidentity/safeguard/safeguardjava/data/SafeguardEventListenerState.java @@ -1,6 +1,6 @@ package com.oneidentity.safeguard.safeguardjava.data; - /** + /** * Connection state of the Safeguard event listener. */ public enum SafeguardEventListenerState