Clients - http : HttpSecureClient

Provides secure HTTP remote functions for interacting with HTTP endpoints. This will make use of the authentication schemes configured in the HTTP client endpoint to secure the HTTP requests.

Constructor

__init

(string url, ClientConfiguration config)

  • url string
  • URL of the target service

Remote Methods

post

This wraps the HttpSecureClient.post() function of the underlying HTTP remote functions provider. Add relevant authentication headers to the request and send the request to actual network call.

head

This wraps the HttpSecureClient.head() function of the underlying HTTP remote functions provider. Add relevant authentication headers to the request and send the request to actual network call.

put

This wraps the HttpSecureClient.put() function of the underlying HTTP remote functions provider. Add relevant authentication headers to the request and send the request to actual network call.

execute

This wraps the HttpSecureClient.execute() function of the underlying HTTP remote functions provider. Add relevant authentication headers o the request and send the request to actual network call.

patch

This wraps the HttpSecureClient.patch() function of the underlying HTTP remote functions provider. Add relevant authentication headers to the request and send the request to actual network call.

delete

This wraps the HttpSecureClient.delete() function of the underlying HTTP remote functions provider. Add relevant authentication headers to the request and send the request to actual network call.

get

This wraps the HttpSecureClient.get() function of the underlying HTTP remote functions provider. Add relevant authentication headers to the request and send the request to actual network call.

options

This wraps the HttpSecureClient.options() function of the underlying HTTP remote functions provider. Add relevant authentication headers to the request and send the request to actual network call.

forward

This wraps the HttpSecureClient.forward() function of the underlying HTTP remote functions provider. Add relevant authentication headers to the request and send the request to actual network call.

submit

This wraps the HttpSecureClient.submit() function of the underlying HTTP remote functions provider. Add relevant authentication headers to the request and send the request to actual network call.

getResponse

This just passes the request to the actual network call.

hasPromise

Passes the request to an actual network call.

getNextPromise

Passes the request to an actual network call.

getPromisedResponse

Passes the request to an actual network call.

rejectPromise

Passes the request to an actual network call.

Fields

  • url string
  • The URL of the remote HTTP endpoint

  • config ClientConfiguration (default {})
  • The configurations of the client endpoint associated with this HttpActions instance

  • httpClient HttpClient
  • The underlying HttpActions instance, which will make the actual network calls

post

(string path, RequestMessage message)

returns Response | ClientError

This wraps the HttpSecureClient.post() function of the underlying HTTP remote functions provider. Add relevant authentication headers to the request and send the request to actual network call.

Parameters

  • path string
  • Resource path

  • message RequestMessage
  • An HTTP outbound request message or any payload of type string, xml, json, byte[], io:ReadableByteChannel or mime:Entity[]

  • Return Type

    (Response | ClientError)
  • The inbound response message or the error if one occurred while attempting to fulfill the HTTP request

This wraps the HttpSecureClient.head() function of the underlying HTTP remote functions provider. Add relevant authentication headers to the request and send the request to actual network call.

Parameters

  • path string
  • Resource path

  • message RequestMessage (default ())
  • An optional HTTP outbound request message or any payload of type string, xml, json, byte[], io:ReadableByteChannel or mime:Entity[]

  • Return Type

    (Response | ClientError)
  • The inbound response message or the error if one occurred while attempting to fulfill the HTTP request

put

(string path, RequestMessage message)

returns Response | ClientError

This wraps the HttpSecureClient.put() function of the underlying HTTP remote functions provider. Add relevant authentication headers to the request and send the request to actual network call.

Parameters

  • path string
  • Resource path

  • message RequestMessage
  • An HTTP outbound request message or any payload of type string, xml, json, byte[], io:ReadableByteChannel or mime:Entity[]

  • Return Type

    (Response | ClientError)
  • The inbound response message or an error occurred while attempting to fulfill the HTTP request

execute

(string httpVerb, string path, RequestMessage message)

returns Response | ClientError

This wraps the HttpSecureClient.execute() function of the underlying HTTP remote functions provider. Add relevant authentication headers o the request and send the request to actual network call.

Parameters

  • httpVerb string
  • HTTP verb value

  • path string
  • Resource path

  • message RequestMessage
  • An HTTP outbound request message or any payload of type string, xml, json, byte[], io:ReadableByteChannel or mime:Entity[]

  • Return Type

    (Response | ClientError)
  • The inbound response message or an error occurred while attempting to fulfill the HTTP request

patch

