Package dev.galasa.zosmf

Interface IZosmf

public interface IZosmf
Represents a zOSMF server

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static enum 
    IZosmf.ZosmfCustomHeaders
    Enumeration of zOSMF Custom HTTP headers
    static enum 
    IZosmf.ZosmfRequestType
    Enumeration of zOSMF request types

  • Method Summary

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

  • Method Details

    • setHeader

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

    • clearHeaders

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

    • get

      @NotNull @NotNull IZosmfResponse get(String path, List<Integer> validStatusCodes, boolean convert) throws ZosmfException
      Issue an HTTP PUT request to the zOSMF server with no request body
      Parameters:
      path - identifies the zOSMF REST API
      validStatusCodes - a List of acceptable HTTP Status codes. Default to 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 zOSMF server response
      Throws:
      ZosmfException

    • postJson

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

    • putText

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

    • putJson

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

    • putBinary

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

    • delete

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

    • serverInfo

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

    • getImage

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