Package io.bdeploy.api.remote.v1

Interface PublicProxyResource

@Consumes("*/*") @Produces("*/*") public interface PublicProxyResource
Proxy requests to a target process on an instance.

A request made on any of the resource methods is captured, wrapped, forwarded and executed on the target system. The response (including all headers, types, etc.) is routed back to the caller. Example how to use this using cURL on the command line: 

 $ curl -v 'https://localhost:7705/api/public/v1/common/endpoints?BDeploy_group=[GROUP]&BDeploy_instance=[INSTANCE]' -H 'Accept: application/json, text/plain' -H 'Authorization: Bearer [TOKEN]' --insecure
 $ curl -v 'https://localhost:7705/api/public/v1/common/proxy/[ENDPOINTID]?BDeploy_group=[GROUP]&BDeploy_instance=[INSTANCE]&BDeploy_application=[APPLICATION]' -H 'Accept: application/json, text/plain' -H 'X-BDeploy-Authorization: Bearer [TOKEN]' --insecure -u [USER]:[PASS]

  • Method Summary

    Modifier and Type
    Method
    Description
    jakarta.ws.rs.core.Response
    delete(String endpointId)
     
    jakarta.ws.rs.core.Response
    get(String endpointId)
     
    jakarta.ws.rs.core.Response
    head(String endpointId)
     
    jakarta.ws.rs.core.Response
    options(String endpointId)
     
    jakarta.ws.rs.core.Response
    patch(String endpointId, byte[] body)
     
    jakarta.ws.rs.core.Response
    post(String endpointId, byte[] body)
     
    jakarta.ws.rs.core.Response
    put(String endpointId, byte[] body)
     

  • Method Details

    • head

      @HEAD @Path("{endpoint : .+}") jakarta.ws.rs.core.Response head(@PathParam("endpoint") String endpointId)

    • options

      @OPTIONS @Path("{endpoint : .+}") jakarta.ws.rs.core.Response options(@PathParam("endpoint") String endpointId)

    • get

      @GET @Path("{endpoint : .+}") jakarta.ws.rs.core.Response get(@PathParam("endpoint") String endpointId)

    • put

      @PUT @Path("{endpoint : .+}") jakarta.ws.rs.core.Response put(@PathParam("endpoint") String endpointId, byte[] body)

    • post

      @POST @Path("{endpoint : .+}") jakarta.ws.rs.core.Response post(@PathParam("endpoint") String endpointId, byte[] body)

    • delete

      @DELETE @Path("{endpoint : .+}") jakarta.ws.rs.core.Response delete(@PathParam("endpoint") String endpointId)

    • patch

      @PATCH @Path("{endpoint : .+}") jakarta.ws.rs.core.Response patch(@PathParam("endpoint") String endpointId, byte[] body)