Skip to content

Fix the javadoc #100

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bnicholesdell merged 1 commit into from
Sep 24, 2021
Merged

Fix the javadoc #100

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/main/java/com/oneidentity/safeguard/safeguardjava/ISafeguardConnection.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ FullResponse invokeMethodFull(Service service, Method method, String relativeUrl
* @param parameters Additional parameters to add to the URL.
* @param additionalHeaders Additional headers to add to the request.
* @param timeout Per-request timeout in milliseconds (null for default)
* @returns Response body as a CSV string.
* @return Response body as a CSV string.
* @throws ObjectDisposedException Object has already been disposed.
* @throws SafeguardForJavaException General Safeguard for Java exception.
* @throws ArgumentException Invalid argument.
Expand All @@ -107,7 +107,7 @@ String invokeMethodCsv(Service service, Method method, String relativeUrl,
* @param spsConnection A connection to the SafeguardForPrivilegedSessions appliance.
* @param certificateChain The PEM certificate chain of the Safeguard web api.
* @param sppAddress The address of the Safeguard appliance.
* @returns Response with status code, headers, and body as string.
* @return Response with status code, headers, and body as string.
* @throws ObjectDisposedException Object has already been disposed.
* @throws SafeguardForJavaException General Safeguard for Java exception.
* @throws ArgumentException Invalid argument.
Expand Down
20 changes: 12 additions & 8 deletions src/main/java/com/oneidentity/safeguard/safeguardjava/IStreamingRequest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,13 @@ public interface IStreamingRequest {
* @param parameters Additional parameters to add to the URL.
* @param additionalHeaders Additional headers to add to the request.
* @return Response body as a string.
* @throws com.oneidentity.safeguard.safeguardjava.exceptions.SafeguardForJavaException
* @throws com.oneidentity.safeguard.safeguardjava.exceptions.ArgumentException
* @throws com.oneidentity.safeguard.safeguardjava.exceptions.ObjectDisposedException
* @throws ObjectDisposedException Object has already been disposed.
* @throws SafeguardForJavaException General Safeguard for Java exception.
* @throws ArgumentException Invalid argument.
*/
String uploadStream(Service service, String relativeUrl, byte[] stream, IProgressCallback progressCallback, Map<String, String> parameters, Map<String, String> additionalHeaders) throws SafeguardForJavaException, ArgumentException, ObjectDisposedException;
String uploadStream(Service service, String relativeUrl, byte[] stream, IProgressCallback progressCallback,
Map<String, String> parameters, Map<String, String> additionalHeaders)
throws SafeguardForJavaException, ArgumentException, ObjectDisposedException;

/**
* Call a Safeguard GET API providing an output file path to which streaming download data will
Expand All @@ -38,9 +40,11 @@ public interface IStreamingRequest {
* @param progressCallback Optionally report upload progress.
* @param parameters Additional parameters to add to the URL.
* @param additionalHeaders Additional headers to add to the request.
* @throws com.oneidentity.safeguard.safeguardjava.exceptions.SafeguardForJavaException
* @throws com.oneidentity.safeguard.safeguardjava.exceptions.ArgumentException
* @throws com.oneidentity.safeguard.safeguardjava.exceptions.ObjectDisposedException
* @throws ObjectDisposedException Object has already been disposed.
* @throws SafeguardForJavaException General Safeguard for Java exception.
* @throws ArgumentException Invalid argument.
*/
void downloadStream(Service service, String relativeUrl, String outputFilePath, IProgressCallback progressCallback, Map<String, String> parameters, Map<String, String> additionalHeaders) throws SafeguardForJavaException, ArgumentException, ObjectDisposedException;
void downloadStream(Service service, String relativeUrl, String outputFilePath, IProgressCallback progressCallback,
Map<String, String> parameters, Map<String, String> additionalHeaders)
throws SafeguardForJavaException, ArgumentException, ObjectDisposedException;
}
8 changes: 4 additions & 4 deletions src/main/java/com/oneidentity/safeguard/safeguardjava/Safeguard.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1372,7 +1372,7 @@ public static ISafeguardA2AContext getContext(String networkAddress, String keys
* @param ignoreSsl Ignore server certificate validation.
*
* @return Reusable Safeguard A2A context.
* @throws com.oneidentity.safeguard.safeguardjava.exceptions.SafeguardForJavaException
* @throws SafeguardForJavaException General Safeguard for Java exception.
*/
public static ISafeguardA2AContext getContext(String networkAddress, String thumbprint,
Integer apiVersion, Boolean ignoreSsl) throws SafeguardForJavaException {
Expand Down Expand Up @@ -1409,7 +1409,7 @@ public static ISafeguardA2AContext getContext(String networkAddress, String thum
* @param validationCallback Callback function to be executed during SSL certificate validation.
*
* @return Reusable Safeguard A2A context.
* @throws com.oneidentity.safeguard.safeguardjava.exceptions.SafeguardForJavaException
* @throws SafeguardForJavaException General Safeguard for Java exception.
*/
public static ISafeguardA2AContext getContext(String networkAddress, String thumbprint,
HostnameVerifier validationCallback, Integer apiVersion) throws SafeguardForJavaException {
Expand Down Expand Up @@ -1906,7 +1906,7 @@ public static ISafeguardEventListener getPersistentA2AEventListener(List<char[]>
* @return New persistent A2A event listener.
* @throws ObjectDisposedException Object has already been disposed.
* @throws ArgumentException Invalid argument.
* @throws com.oneidentity.safeguard.safeguardjava.exceptions.SafeguardForJavaException
* @throws SafeguardForJavaException General Safeguard for Java exception.
*/
public static ISafeguardEventListener getPersistentA2AEventListener(List<char[]> apiKeys,
ISafeguardEventHandler handler, String networkAddress, String thumbprint,
Expand Down Expand Up @@ -1952,7 +1952,7 @@ public static ISafeguardEventListener getPersistentA2AEventListener(List<char[]>
* @return New persistent A2A event listener.
* @throws ObjectDisposedException Object has already been disposed.
* @throws ArgumentException Invalid argument.
* @throws com.oneidentity.safeguard.safeguardjava.exceptions.SafeguardForJavaException
* @throws SafeguardForJavaException General Safeguard for Java exception.
*/
public static ISafeguardEventListener getPersistentA2AEventListener(List<char[]> apiKeys,
ISafeguardEventHandler handler, String networkAddress, String thumbprint,
Expand Down
4 changes: 0 additions & 4 deletions src/main/java/com/oneidentity/safeguard/safeguardjava/restclient/ByteArrayEntity.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,6 @@ public void writeTo(OutputStream outstream) throws IOException {
super.writeTo(this.outstream);
}

/**
* Progress: 0-100
* @return
*/
public int getProgress() {
if (outstream == null) {
return 0;
Expand Down