Skip to content

Refactor Response handling by adding typed helper methods for responsePhrase #454

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
frankgiordano merged 5 commits into from
Mar 30, 2026
+393 −317
Merged

Refactor Response handling by adding typed helper methods for responsePhrase #454

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4464790
Refactor Response handling by adding typed helper methods for respons…
frankgiordano Mar 29, 2026
dcfe6eb
update hasTextResponsePhrase
frankgiordano Mar 29, 2026
85648c6
update example readmes
frankgiordano Mar 29, 2026
f926e70
format tweak
frankgiordano Mar 30, 2026
639ee92
ResponseTest
frankgiordano Mar 30, 2026
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
63 changes: 60 additions & 3 deletions src/main/java/zowe/client/sdk/rest/Response.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,9 @@ public class Response {
* @param statusText http response status text
* @author Frank Giordano
*/
public Response(final Object responsePhrase, final Integer statusCode, final String statusText) {
public Response(final Object responsePhrase,
final Integer statusCode,
final String statusText) {
this.responsePhrase = responsePhrase;
this.statusCode = statusCode;
this.statusText = statusText;
Expand All @@ -66,7 +68,9 @@ public Response(final Object responsePhrase, final Integer statusCode, final Str
* @param tokens http response Cookies object representing TOKENS
* @author Frank Giordano
*/
public Response(final Object responsePhrase, final Integer statusCode, final String statusText,
public Response(final Object responsePhrase,
final Integer statusCode,
final String statusText,
final Cookies tokens) {
this.responsePhrase = responsePhrase;
this.statusCode = statusCode;
Expand Down Expand Up @@ -112,7 +116,60 @@ public Cookies getTokens() {
}

/**
* Return string value representing Response object
* Retrieve responsePhrase value as a String
*
* @return responsePhrase Optional String value
*/
public Optional<String> getResponsePhraseAsString() {
return getResponsePhrase().map(Object::toString);
}

/**
* Retrieve responsePhrase value as a byte array
*
* @return responsePhrase Optional byte array value
*/
public Optional<byte[]> getResponsePhraseAsBytes() {
return (responsePhrase instanceof byte[])
? Optional.of((byte[]) responsePhrase)
: Optional.empty();
}

/**
* Determine whether a responsePhrase has a value
*
* @return true if responsePhrase is not null, false otherwise
*/
public boolean hasResponsePhrase() {
return responsePhrase != null;
}

/**
* Determine whether responsePhrase is a non-blank String
*
* @return true if responsePhrase is a non-blank String, false otherwise
*/
public boolean hasTextResponsePhrase() {
if (!(responsePhrase instanceof String)) {
return false;
}

String str = (String) responsePhrase;
return !str.isBlank() && !"{}".equals(str);
}

/**
* Retrieve responsePhrase value as a String or return a default value
*
* @param defaultValue String value returned when responsePhrase is not present
* @return responsePhrase String value or provided default value
*/
public String getResponsePhraseAsStringOrDefault(final String defaultValue) {
return getResponsePhraseAsString().orElse(defaultValue);
}

/**
* Return string value representing a Response object
*
* @return string representation of Response
*/
Expand Down
16 changes: 5 additions & 11 deletions src/main/java/zowe/client/sdk/zosconsole/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ public class IssueConsoleExp extends TstZosConnection {
/**
* The main method defines z/OSMF host and user connection, and mvs command used for the example tests.
*
* @param args for main not used
* @param args for main isn't used
* @author Frank Giordano
*/
public static void main(String[] args) {
Expand All @@ -50,11 +50,8 @@ public class IssueConsoleExp extends TstZosConnection {
response = consoleCmd.issueCommand(cmd);
} catch (ZosmfRequestException e) {
String errMsg = e.getMessage();
if (e.getResponse() != null && e.getResponse().getResponsePhrase().isPresent()) {
String response = e.getResponse().getResponsePhrase().get().toString();
if (!response.isBlank() && !"{}".equals(response)) {
errMsg = response;
}
if (e.getResponse() != null && e.getResponse().hasTextResponsePhrase()) {
errMsg = e.getResponse().getResponsePhraseAsString().orElse(errMsg);
}
throw new RuntimeException(errMsg, e);
}
Expand All @@ -78,11 +75,8 @@ public class IssueConsoleExp extends TstZosConnection {
response = consoleCmd.issueCommandCommon(ConsoleConstants.RES_DEF_CN, consoleInputData);
} catch (ZosmfRequestException e) {
String errMsg = e.getMessage();
if (e.getResponse() != null && e.getResponse().getResponsePhrase().isPresent()) {
String response = e.getResponse().getResponsePhrase().get().toString();
if (!response.isBlank() && !"{}".equals(response)) {
errMsg = response;
}
if (e.getResponse() != null && e.getResponse().hasTextResponsePhrase()) {
errMsg = e.getResponse().getResponsePhraseAsString().orElse(errMsg);
}
throw new RuntimeException(errMsg, e);
}
Expand Down
100 changes: 28 additions & 72 deletions src/main/java/zowe/client/sdk/zosfiles/dsn/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,11 +73,8 @@ public class DsnCopyExp extends TstZosConnection {
response = dsnCopy.copy(fromDataSetName, toDataSetName, true, false);
} catch (ZosmfRequestException e) {
String errMsg = e.getMessage();
if (e.getResponse() != null && e.getResponse().getResponsePhrase().isPresent()) {
String response = e.getResponse().getResponsePhrase().get().toString();
if (!response.isBlank() && !"{}".equals(response)) {
errMsg = response;
}
if (e.getResponse() != null && e.getResponse().hasTextResponsePhrase()) {
errMsg = e.getResponse().getResponsePhraseAsString().orElse(errMsg);
}
throw new RuntimeException(errMsg, e);
}
Expand Down Expand Up @@ -112,11 +109,8 @@ public class DsnCopyExp extends TstZosConnection {
response = dsnCopy.copyCommon(dsnCopyInputData);
} catch (ZosmfRequestException e) {
String errMsg = e.getMessage();
if (e.getResponse() != null && e.getResponse().getResponsePhrase().isPresent()) {
String response = e.getResponse().getResponsePhrase().get().toString();
if (!response.isBlank() && !"{}".equals(response)) {
errMsg = response;
}
if (e.getResponse() != null && e.getResponse().hasTextResponsePhrase()) {
errMsg = e.getResponse().getResponsePhraseAsString().orElse(errMsg);
}
throw new RuntimeException(errMsg, e);
}
Expand Down Expand Up @@ -150,11 +144,8 @@ public class DsnCopyExp extends TstZosConnection {
response = dsnCopy.copyCommon(dsnCopyInputData);
} catch (ZosmfRequestException e) {
String errMsg = e.getMessage();
if (e.getResponse() != null && e.getResponse().getResponsePhrase().isPresent()) {
String response = e.getResponse().getResponsePhrase().get().toString();
if (!response.isBlank() && !"{}".equals(response)) {
errMsg = response;
}
if (e.getResponse() != null && e.getResponse().hasTextResponsePhrase()) {
errMsg = e.getResponse().getResponsePhraseAsString().orElse(errMsg);
}
throw new RuntimeException(errMsg, e);
}
Expand Down Expand Up @@ -217,11 +208,8 @@ public class DsnCreateExp extends TstZosConnection {
response = dsnCreate.create(dataSetName, sequential());
} catch (ZosmfRequestException e) {
String errMsg = e.getMessage();
if (e.getResponse() != null && e.getResponse().getResponsePhrase().isPresent()) {
String response = e.getResponse().getResponsePhrase().get().toString();
if (!response.isBlank() && !"{}".equals(response)) {
errMsg = response;
}
if (e.getResponse() != null && e.getResponse().hasTextResponsePhrase()) {
errMsg = e.getResponse().getResponsePhraseAsString().orElse(errMsg);
}
throw new RuntimeException(errMsg, e);
}
Expand All @@ -242,11 +230,8 @@ public class DsnCreateExp extends TstZosConnection {
response = dsnCreate.create(dataSetName, partitioned());
} catch (ZosmfRequestException e) {
String errMsg = e.getMessage();
if (e.getResponse() != null && e.getResponse().getResponsePhrase().isPresent()) {
String response = e.getResponse().getResponsePhrase().get().toString();
if (!response.isBlank() && !"{}".equals(response)) {
errMsg = response;
}
if (e.getResponse() != null && e.getResponse().hasTextResponsePhrase()) {
errMsg = e.getResponse().getResponsePhraseAsString().orElse(errMsg);
}
throw new RuntimeException(errMsg, e);
}
Expand Down Expand Up @@ -393,11 +378,8 @@ public class DsnGetInfoExp extends TstZosConnection {
return dsnGet.getDsnInfo(dataSetName);
} catch (ZosmfRequestException e) {
String errMsg = e.getMessage();
if (e.getResponse() != null && e.getResponse().getResponsePhrase().isPresent()) {
String response = e.getResponse().getResponsePhrase().get().toString();
if (!response.isBlank() && !"{}".equals(response)) {
errMsg = response;
}
if (e.getResponse() != null && e.getResponse().hasTextResponsePhrase()) {
errMsg = e.getResponse().getResponsePhraseAsString().orElse(errMsg);
}
throw new RuntimeException(errMsg, e);
}
Expand Down Expand Up @@ -457,11 +439,8 @@ public class DsnDeleteExp extends TstZosConnection {
response = zosDsn.delete(dataSetName);
} catch (ZosmfRequestException e) {
String errMsg = e.getMessage();
if (e.getResponse() != null && e.getResponse().getResponsePhrase().isPresent()) {
String response = e.getResponse().getResponsePhrase().get().toString();
if (!response.isBlank() && !"{}".equals(response)) {
errMsg = response;
}
if (e.getResponse() != null && e.getResponse().hasTextResponsePhrase()) {
errMsg = e.getResponse().getResponsePhraseAsString().orElse(errMsg);
}
throw new RuntimeException(errMsg, e);
}
Expand All @@ -483,11 +462,8 @@ public class DsnDeleteExp extends TstZosConnection {
response = zosDsn.delete(dataSetName, member);
} catch (ZosmfRequestException e) {
String errMsg = e.getMessage();
if (e.getResponse() != null && e.getResponse().getResponsePhrase().isPresent()) {
String response = e.getResponse().getResponsePhrase().get().toString();
if (!response.isBlank() && !"{}".equals(response)) {
errMsg = response;
}
if (e.getResponse() != null && e.getResponse().hasTextResponsePhrase()) {
errMsg = e.getResponse().getResponsePhraseAsString().orElse(errMsg);
}
throw new RuntimeException(errMsg, e);
}
Expand Down Expand Up @@ -678,11 +654,8 @@ public class DsnListExp extends TstZosConnection {
datasets = dsnList.getMembers(dataSetName, dsnListInputData);
} catch (ZosmfRequestException e) {
String errMsg = e.getMessage();
if (e.getResponse() != null && e.getResponse().getResponsePhrase().isPresent()) {
String response = e.getResponse().getResponsePhrase().get().toString();
if (!response.isBlank() && !"{}".equals(response)) {
errMsg = response;
}
if (e.getResponse() != null && e.getResponse().hasTextResponsePhrase()) {
errMsg = e.getResponse().getResponsePhraseAsString().orElse(errMsg);
}
throw new RuntimeException(errMsg, e);
}
Expand All @@ -704,11 +677,8 @@ public class DsnListExp extends TstZosConnection {
datasets = dsnList.getMembers(dataSetName, dsnListInputData);
} catch (ZosmfRequestException e) {
String errMsg = e.getMessage();
if (e.getResponse() != null && e.getResponse().getResponsePhrase().isPresent()) {
String response = e.getResponse().getResponsePhrase().get().toString();
if (!response.isBlank() && !"{}".equals(response)) {
errMsg = response;
}
if (e.getResponse() != null && e.getResponse().hasTextResponsePhrase()) {
errMsg = e.getResponse().getResponsePhraseAsString().orElse(errMsg);
}
throw new RuntimeException(errMsg, e);
}
Expand All @@ -730,11 +700,8 @@ public class DsnListExp extends TstZosConnection {
datasets = dsnList.getDatasets(dataSetName, dsnListInputData);
} catch (ZosmfRequestException e) {
String errMsg = e.getMessage();
if (e.getResponse() != null && e.getResponse().getResponsePhrase().isPresent()) {
String response = e.getResponse().getResponsePhrase().get().toString();
if (!response.isBlank() && !"{}".equals(response)) {
errMsg = response;
}
if (e.getResponse() != null && e.getResponse().hasTextResponsePhrase()) {
errMsg = e.getResponse().getResponsePhraseAsString().orElse(errMsg);
}
throw new RuntimeException(errMsg, e);
}
Expand All @@ -756,11 +723,8 @@ public class DsnListExp extends TstZosConnection {
datasets = dsnList.getDatasets(dataSetName, dsnListInputData);
} catch (ZosmfRequestException e) {
String errMsg = e.getMessage();
if (e.getResponse() != null && e.getResponse().getResponsePhrase().isPresent()) {
String response = e.getResponse().getResponsePhrase().get().toString();
if (!response.isBlank() && !"{}".equals(response)) {
errMsg = response;
}
if (e.getResponse() != null && e.getResponse().hasTextResponsePhrase()) {
errMsg = e.getResponse().getResponsePhraseAsString().orElse(errMsg);
}
throw new RuntimeException(errMsg, e);
}
Expand Down Expand Up @@ -825,15 +789,11 @@ public class DsnWriteExp extends TstZosConnection {
response = dsnWrite.write(dataSetName, member, content);
} catch (ZosmfRequestException e) {
String errMsg = e.getMessage();
if (e.getResponse() != null && e.getResponse().getResponsePhrase().isPresent()) {
String response = e.getResponse().getResponsePhrase().get().toString();
if (!response.isBlank() && !"{}".equals(response)) {
errMsg = response;
}
if (e.getResponse() != null && e.getResponse().hasTextResponsePhrase()) {
errMsg = e.getResponse().getResponsePhraseAsString().orElse(errMsg);
}
throw new RuntimeException(errMsg, e);
}

System.out.println(response.toString());
}

Expand All @@ -851,15 +811,11 @@ public class DsnWriteExp extends TstZosConnection {
response = dsnWrite.write(dataSetName, content);
} catch (ZosmfRequestException e) {
String errMsg = e.getMessage();
if (e.getResponse() != null && e.getResponse().getResponsePhrase().isPresent()) {
String response = e.getResponse().getResponsePhrase().get().toString();
if (!response.isBlank() && !"{}".equals(response)) {
errMsg = response;
}
if (e.getResponse() != null && e.getResponse().hasTextResponsePhrase()) {
errMsg = e.getResponse().getResponsePhraseAsString().orElse(errMsg);
}
throw new RuntimeException(errMsg, e);
}

System.out.println(response.toString());
}

Expand Down
Loading
Loading