com.goldencode.p2j.oo.net.http

Class RequestBuilder

java.lang.Object

com.goldencode.p2j.oo.lang.BaseObject

com.goldencode.p2j.oo.core.util.ConfigBuilder

com.goldencode.p2j.oo.net.http.ConfigBuilder

com.goldencode.p2j.oo.net.http.RequestBuilder

All Implemented Interfaces:

ISupportInitialize, _BaseObject_

Direct Known Subclasses:

DefaultRequestBuilder

public abstract class RequestBuilder
extends ConfigBuilder
implements ISupportInitialize

Business logic (converted to Java from the 4GL source code in OpenEdge/Net/HTTP/RequestBuilder.cls).

Nested Class Summary

Nested classes/interfaces inherited from class com.goldencode.p2j.oo.core.util.ConfigBuilder

ConfigBuilder.OptionTypeHelper<T>, ConfigBuilder.OptionValueHolder

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	APPLICATION_JSON
protected static java.lang.String	CHAR
protected static java.lang.String	FORM_URLENCODED
protected static java.lang.String	HANDLE
protected static java.lang.String	IHTTPREQUEST
protected static java.lang.String	INPUT
protected static java.lang.String	LANG_CLASS
protected static java.lang.String	LANG_OBJECT
protected static java.lang.String	NET_URI
protected static java.lang.String	OBJECT
protected static java.lang.String	OPTION_ACCEPT_CONTENT_TYPE
protected static java.lang.String	OPTION_AUTH_CHALLENGE
protected static java.lang.String	OPTION_AUTH_CREDENTIALS
protected static java.lang.String	OPTION_AUTH_LISTENER
protected static java.lang.String	OPTION_AUTH_METHOD
protected static java.lang.String	OPTION_ENTITY
protected static java.lang.String	OPTION_EVENT_LISTENER_TYPE
protected static java.lang.String	OPTION_METHOD
protected static java.lang.String	OPTION_PROXY_URI
protected static java.lang.String	OPTION_SUPPORT_AUTHENTICATION
protected static java.lang.String	OPTION_SUPPORT_PROXY
protected static java.lang.String	OPTION_URI
protected static java.lang.String	OPTION_VERSION
private static ContextLocal<object<? extends BuilderRegistry>>	REGISTRY
protected static java.lang.String	REQUESTBUILDER
protected static java.lang.String	TEXT_HTML
protected static java.lang.String	XML_CONTENT_TYPES
protected static java.util.List<java.lang.String>	XML_CONTENT_TYPES_LIST

Fields inherited from class com.goldencode.p2j.oo.core.util.ConfigBuilder

options

Constructor Summary

Constructors

Constructor and Description
RequestBuilder()

Method Summary

