Namespace: OpenEdge.Net.HTTP
Class
RequestBuilder
Parent classes:
Inherits: OpenEdge.Net.HTTP.ConfigBuilder
Implements: OpenEdge.Core.ISupportInitialize

Copyright (c) 2014-2017, 2019 by Progress Software Corporation. All rights reserved.
File:RequestBuilder
Purpose:Builds an HttpRequest for use with an HttpClient
Author(s):pjudge
Created:Tue May 20 11:48:05 EDT 2014
Notes:* this builder performs 2 functions:
1/ creates a useable Request object
2/ provides a fluent interface for setting values on that request
/* The first comma-delimited entry is considered the default value.




Method Summary
Options Name Purpose
OpenEdge.Net.HTTP.RequestBuilder AcceptAll () /** Allows the request to accept all content types. @return RequestBuilder The request builder being constructed. */
OpenEdge.Net.HTTP.RequestBuilder AcceptContentType (character) /** Allows the request to accept the input content type. @param character A content type. Must be non-empty, but otherwise not validated @return RequestBuilder The request builder being constructed. */
OpenEdge.Net.HTTP.RequestBuilder AcceptFormData () /** Allows the request to accept form data content @return RequestBuilder The request builder being constructed. */
OpenEdge.Net.HTTP.RequestBuilder AcceptHtml () /** Allows the request to accept HTML content types @return RequestBuilder The request builder being constructed. */
OpenEdge.Net.HTTP.RequestBuilder AcceptJson () /** Allows the request to accept basic JSON content types. @return RequestBuilder The request builder being constructed. */
OpenEdge.Net.HTTP.RequestBuilder AcceptXml () /** Allows the request to accept XML content types @return RequestBuilder The request builder being constructed. */
OpenEdge.Net.HTTP.RequestBuilder AddCallback (Class, handle) /** Adds a listener to events from the Request. @param Progress.Lang.Class The type of events the EventProviders is capable of listening to @param handle The listening procedure. Must conform to the type */
OpenEdge.Net.HTTP.RequestBuilder AddCallback (Class, Object) /** Adds a listener to events from the Request. @param Progress.Lang.Class The type of events the EventProviders is capable of listening to @param Progress.Lang.Object The listening object. Must conform to the type */
OpenEdge.Net.HTTP.RequestBuilder AddCookie (Cookie) /** Adds (or replaces) a cookie @param Cookie The cookie @return RequestBuilder The request builder being constructed. */
OpenEdge.Net.HTTP.RequestBuilder AddFormData (character, character) /** Adds a form data as a body to the request @param character The field name (key) for the data being added @param character The value for the field @return RequestBuilder The request builder being constructed. */
OpenEdge.Net.HTTP.RequestBuilder AddFormData (IStringStringMap) /** Adds a form data as a body to the request @param IStringStringMap The complete data being added to the request @return RequestBuilder The request builder being constructed. */
OpenEdge.Net.HTTP.RequestBuilder AddHeader (character, character) /** Adds (or replaces) a header @param character The header name @param character The value @return RequestBuilder The request builder being constructed. */
OpenEdge.Net.HTTP.RequestBuilder AddHeader (HttpHeader) /** Adds (or replaces) a header @param HttpHeader The header @return RequestBuilder The request builder being constructed. */
OpenEdge.Net.HTTP.RequestBuilder AddJsonData (JsonObject) /** Adds a JSON body to the request @param JsonObject The JSON data being added to the request @return RequestBuilder The request builder being constructed. */
OpenEdge.Net.HTTP.RequestBuilder AuthCallback (handle) /** Adds an authentication listener to events from the Request. @param handle The listening procedure. Must conform to the type */
OpenEdge.Net.HTTP.RequestBuilder AuthCallback (Object) /** Adds an authentication listener to events from the Request. @param Progress.Lang.Object The listening object. Must conform to the type */
OpenEdge.Net.HTTP.RequestBuilder Build (character, URI) /** Builder director method. @return RequestBuilder A builder for the requested type */
OpenEdge.Net.HTTP.RequestBuilder ContentType (character) /** Sets the content type for the request. @param character The content type @return RequestBuilder This builder object */
OpenEdge.Net.HTTP.IHttpRequest DecorateRequest (Class, IHttpRequest) /** Decorate the request with additional behaviour @param Class The type of decorator to use @param IHttpRequest The request/instance we're decorating @return IHttpRequest The new, decorating request */
OpenEdge.Net.HTTP.RequestBuilder Delete (character) /** Returns a request builder for a default DELETE request @param URI The target URI @return RequestBuilder The request builder being constructed. */
OpenEdge.Net.HTTP.RequestBuilder Delete (character, Object) /** Returns a request builder for a default DELETE request @param character The target URI @param Object The message body/entity for the request @return RequestBuilder The request builder being constructed. */
OpenEdge.Net.HTTP.RequestBuilder Delete (URI) /** Returns a request builder for a default DELETE request @param URI The target URI @return RequestBuilder The request builder being constructed. */
OpenEdge.Net.HTTP.RequestBuilder Delete (URI, Object) /** Returns a request builder for a default DELETE request @param URI The target URI @param Object The message body/entity for the request @return RequestBuilder The request builder being constructed. */
OpenEdge.Net.HTTP.RequestBuilder Delete (URI, Object, character) /** Returns a request builder for a default DELETE request @param URI The target URI @param Object The message body/entity for the request @param character The content type of the entity @return RequestBuilder The request builder being constructed. */
Destroy () /** METHOD FACTORY METHODS END **/
OpenEdge.Net.HTTP.RequestBuilder ETag (character) /** Adds an ETag value to the request. @param character The tag value @return RequestBuilder This builder object */
OpenEdge.Net.HTTP.RequestBuilder Get (character) /** Returns a request builder for a default GET request @param character The target URI @return RequestBuilder The request builder being constructed. */
OpenEdge.Net.HTTP.RequestBuilder Get (character, Object) /** Returns a request builder for a default GET request @param character The target URI @param Object The message body/entity for the request @return RequestBuilder The request builder being constructed. */
OpenEdge.Net.HTTP.RequestBuilder Get (URI) /** Returns a request builder for a default GET request @param URI The target URI @return RequestBuilder The request builder being constructed. */
OpenEdge.Net.HTTP.RequestBuilder Get (URI, Object) /** Returns a request builder for a default GET request @param URI The target URI @param Object The message body/entity for the request @return RequestBuilder The request builder being constructed. */
OpenEdge.Net.HTTP.RequestBuilder Get (URI, Object, character) /** Returns a request builder for a default GET request @param URI The target URI @param Object The message body/entity for the request @param character The content type of the entity @return RequestBuilder The request builder being constructed. */
OpenEdge.Net.HTTP.RequestBuilder Head (character) /** Returns a request builder for a default HEAD request @param character The target URI @return RequestBuilder The request builder being constructed. */
OpenEdge.Net.HTTP.RequestBuilder Head (URI) /** Returns a request builder for a default HEAD request @param URI The target URI @return RequestBuilder The request builder being constructed. */
OpenEdge.Net.HTTP.RequestBuilder HttpVersion (character) /** Sets the HTTP version of the request. @param character A version @return RequestBuilder The request builder being constructed. */
OpenEdge.Net.HTTP.RequestBuilder Id (character) /** Sets the X-Request-Id header. True or false (no unknowns allowed). @param logical True if the request id should be sent. @return RequestBuilder The request builder being constructed. */
Initialize () /* default values */
InitializeRegistry (BuilderRegistry) /** Adds initial values into the registry @param BuilderRegistry The registry to populate */
OpenEdge.Net.HTTP.RequestBuilder Options (character) /** Returns a request builder for a default OPTIONS request @param character The target URI @return RequestBuilder The request builder being constructed. */
OpenEdge.Net.HTTP.RequestBuilder Options (character, Object) /** Returns a request builder for a default OPTIONS request @param character The target URI @param Object The message body/entity for the request @return RequestBuilder The request builder being constructed. */
OpenEdge.Net.HTTP.RequestBuilder Options (URI) /** Returns a request builder for a default OPTIONS request @param URI The target URI @return RequestBuilder The request builder being constructed. */
OpenEdge.Net.HTTP.RequestBuilder Options (URI, Object) /** Returns a request builder for a default OPTIONS request @param URI The target URI @param Object The message body/entity for the request @return RequestBuilder The request builder being constructed. */
OpenEdge.Net.HTTP.RequestBuilder Options (URI, Object, character) /** Returns a request builder for a default OPTIONS request @param URI The target URI @param Object The message body/entity for the request @param character The content type of the entity @return RequestBuilder The request builder being constructed. */
OpenEdge.Net.HTTP.RequestBuilder Patch (character, Object) /** Returns a request builder for a default Patch request @param character The target URI @param Object The message body/entity for the request @return RequestBuilder The request builder being constructed. */
OpenEdge.Net.HTTP.RequestBuilder Patch (URI, Object) /** Returns a request builder for a default Patch request @param URI The target URI @param Object The message body/entity for the request @return RequestBuilder The request builder being constructed. */
OpenEdge.Net.HTTP.RequestBuilder Patch (URI, Object, character) /** Returns a request builder for a default Patch request @param URI The target URI @param Object The message body/entity for the request @param character The content type of the entity @return RequestBuilder The request builder being constructed. */
OpenEdge.Net.HTTP.RequestBuilder Post (character) /** Returns a request builder for an empty POST request @param character The target URI @return RequestBuilder The request builder being constructed. */
OpenEdge.Net.HTTP.RequestBuilder Post (character, Object) /** Returns a request builder for a default POST request @param character The target URI @param Object The message body/entity for the request @return RequestBuilder The request builder being constructed. */
OpenEdge.Net.HTTP.RequestBuilder Post (URI) /** Returns a request builder for an empty POST request @param URI The target URI @return RequestBuilder The request builder being constructed. */
OpenEdge.Net.HTTP.RequestBuilder Post (URI, Object) /** Returns a request builder for a default POST request @param URI The target URI @param Object The message body/entity for the request @return RequestBuilder The request builder being constructed. */
OpenEdge.Net.HTTP.RequestBuilder Post (URI, Object, character) /** Returns a request builder for a default POST request @param URI The target URI @param Object The message body/entity for the request @param character The content type of the entity @return RequestBuilder The request builder being constructed. */
OpenEdge.Net.HTTP.RequestBuilder Put (character, Object) /** Returns a request builder for a default PUT request @param character The target URI @param Object The message body/entity for the request @return RequestBuilder The request builder being constructed. */
OpenEdge.Net.HTTP.RequestBuilder Put (URI, Object) /** Returns a request builder for a default PUT request @param URI The target URI @param Object The message body/entity for the request @return RequestBuilder The request builder being constructed. */
OpenEdge.Net.HTTP.RequestBuilder Put (URI, Object, character) /** Returns a request builder for a default PUT request @param URI The target URI @param Object The message body/entity for the request @param character The content type of the entity @return RequestBuilder The request builder being constructed. */
OpenEdge.Net.HTTP.RequestBuilder SendRequestId () /** Flags the setting of the X-Request-Id header @return RequestBuilder The request builder being constructed. */
LOGICAL SetHeaderOption (HttpHeader) /** Stores a header value as an option @param HttpHeader The header */
OpenEdge.Net.HTTP.RequestBuilder SupportsAuthentication () /** Indicates that this request is can handle authentication This allows credentials etc to be supplied later. @return RequestBuilder This builder object */
OpenEdge.Net.HTTP.RequestBuilder SupportsProxy () /** Indicates that this request is capable of being proxied. This allows the proxy to be supplied later. @return RequestBuilder This builder object */
OpenEdge.Net.HTTP.RequestBuilder Trace (character) /** Returns a request builder for a default TRACE request @param character The target URI @return RequestBuilder The request builder being constructed. */
OpenEdge.Net.HTTP.RequestBuilder Trace (URI) /** Returns a request builder for a default TRACE request @param URI The target URI @return RequestBuilder The request builder being constructed. */
OpenEdge.Net.HTTP.RequestBuilder UsingBasicAuthentication (Credentials) /** Add credentials for HTTP Basic authentication is required for the request. @param Credentials The credentials for the basic auth @return RequestBuilder This builder object */
OpenEdge.Net.HTTP.RequestBuilder UsingCredentials (Credentials) /** Add credentials to the HTTP Request @param Credentials The credentials for the basic auth @return RequestBuilder This builder object */
OpenEdge.Net.HTTP.RequestBuilder UsingCredentials (Credentials, character, character) /** Add credentials to the HTTP Request @param Credentials The credentials for the basic auth @param AuthenticationMethodEnum The authentication method these credentials apply to @param character The authentication challenge text @return RequestBuilder This builder object */
OpenEdge.Net.HTTP.RequestBuilder UsingDigestAuthentication (Credentials) /** Add credentials for HTTP Digest authentication is required for the request. @param Credentials The credentials for the basic auth @return RequestBuilder This builder object */
OpenEdge.Net.HTTP.RequestBuilder ViaProxy (character) /** Sets the URI to use as a proxy server for all requests @param character The proxy server URI @return RequestBuilder This builder object. */
OpenEdge.Net.HTTP.RequestBuilder ViaProxy (URI) /** Sets the URI to use as a proxy server for all requests @param URI The proxy server URI @return RequestBuilder This builder object. */
OpenEdge.Net.HTTP.RequestBuilder WithData (Object) /** Adds data to the request. @param Object The object to use as the request payload/entity @return RequestBuilder The request builder being constructed. */
OpenEdge.Net.HTTP.RequestBuilder WithData (Object, character) /** Adds data to the request. @param Object The object to use as the request payload/entity @param character The content type for this entity/payload @return RequestBuilder The request builder being constructed. */
OpenEdge.Net.HTTP.RequestBuilder WithTransferEncoding (TransferEncodingEnum) /** Sets the transfer encoding for the request @param TransferEncodingEnum The encoding to use @return RequestBuilder The request builder being constructed. */

