DTWebRequest

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

```
public class DTWebRequest
```
Object containing the necessary information for a web request, including URL, method, authorization, and headers.

See Also:
[]

Field Summary

Fields
Modifier and Type	Field and Description
`String`	`Content!` A payload of data to be sent with the request. This is often used with POST and PUT and can be the contents of a form that the user submitted. Or a file that is to be uploaded to the webserver.
`BBjVector`	`Headers!=BBjAPI().makeVector()` A vector of DTHeaders. These are name/value pairs that provide the web server with additional information about the request.
`BBjString`	`Method!="GET"` Specifies the operation that the webserver should perform. Supported operations include:
`BBjString`	`URI!` The requested web address. Example: "http://www.basis.cloud"

Constructor Summary
Constructors
Constructor and Description
DTWebRequest()

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addHeader(BBjString key!, BBjString value!)` Adds the specified header to the request.
`org.apache.http.client.methods.HttpRequestBase`	`Create()` Creates an HttpRequestBase object from the fields of this object.
`BBjVector`	`getHeaders()`
`void`	`setAuthorization(BBjString authorization!)` Adds an authorization header to the request.

Field Detail
- Content!
```
public String Content!
```
  A payload of data to be sent with the request. This is often used with POST and PUT and can be the contents of a form that the user submitted. Or a file that is to be uploaded to the webserver.
- Headers!=BBjAPI().makeVector()
```
public BBjVector Headers!=BBjAPI().makeVector()
```
  A vector of DTHeaders. These are name/value pairs that provide the web server with additional information about the request.
- Method!="GET"
```
public BBjString Method!="GET"
```
  Specifies the operation that the webserver should perform. Supported operations include:
- URI!
```
public BBjString URI!
```
  The requested web address. Example: "http://www.basis.cloud"

Constructor Detail
- DTWebRequest
```
public DTWebRequest()
```

- Method Detail
  - addHeader
```
public void addHeader(BBjString key!, BBjString value!)
```
    Adds the specified header to the request.
  - Create
```
public org.apache.http.client.methods.HttpRequestBase Create()
```
    Creates an HttpRequestBase object from the fields of this object.
  - getHeaders
```
public BBjVector getHeaders()
```
  - setAuthorization
```
public void setAuthorization(BBjString authorization!)
```
    Adds an authorization header to the request.
    
    Parameters:
    authorization! The format is specific to the authorization scheme the web server uses.