HttpRequest

java.lang.Object
- com.sap.client.odata.v4.http.HttpRequest

public class HttpRequest
extends java.lang.Object

A cross-platform HTTP API modeled after XMLHttpRequest. Supports streaming of request and response content.

Example:

 public void classExample() {
     try {
         com.sap.client.odata.v4.core.DebugConsole.traceIn("example.HttpRequestExample.classExample"); {
             com.sap.client.odata.v4.http.HttpRequest request = new com.sap.client.odata.v4.http.HttpRequest();
             request.open(com.sap.client.odata.v4.http.HttpRequest.GET,
                 "http://google.com");
             request.send();
             String text = request.getResponseText();
             request.close();
             Example.show("google.com home page text: ", text);
         }
     }
     catch (java.lang.RuntimeException _tex_) {
         com.sap.client.odata.v4.core.Assert.error("/data/home/ppurple/xMDP/workspace/NAAS-Mobile-com.sap.odata.core.framework-OD-darwinintel64_ent_indirectshipment-darwinintel64_ent/src/main/xs/examples/example.HttpRequestExample.xs:5:11",
             _tex_);
         throw _tex_;
     }
     finally {
         com.sap.client.odata.v4.core.DebugConsole.traceOut("example.HttpRequestExample.classExample");
     }
 }

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CONNECT` The HTTP CONNECT verb.
`static java.lang.String`	`DELETE` The HTTP DELETE verb.
`static java.lang.String`	`GET` The HTTP GET verb.
`static java.lang.String`	`HEAD` The HTTP HEAD verb.
`static java.lang.String`	`OPTIONS` The HTTP OPTIONS verb.
`static java.lang.String`	`PATCH` The HTTP PATCH verb.
`static java.lang.String`	`POST` The HTTP POST verb.
`static java.lang.String`	`PUT` The HTTP PUT verb.
`static java.lang.String`	`TRACE` The HTTP TRACE verb.

Constructor Summary

Constructors
Constructor and Description

HttpRequest()

Constructors
Constructor and Description
`HttpRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()` Close this HTTP request, and any response stream that may have been opened by `HttpRequest.send`.
`void`	`enableTrace(java.lang.String serviceName, boolean traceRequest, boolean traceHeaders, boolean traceContent, boolean prettyPrint)` Enable HTTP request tracing.
`boolean`	`getCompressResponse()` Set to `false` before calling `HttpRequest.send` if the caller does not wish the server to compress the response content (using "gzip").
`HttpHandler`	`getHandler()` (nullable) The optional internal handler for this request.
`java.lang.String`	`getMethod()` The HTTP method for this request.
`java.lang.String`	`getPassword()` (nullable) The password for this request.
`boolean`	`getPrettyPrint()` Is this request enabled for pretty-printed tracing?
`ByteStream`	`getRequestBytes()` (nullable) Request data stream.
`CharStream`	`getRequestChars()` (nullable) Request text stream.
`java.lang.String`	`getRequestCookie(java.lang.String name)` Get a request cookie value.
`HttpCookies`	`getRequestCookies()` HTTP request cookies.
`byte[]`	`getRequestData()` (nullable) Request data for a non-streamed request.
`java.lang.String`	`getRequestHeader(java.lang.String name)` Get a request header value.
`HttpHeaders`	`getRequestHeaders()` HTTP request headers.
`java.lang.String`	`getRequestText()` (nullable) Request text for a non-streamed request.
`ByteStream`	`getResponseBytes()` Response data stream.
`CharStream`	`getResponseChars()` Response text stream.
`java.lang.String`	`getResponseCookie(java.lang.String name)` Get a response cookie value.
`HttpCookies`	`getResponseCookies()` HTTP response cookies.
`byte[]`	`getResponseData()` Response data for a non-streamed response.
`long`	`getResponseDataCount()` Response data counter.
`long`	`getResponseGzipCount()` Response gzip counter.
`java.lang.String`	`getResponseHeader(java.lang.String name)` Get a response header value.
`HttpHeaders`	`getResponseHeaders()` HTTP response headers.
`java.lang.String`	`getResponseText()` Response text for a non-streamed response.
`int`	`getStatus()` HTTP response status code.
`java.lang.String`	`getStatusText()` HTTP response status text.
`boolean`	`getStreamRequest()` Set to `false` before calling `HttpRequest.send` if the caller does not wish to stream the request content.
`boolean`	`getStreamResponse()` Set to `false` before calling `HttpRequest.send` if the caller does not wish to stream the response content.
`boolean`	`getTraceContent()` Is this request enabled for tracing of request/response content?
`boolean`	`getTraceHeaders()` Is this request enabled for tracing of request/response headers?
`boolean`	`getTraceRequest()` Is this request enabled for request/response tracing?
`boolean`	`getUnzipResponse()` Does response need to be unzipped? Should be set by `HttpHandler` subclasses.
`java.lang.String`	`getUrl()` The URL for this request.
`java.lang.String`	`getUsername()` (nullable) The username for this request.
`int`	`getVersion()` The HTTP version for this request.
`boolean`	`hasResponseBytes()` Does this request have a byte stream response already set?
`boolean`	`hasResponseChars()` Does this request have a text stream response already set?
`boolean`	`hasResponseData()` Does this request have a binary (data) response already set?
`boolean`	`hasResponseText()` Does this request have a string (text) response already set?
`boolean`	`isActive()` Is a connection active (`HttpRequest.send` was called, but `HttpRequest.close` has not yet been called)?
`void`	`login(java.lang.String username, java.lang.String password)` Specify the HTTP basic credentials.
`void`	`open(java.lang.String method, java.lang.String url)` Specify the HTTP `HttpRequest.method` and `HttpRequest.url`.
`void`	`send()` Send this HTTP request to the server, and wait for a response.
`void`	`setActive(boolean value)` Is a connection active (`HttpRequest.send` was called, but `HttpRequest.close` has not yet been called)?
`void`	`setCompressResponse(boolean value)` Set to `false` before calling `HttpRequest.send` if the caller does not wish the server to compress the response content (using "gzip").
`void`	`setHandler(HttpHandler value)` The optional internal handler for this request.
`void`	`setInputStream(java.io.InputStream stream)`
`void`	`setMethod(java.lang.String value)` The HTTP method for this request.
`void`	`setPassword(java.lang.String value)` The password for this request.
`void`	`setRequestBytes(ByteStream value)` Request data stream.
`void`	`setRequestChars(CharStream value)` Request text stream.
`void`	`setRequestCookie(java.lang.String name, java.lang.String value)` Set a request cookie.
`void`	`setRequestCookies(HttpCookies value)` HTTP request cookies.
`void`	`setRequestData(byte[] value)` Request data for a non-streamed request.
`void`	`setRequestHeader(java.lang.String name, java.lang.String value)` Set a request header.
`void`	`setRequestHeaders(HttpHeaders value)` HTTP request headers.
`void`	`setRequestText(java.lang.String value)` Request text for a non-streamed request.
`void`	`setResponseBytes(ByteStream value)` Response data stream.
`void`	`setResponseChars(CharStream value)` Response text stream.
`void`	`setResponseCookie(java.lang.String name, java.lang.String value)` Set a response cookie.
`void`	`setResponseCookies(HttpCookies value)` HTTP response cookies.
`void`	`setResponseData(byte[] value)` Response data for a non-streamed response.
`void`	`setResponseHeader(java.lang.String name, java.lang.String value)` Set a response header.
`void`	`setResponseHeaders(HttpHeaders value)` HTTP response headers.
`void`	`setResponseText(java.lang.String value)` Response text for a non-streamed response.
`void`	`setStatus(int value)` HTTP response status code.
`void`	`setStatusText(java.lang.String value)` HTTP response status text.
`void`	`setStreamRequest(boolean value)` Set to `false` before calling `HttpRequest.send` if the caller does not wish to stream the request content.
`void`	`setStreamResponse(boolean value)` Set to `false` before calling `HttpRequest.send` if the caller does not wish to stream the response content.
`void`	`setUnzipResponse(boolean value)` Does response need to be unzipped? Should be set by `HttpHandler` subclasses.
`void`	`setUrl(java.lang.String value)` The URL for this request.
`void`	`setUsername(java.lang.String value)` The username for this request.
`void`	`setVersion(int value)` The HTTP version for this request.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - CONNECT
```
public static final java.lang.String CONNECT
```
    The HTTP CONNECT verb.
    
    See Also:
    
    Constant Field Values
  - DELETE
```
public static final java.lang.String DELETE
```
    The HTTP DELETE verb.
    
    See Also:
    
    Constant Field Values
  - GET
```
public static final java.lang.String GET
```
    The HTTP GET verb.
    
    See Also:
    
    Constant Field Values
  - HEAD
```
public static final java.lang.String HEAD
```
    The HTTP HEAD verb.
    
    See Also:
    
    Constant Field Values
  - OPTIONS
```
public static final java.lang.String OPTIONS
```
    The HTTP OPTIONS verb.
    
    See Also:
    
    Constant Field Values
  - PATCH
```
public static final java.lang.String PATCH
```
    The HTTP PATCH verb.
    
    See Also:
    
    Constant Field Values
  - POST
```
public static final java.lang.String POST
```
    The HTTP POST verb.
    
    See Also:
    
    Constant Field Values
  - PUT
```
public static final java.lang.String PUT
```
    The HTTP PUT verb.
    
    See Also:
    
    Constant Field Values
  - TRACE
```
public static final java.lang.String TRACE
```
    The HTTP TRACE verb.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - HttpRequest
```
public HttpRequest()
```
- Method Detail
  - setInputStream
```
public void setInputStream(java.io.InputStream stream)
```
  - close
```
public void close()
```
    Close this HTTP request, and any response stream that may have been opened by HttpRequest.send. If an application calls HttpRequest.send, then it must also call this function to avoid resource leaks.
  - enableTrace
```
public void enableTrace(java.lang.String serviceName,
                        boolean traceRequest,
                        boolean traceHeaders,
                        boolean traceContent,
                        boolean prettyPrint)