Constructor Summary
Options Name Purpose
RequestBuilder (character, URI) /** Constructor. @param character The HTTP method @param URI The target URI */

Property Summary
Options Name Purpose
OpenEdge.Net.HTTP.BuilderRegistry Registry
OpenEdge.Net.HTTP.IHttpRequest Request


Method Detail
Top

OpenEdge.Net.HTTP.RequestBuilder AcceptAll ()

Purpose: Allows the request to accept all content types.
Returns OpenEdge.Net.HTTP.RequestBuilder
RequestBuilder The request builder being constructed.
Top

OpenEdge.Net.HTTP.RequestBuilder AcceptContentType (character)

Purpose: Allows the request to accept the input content type.
Parameters:
pcContentType CHARACTER
Returns OpenEdge.Net.HTTP.RequestBuilder
RequestBuilder The request builder being constructed.
Top

OpenEdge.Net.HTTP.RequestBuilder AcceptFormData ()

Purpose: Allows the request to accept form data content
Returns OpenEdge.Net.HTTP.RequestBuilder
RequestBuilder The request builder being constructed.
Top

OpenEdge.Net.HTTP.RequestBuilder AcceptHtml ()

Purpose: Allows the request to accept HTML content types
Returns OpenEdge.Net.HTTP.RequestBuilder
RequestBuilder The request builder being constructed.
Top

