Functions of ballerina.net.http package
function convertToResponse(message m)
Converts the message into an HTTP response
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
m | message | A message object |
function getContentLength(message m) (int )
Gets the Content-Length header from the message
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
m | message | A message object |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
int | length of the message |
function getMethod(message m) (string )
Gets the HTTP method from the message
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
m | message | A message object |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
string | http method value |
function getRequestURL(message m) (string )
Gets the request URL from the message
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
m | message | The message object |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
string | The request URL value |
function getStatusCode(message m) (int )
Gets the HTTP status code from the message
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
m | message | A message object |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
int | http status code |
function setContentLength(message m, int contentLength)
Sets the Content-Length header on the message
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
m | message | A message object |
contentLength | int | Length of the message |
function setReasonPhrase(message m, string reasonPhrase)
Sets a custom HTTP Reason phrase
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
m | message | A message object |
reasonPhrase | string | Reason phrase value |
function setStatusCode(message m, int statusCode)
Sets the HTTP StatusCode on the message
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
m | message | A message object |
statusCode | int | HTTP status code |
Connectors of ballerina.net.http package
connector ClientConnector (string serviceUri)
Native HTTP Client Connector
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
serviceUri | string |
action delete()
The DELETE action implementation of the HTTP connector
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
c | ClientConnector | A connector object |
path | string | Resource path |
m | message | A message object |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
message | The response message object |
action execute()
Invokes an HTTP call with the specified HTTP verb.
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
c | ClientConnector | A connector object |
httpVerb | string | HTTP verb value |
path | string | Resource path |
m | message | A message object |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
message | The response message object |
action get()
GET action implementation of the HTTP Connector
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
c | ClientConnector | Connector |
path | string | Request path |
m | message | message |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
message |
action head()
The HEAD action implementation of the HTTP Connector.
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
c | ClientConnector | A connector object |
path | string | Resource path |
m | message | A message object |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
message | The response message object |
action patch()
The PATCH action implementation of the HTTP Connector.
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
c | ClientConnector | A connector object |
path | string | Resource path |
m | message | A message object |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
message | The response message object |
action post()
The POST action implementation of the HTTP Connector.
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
c | ClientConnector | A connector object |
path | string | Resource path |
m | message | A message object |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
message | The response message object |
action put()
The PUT action implementation of the HTTP Connector.
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
c | ClientConnector | A connector object |
path | string | Resource path |
m | message | A message object |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
message | The response message object |