Modifier and Type	Method and Description
protected void	__net_http_RequestBuilder_constructor__(character _pcMethod, object<? extends Uri> _poURI) 'constructor'.
static void	__net_http_RequestBuilder_constructor__static__()
void	__net_http_RequestBuilder_execute__() ????.
object<? extends RequestBuilder>	acceptAll() Allows the request to accept all content types.
object<? extends RequestBuilder>	acceptContentType(character _pcContentType) Allows the request to accept the input content type.
object<? extends RequestBuilder>	acceptFormData() Allows the request to accept form data content.
object<? extends RequestBuilder>	acceptHtml() Allows the request to accept HTML content types.
object<? extends RequestBuilder>	acceptJson() Allows the request to accept basic JSON content types.
object<? extends RequestBuilder>	acceptXml() Allows the request to accept XML content types.
object<? extends RequestBuilder>	addCallback(object<? extends LegacyClass> _poEventListenerType, handle _phListener) Adds a listener to events from the Request.
object<? extends RequestBuilder>	addCallback(object<? extends LegacyClass> _poEventListenerType, object<? extends _BaseObject_> _poListener) Adds a listener to events from the Request.
object<? extends RequestBuilder>	addCookie(object<? extends Cookie> _poCookie) Adds (or replaces) a cookie
object<? extends RequestBuilder>	addFormData(character _pcFieldName, character _pcFieldValue) Adds a form data as a body to the request.
object<? extends RequestBuilder>	addFormData(object<? extends IStringStringMap> _poEntity) Adds a form data as a body to the request.
object<? extends RequestBuilder>	addHeader(character _pcName, character _pcValue) Adds (or replaces) a heade
object<? extends RequestBuilder>	addHeader(object<? extends HttpHeader> _poHeader) Adds (or replaces) a header
object<? extends RequestBuilder>	addJsonData(object<? extends JsonObject> _poEntity) Adds a JSON body to the request.
object<? extends RequestBuilder>	authCallback(handle _phListener) Adds an authentication listener to events from the Request.
object<? extends RequestBuilder>	authCallback(object<? extends _BaseObject_> _poListener) Adds an authentication listener to events from the Request.
static object<? extends RequestBuilder>	build(character _pcMethod, object<? extends Uri> _poURI) Builder director method.
object<? extends RequestBuilder>	contentType(character _pcContentType) Sets the content type for the request.
static object<? extends IhttpRequest>	decorateRequest(object<? extends LegacyClass> _poDecorationType, object<? extends IhttpRequest> _poDecoratedRequest) Decorate the request with additional behavior
static object<? extends RequestBuilder>	delete(character _pcURI) Create builder for the HTTP DELETE.
static object<? extends RequestBuilder>	delete(character _pcURI, object<? extends _BaseObject_> _poEntity) Create builder for the HTTP DELETE.
static object<? extends RequestBuilder>	delete(object<? extends Uri> _poURI) Create builder for the HTTP DELETE.
static object<? extends RequestBuilder>	delete(object<? extends Uri> _poURI, object<? extends _BaseObject_> _poEntity) Create builder for the HTTP DELETE.
static object<? extends RequestBuilder>	delete(object<? extends Uri> _poURI, object<? extends _BaseObject_> _poEntity, character _pcContentType) Create builder for the HTTP DELETE.
void	destroy() Destroy.
object<? extends RequestBuilder>	etag(character _pcETag) Adds an ETag value to the request.
static object<? extends RequestBuilder>	get(character _pcURI) Create builder for the HTTP GET.
static object<? extends RequestBuilder>	get(character _pcURI, object<? extends _BaseObject_> _poEntity) Create builder for the HTTP GET.
static object<? extends RequestBuilder>	get(object<? extends Uri> _poURI) Create builder for the HTTP GET.
static object<? extends RequestBuilder>	get(object<? extends Uri> _poURI, object<? extends _BaseObject_> _poEntity) Create builder for the HTTP GET.
static object<? extends RequestBuilder>	get(object<? extends Uri> _poURI, object<? extends _BaseObject_> _poEntity, character _pcContentType) Create builder for the HTTP GET.
static object<? extends BuilderRegistry>	getRegistry() Get the registry
abstract object<? extends IhttpRequest>	getRequest() Get the HTTP Request
static object<? extends RequestBuilder>	head(character _pcURI) Create builder for the HTTP HEAD.
static object<? extends RequestBuilder>	head(object<? extends Uri> _poURI) Create builder for the HTTP HEAD.
object<? extends RequestBuilder>	httpVersion(character _pcVersion) Sets the HTTP version of the request
object<? extends RequestBuilder>	id(character _pcRequestId) Sets the X-Request-Id header.
void	initialize() Initialize.
private static void	initializeRegistry(object<? extends BuilderRegistry> _poRegistry) Adds initial values into the registry
static object<? extends RequestBuilder>	options(character _pcURI) Create builder for the HTTP OPTIONS.
static object<? extends RequestBuilder>	options(character _pcURI, object<? extends _BaseObject_> _poEntity) Create builder for the HTTP OPTIONS.
static object<? extends RequestBuilder>	options(object<? extends Uri> _poURI) Create builder for the HTTP OPTIONS.
static object<? extends RequestBuilder>	options(object<? extends Uri> _poURI, object<? extends _BaseObject_> _poEntity) Create builder for the HTTP OPTIONS.
static object<? extends RequestBuilder>	options(object<? extends Uri> _poURI, object<? extends _BaseObject_> _poEntity, character _pcContentType) Create builder for the HTTP OPTIONS.
static object<? extends RequestBuilder>	patch(character _pcURI, object<? extends _BaseObject_> _poEntity) Create builder for the HTTP PATCH.
static object<? extends RequestBuilder>	patch(object<? extends Uri> _poURI, object<? extends _BaseObject_> _poEntity) Create builder for the HTTP PATCH.
static object<? extends RequestBuilder>	patch(object<? extends Uri> _poURI, object<? extends _BaseObject_> _poEntity, character _pcContentType) Create builder for the HTTP PATCH.
static object<? extends RequestBuilder>	post(character _pcURI) Create builder for the HTTP POST.
static object<? extends RequestBuilder>	post(character _pcURI, object<? extends _BaseObject_> _poEntity) Create builder for the HTTP POST.
static object<? extends RequestBuilder>	post(object<? extends Uri> _poURI) Create builder for the HTTP POST.
static object<? extends RequestBuilder>	post(object<? extends Uri> _poURI, object<? extends _BaseObject_> _poEntity) Create builder for the HTTP POST.
static object<? extends RequestBuilder>	post(object<? extends Uri> _poURI, object<? extends _BaseObject_> _poEntity, character _pcContentType) Create builder for the HTTP POST.
static object<? extends RequestBuilder>	put(character _pcURI, object<? extends _BaseObject_> _poEntity) Create builder for the HTTP PUT.
static object<? extends RequestBuilder>	put(object<? extends Uri> _poURI, object<? extends _BaseObject_> _poEntity) Create builder for the HTTP PUT.
static object<? extends RequestBuilder>	put(object<? extends Uri> _poURI, object<? extends _BaseObject_> _poEntity, character _pcContentType) Create builder for the HTTP PUT.
object<? extends RequestBuilder>	sendRequestId() Flags the setting of the X-Request-Id header.
protected logical	setHeaderOption(object<? extends HttpHeader> _poHeader) Stores a header value as an option.
object<? extends RequestBuilder>	supportsAuthentication() Indicates that this request is can handle authentication This allows credentials etc to be supplied later.
object<? extends RequestBuilder>	supportsProxy() Indicates that this request is capable of being proxied.
static object<? extends RequestBuilder>	trace(character _pcURI) Create builder for the HTTP TRACE.
static object<? extends RequestBuilder>	trace(object<? extends Uri> _poURI) Create builder for the HTTP TRACE.
object<? extends RequestBuilder>	usingBasicAuthentication(object<? extends Credentials> p1)
object<? extends RequestBuilder>	usingCredentials(object<? extends Credentials> _p1)
object<? extends RequestBuilder>	usingCredentials(object<? extends Credentials> _p1, character _p2, character _p3)
object<? extends RequestBuilder>	usingDigestAuthentication(object<? extends Credentials> _p1)
object<? extends RequestBuilder>	viaProxy(character _pcProxyURI) Sets the URI to use as a proxy server for all requests.
object<? extends RequestBuilder>	viaProxy(object<? extends Uri> _poProxyURI) Sets the URI to use as a proxy server for all requests.
object<? extends RequestBuilder>	withData(object<? extends _BaseObject_> _poEntity) Adds data to the request.
object<? extends RequestBuilder>	withData(object<? extends _BaseObject_> _poEntity, character _pcContentType) Adds data to the request.
object<? extends RequestBuilder>	withTransferEncoding(object<? extends TransferEncodingEnum> _poEncoding) Set the transfer encoding method.