OpenEdge.Net.HTTP.RequestBuilder AcceptJson ()

Purpose: Allows the request to accept basic JSON content types.
Returns OpenEdge.Net.HTTP.RequestBuilder
RequestBuilder The request builder being constructed.
Top

OpenEdge.Net.HTTP.RequestBuilder AcceptXml ()

Purpose: Allows the request to accept XML content types
Returns OpenEdge.Net.HTTP.RequestBuilder
RequestBuilder The request builder being constructed.
Top

OpenEdge.Net.HTTP.RequestBuilder AddCallback (Class, handle)

Purpose: Adds a listener to events from the Request.
listening to
Parameters:
poEventListenerType Progress.Lang.Class
phListener HANDLE
Returns OpenEdge.Net.HTTP.RequestBuilder
Top

OpenEdge.Net.HTTP.RequestBuilder AddCallback (Class, Object)

Purpose: Adds a listener to events from the Request.
listening to
Parameters:
poEventListenerType Progress.Lang.Class
poListener Progress.Lang.Object
Returns OpenEdge.Net.HTTP.RequestBuilder
Top

OpenEdge.Net.HTTP.RequestBuilder AddCookie (Cookie)

Purpose: Adds (or replaces) a cookie
Parameters:
pCookie OpenEdge.Net.HTTP.Cookie
Returns OpenEdge.Net.HTTP.RequestBuilder
RequestBuilder The request builder being constructed.
Top

