Package dev.galasa.zosrseapi

Interface IRseapi

public interface IRseapi
Represents a RSE API server

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static enum 
    IRseapi.RseapiRequestType
    Enumeration of RSE API request types

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    clearHeaders()
    Clear the existing HTTP Headers ready for the next RSE API request
    @NotNull IRseapiResponse
    delete(String path, List<Integer> validStatusCodes)
    Issue an HTTP DELETE request to the RSE API server with no request body
    @NotNull IRseapiResponse
    get(String path, List<Integer> validStatusCodes, boolean convert)
    Issue an HTTP PUT request to the RSE API server with no request body
    IZosImage
    getImage()
    Get the zOS image associated with the RSE API server
    @NotNull IRseapiResponse
    post(String path, List<Integer> validStatusCodes)
    Issue an HTTP POST request to the RSE API server with no request body
    @NotNull IRseapiResponse
    postJson(String path, com.google.gson.JsonObject requestBody, List<Integer> validStatusCodes)
    Issue an HTTP POST request to the RSE API server with a request body of content type of application/json
    @NotNull IRseapiResponse
    putBinary(String path, byte[] body, List<Integer> validStatusCodes)
    Issue an HTTP PUT request to the RSE API server with a request body of content type of text/plain
    @NotNull IRseapiResponse
    putJson(String path, com.google.gson.JsonObject body, List<Integer> validStatusCodes)
    Issue an HTTP PUT request to the RSE API server with a request body of content type of application/json
    @NotNull IRseapiResponse
    putText(String path, String body, List<Integer> validStatusCodes)
    Issue an HTTP PUT request to the RSE API server with text request body text/plain
    @NotNull com.google.gson.JsonObject
    serverInfo()
    Return the JSON response from the RSE API server Server Information request
    void
    setHeader(String name, String value)
    Set an HTTP Header for the pending RSE API request

  • Method Details

    • setHeader

      void setHeader(String name, String value)
      Set an HTTP Header for the pending RSE API request
      Parameters:
      name - header name
      value - header value

    • clearHeaders

      void clearHeaders()
      Clear the existing HTTP Headers ready for the next RSE API request

    • get

      @NotNull @NotNull IRseapiResponse get(String path, List<Integer> validStatusCodes, boolean convert) throws RseapiException
      Issue an HTTP PUT request to the RSE API server with no request body
      Parameters:
      path - identifies the RSE API REST API server
      validStatusCodes - a List of acceptable HTTP Status codes. Default to
      invalid @link 
      HttpStatus.HttpStatus.SC_OK
      when null
      convert - is a data conversion required. If true, data will be converted betwen EBCDIC to ISO8859-1. If false, no data conversion will take place.
      Returns:
      the RSE API server response
      Throws:
      RseapiException

    • putText

      @NotNull @NotNull IRseapiResponse putText(String path, String body, List<Integer> validStatusCodes) throws RseapiException
      Issue an HTTP PUT request to the RSE API server with text request body text/plain
      Parameters:
      path - identifies the RSE API REST API server
      body - the request body
      validStatusCodes - a List of acceptable HTTP Status codes. Default to
      invalid @link 
      HttpStatus.HttpStatus.SC_OK
      when null
      Returns:
      the RSE API server response
      Throws:
      RseapiException

    • putJson

      @NotNull @NotNull IRseapiResponse putJson(String path, com.google.gson.JsonObject body, List<Integer> validStatusCodes) throws RseapiException
      Issue an HTTP PUT request to the RSE API server with a request body of content type of application/json
      Parameters:
      path - identifies the RSE API REST API server
      body - the request body
      validStatusCodes - a List of acceptable HTTP Status codes. Default to
      invalid @link 
      HttpStatus.HttpStatus.SC_OK
      when null
      Returns:
      the RSE API server response
      Throws:
      RseapiException

    • putBinary

      @NotNull @NotNull IRseapiResponse putBinary(String path, byte[] body, List<Integer> validStatusCodes) throws RseapiException
      Issue an HTTP PUT request to the RSE API server with a request body of content type of text/plain
      Parameters:
      path - identifies the RSE API REST API server
      body - the request body
      validStatusCodes - a List of acceptable HTTP Status codes. Default to
      invalid @link 
      HttpStatus.HttpStatus.SC_OK
      when null
      Returns:
      the RSE API server response
      Throws:
      RseapiException

    • post

      @NotNull @NotNull IRseapiResponse post(String path, List<Integer> validStatusCodes) throws RseapiException
      Issue an HTTP POST request to the RSE API server with no request body
      Parameters:
      path - identifies the RSE API REST API server
      requestBody - the request body
      validStatusCodes - a List of acceptable HTTP Status codes. Default to
      invalid @link 
      HttpStatus.HttpStatus.SC_OK
      when null
      Returns:
      the RSE API server response
      Throws:
      RseapiException

    • postJson

      @NotNull @NotNull IRseapiResponse postJson(String path, com.google.gson.JsonObject requestBody, List<Integer> validStatusCodes) throws RseapiException
      Issue an HTTP POST request to the RSE API server with a request body of content type of application/json
      Parameters:
      path - identifies the RSE API REST API server
      requestBody - the request body
      validStatusCodes - a List of acceptable HTTP Status codes. Default to
      invalid @link 
      HttpStatus.HttpStatus.SC_OK
      when null
      Returns:
      the RSE API server response
      Throws:
      RseapiException

    • delete

      @NotNull @NotNull IRseapiResponse delete(String path, List<Integer> validStatusCodes) throws RseapiException
      Issue an HTTP DELETE request to the RSE API server with no request body
      Parameters:
      path - identifies the RSE API REST API server
      validStatusCodes - a List of acceptable HTTP Status codes. Default to
      invalid @link 
      HttpStatus.HttpStatus.SC_OK
      when null
      Returns:
      the RSE API server response
      Throws:
      RseapiException

    • serverInfo

      @NotNull @NotNull com.google.gson.JsonObject serverInfo() throws RseapiException
      Return the JSON response from the RSE API server Server Information request
      Returns:
      the RSE API server JSON response
      Throws:
      RseapiException

    • getImage

      IZosImage getImage()
      Get the zOS image associated with the RSE API server
      Returns:
      the zOS image