Methods inherited from class com.goldencode.p2j.oo.net.http.ConfigBuilder

__net_http_ConfigBuilder_constructor__, __net_http_ConfigBuilder_execute__

Methods inherited from class com.goldencode.p2j.oo.core.util.ConfigBuilder

__core_util_ConfigBuilder_constructor__, _hasOption, appendArrayCharacterValue, clearOptions, getOptionDateTimeValue, getOptionLogicalValue, getOptionLongcharValue, getOptionNumericValue, getOptionObjectValue, getOptionStringArrayValue, getOptionStringValue, hasOption, removeOption, setOption, setOption, setOption, setOption, setOption, setOption, setOption

Methods inherited from class com.goldencode.p2j.oo.lang.BaseObject

__isValidInternal__, __lang_BaseObject_constructor__, __setValidInternal__, assertNotNull, assertNotNull, getLegacyClass, getNextSibling, getPrevSibling, legacyClone, legacyEquals, toLegacyString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.goldencode.p2j.oo.lang._BaseObject_

__isValidInternal__, __lang_BaseObject_constructor__, __setValidInternal__, getLegacyClass, getNextSibling, getPrevSibling, isTracked, legacyClone, legacyEquals, toLegacyString

Field Detail

LANG_CLASS

protected static final java.lang.String LANG_CLASS

