public abstract class RequestBuilder extends ConfigBuilder implements ISupportInitialize
ConfigBuilder.OptionTypeHelper<T>, ConfigBuilder.OptionValueHolder
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 |
options
Constructor and Description |
---|
RequestBuilder() |
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.
|
__net_http_ConfigBuilder_constructor__, __net_http_ConfigBuilder_execute__
__core_util_ConfigBuilder_constructor__, __core_util_ConfigBuilder_execute__, _hasOption, appendArrayCharacterValue, clearOptions, getOptionDateTimeValue, getOptionLogicalValue, getOptionLongcharValue, getOptionNumericValue, getOptionObjectValue, getOptionStringArrayValue, getOptionStringValue, hasOption, removeOption, setOption, setOption, setOption, setOption, setOption, setOption, setOption
__lang_BaseObject_constructor__, __lang_BaseObject_execute__, assertNotNull, assertNotNull, clone, getLegacyClass, getNextSibling, getPrevSibling, legacyEquals, toLegacyString
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
__lang_BaseObject_constructor__, clone, getLegacyClass, getNextSibling, getPrevSibling, isTracked, legacyEquals, toLegacyString
protected static final java.lang.String LANG_CLASS
protected static final java.lang.String LANG_OBJECT
protected static final java.lang.String IHTTPREQUEST
protected static final java.lang.String NET_URI
protected static final java.lang.String REQUESTBUILDER
protected static final java.util.List<java.lang.String> XML_CONTENT_TYPES_LIST
protected static final java.lang.String XML_CONTENT_TYPES
protected static final java.lang.String APPLICATION_JSON
protected static final java.lang.String TEXT_HTML
protected static final java.lang.String FORM_URLENCODED
protected static final java.lang.String OPTION_METHOD
protected static final java.lang.String OPTION_URI
protected static final java.lang.String OPTION_ACCEPT_CONTENT_TYPE
protected static final java.lang.String OPTION_VERSION
protected static final java.lang.String OPTION_SUPPORT_AUTHENTICATION
protected static final java.lang.String OPTION_SUPPORT_PROXY
protected static final java.lang.String OPTION_PROXY_URI
protected static final java.lang.String OPTION_ENTITY
protected static final java.lang.String OPTION_EVENT_LISTENER_TYPE
protected static final java.lang.String OPTION_AUTH_LISTENER
protected static final java.lang.String OPTION_AUTH_CREDENTIALS
protected static final java.lang.String OPTION_AUTH_METHOD
protected static final java.lang.String OPTION_AUTH_CHALLENGE
protected static final java.lang.String HANDLE
protected static final java.lang.String CHAR
protected static final java.lang.String INPUT
protected static final java.lang.String OBJECT
private static ContextLocal<object<? extends BuilderRegistry>> REGISTRY
public static object<? extends IhttpRequest> decorateRequest(object<? extends LegacyClass> _poDecorationType, object<? extends IhttpRequest> _poDecoratedRequest)
_poDecorationType
- The type of decorator to use_poDecoratedRequest
- The request/instance we're decoratingprivate static void initializeRegistry(object<? extends BuilderRegistry> _poRegistry)
_poRegistry
- The registry to populatepublic static object<? extends BuilderRegistry> getRegistry()
public static object<? extends RequestBuilder> build(character _pcMethod, object<? extends Uri> _poURI)
_pcMethod
- HTTP method_poURI
- HTTP URIpublic static object<? extends RequestBuilder> delete(character _pcURI)
_pcURI
- HTTP URIpublic static object<? extends RequestBuilder> delete(character _pcURI, object<? extends _BaseObject_> _poEntity)
_pcURI
- HTTP URI_poEntity
- request bodypublic static object<? extends RequestBuilder> delete(object<? extends Uri> _poURI)
_poURI
- HTTP URIpublic static object<? extends RequestBuilder> delete(object<? extends Uri> _poURI, object<? extends _BaseObject_> _poEntity)
_poURI
- HTTP URI_poEntity
- request bodypublic static object<? extends RequestBuilder> delete(object<? extends Uri> _poURI, object<? extends _BaseObject_> _poEntity, character _pcContentType)
_poURI
- HTTP URI_poEntity
- request body_pcContentType
- body content typepublic static object<? extends RequestBuilder> get(character _pcURI)
_pcURI
- HTTP URIpublic static object<? extends RequestBuilder> get(character _pcURI, object<? extends _BaseObject_> _poEntity)
_pcURI
- HTTP URI_poEntity
- request bodypublic static object<? extends RequestBuilder> get(object<? extends Uri> _poURI)
_poURI
- HTTP URIpublic static object<? extends RequestBuilder> get(object<? extends Uri> _poURI, object<? extends _BaseObject_> _poEntity)
_poURI
- HTTP URI_poEntity
- request bodypublic static object<? extends RequestBuilder> get(object<? extends Uri> _poURI, object<? extends _BaseObject_> _poEntity, character _pcContentType)
_poURI
- HTTP URI_poEntity
- request body_pcContentType
- body content typepublic static object<? extends RequestBuilder> head(character _pcURI)
_pcURI
- HTTP URIpublic static object<? extends RequestBuilder> head(object<? extends Uri> _poURI)
_poURI
- HTTP URIpublic static object<? extends RequestBuilder> options(character _pcURI)
_pcURI
- HTTP URIpublic static object<? extends RequestBuilder> options(character _pcURI, object<? extends _BaseObject_> _poEntity)
_pcURI
- HTTP URI_poEntity
- request bodypublic static object<? extends RequestBuilder> options(object<? extends Uri> _poURI)
_poURI
- HTTP URIpublic static object<? extends RequestBuilder> options(object<? extends Uri> _poURI, object<? extends _BaseObject_> _poEntity)
_poURI
- HTTP URI_poEntity
- request bodypublic static object<? extends RequestBuilder> options(object<? extends Uri> _poURI, object<? extends _BaseObject_> _poEntity, character _pcContentType)
_poURI
- HTTP URI_poEntity
- request body_pcContentType
- body content typepublic static object<? extends RequestBuilder> patch(character _pcURI, object<? extends _BaseObject_> _poEntity)
_pcURI
- HTTP URI_poEntity
- request bodypublic static object<? extends RequestBuilder> patch(object<? extends Uri> _poURI, object<? extends _BaseObject_> _poEntity)
_poURI
- HTTP URI_poEntity
- request bodypublic static object<? extends RequestBuilder> patch(object<? extends Uri> _poURI, object<? extends _BaseObject_> _poEntity, character _pcContentType)
_poURI
- HTTP URI_poEntity
- request body_pcContentType
- body content typepublic static object<? extends RequestBuilder> post(character _pcURI)
_pcURI
- HTTP URIpublic static object<? extends RequestBuilder> post(character _pcURI, object<? extends _BaseObject_> _poEntity)
_pcURI
- HTTP URI_poEntity
- request bodypublic static object<? extends RequestBuilder> post(object<? extends Uri> _poURI)
_poURI
- HTTP URIpublic static object<? extends RequestBuilder> post(object<? extends Uri> _poURI, object<? extends _BaseObject_> _poEntity)
_poURI
- HTTP URI_poEntity
- request bodypublic static object<? extends RequestBuilder> post(object<? extends Uri> _poURI, object<? extends _BaseObject_> _poEntity, character _pcContentType)
_poURI
- HTTP URI_poEntity
- request body_pcContentType
- body content typepublic static object<? extends RequestBuilder> put(object<? extends Uri> _poURI, object<? extends _BaseObject_> _poEntity, character _pcContentType)
_poURI
- HTTP URI_poEntity
- request body_pcContentType
- body content typepublic static object<? extends RequestBuilder> put(character _pcURI, object<? extends _BaseObject_> _poEntity)
_pcURI
- HTTP URI_poEntity
- request bodypublic static object<? extends RequestBuilder> put(object<? extends Uri> _poURI, object<? extends _BaseObject_> _poEntity)
_poURI
- HTTP URI_poEntity
- request bodypublic static object<? extends RequestBuilder> trace(character _pcURI)
_pcURI
- HTTP URIpublic static object<? extends RequestBuilder> trace(object<? extends Uri> _poURI)
_poURI
- HTTP URIpublic static void __net_http_RequestBuilder_constructor__static__()
protected void __net_http_RequestBuilder_constructor__(character _pcMethod, object<? extends Uri> _poURI)
_pcMethod
- HTTP method_poURI
- HTTP URIpublic void __net_http_RequestBuilder_execute__()
public void initialize()
initialize
in interface ISupportInitialize
public void destroy()
destroy
in interface ISupportInitialize
public abstract object<? extends IhttpRequest> getRequest()
public object<? extends RequestBuilder> acceptAll()
public object<? extends RequestBuilder> acceptContentType(character _pcContentType)
_pcContentType
- Content Typepublic object<? extends RequestBuilder> acceptFormData()
public object<? extends RequestBuilder> acceptHtml()
public object<? extends RequestBuilder> acceptJson()
public object<? extends RequestBuilder> acceptXml()
public object<? extends RequestBuilder> addCallback(object<? extends LegacyClass> _poEventListenerType, handle _phListener)
_poEventListenerType
- The type of events the EventProviders is capable of listening to_phListener
- The listening procedure. Must conform to the typepublic object<? extends RequestBuilder> addCallback(object<? extends LegacyClass> _poEventListenerType, object<? extends _BaseObject_> _poListener)
_poEventListenerType
- The type of events the EventProviders is capable of listening to_poListener
- The listening procedure. Must conform to the typepublic object<? extends RequestBuilder> addCookie(object<? extends Cookie> _poCookie)
_poCookie
- cookie to be addedpublic object<? extends RequestBuilder> addFormData(character _pcFieldName, character _pcFieldValue)
_pcFieldName
- form field name_pcFieldValue
- form field valuepublic object<? extends RequestBuilder> addFormData(object<? extends IStringStringMap> _poEntity)
_poEntity
- The complete data being added to the requestpublic object<? extends RequestBuilder> addHeader(character _pcName, character _pcValue)
_pcName
- header name_pcValue
- header valuepublic object<? extends RequestBuilder> addHeader(object<? extends HttpHeader> _poHeader)
_poHeader
- header to be addedpublic object<? extends RequestBuilder> addJsonData(object<? extends JsonObject> _poEntity)
_poEntity
- JSON bodypublic object<? extends RequestBuilder> authCallback(handle _phListener)
_phListener
- The listening procedure. Must conform to the typepublic object<? extends RequestBuilder> authCallback(object<? extends _BaseObject_> _poListener)
_poListener
- The listening procedure. Must conform to the typepublic object<? extends RequestBuilder> contentType(character _pcContentType)
_pcContentType
- content typepublic object<? extends RequestBuilder> etag(character _pcETag)
_pcETag
- The tag valuepublic object<? extends RequestBuilder> httpVersion(character _pcVersion)
_pcVersion
- HTTP versionpublic object<? extends RequestBuilder> id(character _pcRequestId)
_pcRequestId
- True if the request id should be sent.public object<? extends RequestBuilder> sendRequestId()
public object<? extends RequestBuilder> supportsAuthentication()
public object<? extends RequestBuilder> supportsProxy()
public object<? extends RequestBuilder> viaProxy(character _pcProxyURI)
_pcProxyURI
- proxy URIpublic object<? extends RequestBuilder> viaProxy(object<? extends Uri> _poProxyURI)
_poProxyURI
- proxy URIpublic object<? extends RequestBuilder> withData(object<? extends _BaseObject_> _poEntity)
_poEntity
- The object to use as the request payload/entitypublic object<? extends RequestBuilder> withData(object<? extends _BaseObject_> _poEntity, character _pcContentType)
_poEntity
- The object to use as the request payload/entity_pcContentType
- The content type for this entity/payloaprotected logical setHeaderOption(object<? extends HttpHeader> _poHeader)
_poHeader
- header.true
if option was replaced.public object<? extends RequestBuilder> usingBasicAuthentication(object<? extends Credentials> p1)
public object<? extends RequestBuilder> usingCredentials(object<? extends Credentials> _p1)
public object<? extends RequestBuilder> usingCredentials(object<? extends Credentials> _p1, character _p2, character _p3)
public object<? extends RequestBuilder> usingDigestAuthentication(object<? extends Credentials> _p1)
public object<? extends RequestBuilder> withTransferEncoding(object<? extends TransferEncodingEnum> _poEncoding)
_poEncoding
- The encoding to be used for data transfer.