OpenEdge.Net.HTTP.RequestBuilder AddFormData (character, character)

Purpose: Adds a form data as a body to the request
Parameters:
pcFieldName CHARACTER
pcFieldValue CHARACTER
Returns OpenEdge.Net.HTTP.RequestBuilder
RequestBuilder The request builder being constructed.
Top

OpenEdge.Net.HTTP.RequestBuilder AddFormData (IStringStringMap)

Purpose: Adds a form data as a body to the request
Parameters:
poEntity OpenEdge.Core.Collections.IStringStringMap
Returns OpenEdge.Net.HTTP.RequestBuilder
RequestBuilder The request builder being constructed.
Top

OpenEdge.Net.HTTP.RequestBuilder AddHeader (character, character)

Purpose: Adds (or replaces) a header
Parameters:
pcName CHARACTER
pcValue CHARACTER
Returns OpenEdge.Net.HTTP.RequestBuilder
RequestBuilder The request builder being constructed.
Top

OpenEdge.Net.HTTP.RequestBuilder AddHeader (HttpHeader)

Purpose: Adds (or replaces) a header
Parameters:
poHeader OpenEdge.Net.HTTP.HttpHeader
Returns OpenEdge.Net.HTTP.RequestBuilder
RequestBuilder The request builder being constructed.
Top

