[]
        
(Showing Draft Content)

WebRequestResult

Class WebRequestResult

java.lang.Object
com.grapecity.documents.excel.WebRequestResult

public class WebRequestResult extends Object
Represents the result of a web request, including the success status, the response content, any connection failure, and the HTTP status code.

 IWebRequestHandler handler = new IWebRequestHandler() {
     @Override
     public CompletableFuture<WebRequestResult> getAsync(String requestUri) {
         WebRequestResult result = new WebRequestResult();
         result.setStatusCode(200);
         result.setConnectionFailed(false);
         result.setResponseContent(new byte[] {1, 2, 3});
         return CompletableFuture.completedFuture(result);
     }
 };
 WebRequestResult result = handler.getAsync("https://example.com/data").join();
 int statusCode = result.getStatusCode();
 
  • Constructor Details

    • WebRequestResult

      public WebRequestResult()
  • Method Details

    • getStatusCode

      public int getStatusCode()
      Gets the HTTP status code of the web request.
      
       IWebRequestHandler handler = new IWebRequestHandler() {
           @Override
           public CompletableFuture<WebRequestResult> getAsync(String requestUri) {
               WebRequestResult result = new WebRequestResult();
               result.setStatusCode(200);
               return CompletableFuture.completedFuture(result);
           }
       };
       WebRequestResult result = handler.getAsync("https://example.com/data").join();
       int statusCode = result.getStatusCode();
       
      Returns:
      the HTTP status code
    • setStatusCode

      public void setStatusCode(int statusCode)
      Sets the HTTP status code of the web request.
      
       IWebRequestHandler handler = new IWebRequestHandler() {
           @Override
           public CompletableFuture<WebRequestResult> getAsync(String requestUri) {
               WebRequestResult result = new WebRequestResult();
               result.setStatusCode(200);
               return CompletableFuture.completedFuture(result);
           }
       };
       
      Parameters:
      statusCode - the HTTP status code
    • isConnectionFailed

      public boolean isConnectionFailed()
      Checks if the web request failed due to a connection issue.
      
       IWebRequestHandler handler = new IWebRequestHandler() {
           @Override
           public CompletableFuture<WebRequestResult> getAsync(String requestUri) {
               WebRequestResult result = new WebRequestResult();
               result.setConnectionFailed(true);
               return CompletableFuture.completedFuture(result);
           }
       };
       WebRequestResult result = handler.getAsync("https://example.com/data").join();
       boolean connectionFailed = result.isConnectionFailed();
       
      Returns:
      true if the request failed due to a connection issue, false otherwise
    • setConnectionFailed

      public void setConnectionFailed(boolean connectionFailed)
      Sets the connection failure status of the web request.
      
       IWebRequestHandler handler = new IWebRequestHandler() {
           @Override
           public CompletableFuture<WebRequestResult> getAsync(String requestUri) {
               WebRequestResult result = new WebRequestResult();
               result.setConnectionFailed(true);
               return CompletableFuture.completedFuture(result);
           }
       };
       
      Parameters:
      connectionFailed - true if the request failed due to a connection issue, false otherwise
    • getResponseContent

      public byte[] getResponseContent()
      Gets the response content from the web request, if the request was successful. The content is stored as a byte array to preserve the original data format.
      
       IWebRequestHandler handler = new IWebRequestHandler() {
           @Override
           public CompletableFuture<WebRequestResult> getAsync(String requestUri) {
               WebRequestResult result = new WebRequestResult();
               result.setResponseContent(new byte[] {1, 2, 3});
               return CompletableFuture.completedFuture(result);
           }
       };
       WebRequestResult result = handler.getAsync("https://example.com/data").join();
       byte[] responseContent = result.getResponseContent();
       
      Returns:
      the response content as a byte array
    • setResponseContent

      public void setResponseContent(byte[] responseContent)
      Sets the response content from the web request.
      
       IWebRequestHandler handler = new IWebRequestHandler() {
           @Override
           public CompletableFuture<WebRequestResult> getAsync(String requestUri) {
               WebRequestResult result = new WebRequestResult();
               result.setResponseContent(new byte[] {1, 2, 3});
               return CompletableFuture.completedFuture(result);
           }
       };
       
      Parameters:
      responseContent - the response content as a byte array