See Also:

Constant Field Values

LANG_OBJECT

protected static final java.lang.String LANG_OBJECT

See Also:

Constant Field Values

IHTTPREQUEST

protected static final java.lang.String IHTTPREQUEST

See Also:

Constant Field Values

NET_URI

protected static final java.lang.String NET_URI

See Also:

Constant Field Values

REQUESTBUILDER

protected static final java.lang.String REQUESTBUILDER

See Also:

Constant Field Values

XML_CONTENT_TYPES_LIST

protected static final java.util.List<java.lang.String> XML_CONTENT_TYPES_LIST

XML_CONTENT_TYPES

protected static final java.lang.String XML_CONTENT_TYPES

APPLICATION_JSON

protected static final java.lang.String APPLICATION_JSON

See Also:

Constant Field Values

TEXT_HTML

protected static final java.lang.String TEXT_HTML

See Also:

Constant Field Values

FORM_URLENCODED

protected static final java.lang.String FORM_URLENCODED

See Also:

Constant Field Values

OPTION_METHOD

protected static final java.lang.String OPTION_METHOD

See Also:

Constant Field Values

OPTION_URI

protected static final java.lang.String OPTION_URI

See Also:

Constant Field Values

OPTION_ACCEPT_CONTENT_TYPE

protected static final java.lang.String OPTION_ACCEPT_CONTENT_TYPE

See Also:

Constant Field Values

OPTION_VERSION

protected static final java.lang.String OPTION_VERSION

See Also:

Constant Field Values

OPTION_SUPPORT_AUTHENTICATION

protected static final java.lang.String OPTION_SUPPORT_AUTHENTICATION

See Also:

Constant Field Values

OPTION_SUPPORT_PROXY

protected static final java.lang.String OPTION_SUPPORT_PROXY

See Also:

Constant Field Values

OPTION_PROXY_URI

protected static final java.lang.String OPTION_PROXY_URI

See Also:

Constant Field Values

OPTION_ENTITY

protected static final java.lang.String OPTION_ENTITY

See Also:

Constant Field Values

OPTION_EVENT_LISTENER_TYPE

protected static final java.lang.String OPTION_EVENT_LISTENER_TYPE

See Also:

Constant Field Values

OPTION_AUTH_LISTENER

protected static final java.lang.String OPTION_AUTH_LISTENER

See Also:

Constant Field Values

OPTION_AUTH_CREDENTIALS

protected static final java.lang.String OPTION_AUTH_CREDENTIALS

See Also:

Constant Field Values

OPTION_AUTH_METHOD

protected static final java.lang.String OPTION_AUTH_METHOD

See Also:

Constant Field Values

OPTION_AUTH_CHALLENGE

protected static final java.lang.String OPTION_AUTH_CHALLENGE

See Also:

Constant Field Values

HANDLE

protected static final java.lang.String HANDLE

See Also:

Constant Field Values

CHAR

protected static final java.lang.String CHAR

See Also:

Constant Field Values

INPUT

protected static final java.lang.String INPUT

See Also:

Constant Field Values

OBJECT

protected static final java.lang.String OBJECT

See Also:

Constant Field Values

REGISTRY

private static ContextLocal<object<? extends BuilderRegistry>> REGISTRY

Constructor Detail

RequestBuilder

public RequestBuilder()

Method Detail

decorateRequest

public static object<? extends IhttpRequest> decorateRequest(object<? extends LegacyClass> _poDecorationType,
                                                             object<? extends IhttpRequest> _poDecoratedRequest)

Decorate the request with additional behavior

Parameters:

_poDecorationType - The type of decorator to use

_poDecoratedRequest - The request/instance we're decorating

Returns:

The new, decorating request

initializeRegistry

private static void initializeRegistry(object<? extends BuilderRegistry> _poRegistry)

Adds initial values into the registry

Parameters:

_poRegistry - The registry to populate

getRegistry

public static object<? extends BuilderRegistry> getRegistry()

Get the registry

Returns:

registry

build

public static object<? extends RequestBuilder> build(character _pcMethod,
                                                     object<? extends Uri> _poURI)

Builder director method.

Parameters:

_pcMethod - HTTP method

_poURI - HTTP URI

Returns:

A builder for the requested type

delete

public static object<? extends RequestBuilder> delete(character _pcURI)

Create builder for the HTTP DELETE.

Parameters:

_pcURI - HTTP URI

Returns:

A builder for the HTTP DELETE

delete

public static object<? extends RequestBuilder> delete(character _pcURI,
                                                      object<? extends _BaseObject_> _poEntity)

Create builder for the HTTP DELETE.

Parameters:

_pcURI - HTTP URI

_poEntity - request body

Returns:

A builder for the HTTP DELETE

delete

public static object<? extends RequestBuilder> delete(object<? extends Uri> _poURI)

Create builder for the HTTP DELETE.

Parameters:

_poURI - HTTP URI

Returns:

A builder for the HTTP DELETE

delete

public static object<? extends RequestBuilder> delete(object<? extends Uri> _poURI,
                                                      object<? extends _BaseObject_> _poEntity)

Create builder for the HTTP DELETE.

Parameters:

_poURI - HTTP URI

_poEntity - request body

Returns:

A builder for the HTTP DELETE

delete

public static object<? extends RequestBuilder> delete(object<? extends Uri> _poURI,
                                                      object<? extends _BaseObject_> _poEntity,
                                                      character _pcContentType)

Create builder for the HTTP DELETE.

Parameters:

_poURI - HTTP URI

_poEntity - request body

_pcContentType - body content type

Returns:

A builder for the HTTP DELETE

get

public static object<? extends RequestBuilder> get(character _pcURI)

Create builder for the HTTP GET.

Parameters:

_pcURI - HTTP URI

Returns:

A builder for the HTTP GET

get

public static object<? extends RequestBuilder> get(character _pcURI,
                                                   object<? extends _BaseObject_> _poEntity)

Create builder for the HTTP GET.

Parameters:

_pcURI - HTTP URI

_poEntity - request body

Returns:

A builder for the HTTP GET

get

public static object<? extends RequestBuilder> get(object<? extends Uri> _poURI)

Create builder for the HTTP GET.

Parameters:

_poURI - HTTP URI

Returns:

A builder for the HTTP GET

get

public static object<? extends RequestBuilder> get(object<? extends Uri> _poURI,
                                                   object<? extends _BaseObject_> _poEntity)

Create builder for the HTTP GET.

Parameters:

_poURI - HTTP URI

_poEntity - request body

Returns:

A builder for the HTTP GET

get

public static object<? extends RequestBuilder> get(object<? extends Uri> _poURI,
                                                   object<? extends _BaseObject_> _poEntity,
                                                   character _pcContentType)

Create builder for the HTTP GET.

Parameters:

_poURI - HTTP URI

_poEntity - request body

_pcContentType - body content type

Returns:

A builder for the HTTP GET

head

public static object<? extends RequestBuilder> head(character _pcURI)

Create builder for the HTTP HEAD.

Parameters:

_pcURI - HTTP URI

Returns:

A builder for the HTTP HEAD

head

public static object<? extends RequestBuilder> head(object<? extends Uri> _poURI)

Create builder for the HTTP HEAD.

Parameters:

_poURI - HTTP URI

Returns:

A builder for the HTTP HEAD

options

public static object<? extends RequestBuilder> options(character _pcURI)

Create builder for the HTTP OPTIONS.

Parameters:

_pcURI - HTTP URI

Returns:

A builder for the HTTP OPTIONS

options

public static object<? extends RequestBuilder> options(character _pcURI,
                                                       object<? extends _BaseObject_> _poEntity)