```
    Enable HTTP request tracing. Call this before calling HttpRequest.send.
    
    Parameters:
    
    serviceName - (nullable) Name of the service which this request will be sent to.
    
    traceRequest - Trace the request (URL), and basic request/response flow. Note: this may result in tracing of sensitive data, such as URL query parameters.
    
    traceHeaders - Trace the headers. Note: this may result in tracing of sensitive data, such as authentication information or cookie values.
    
    traceContent - Trace the content. Note: this may result in tracing of sensitive data.
    
    prettyPrint - If traceContent is true and HttpRequest.streamResponse is false, then content tracing of JSON or XML will be pretty-printed.
  - getCompressResponse
```
public boolean getCompressResponse()
```
    Set to false before calling HttpRequest.send if the caller does not wish the server to compress the response content (using "gzip"). True by default.
  - getHandler
```
public HttpHandler getHandler()
```
    (nullable) The optional internal handler for this request.
    
    See Also:
    
    HttpHandlerType.
  - getMethod
```
public java.lang.String getMethod()
```
    The HTTP method for this request. Set this using the HttpRequest.open function.
    
    See Also:
    
    constants.
  - getPassword
```
public java.lang.String getPassword()
```
    (nullable) The password for this request. Set this using the HttpRequest.login function.
  - getPrettyPrint
```
public boolean getPrettyPrint()
```
    Is this request enabled for pretty-printed tracing?
    
    See Also:
    
    HttpRequest.enableTrace.
  - getRequestBytes
```
public ByteStream getRequestBytes()
```
    (nullable) Request data stream. Set this before calling HttpRequest.send.
  - getRequestChars
```
public CharStream getRequestChars()
```
    (nullable) Request text stream. Set this before calling HttpRequest.send.
  - getRequestCookie
```
public java.lang.String getRequestCookie(java.lang.String name)
```
    Get a request cookie value. For use by servers.
    
    See Also:
    
    HttpRequest.requestCookies.
    
    Parameters:
    
    name - Cookie name.
    
    Returns:
    
    (nullable) Request cookie value, or `null` if not found.
  - getRequestCookies
```
public HttpCookies getRequestCookies()
```
    HTTP request cookies. Set request cookies before calling HttpRequest.send.
  - getRequestData
```
public byte[] getRequestData()
```
    (nullable) Request data for a non-streamed request. Set this before calling HttpRequest.send.
  - getRequestHeader
```
public java.lang.String getRequestHeader(java.lang.String name)
```
    Get a request header value. For use by servers.
    
    See Also:
    
    HttpRequest.requestHeaders.
    
    Parameters:
    
    name - Header name.
    
    Returns:
    
    (nullable) Request header value, or `null` if not found.
  - getRequestHeaders
```
public HttpHeaders getRequestHeaders()
```
    HTTP request headers. Set request headers before calling HttpRequest.send.
  - getRequestText
```
public java.lang.String getRequestText()
```
    (nullable) Request text for a non-streamed request. Set this before calling HttpRequest.send.
  - getResponseBytes
```
public ByteStream getResponseBytes()
```
    Response data stream. Access this after calling HttpRequest.send.
  - getResponseChars
```
public CharStream getResponseChars()
```
    Response text stream. Access this after calling HttpRequest.send.
  - getResponseCookie
```
public java.lang.String getResponseCookie(java.lang.String name)
```
    Get a response cookie value. Call this after calling HttpRequest.send.
    
    See Also:
    
    HttpRequest.responseCookies.
    
    Parameters:
    
    name - Cookie name.
    
    Returns:
    
    (nullable) Response cookie value, or `null` if not found.
  - getResponseCookies
```
public HttpCookies getResponseCookies()
```
    HTTP response cookies. Access response cookies after calling HttpRequest.send.
  - getResponseData
```
public byte[] getResponseData()
```
    Response data for a non-streamed response. Access this after calling HttpRequest.send.
    
    See Also:
    
    HttpRequest.streamResponse.
  - getResponseDataCount
```
public long getResponseDataCount()
```
    Response data counter. Counts received content data length in bytes.
  - getResponseGzipCount
```
public long getResponseGzipCount()
```
    Response gzip counter. Counts received content gzip length in bytes.
  - getResponseHeader
```
public java.lang.String getResponseHeader(java.lang.String name)
```
    Get a response header value. Call this after calling HttpRequest.send.
    
    See Also:
    
    HttpRequest.responseHeaders.
    
    Parameters:
    
    name - Header name.
    
    Returns:
    
    (nullable) Response header value, or `null` if not found.
  - getResponseHeaders
```
public HttpHeaders getResponseHeaders()
```
    HTTP response headers. Access response headers after calling HttpRequest.send.
  - getResponseText
```
public java.lang.String getResponseText()
```
    Response text for a non-streamed response. Access this after calling HttpRequest.send.
    
    See Also:
    
    HttpRequest.streamResponse.
  - getStatus
```
public int getStatus()
```
    HTTP response status code. Access this after calling HttpRequest.send.
  - getStatusText
```
public java.lang.String getStatusText()
```
    HTTP response status text. Access this after calling HttpRequest.send.
  - getStreamRequest
```
public boolean getStreamRequest()
```
    Set to false before calling HttpRequest.send if the caller does not wish to stream the request content. True by default.
  - getStreamResponse
```
public boolean getStreamResponse()
```
    Set to false before calling HttpRequest.send if the caller does not wish to stream the response content. True by default.
  - getTraceContent
```
public boolean getTraceContent()
```
    Is this request enabled for tracing of request/response content?
    
    See Also:
    
    HttpRequest.enableTrace.
  - getTraceHeaders
```
public boolean getTraceHeaders()
```
    Is this request enabled for tracing of request/response headers?
    
    See Also:
    
    HttpRequest.enableTrace.
  - getTraceRequest
```
public boolean getTraceRequest()
```
    Is this request enabled for request/response tracing?
    
    See Also:
    
    HttpRequest.enableTrace.
  - getUnzipResponse
```
public boolean getUnzipResponse()
```
    Does response need to be unzipped? Should be set by HttpHandler subclasses.
  - getUrl
```
public java.lang.String getUrl()
```
    The URL for this request. Set this using the HttpRequest.open function.
  - getUsername
```
public java.lang.String getUsername()
```
    (nullable) The username for this request. Set this using the HttpRequest.login function.
  - getVersion
```
public int getVersion()
```
    The HTTP version for this request. Defaults to HTTP 1.1.
    
    See Also:
    
    HttpVersion.
  - hasResponseBytes
```
public boolean hasResponseBytes()
```
    Does this request have a byte stream response already set?
  - hasResponseChars
```
public boolean hasResponseChars()
```
    Does this request have a text stream response already set?
  - hasResponseData
```
public boolean hasResponseData()
```
    Does this request have a binary (data) response already set?
  - hasResponseText
```
public boolean hasResponseText()
```
    Does this request have a string (text) response already set?
  - isActive
```
public boolean isActive()
```
    Is a connection active (HttpRequest.send was called, but HttpRequest.close has not yet been called)?
  - login
```
public void login(java.lang.String username,
                  java.lang.String password)
