Skip to content
This repository has been archived by the owner on Nov 4, 2024. It is now read-only.

Commit

Permalink
Changes made as requested Issue #1249
Browse files Browse the repository at this point in the history 
Signed-off-by: Aashir Siddiqui <[email protected]>
  • Loading branch information
@aashir21
aashir21 committed Jul 23, 2024
1 parent 7d86f58 commit 2fc79cd
Show file tree
Hide file tree
Showing 8 changed files with 91 additions and 90 deletions.
2 changes: 1 addition & 1 deletion ...nagers-cicsts-parent/dev.galasa.cicsts.manager/src/main/java/dev/galasa/cicsts/ICemt.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ public interface ICemt {
/**
* Inquire a CEMT resource using the resource type and name.
* This does not support inquiries of multiple resources at once.
* Will return null if the resource is not found.
* @return null if the resource is not found.
* @param cemtTerminal an {@link ITerminal} object logged on to the CICS region and in an active CEMT session.
* If mixed case is required, the terminal should be presented with no upper case translate status.
* For example, the test could first issue <code>CEOT TRANIDONLY</code>
Expand Down
119 changes: 59 additions & 60 deletions ...parent/dev.galasa.cicsts.manager/src/main/java/dev/galasa/cicsts/IExecInterfaceBlock.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,187 +12,186 @@
public interface IExecInterfaceBlock {

/**
* Returns a {@link String} representation of the EIBRESP field if available
* @return
* @return a {@link String} representation of the EIBRESP field if available
*/
public String getResponse();

/**
* Returns the value of the EIBTIME field in the EIB.
* @return
* @return the value of the EIBTIME field in the EIB.
*
*/
public int getEIBTIME();

/**
* Returns the value of the EIBDATE field in the EIB.
* @return
* @return the value of the EIBDATE field in the EIB.
*
*/
public int getEIBDATE();

/**
* Returns the value of the EIBTRNID field in the EIB.
* @return the value of the EIBTRNID field in the EIB.
* @param hex return a char array containing the hex values of the field
* @return
*
*/
public String getEIBTRNID(boolean hex);

/**
* Returns the value of the EIBTASKN field in the EIB.
* @return
* @return the value of the EIBTASKN field in the EIB.
*
*/
public int getEIBTASKN();

/**
* Returns the value of the EIBTRMID field in the EIB.
* @return the value of the EIBTRMID field in the EIB.
* @param hex return a char array containing the hex values of the field
* @return
*
*/
public String getEIBTRMID(boolean hex);

/**
* Returns the value of the EIBCPOSN field in the EIB.
* @return
* @return the value of the EIBCPOSN field in the EIB.
*
*/
public int getEIBCPOSN();

/**
* Returns the value of the EIBCALEN field in the EIB.
* @return
* @return the value of the EIBCALEN field in the EIB.
*
*/
public int getEIBCALEN();

/**
* Returns the value of the EIBAID field in the EIB.
* @return
* @return the value of the EIBAID field in the EIB.
*
*/
public char getEIBAID();

/**
* Returns the value of the EIBFN field in the EIB.
* @return
* @return the value of the EIBFN field in the EIB.
*
*/
public char[] getEIBFN();

/**
* Returns the value of the EIBRCODE field in the EIB.
* @return
* @return the value of the EIBRCODE field in the EIB.
*
*/
public char[] getEIBRCODE();

/**
* Returns the value of the EIBDS field in the EIB.
* @return the value of the EIBDS field in the EIB.
* @param hex return a char array containing the hex values of the field
* @return
*
*/
public String getEIBDS(boolean hex);

/**
* Returns the value of the EIBREQID field in the EIB.
* @return the value of the EIBREQID field in the EIB.
* @param hex return a char array containing the hex values of the field
* @return
*
*/
public String getEIBREQID(boolean hex);

/**
* Returns the value of the EIBRSRCE field in the EIB.
* @return the value of the EIBRSRCE field in the EIB.
* @param hex return a char array containing the hex values of the field
* @return
*
*/
public String getEIBRSRCE(boolean hex);

/**
* Returns the value of the EIBSYNC field in the EIB.
* @return
* @return the value of the EIBSYNC field in the EIB.
*
*/
public char getEIBSYNC();

/**
* Returns the value of the EIBFREE field in the EIB.
* @return
* @return the value of the EIBFREE field in the EIB.
*
*/
public char getEIBFREE();

/**
* Returns the value of the EIBRECV field in the EIB.
* @return
* @return the value of the EIBRECV field in the EIB.
*
*/
public char getEIBRECV();

/**
* Returns the value of the EIBATT field in the EIB.
* @return
* @return the value of the EIBATT field in the EIB.
*
*/
public char getEIBATT();

/**
* Returns the value of the EIBEOC field in the EIB.
* @return
* @return the value of the EIBEOC field in the EIB.
*
*/
public char getEIBEOC();

/**
* Returns the value of the field in the EIB.
* @return
* @return the value of the field in the EIB.
*
*/
public char getEIBFMH();

/**
* Returns the value of the EIBCOMPL field in the EIB.
* @return
* @return the value of the EIBCOMPL field in the EIB.
*
*/
public char getEIBCOMPL();

/**
* Returns the value of the EIBSIG field in the EIB.
* @return
* @return the value of the EIBSIG field in the EIB.
*
*/
public char getEIBSIG();

/**
* Returns the value of the EIBCONF field in the EIB.
* @return
* @return the value of the EIBCONF field in the EIB.
*
*/
public char getEIBCONF();

/**
* Returns the value of the EIBERR field in the EIB.
* @return
* @return the value of the EIBERR field in the EIB.
*
*/
public char getEIBERR();

/**
* Returns the value of the EIBERRCD field in the EIB.
* @return
* @return the value of the EIBERRCD field in the EIB.
*
*/
public char[] getEIBERRCD();

/**
* Returns the value of the EIBSYNRB field in the EIB.
* @return
* @return the value of the EIBSYNRB field in the EIB.
*
*/
public char getEIBSYNRB();

/**
* Returns the value of the EIBNODAT field in the EIB.
* @return
* @return the value of the EIBNODAT field in the EIB.
*
*/
public char getEIBNODAT();

/**
* Returns the value of the EIBRESP field in the EIB.
* @return
* @return the value of the EIBRESP field in the EIB.
*
*/
public int getEIBRESP();

/**
* Returns the value of the EIBRESP2 field in the EIB.
* @return
* @return the value of the EIBRESP2 field in the EIB.
*
*/
public int getEIBRESP2();

/**
* Returns the value of the EIBRLDBK field in the EIB.
* @return
* @return the value of the EIBRLDBK field in the EIB.
*
*/
public char getEIBRLDBK();
}
8 changes: 4 additions & 4 deletions ...omms-parent/dev.galasa.http.manager/src/main/java/dev/galasa/http/HttpClientResponse.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -240,11 +240,11 @@ public static HttpClientResponse<String> textResponse(CloseableHttpResponse http
}