Create builder for the HTTP OPTIONS.

Parameters:

_pcURI - HTTP URI

_poEntity - request body

Returns:

A builder for the HTTP OPTIONS

options

public static object<? extends RequestBuilder> options(object<? extends Uri> _poURI)

Create builder for the HTTP OPTIONS.

Parameters:

_poURI - HTTP URI

Returns:

A builder for the HTTP OPTIONS

options

public static object<? extends RequestBuilder> options(object<? extends Uri> _poURI,
                                                       object<? extends _BaseObject_> _poEntity)

Create builder for the HTTP OPTIONS.

Parameters:

_poURI - HTTP URI

_poEntity - request body

Returns:

A builder for the HTTP OPTIONS

options

public static object<? extends RequestBuilder> options(object<? extends Uri> _poURI,
                                                       object<? extends _BaseObject_> _poEntity,
                                                       character _pcContentType)

Create builder for the HTTP OPTIONS.

Parameters:

_poURI - HTTP URI

_poEntity - request body

_pcContentType - body content type

Returns:

A builder for the HTTP OPTIONS

patch

public static object<? extends RequestBuilder> patch(character _pcURI,
                                                     object<? extends _BaseObject_> _poEntity)

Create builder for the HTTP PATCH.

Parameters:

_pcURI - HTTP URI

_poEntity - request body

Returns:

A builder for the HTTP PATCH

patch

public static object<? extends RequestBuilder> patch(object<? extends Uri> _poURI,
                                                     object<? extends _BaseObject_> _poEntity)

Create builder for the HTTP PATCH.

Parameters:

_poURI - HTTP URI

_poEntity - request body

Returns:

A builder for the HTTP PATCH

patch

public static object<? extends RequestBuilder> patch(object<? extends Uri> _poURI,
                                                     object<? extends _BaseObject_> _poEntity,
                                                     character _pcContentType)

Create builder for the HTTP PATCH.

Parameters:

_poURI - HTTP URI

_poEntity - request body

_pcContentType - body content type

Returns:

A builder for the HTTP PATCH

post

public static object<? extends RequestBuilder> post(character _pcURI)

Create builder for the HTTP POST.

Parameters:

_pcURI - HTTP URI

Returns:

A builder for the HTTP POST

post

public static object<? extends RequestBuilder> post(character _pcURI,
                                                    object<? extends _BaseObject_> _poEntity)

Create builder for the HTTP POST.

Parameters:

_pcURI - HTTP URI

_poEntity - request body

Returns:

A builder for the HTTP POST

post

public static object<? extends RequestBuilder> post(object<? extends Uri> _poURI)

Create builder for the HTTP POST.

Parameters:

_poURI - HTTP URI

Returns:

A builder for the HTTP POST

post

public static object<? extends RequestBuilder> post(object<? extends Uri> _poURI,
                                                    object<? extends _BaseObject_> _poEntity)

Create builder for the HTTP POST.

Parameters:

_poURI - HTTP URI

_poEntity - request body

Returns:

A builder for the HTTP POST

post

public static object<? extends RequestBuilder> post(object<? extends Uri> _poURI,
                                                    object<? extends _BaseObject_> _poEntity,
                                                    character _pcContentType)

Create builder for the HTTP POST.

Parameters:

_poURI - HTTP URI

_poEntity - request body

_pcContentType - body content type

Returns:

A builder for the HTTP POST

put

public static object<? extends RequestBuilder> put(object<? extends Uri> _poURI,
                                                   object<? extends _BaseObject_> _poEntity,
                                                   character _pcContentType)

Create builder for the HTTP PUT.

Parameters:

_poURI - HTTP URI

_poEntity - request body

_pcContentType - body content type

Returns:

A builder for the HTTP PUT

put

public static object<? extends RequestBuilder> put(character _pcURI,
                                                   object<? extends _BaseObject_> _poEntity)

Create builder for the HTTP PUT.

Parameters:

_pcURI - HTTP URI

_poEntity - request body

Returns:

A builder for the HTTP PUT

put

public static object<? extends RequestBuilder> put(object<? extends Uri> _poURI,
                                                   object<? extends _BaseObject_> _poEntity)