```
    Specify the HTTP basic credentials. Call this before calling HttpRequest.send if the server requires HTTP basic authentication.
    
    Parameters:
    
    username - Username for HTTP basic authentication.
    
    password - Password for HTTP basic authentication.
  - open
```
public void open(java.lang.String method,
                 java.lang.String url)
```
    Specify the HTTP HttpRequest.method and HttpRequest.url. Call this before calling HttpRequest.send.
    
    Parameters:
    
    method - Value for HttpRequest.method.
    
    url - Value for HttpRequest.url.
  - send
```
public void send()
```
    Send this HTTP request to the server, and wait for a response. If HttpRequest.streamResponse is true, then waiting is only until response headers come back, and response content may be streamed as it is accessed. If an application calls this function, then it must also call HttpRequest.close after accessing all desired response content, to avoid resource leaks.
    
    See Also:
    
    HttpException.
  - setActive
```
public void setActive(boolean value)
```
    Is a connection active (HttpRequest.send was called, but HttpRequest.close has not yet been called)?
  - setCompressResponse
```
public void setCompressResponse(boolean value)
```
    Set to false before calling HttpRequest.send if the caller does not wish the server to compress the response content (using "gzip"). True by default.
  - setHandler
```
public void setHandler(HttpHandler value)
```
    The optional internal handler for this request.
    
    See Also:
    
    HttpHandlerType.
  - setMethod
```
public void setMethod(java.lang.String value)
```
    The HTTP method for this request. Set this using the HttpRequest.open function.
    
    See Also:
    
    constants.
  - setPassword
```
public void setPassword(java.lang.String value)
```
    The password for this request. Set this using the HttpRequest.login function.
  - setRequestBytes
```
public void setRequestBytes(ByteStream value)
```
    Request data stream. Set this before calling HttpRequest.send.
  - setRequestChars
```
public void setRequestChars(CharStream value)
```
    Request text stream. Set this before calling HttpRequest.send.
  - setRequestCookie
```
public void setRequestCookie(java.lang.String name,
                             java.lang.String value)