OpenEdge.Net.HTTP.RequestBuilder AddJsonData (JsonObject)

Purpose: Adds a JSON body to the request
Parameters:
poEntity Progress.Json.ObjectModel.JsonObject
Returns OpenEdge.Net.HTTP.RequestBuilder
RequestBuilder The request builder being constructed.
Top

OpenEdge.Net.HTTP.RequestBuilder AuthCallback (handle)

Purpose: Adds an authentication listener to events from the Request.
Parameters:
phListener HANDLE
Returns OpenEdge.Net.HTTP.RequestBuilder
Top

OpenEdge.Net.HTTP.RequestBuilder AuthCallback (Object)

Purpose: Adds an authentication listener to events from the Request.
Parameters:
poListener Progress.Lang.Object
Returns OpenEdge.Net.HTTP.RequestBuilder
Top

OpenEdge.Net.HTTP.RequestBuilder Build (character, URI)

Purpose: Builder director method.
Parameters:
pcMethod CHARACTER
poURI OpenEdge.Net.URI
Returns OpenEdge.Net.HTTP.RequestBuilder
RequestBuilder A builder for the requested type
Top

OpenEdge.Net.HTTP.RequestBuilder ContentType (character)

Purpose: Sets the content type for the request.
Parameters:
pcContentType CHARACTER
Returns OpenEdge.Net.HTTP.RequestBuilder
RequestBuilder This builder object
Top

OpenEdge.Net.HTTP.IHttpRequest DecorateRequest (Class, IHttpRequest)

Purpose: Decorate the request with additional behaviour
Parameters:
poDecorationType Progress.Lang.Class
poDecoratedRequest OpenEdge.Net.HTTP.IHttpRequest
Returns OpenEdge.Net.HTTP.IHttpRequest
IHttpRequest The new, decorating request
Top

OpenEdge.Net.HTTP.RequestBuilder Delete (character)

Purpose: Returns a request builder for a default DELETE request
Parameters:
pcURI CHARACTER
Returns OpenEdge.Net.HTTP.RequestBuilder
RequestBuilder The request builder being constructed.
Top

OpenEdge.Net.HTTP.RequestBuilder Delete (character, Object)

Purpose: Returns a request builder for a default DELETE request
Parameters:
pcURI CHARACTER
poEntity Progress.Lang.Object
Returns OpenEdge.Net.HTTP.RequestBuilder
RequestBuilder The request builder being constructed.
Top

OpenEdge.Net.HTTP.RequestBuilder Delete (URI)

Purpose: Returns a request builder for a default DELETE request
Parameters:
poURI OpenEdge.Net.URI
Returns OpenEdge.Net.HTTP.RequestBuilder
RequestBuilder The request builder being constructed.
Top

OpenEdge.Net.HTTP.RequestBuilder Delete (URI, Object)

Purpose: Returns a request builder for a default DELETE request
Parameters:
poURI OpenEdge.Net.URI
poEntity Progress.Lang.Object
Returns OpenEdge.Net.HTTP.RequestBuilder
RequestBuilder The request builder being constructed.
Top

OpenEdge.Net.HTTP.RequestBuilder Delete (URI, Object, character)

Purpose: Returns a request builder for a default DELETE request
Parameters:
poURI OpenEdge.Net.URI
poEntity Progress.Lang.Object
pcContentType CHARACTER
Returns OpenEdge.Net.HTTP.RequestBuilder
RequestBuilder The request builder being constructed.
Top

Destroy ()

Purpose: METHOD FACTORY METHODS END
Top

OpenEdge.Net.HTTP.RequestBuilder ETag (character)

Purpose: Adds an ETag value to the request.
Parameters:
pcETag CHARACTER
Returns OpenEdge.Net.HTTP.RequestBuilder
RequestBuilder This builder object
Top

OpenEdge.Net.HTTP.RequestBuilder Get (character)