Create builder for the HTTP PUT.

Parameters:

_poURI - HTTP URI

_poEntity - request body

Returns:

A builder for the HTTP PUT

trace

public static object<? extends RequestBuilder> trace(character _pcURI)

Create builder for the HTTP TRACE.

Parameters:

_pcURI - HTTP URI

Returns:

A builder for the HTTP TRACE

trace

public static object<? extends RequestBuilder> trace(object<? extends Uri> _poURI)

Create builder for the HTTP TRACE.

Parameters:

_poURI - HTTP URI

Returns:

A builder for the HTTP TRACE

__net_http_RequestBuilder_constructor__static__

public static void __net_http_RequestBuilder_constructor__static__()

__net_http_RequestBuilder_constructor__

protected void __net_http_RequestBuilder_constructor__(character _pcMethod,
                                                       object<? extends Uri> _poURI)

'constructor'.

Parameters:

_pcMethod - HTTP method

_poURI - HTTP URI

__net_http_RequestBuilder_execute__

public void __net_http_RequestBuilder_execute__()

????.

initialize

public void initialize()

Initialize.

Specified by:

initialize in interface ISupportInitialize

destroy

public void destroy()

Destroy.

Specified by:

destroy in interface ISupportInitialize

getRequest

public abstract object<? extends IhttpRequest> getRequest()

Get the HTTP Request

Returns:

HTTP request

acceptAll

public object<? extends RequestBuilder> acceptAll()

Allows the request to accept all content types.

Returns:

The request builder being constructed.

acceptContentType

public object<? extends RequestBuilder> acceptContentType(character _pcContentType)

Allows the request to accept the input content type.

Parameters:

_pcContentType - Content Type

Returns:

The request builder being constructed.

acceptFormData

public object<? extends RequestBuilder> acceptFormData()

Allows the request to accept form data content.

Returns:

The request builder being constructed.

acceptHtml

public object<? extends RequestBuilder> acceptHtml()

Allows the request to accept HTML content types.

Returns:

The request builder being constructed.

acceptJson

public object<? extends RequestBuilder> acceptJson()

Allows the request to accept basic JSON content types.

Returns:

The request builder being constructed.

acceptXml

public object<? extends RequestBuilder> acceptXml()

Allows the request to accept XML content types.

Returns:

The request builder being constructed.

addCallback

public object<? extends RequestBuilder> addCallback(object<? extends LegacyClass> _poEventListenerType,
                                                    handle _phListener)

Adds a listener to events from the Request.

Parameters:

_poEventListenerType - The type of events the EventProviders is capable of listening to

_phListener - The listening procedure. Must conform to the type

Returns:

The request builder being constructed.

addCallback

public object<? extends RequestBuilder> addCallback(object<? extends LegacyClass> _poEventListenerType,
                                                    object<? extends _BaseObject_> _poListener)

Adds a listener to events from the Request.

Parameters:

_poEventListenerType - The type of events the EventProviders is capable of listening to

_poListener - The listening procedure. Must conform to the type

Returns:

The request builder being constructed.

addCookie

public object<? extends RequestBuilder> addCookie(object<? extends Cookie> _poCookie)

Adds (or replaces) a cookie

Parameters:

_poCookie - cookie to be added

Returns:

The request builder being constructed.

addFormData

public object<? extends RequestBuilder> addFormData(character _pcFieldName,
                                                    character _pcFieldValue)

Adds a form data as a body to the request.

Parameters:

_pcFieldName - form field name

_pcFieldValue - form field value

Returns:

The request builder being constructed.

addFormData

public object<? extends RequestBuilder> addFormData(object<? extends IStringStringMap> _poEntity)

Adds a form data as a body to the request.

Parameters:

_poEntity - The complete data being added to the request

Returns:

The request builder being constructed.

addHeader

public object<? extends RequestBuilder> addHeader(character _pcName,
                                                  character _pcValue)

Adds (or replaces) a heade

Parameters:

_pcName - header name

_pcValue - header value

Returns:

The request builder being constructed.

addHeader

public object<? extends RequestBuilder> addHeader(object<? extends HttpHeader> _poHeader)