```
    Set a request cookie. Call this before calling HttpRequest.send.
    
    See Also:
    
    HttpRequest.requestCookies.
    
    Parameters:
    
    name - Cookie name.
    
    value - Cookie value.
  - setRequestCookies
```
public void setRequestCookies(HttpCookies value)
```
    HTTP request cookies. Set request cookies before calling HttpRequest.send.
  - setRequestData
```
public void setRequestData(byte[] value)
```
    Request data for a non-streamed request. Set this before calling HttpRequest.send.
  - setRequestHeader
```
public void setRequestHeader(java.lang.String name,
                             java.lang.String value)
```
    Set a request header. Call this before calling HttpRequest.send.
    
    See Also:
    
    HttpRequest.requestHeaders.
    
    Parameters:
    
    name - Header name.
    
    value - Header value.
  - setRequestHeaders
```
public void setRequestHeaders(HttpHeaders value)
```
    HTTP request headers. Set request headers before calling HttpRequest.send.
  - setRequestText
```
public void setRequestText(java.lang.String value)
```
    Request text for a non-streamed request. Set this before calling HttpRequest.send.
  - setResponseBytes
```
public void setResponseBytes(ByteStream value)
```
    Response data stream. Access this after calling HttpRequest.send.
  - setResponseChars
```
public void setResponseChars(CharStream value)
```
    Response text stream. Access this after calling HttpRequest.send.
  - setResponseCookie
```
public void setResponseCookie(java.lang.String name,
                              java.lang.String value)