Purpose: Returns a request builder for a default GET request
Parameters:
pcURI CHARACTER
Returns OpenEdge.Net.HTTP.RequestBuilder
RequestBuilder The request builder being constructed.
Top

OpenEdge.Net.HTTP.RequestBuilder Get (character, Object)

Purpose: Returns a request builder for a default GET request
Parameters:
pcURI CHARACTER
poEntity Progress.Lang.Object
Returns OpenEdge.Net.HTTP.RequestBuilder
RequestBuilder The request builder being constructed.
Top

OpenEdge.Net.HTTP.RequestBuilder Get (URI)

Purpose: Returns a request builder for a default GET request
Parameters:
poURI OpenEdge.Net.URI
Returns OpenEdge.Net.HTTP.RequestBuilder
RequestBuilder The request builder being constructed.
Top

OpenEdge.Net.HTTP.RequestBuilder Get (URI, Object)

Purpose: Returns a request builder for a default GET request
Parameters:
poURI OpenEdge.Net.URI
poEntity Progress.Lang.Object
Returns OpenEdge.Net.HTTP.RequestBuilder
RequestBuilder The request builder being constructed.
Top

OpenEdge.Net.HTTP.RequestBuilder Get (URI, Object, character)

Purpose: Returns a request builder for a default GET request
Parameters:
poURI OpenEdge.Net.URI
poEntity Progress.Lang.Object
pcContentType CHARACTER
Returns OpenEdge.Net.HTTP.RequestBuilder
RequestBuilder The request builder being constructed.
Top

OpenEdge.Net.HTTP.RequestBuilder Head (character)

Purpose: Returns a request builder for a default HEAD request
Parameters:
pcURI CHARACTER
Returns OpenEdge.Net.HTTP.RequestBuilder
RequestBuilder The request builder being constructed.
Top

OpenEdge.Net.HTTP.RequestBuilder Head (URI)

Purpose: Returns a request builder for a default HEAD request
Parameters:
poURI OpenEdge.Net.URI
Returns OpenEdge.Net.HTTP.RequestBuilder
RequestBuilder The request builder being constructed.
Top

OpenEdge.Net.HTTP.RequestBuilder HttpVersion (character)

Purpose: Sets the HTTP version of the request.
Parameters:
pcVersion CHARACTER
Returns OpenEdge.Net.HTTP.RequestBuilder
RequestBuilder The request builder being constructed.
Top

OpenEdge.Net.HTTP.RequestBuilder Id (character)

Purpose: Sets the X-Request-Id header. True or false (no unknowns allowed).
Parameters:
pcRequestId CHARACTER
Returns OpenEdge.Net.HTTP.RequestBuilder
RequestBuilder The request builder being constructed.
Top

Initialize ()