Adds (or replaces) a header

Parameters:

_poHeader - header to be added

Returns:

The request builder being constructed.

addJsonData

public object<? extends RequestBuilder> addJsonData(object<? extends JsonObject> _poEntity)

Adds a JSON body to the request.

Parameters:

_poEntity - JSON body

Returns:

The request builder being constructed.

authCallback

public object<? extends RequestBuilder> authCallback(handle _phListener)

Adds an authentication listener to events from the Request.

Parameters:

_phListener - The listening procedure. Must conform to the type

Returns:

The request builder being constructed.

authCallback

public object<? extends RequestBuilder> authCallback(object<? extends _BaseObject_> _poListener)

Adds an authentication listener to events from the Request.

Parameters:

_poListener - The listening procedure. Must conform to the type

Returns:

The request builder being constructed.

contentType

public object<? extends RequestBuilder> contentType(character _pcContentType)

Sets the content type for the request.

Parameters:

_pcContentType - content type

Returns:

The request builder being constructed.

etag

public object<? extends RequestBuilder> etag(character _pcETag)

Adds an ETag value to the request.

Parameters:

_pcETag - The tag value

Returns:

The request builder being constructed.

httpVersion

public object<? extends RequestBuilder> httpVersion(character _pcVersion)

Sets the HTTP version of the request

Parameters:

_pcVersion - HTTP version

Returns:

The request builder being constructed.

id

public object<? extends RequestBuilder> id(character _pcRequestId)

Sets the X-Request-Id header.

Parameters:

_pcRequestId - True if the request id should be sent.

Returns:

The request builder being constructed.

sendRequestId

public object<? extends RequestBuilder> sendRequestId()

Flags the setting of the X-Request-Id header.

Returns:

The request builder being constructed.

supportsAuthentication

public object<? extends RequestBuilder> supportsAuthentication()

Indicates that this request is can handle authentication This allows credentials etc to be supplied later.

Returns:

The request builder being constructed.

supportsProxy

public object<? extends RequestBuilder> supportsProxy()

Indicates that this request is capable of being proxied. This allows the proxy to be supplied later.

Returns:

The request builder being constructed.

viaProxy

public object<? extends RequestBuilder> viaProxy(character _pcProxyURI)

Sets the URI to use as a proxy server for all requests.

Parameters:

_pcProxyURI - proxy URI

Returns:

The request builder being constructed.

viaProxy

public object<? extends RequestBuilder> viaProxy(object<? extends Uri> _poProxyURI)

Sets the URI to use as a proxy server for all requests.

Parameters:

_poProxyURI - proxy URI

Returns:

The request builder being constructed.

withData

public object<? extends RequestBuilder> withData(object<? extends _BaseObject_> _poEntity)

Adds data to the request.

Parameters:

_poEntity - The object to use as the request payload/entity

Returns:

The request builder being constructed.

withData

public object<? extends RequestBuilder> withData(object<? extends _BaseObject_> _poEntity,
                                                 character _pcContentType)

Adds data to the request.

Parameters:

_poEntity - The object to use as the request payload/entity

_pcContentType - The content type for this entity/payloa

Returns:

The request builder being constructed.

setHeaderOption

protected logical setHeaderOption(object<? extends HttpHeader> _poHeader)

Stores a header value as an option.

Parameters:

_poHeader - header.

Returns:

true if option was replaced.

usingBasicAuthentication

public object<? extends RequestBuilder> usingBasicAuthentication(object<? extends Credentials> p1)

usingCredentials

public object<? extends RequestBuilder> usingCredentials(object<? extends Credentials> _p1)

usingCredentials

public object<? extends RequestBuilder> usingCredentials(object<? extends Credentials> _p1,
                                                         character _p2,
                                                         character _p3)

usingDigestAuthentication

public object<? extends RequestBuilder> usingDigestAuthentication(object<? extends Credentials> _p1)

withTransferEncoding

public object<? extends RequestBuilder> withTransferEncoding(object<? extends TransferEncodingEnum> _poEncoding)

Set the transfer encoding method.

Parameters:

_poEncoding - The encoding to be used for data transfer.

Returns:

The request builder being constructed.