```
    Set a response cookie. For use by servers.
    
    See Also:
    
    HttpRequest.responseCookies.
    
    Parameters:
    
    name - Cookie name.
    
    value - Cookie value.
  - setResponseCookies
```
public void setResponseCookies(HttpCookies value)
```
    HTTP response cookies. Access response cookies after calling HttpRequest.send.
  - setResponseData
```
public void setResponseData(byte[] value)
```
    Response data for a non-streamed response. Access this after calling HttpRequest.send.
    
    See Also:
    
    HttpRequest.streamResponse.
  - setResponseHeader
```
public void setResponseHeader(java.lang.String name,
                              java.lang.String value)
```
    Set a response header. For use by servers.
    
    See Also:
    
    HttpRequest.responseHeaders.
    
    Parameters:
    
    name - Header name.
    
    value - Header value.
  - setResponseHeaders
```
public void setResponseHeaders(HttpHeaders value)
```
    HTTP response headers. Access response headers after calling HttpRequest.send.
  - setResponseText
```
public void setResponseText(java.lang.String value)
```
    Response text for a non-streamed response. Access this after calling HttpRequest.send.
    
    See Also:
    
    HttpRequest.streamResponse.
  - setStatus
```
public void setStatus(int value)
```
    HTTP response status code. Access this after calling HttpRequest.send.
  - setStatusText
```
public void setStatusText(java.lang.String value)
```
    HTTP response status text. Access this after calling HttpRequest.send.
  - setStreamRequest
```
public void setStreamRequest(boolean value)
```
    Set to false before calling HttpRequest.send if the caller does not wish to stream the request content. True by default.
  - setStreamResponse
```
public void setStreamResponse(boolean value)
```
    Set to false before calling HttpRequest.send if the caller does not wish to stream the response content. True by default.
  - setUnzipResponse
```
public void setUnzipResponse(boolean value)
```
    Does response need to be unzipped? Should be set by HttpHandler subclasses.
  - setUrl
```
public void setUrl(java.lang.String value)
```
    The URL for this request. Set this using the HttpRequest.open function.
  - setUsername
```
public void setUsername(java.lang.String value)
```
    The username for this request. Set this using the HttpRequest.login function.
  - setVersion
```
public void setVersion(int value)
```
    The HTTP version for this request. Defaults to HTTP 1.1.
    
    See Also:
    
    HttpVersion.

Class HttpRequest

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CONNECT

DELETE

GET

HEAD

OPTIONS

PATCH

POST

PUT

TRACE

Constructor Detail

HttpRequest

Method Detail

setInputStream

close

enableTrace

getCompressResponse

getHandler

getMethod

getPassword

getPrettyPrint

getRequestBytes

getRequestChars

getRequestCookie

getRequestCookies

getRequestData

getRequestHeader

getRequestHeaders

getRequestText

getResponseBytes

getResponseChars

getResponseCookie

getResponseCookies

getResponseData

getResponseDataCount

getResponseGzipCount

getResponseHeader

getResponseHeaders

getResponseText

getStatus

getStatusText

getStreamRequest

getStreamResponse

getTraceContent

getTraceHeaders

getTraceRequest

getUnzipResponse

getUrl

getUsername

getVersion

hasResponseBytes

hasResponseChars

hasResponseData

hasResponseText

isActive

login

open

send

setActive

setCompressResponse

setHandler

setMethod

setPassword

setRequestBytes

setRequestChars

setRequestCookie

setRequestCookies

setRequestData

setRequestHeader

setRequestHeaders

setRequestText

setResponseBytes

setResponseChars

setResponseCookie

setResponseCookies