/* default values
Top

InitializeRegistry (BuilderRegistry)

Purpose: Adds initial values into the registry
Parameters:
poRegistry OpenEdge.Net.HTTP.BuilderRegistry
Top

OpenEdge.Net.HTTP.RequestBuilder Options (character)

Purpose: Returns a request builder for a default OPTIONS request
Parameters:
pcURI CHARACTER
Returns OpenEdge.Net.HTTP.RequestBuilder
RequestBuilder The request builder being constructed.
Top

OpenEdge.Net.HTTP.RequestBuilder Options (character, Object)

Purpose: Returns a request builder for a default OPTIONS request
Parameters:
pcURI CHARACTER
poEntity Progress.Lang.Object
Returns OpenEdge.Net.HTTP.RequestBuilder
RequestBuilder The request builder being constructed.
Top

OpenEdge.Net.HTTP.RequestBuilder Options (URI)

Purpose: Returns a request builder for a default OPTIONS request
Parameters:
poURI OpenEdge.Net.URI
Returns OpenEdge.Net.HTTP.RequestBuilder
RequestBuilder The request builder being constructed.
Top

OpenEdge.Net.HTTP.RequestBuilder Options (URI, Object)

Purpose: Returns a request builder for a default OPTIONS request
Parameters:
poURI OpenEdge.Net.URI
poEntity Progress.Lang.Object
Returns OpenEdge.Net.HTTP.RequestBuilder
RequestBuilder The request builder being constructed.
Top

OpenEdge.Net.HTTP.RequestBuilder Options (URI, Object, character)

Purpose: Returns a request builder for a default OPTIONS request
Parameters:
poURI OpenEdge.Net.URI
poEntity Progress.Lang.Object
pcContentType CHARACTER
Returns OpenEdge.Net.HTTP.RequestBuilder
RequestBuilder The request builder being constructed.
Top

OpenEdge.Net.HTTP.RequestBuilder Patch (character, Object)

Purpose: Returns a request builder for a default Patch request
Parameters:
pcURI CHARACTER
poEntity Progress.Lang.Object
Returns OpenEdge.Net.HTTP.RequestBuilder
RequestBuilder The request builder being constructed.
Top

OpenEdge.Net.HTTP.RequestBuilder Patch (URI, Object)

Purpose: Returns a request builder for a default Patch request
Parameters:
poURI OpenEdge.Net.URI
poEntity Progress.Lang.Object
Returns OpenEdge.Net.HTTP.RequestBuilder
RequestBuilder The request builder being constructed.
Top

OpenEdge.Net.HTTP.RequestBuilder Patch (URI, Object, character)

Purpose: Returns a request builder for a default Patch request
Parameters:
poURI OpenEdge.Net.URI
poEntity Progress.Lang.Object
pcContentType CHARACTER
Returns OpenEdge.Net.HTTP.RequestBuilder
RequestBuilder The request builder being constructed.
Top

OpenEdge.Net.HTTP.RequestBuilder Post (character)

Purpose: Returns a request builder for an empty POST request
Parameters:
pcURI CHARACTER
Returns OpenEdge.Net.HTTP.RequestBuilder
RequestBuilder The request builder being constructed.
Top

OpenEdge.Net.HTTP.RequestBuilder Post (character, Object)

Purpose: Returns a request builder for a default POST request
Parameters:
pcURI CHARACTER
poEntity Progress.Lang.Object
Returns OpenEdge.Net.HTTP.RequestBuilder
RequestBuilder The request builder being constructed.
Top

OpenEdge.Net.HTTP.RequestBuilder Post (URI)

Purpose: Returns a request builder for an empty POST request
Parameters:
poURI OpenEdge.Net.URI
Returns OpenEdge.Net.HTTP.RequestBuilder
RequestBuilder The request builder being constructed.
Top

OpenEdge.Net.HTTP.RequestBuilder Post (URI, Object)

Purpose: Returns a request builder for a default POST request
Parameters:
poURI OpenEdge.Net.URI
poEntity Progress.Lang.Object
Returns OpenEdge.Net.HTTP.RequestBuilder
RequestBuilder The request builder being constructed.
Top

OpenEdge.Net.HTTP.RequestBuilder Post (URI, Object, character)

Purpose: Returns a request builder for a default POST request
Parameters:
poURI OpenEdge.Net.URI
poEntity Progress.Lang.Object
pcContentType CHARACTER
Returns OpenEdge.Net.HTTP.RequestBuilder
RequestBuilder The request builder being constructed.
Top

OpenEdge.Net.HTTP.RequestBuilder Put (character, Object)

Purpose: Returns a request builder for a default PUT request
Parameters:
pcURI CHARACTER
poEntity Progress.Lang.Object
Returns OpenEdge.Net.HTTP.RequestBuilder
RequestBuilder The request builder being constructed.
Top

OpenEdge.Net.HTTP.RequestBuilder Put (URI, Object)

Purpose: Returns a request builder for a default PUT request
Parameters:
poURI OpenEdge.Net.URI
poEntity Progress.Lang.Object
Returns OpenEdge.Net.HTTP.RequestBuilder
RequestBuilder The request builder being constructed.
Top

OpenEdge.Net.HTTP.RequestBuilder Put (URI, Object, character)

Purpose: Returns a request builder for a default PUT request
Parameters:
poURI OpenEdge.Net.URI
poEntity Progress.Lang.Object
pcContentType CHARACTER
Returns OpenEdge.Net.HTTP.RequestBuilder
RequestBuilder The request builder being constructed.
Top

OpenEdge.Net.HTTP.RequestBuilder SendRequestId ()

Purpose: Flags the setting of the X-Request-Id header
Returns OpenEdge.Net.HTTP.RequestBuilder
RequestBuilder The request builder being constructed.
Top

LOGICAL SetHeaderOption (HttpHeader)

Purpose: Stores a header value as an option
Parameters:
poHeader OpenEdge.Net.HTTP.HttpHeader
Returns LOGICAL
Top

OpenEdge.Net.HTTP.RequestBuilder SupportsAuthentication ()

Purpose: Indicates that this request is can handle authentication
This allows credentials etc to be supplied later.
Returns OpenEdge.Net.HTTP.RequestBuilder
RequestBuilder This builder object
Top

OpenEdge.Net.HTTP.RequestBuilder SupportsProxy ()

Purpose: Indicates that this request is capable of being proxied.
This allows the proxy to be supplied later.
Returns OpenEdge.Net.HTTP.RequestBuilder
RequestBuilder This builder object
Top

OpenEdge.Net.HTTP.RequestBuilder Trace (character)

Purpose: Returns a request builder for a default TRACE request
Parameters:
pcURI CHARACTER
Returns OpenEdge.Net.HTTP.RequestBuilder
RequestBuilder The request builder being constructed.
Top

OpenEdge.Net.HTTP.RequestBuilder Trace (URI)

Purpose: Returns a request builder for a default TRACE request
Parameters:
poURI OpenEdge.Net.URI
Returns OpenEdge.Net.HTTP.RequestBuilder
RequestBuilder The request builder being constructed.
Top

OpenEdge.Net.HTTP.RequestBuilder UsingBasicAuthentication (Credentials)

Purpose: Add credentials for HTTP Basic authentication is required for the request.
Parameters:
poCredentials OpenEdge.Net.HTTP.Credentials
Returns OpenEdge.Net.HTTP.RequestBuilder
RequestBuilder This builder object
Top

OpenEdge.Net.HTTP.RequestBuilder UsingCredentials (Credentials)

Purpose: Add credentials to the HTTP Request
Parameters:
poCredentials OpenEdge.Net.HTTP.Credentials
Returns OpenEdge.Net.HTTP.RequestBuilder
RequestBuilder This builder object
Top

OpenEdge.Net.HTTP.RequestBuilder UsingCredentials (Credentials, character, character)

Purpose: Add credentials to the HTTP Request
Parameters:
poCredentials OpenEdge.Net.HTTP.Credentials
pcAuthenticationMethod CHARACTER
pcChallenge CHARACTER
Returns OpenEdge.Net.HTTP.RequestBuilder
RequestBuilder This builder object
Top

OpenEdge.Net.HTTP.RequestBuilder UsingDigestAuthentication (Credentials)

Purpose: Add credentials for HTTP Digest authentication is required for the request.
Parameters:
poCredentials OpenEdge.Net.HTTP.Credentials
Returns OpenEdge.Net.HTTP.RequestBuilder
RequestBuilder This builder object
Top

OpenEdge.Net.HTTP.RequestBuilder ViaProxy (character)

Purpose: Sets the URI to use as a proxy server for all requests
Parameters:
pcProxyURI CHARACTER
Returns OpenEdge.Net.HTTP.RequestBuilder
RequestBuilder This builder object.
Top

OpenEdge.Net.HTTP.RequestBuilder ViaProxy (URI)

Purpose: Sets the URI to use as a proxy server for all requests
Parameters:
poProxyURI OpenEdge.Net.URI
Returns OpenEdge.Net.HTTP.RequestBuilder
RequestBuilder This builder object.
Top

OpenEdge.Net.HTTP.RequestBuilder WithData (Object)

Purpose: Adds data to the request.
Parameters:
poEntity Progress.Lang.Object
Returns OpenEdge.Net.HTTP.RequestBuilder
RequestBuilder The request builder being constructed.
Top

OpenEdge.Net.HTTP.RequestBuilder WithData (Object, character)

Purpose: Adds data to the request.
Parameters:
poEntity Progress.Lang.Object
pcContentType CHARACTER
Returns OpenEdge.Net.HTTP.RequestBuilder
RequestBuilder The request builder being constructed.
Top

OpenEdge.Net.HTTP.RequestBuilder WithTransferEncoding (TransferEncodingEnum)

Purpose: Sets the transfer encoding for the request
Parameters:
poEncoding OpenEdge.Net.HTTP.TransferEncodingEnum
Returns OpenEdge.Net.HTTP.RequestBuilder
RequestBuilder The request builder being constructed.


Constructor Detail
Top

RequestBuilder (character, URI)

Purpose: Constructor.
Parameters:
pcMethod CHARACTER
poURI OpenEdge.Net.URI


Property Detail
Top

OpenEdge.Net.HTTP.BuilderRegistry Registry

Returns OpenEdge.Net.HTTP.BuilderRegistry
Top

OpenEdge.Net.HTTP.IHttpRequest Request

Returns OpenEdge.Net.HTTP.IHttpRequest


Copyright © 2022 Progress Software Corporation. All rights Reserved.

Progress® OpenEdge® Release 11.7.15