Skip to content

- Add Header parameter methods for API Objects. #945

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
AlejandroP merged 5 commits into from
May 2, 2025
Merged

- Add Header parameter methods for API Objects. #945

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e7b100e
- Add Header paramter methods for API Objects.
Feb 20, 2025
6606adb
Merge branch 'master' into feature/APIHeaderParms
AlejandroP Feb 20, 2025
ab04725
- Added enum for Date Format
Feb 20, 2025
9593934
Fix spelling of constant Name and unnecesary temp variables.
Feb 21, 2025
2e0a9f0
Merge branch 'master' into feature/APIHeaderParms
AlejandroP May 2, 2025
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
190 changes: 135 additions & 55 deletions java/src/main/java/com/genexus/internet/GXRestAPIClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,7 @@
import java.text.ParseException;

import org.json.JSONArray;
import com.genexus.internet.IGxJSONAble;
import com.genexus.xml.GXXMLSerializable;
import com.genexus.internet.IGxJSONSerializable;
import com.genexus.common.interfaces.SpecificImplementation;
import com.genexus.*;
import com.genexus.diagnostics.core.ILogger;
Expand All @@ -32,17 +30,15 @@ public class GXRestAPIClient {
private String responseMessage;

private String contentType = "application/json; charset=utf-8";
private String queryString = "";
private String bodyString = "";
static final String CONTENT_TYPE_LABEL = "Content-Type";
static final String AUTHORIZATION_LABEL = "Authorization";

private JSONObject jsonResponse;
private HashMap<String, String> queryVars = new HashMap<String, String>();
private HashMap<String, String> bodyVars = new HashMap<String, String>();
private HashMap<String, String> responseData = new HashMap<String, String>();
private HashMap<String, String> headerVars = new HashMap<String, String>();


static final String DATE_FMT = "yyyy-MM-dd";
static final String DATETIME_FMT = "yyyy-MM-dd'T'HH:mm:ss";
static final String DATETIME_FMT_MS = "yyyy-MM-dd'T'HH:mm:ss.SSS";
static final String DATE_NULL = "0000-00-00";
static final String DATETIME_NULL = "0000-00-00T00:00:00";

Expand All @@ -54,6 +50,40 @@ public class GXRestAPIClient {
static final String RESPONSE_ERROR_MSG = "Invalid response";
static final String PARSING_ERROR_MSG = "Error parsing response";
static final String DESERIALIZING_ERROR_MSG = "Error serializing/deserializing object";

public enum DateFormat {

DATE_FMT(1, "yyyy-MM-dd"),
DATETIME_FMT(3, "yyyy-MM-dd'T'HH:mm:ss"),
DATETIME_FMT_MS(4, "yyyy-MM-dd'T'HH:mm:ss.SSS");

private final int fmtId;
private final String fmtString;

DateFormat(int fmtId, String fmtString) {
this.fmtId = fmtId;
this.fmtString = fmtString;
}

public int getId() {
return fmtId;
}

public String getFormat() {
return fmtString;
}

public static DateFormat fromId(int fmtId) {
for (DateFormat format : DateFormat.values()) {
if (format.getId() == fmtId) {
return format;
}
}
throw new IllegalArgumentException("Unknown error code: " + fmtId);
}
}



public GXRestAPIClient() {
responseCode = 0;
Expand Down Expand Up @@ -151,16 +181,11 @@ public void addQueryVar(String varName, double varValue) {
queryVars.put(varName, Double.toString(varValue));
}

public void addQueryVar(String varName, Date varValue) {
SimpleDateFormat df = new SimpleDateFormat(DATE_FMT);
queryVars.put(varName, df.format(varValue));
}
public void addQueryVar(String varName, Date varValue, int fmtId) {
DateFormat fmt = DateFormat.fromId(fmtId);
String fmtString = fmt.getFormat();

public void addQueryVar(String varName, Date varValue, boolean hasMilliseconds) {
String fmt = DATETIME_FMT;
if (hasMilliseconds)
fmt = DATETIME_FMT_MS;
SimpleDateFormat df = new SimpleDateFormat(fmt);
SimpleDateFormat df = new SimpleDateFormat(fmtString);
queryVars.put(varName, df.format(varValue));
}

Expand Down Expand Up @@ -190,6 +215,66 @@ private String quoteString(String value) {
return "\"" + value + "\"";
}

/// Add Header parameters

public <T extends GXXMLSerializable> void addHeaderVar(String varName, GXBaseCollection<T> varValue) {
if ( varValue != null) {
headerVars.put(varName, varValue.toJSonString(false));
}
}

public void addHeaderVar(String varName, GXXMLSerializable varValue) {
if ( varValue != null) {
headerVars.put(varName, varValue.toJSonString(false));
}
}

public void addHeaderVar(String varName, String varValue) {
headerVars.put( varName, quoteString(varValue));
}

public void addHeaderVar(String varName, double varValue) {
headerVars.put(varName, quoteString(Double.toString(varValue)));
}

public void addHeaderVar(String varName, Date varValue, int fmtId) {
DateFormat fmt = DateFormat.fromId(fmtId);
String fmtString = fmt.getFormat();

SimpleDateFormat df = new SimpleDateFormat(fmtString);
headerVars.put(varName, df.format(varValue));
}

public void addHeaderVar(String varName, short varValue) {
headerVars.put( varName, Short.toString(varValue));
}

public void addHeaderVar(String varName, int varValue) {
headerVars.put( varName, Integer.toString(varValue));
}

public void addHeaderVar(String varName, long varValue) {
headerVars.put( varName, Long.toString(varValue));
}

public void addHeaderVar(String varName, Boolean varValue) {
headerVars.put( varName, varValue.toString());
}

public void addHeaderVar(String varName, BigDecimal varValue) {
headerVars.put( varName, varValue.toString());
}

public void addHeaderVar(String varName, java.util.UUID varValue) {
headerVars.put( varName, quoteString(varValue.toString()));
}

public void addHeaderVar(String varName, IGxJSONSerializable varValue) {
headerVars.put( varName, quoteString(varValue.toJSonString()));
}

///

public <T extends GXXMLSerializable> void addBodyVar(String varName, GXBaseCollection<T> varValue) {
if ( varValue != null) {
bodyVars.put(varName, varValue.toJSonString(false));
Expand All @@ -205,21 +290,11 @@ public void addBodyVar(String varName, GXXMLSerializable varValue) {
public void addBodyVar(String varName, String varValue) {
bodyVars.put( varName, quoteString(varValue));
}

public void addBodyVar(String varName, double varValue) {
bodyVars.put(varName, quoteString(Double.toString(varValue)));
}

public void addBodyVar(String varName, Date varValue) {
SimpleDateFormat df = new SimpleDateFormat(DATE_FMT);
bodyVars.put(varName, quoteString(df.format(varValue)));
}

public void addBodyVar(String varName, Date varValue, boolean hasMilliseconds) {
String fmt = DATETIME_FMT;
if (hasMilliseconds)
fmt = DATETIME_FMT_MS;
SimpleDateFormat df = new SimpleDateFormat(fmt);

public void addBodyVar(String varName, Date varValue, int fmtId) {
DateFormat fmt = DateFormat.fromId(fmtId);
String fmtString = fmt.getFormat();
SimpleDateFormat df = new SimpleDateFormat(fmtString);
bodyVars.put( varName, quoteString(df.format(varValue)));
}

Expand Down Expand Up @@ -261,7 +336,7 @@ public Date getBodyDate(String varName) {
if (val.startsWith(DATE_NULL))
return CommonUtil.newNullDate();
else
return new SimpleDateFormat(DATE_FMT).parse(val);
return new SimpleDateFormat(DateFormat.DATETIME_FMT.getFormat()).parse(val);
}
catch (ParseException e) {
return CommonUtil.newNullDate();
Expand All @@ -271,9 +346,9 @@ public Date getBodyDate(String varName) {
public Date getBodyDateTime(String varName, Boolean hasMilliseconds) {
try{
String val = getJsonStr(varName);
String fmt = DATETIME_FMT;
String fmt = DateFormat.DATETIME_FMT.getFormat();
if (hasMilliseconds)
fmt = DATETIME_FMT_MS;
fmt = DateFormat.DATETIME_FMT_MS.getFormat();

if (val.startsWith(DATETIME_NULL))
return CommonUtil.newNullDate();
Expand Down Expand Up @@ -316,16 +391,14 @@ public BigDecimal getBodyNum(String varName) {
return new BigDecimal(getJsonStr(varName));
}

public long getBodyLong(String varName) {
long value =0;
public long getBodyLong(String varName) {
try{
value = Long.parseLong(getJsonStr(varName));
return Long.parseLong(getJsonStr(varName));
}
catch(NumberFormatException ex)
{
value = Double.valueOf(getJsonStr(varName)).longValue();
}
return value;
return Double.valueOf(getJsonStr(varName)).longValue();
}
}

public int getBodyInt(String varName) {
Expand Down Expand Up @@ -418,6 +491,7 @@ public <T extends GXXMLSerializable> GXBaseCollection<T> getBodyObjCollection(St
fillCollection(varName, elementClass, col);
return col;
}

private <T extends GXXMLSerializable> void fillCollection(String varName, Class<T> elementClass, GXBaseCollection col) {
JSONArray jsonarr = new JSONArray();
try {
Expand Down Expand Up @@ -477,46 +551,52 @@ else if (jsonResponse.length() == 1 && jsonResponse.has("")) {
}

public void addUploadFile(String filePath, String fileName) {
httpClient.addFile(filePath, fileName);
String mimeType = SpecificImplementation.Application.getContentType(filePath);
contentType = mimeType;
httpClient.addFile(filePath, fileName);
contentType = SpecificImplementation.Application.getContentType(filePath);;
}

public void RestExecute() {
String separator = "";
queryString = "";
String queryString = "";
String bodyString = "";

if (queryVars.size() > 0) {
separator = "?";
for( Map.Entry<String, String> entry : queryVars.entrySet()) {
queryString += String.format("%s%s=%s", separator, entry.getKey(), entry.getValue());
separator = "&";
}
}
bodyString = "";
if (bodyVars.size() > 0) {
separator = "";
for( Map.Entry<String, String> entry : bodyVars.entrySet()) {
bodyString += separator + "\"" + entry.getKey() + "\":" + entry.getValue() + "";
bodyString += separator + "\"" + entry.getKey() + "\":" + entry.getValue();
separator = ",";
}
}
if (bodyString.length() > 0) {
bodyString = "{" + bodyString + "}";
httpClient.addString( bodyString);
httpClient.addHeader( "Content-Type", contentType);
httpClient.addHeader( CONTENT_TYPE_LABEL, contentType);
}
else {
if (httpMethod == "POST" || httpMethod == "PUT") {
if (httpMethod.equals("POST") || httpMethod.equals( "PUT")) {
bodyString = "{}";
httpClient.addString(bodyString);
httpClient.addHeader("Content-Type", contentType);
httpClient.addHeader(CONTENT_TYPE_LABEL, contentType);
}
}
if (location.getAuthenticationMethod() == 4 && location.getAccessToken() != null && ! location.getAccessToken().trim().isEmpty()) {
httpClient.addHeader("Authorization", location.getAccessToken());
httpClient.addHeader(AUTHORIZATION_LABEL, location.getAccessToken());
}
if (headerVars.size() > 0) {
for( Map.Entry<String, String> entry : headerVars.entrySet()) {
httpClient.addHeader(entry.getKey(), entry.getValue());
}
}
headerVars.clear();
String serviceuri = ((location.getSecure() > 0) ? "https" : "http") + "://" + location.getHost();
serviceuri += (location.getPort() != 80) ? ":" + Integer.toString(location.getPort()): "";
serviceuri += (location.getPort() != 80) ? ":" + location.getPort(): "";
serviceuri += "/" + location.getBaseURL() + "/" + location.getResourceName();
serviceuri += queryString;
httpClient.execute( this.httpMethod, serviceuri);
Expand All @@ -527,7 +607,7 @@ public void RestExecute() {
if (responseCode >= 300 || httpClient.getErrCode() > 0) {
errorCode = httpClient.getErrCode();
errorMessage = httpClient.getErrDescription();
}
}
else {
try {
String response = httpClient.getString();
Expand All @@ -548,9 +628,9 @@ public void RestExecute() {
}

private void logError(int code, String msg) {
logger.error("Error: " + Integer.toString(code) + " " + msg);
logger.error("Error: " + code + " " + msg);
}
private void logError(int code, String msg, Exception e) {
logger.error("Error: " + Integer.toString(code) + " " + msg, e);
logger.error("Error: " + code + " " + msg, e);
}
}
Loading