/**
* Create an {@link HttpClientResponse} with a &lt;com.google.gson.JsonObject&gt; content type
* Create an {@link HttpClientResponse} with a com.google.gson.JsonObject content type
* from an {@link HttpResponse}.
*
* @param httpResponse
* @return - {@link HttpClientResponse} with a &lt;com.google.gson.JsonObject&gt; content type
* @return - {@link HttpClientResponse} with a com.google.gson.JsonObject content type
* @throws HttpClientException
*/
public static HttpClientResponse<JsonObject> jsonResponse(CloseableHttpResponse httpResponse)
Expand All @@ -253,14 +253,14 @@ public static HttpClientResponse<JsonObject> jsonResponse(CloseableHttpResponse
}

/**
* Create an {@link HttpClientResponse} with a &lt;com.google.gson.JsonObject&gt; content type
* Create an {@link HttpClientResponse} with a com.google.gson.JsonObject content type
* from an {@link HttpResponse}. If contentOnBadResponse is true, an attempt
* will be made to retrieve the content even on a non 200 status code, otherwise
* the content will be null in such an instance.
*
* @param httpResponse
* @param contentOnBadResponse
* @return - {@link HttpClientResponse} with a &lt;com.google.gson.JsonObject&gt; content type
* @return - {@link HttpClientResponse} with a com.google.gson.JsonObject content type
* @throws HttpClientException
*/
public static HttpClientResponse<JsonObject> jsonResponse(CloseableHttpResponse httpResponse,
Expand Down
28 changes: 14 additions & 14 deletions ...agers-comms-parent/dev.galasa.http.manager/src/main/java/dev/galasa/http/IHttpClient.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -122,54 +122,54 @@ HttpClientResponse<String> postXML(String url, String xml)
throws HttpClientException;

/**
* Issue an HTTP GET to the provided URL, receiving a &lt;com.google.gson.JsonObject&gt; in the
* Issue an HTTP GET to the provided URL, receiving a com.google.gson.JsonObject in the
* response.
*
* @param url
* @return - {@link HttpClientResponse} with a &lt;com.google.gson.JsonObject&gt; content type
* @return - {@link HttpClientResponse} with a com.google.gson.JsonObject content type
* @throws HttpClientException
*/
HttpClientResponse<JsonObject> getJson(String url) throws HttpClientException;

/**
* Issue an HTTP POST to the provided URL, sending the provided
* &lt;com.google.gson.JsonObject&gt; and receiving a &lt;com.google.gson.JsonObject&gt; in the response.
* com.google.gson.JsonObject and receiving a com.google.gson.JsonObject in the response.
*
* @param url
* @param json
* @return - {@link HttpClientResponse} with a &lt;com.google.gson.JsonObject&gt; content type
* @return - {@link HttpClientResponse} with a com.google.gson.JsonObject content type
* @throws HttpClientException
*/
HttpClientResponse<JsonObject> postJson(String url, JsonObject json) throws HttpClientException;

/**
* Issue an HTTP PUT to the provided URL, sending the provided
* <code>com.google.gson.JSONObject</code> and receiving a <code>com.google.gson.JSONObject</code> in the response.
* <code>com.google.gson.JsonObject</code> and receiving a <code>com.google.gson.JsonObject</code> in the response.
*
* @param url
* @param json
* @return - {@link HttpClientResponse} with a <code>com.google.gson.JSONObject</code> content type
* @return - {@link HttpClientResponse} with a <code>com.google.gson.JsonObject</code> content type
* @throws HttpClientException
*/
HttpClientResponse<JsonObject> putJson(String url, JsonObject json) throws HttpClientException;

/**
* Issue an HTTP DELETE to the provided URL, receiving a &lt;com.google.gson.JsonObject&gt; in
* Issue an HTTP DELETE to the provided URL, receiving a com.google.gson.JsonObject in
* the response.
*
* @param url
* @return - {@link HttpClientResponse} with a &lt;com.google.gson.JsonObject&gt; content type
* @return - {@link HttpClientResponse} with a com.google.gson.JsonObject content type
* @throws HttpClientException
*/
HttpClientResponse<JsonObject> deleteJson(String url) throws HttpClientException;

/**
* Issue an HTTP DELETE to the provided URL, receiving a &lt;com.google.gson.JsonObject&gt; in
* Issue an HTTP DELETE to the provided URL, receiving a com.google.gson.JsonObject in
* the response.
*
* @param url
* @param json
* @return - {@link HttpClientResponse} with a &lt;com.google.gson.JsonObject&gt; content type
* @return - {@link HttpClientResponse} with a com.google.gson.JsonObject content type
* @throws HttpClientException
*/
HttpClientResponse<JsonObject> deleteJson(String url, JsonObject json) throws HttpClientException;
Expand Down Expand Up @@ -222,7 +222,7 @@ HttpClientResponse<String> postXML(String url, String xml)
*
* @param url
* @param binary
* @return - {@link HttpClientResponse} with a &lt;com.google.gson.JsonObject&gt; content type
* @return - {@link HttpClientResponse} with a com.google.gson.JsonObject content type
* @throws HttpClientException
*/
HttpClientResponse<byte[]> putBinary(String url, byte[] binary) throws HttpClientException;
Expand All @@ -233,7 +233,7 @@ HttpClientResponse<String> postXML(String url, String xml)
*
* @param url
* @param binary
* @return - {@link HttpClientResponse} with a &lt;com.google.gson.JsonObject&gt; content type
* @return - {@link HttpClientResponse} with a com.google.gson.JsonObject content type
* @throws HttpClientException
*/
HttpClientResponse<byte[]> getBinary(String url, byte[] binary) throws HttpClientException;
Expand All @@ -244,7 +244,7 @@ HttpClientResponse<String> postXML(String url, String xml)
*
* @param url
* @param binary
* @return - {@link HttpClientResponse} with a &lt;com.google.gson.JsonObject&gt; content type
* @return - {@link HttpClientResponse} with a com.google.gson.JsonObject content type
* @throws HttpClientException
*/
HttpClientResponse<byte[]> postBinary(String url, byte[] binary) throws HttpClientException;
Expand All @@ -255,7 +255,7 @@ HttpClientResponse<String> postXML(String url, String xml)
*
* @param url
* @param binary
* @return - {@link HttpClientResponse} with a &lt;com.google.gson.JsonObject&gt; content type
* @return - {@link HttpClientResponse} with a com.google.gson.JsonObject content type
* @throws HttpClientException
*/
HttpClientResponse<byte[]> deleteBinary(String url, byte[] binary) throws HttpClientException;
Expand Down
Loading

0 comments on commit 2fc79cd

Please sign in to comment.