(string path, RequestMessage message)

returns Response | ClientError

This wraps the HttpSecureClient.patch() function of the underlying HTTP remote functions provider. Add relevant authentication headers to the request and send the request to actual network call.

Parameters

  • path string
  • Resource path

  • message RequestMessage
  • An HTTP outbound request message or any payload of type string, xml, json, byte[], io:ReadableByteChannel or mime:Entity[]

  • Return Type

    (Response | ClientError)
  • The inbound response message or an error occurred while attempting to fulfill the HTTP request

delete

(string path, RequestMessage message)

returns Response | ClientError

This wraps the HttpSecureClient.delete() function of the underlying HTTP remote functions provider. Add relevant authentication headers to the request and send the request to actual network call.

Parameters

  • path string
  • Resource path

  • message RequestMessage (default ())
  • An HTTP outbound request message or any payload of type string, xml, json, byte[], io:ReadableByteChannel or mime:Entity[]

  • Return Type

    (Response | ClientError)
  • The inbound response message or the error if one occurred while attempting to fulfill the HTTP request

get

(string path, RequestMessage message)

returns Response | ClientError

This wraps the HttpSecureClient.get() function of the underlying HTTP remote functions provider. Add relevant authentication headers to the request and send the request to actual network call.

Parameters

  • path string
  • Request path

  • message RequestMessage (default ())
  • An HTTP outbound request message or any payload of type string, xml, json, byte[], io:ReadableByteChannel or mime:Entity[]

  • Return Type

    (Response | ClientError)
  • The inbound response message or the error if one occurred while attempting to fulfill the HTTP request

options

(string path, RequestMessage message)

returns Response | ClientError

This wraps the HttpSecureClient.options() function of the underlying HTTP remote functions provider. Add relevant authentication headers to the request and send the request to actual network call.

Parameters

  • path string
  • Request path

  • message RequestMessage (default ())
  • An optional HTTP outbound request message or any payload of type string, xml, json, byte[], io:ReadableByteChannel or mime:Entity[]

  • Return Type

    (Response | ClientError)
  • The inbound response message or the error if one occurred while attempting to fulfill the HTTP request

forward

(string path, Request request)

returns Response | ClientError

This wraps the HttpSecureClient.forward() function of the underlying HTTP remote functions provider. Add relevant authentication headers to the request and send the request to actual network call.

Parameters

  • path string
  • Request path

  • request Request
  • An HTTP inbound request message

  • Return Type

    (Response | ClientError)
  • The inbound response message or the error if one occurred while attempting to fulfill the HTTP request

submit

(string httpVerb, string path, RequestMessage message)

returns HttpFuture | ClientError

This wraps the HttpSecureClient.submit() function of the underlying HTTP remote functions provider. Add relevant authentication headers to the request and send the request to actual network call.

Parameters

  • httpVerb string
  • The HTTP verb value

  • path string
  • The resource path

  • message RequestMessage
  • An HTTP outbound request message or any payload of type string, xml, json, byte[], io:ReadableByteChannel, or mime:Entity[]

  • Return Type

    (HttpFuture | ClientError)
  • An http:HttpFuture that represents an asynchronous service invocation, or else an http:ClientError if the submission fails

getResponse

(HttpFuture httpFuture)

returns Response | ClientError

This just passes the request to the actual network call.

Parameters

  • httpFuture HttpFuture
  • The http:HttpFuture related to a previous asynchronous invocation

  • Return Type

    (Response | ClientError)
  • An http:Response message or else an http:ClientError if the invocation fails

hasPromise

(HttpFuture httpFuture)

returns boolean

Passes the request to an actual network call.

Parameters

  • httpFuture HttpFuture
  • The http:HttpFuture related to a previous asynchronous invocation

  • Return Type

    (boolean)
  • A boolean, which represents whether an http:PushPromise exists

getNextPromise

(HttpFuture httpFuture)

returns PushPromise | ClientError

Passes the request to an actual network call.

Parameters

  • httpFuture HttpFuture
  • The http:HttpFuture related to a previous asynchronous invocation

  • Return Type

    (PushPromise | ClientError)
  • An http:PushPromise message or else an http:ClientError if the invocation fails

getPromisedResponse

(PushPromise promise)

returns Response | ClientError

Passes the request to an actual network call.

Parameters

  • Return Type

    (Response | ClientError)
  • A promised http:Response message or else an http:ClientError if the invocation fails

rejectPromise

Passes the request to an actual network call.

Parameters