Functions of ballerina.net.http package
public function <Request req> addHeader(string key, string value)
Adds a transport header to the request
Receiver:
Receiver Name | Data Type | Description |
---|---|---|
req | Request | A request message |
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
key | string | The header name |
value | string | The header value |
public function <Request req> clone() (Request)
Clones and creates a new instance of a request message
Receiver:
Receiver Name | Data Type | Description |
---|---|---|
req | Request | A request message |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
Request | request: The new instance of the request message |
public function <Request req> createSessionIfAbsent() (Session)
Gets the session struct for valid id, otherwise create new
Receiver:
Receiver Name | Data Type | Description |
---|---|---|
req | Request | The request message |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
Session | Session: HTTP session struct |
public function <Request req> getBinaryPayload() (blob)
Gets the request payload in blob format
Receiver:
Receiver Name | Data Type | Description |
---|---|---|
req | Request | A request message |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
blob | blob: The blob representation of the message payload |
public function <Request req> getContentLength() (int)
Gets the Content-Length header from the request
Receiver:
Receiver Name | Data Type | Description |
---|---|---|
req | Request | A request message |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
int | int: length of the message |
public function <Request req> getFormParams() (map)
Gets formParam map from HTTP request
Receiver:
Receiver Name | Data Type | Description |
---|---|---|
req | Request | The request message |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
map | map: The map of form params |
public function <Request req> getHeader(string headerName) (string, boolean)
Gets a transport header from the request
Receiver:
Receiver Name | Data Type | Description |
---|---|---|
req | Request | A request message |
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
headerName | string | The header name |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
string | string: The header value | |
boolean | string: The header value |
public function <Request req> getHeaders() (string[])
Gets transport headers from the request
Receiver:
Receiver Name | Data Type | Description |
---|---|---|
req | Request | A request message |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
string[] | string[]: The header values |
public function <Request req> getJsonPayload() (json)
Gets the request payload in JSON format
Receiver:
Receiver Name | Data Type | Description |
---|---|---|
req | Request | A request message |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
json | json: The JSON reresentation of the message payload |
public function <Request req> getMethod() (string)
Gets the HTTP method from the request
Receiver:
Receiver Name | Data Type | Description |
---|---|---|
req | Request | A request message |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
string | string: http method value |
public function <Request req> getProperty(string propertyName) (string)
Retrieve a request property
Receiver:
Receiver Name | Data Type | Description |
---|---|---|
req | Request | A request message |
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
propertyName | string | The name of the property |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
string | string: The property value |
public function <Request req> getQueryParams() (map)
Gets queryParam map from HTTP request
Receiver:
Receiver Name | Data Type | Description |
---|---|---|
req | Request | The request message |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
map | map: The map of query params |
public function <Request req> getRequestURL() (string)
Gets the request URL from the request
Receiver:
Receiver Name | Data Type | Description |
---|---|---|
req | Request | The request message |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
string | string: The request URL value |
public function <Request req> getSession() (Session)
Gets the session struct for valid id
Receiver:
Receiver Name | Data Type | Description |
---|---|---|
req | Request | The request message |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
Session | Session: HTTP session struct |
public function <Request req> getStringPayload() (string)
Gets the request payload in string format
Receiver:
Receiver Name | Data Type | Description |
---|---|---|
req | Request | A request message |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
string | string: The string representation of the message payload |
public function <Request req> getXmlPayload() (xml)
Gets the request payload in XML format
Receiver:
Receiver Name | Data Type | Description |
---|---|---|
req | Request | The request message |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
xml | xml: The XML representation of the message payload |
public function <Request req> removeAllHeaders()
Removes all transport headers from the message
Receiver:
Receiver Name | Data Type | Description |
---|---|---|
req | Request | A request message |
public function <Request req> removeHeader(string key)
Removes a transport header from the request
Receiver:
Receiver Name | Data Type | Description |
---|---|---|
req | Request | A request message |
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
key | string | The header name |
public function <Request req> setContentLength(int contentLength)
Sets the Content-Length header on the request
Receiver:
Receiver Name | Data Type | Description |
---|---|---|
req | Request | A request message |
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
contentLength | int | Length of the message |
public function <Request req> setHeader(string key, string value)
Sets the value of a transport header
Receiver:
Receiver Name | Data Type | Description |
---|---|---|
req | Request | A request message |
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
key | string | The header name |
value | string | The header value |
public function <Request req> setJsonPayload(json payload)
Sets the request payload using a JSON object
Receiver:
Receiver Name | Data Type | Description |
---|---|---|
req | Request | A request message |
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
payload | json | The JSON payload object |
public function <Request req> setProperty(string propertyName, string propertyValue)
Sets a request property
Receiver:
Receiver Name | Data Type | Description |
---|---|---|
req | Request | A request message |
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
propertyName | string | The name of the property |
propertyValue | string | The value of the property |
public function <Request req> setStringPayload(string payload)
Sets the request payload using a string object
Receiver:
Receiver Name | Data Type | Description |
---|---|---|
req | Request | A request message |
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
payload | string | The string payload object |
public function <Request req> setXmlPayload(xml payload)
Sets the message payload using an XML object
Receiver:
Receiver Name | Data Type | Description |
---|---|---|
req | Request | A request message |
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
payload | xml | The XML payload object |
public function <Response res> addHeader(string key, string value)
Adds a transport header to the response
Receiver:
Receiver Name | Data Type | Description |
---|---|---|
res | Response | The response message |
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
key | string | The header name |
value | string | The header value |
public function <Response res> clone() (Response)
Clones and creates a new instance of a response message
Receiver:
Receiver Name | Data Type | Description |
---|---|---|
res | Response | The response message |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
Response | response: The new instance of the response message |
public function <Response res> forward(Response resp)
Forwards client service response directly to the caller.
Receiver:
Receiver Name | Data Type | Description |
---|---|---|
res | Response | The response message |
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
resp | Response | The new instance of the response message |
public function <Response res> getBinaryPayload() (blob)
Gets the response payload in blob format
Receiver:
Receiver Name | Data Type | Description |
---|---|---|
res | Response | The response message |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
blob | blob: The blob representation of the message payload |
public function <Response res> getContentLength() (int)
Gets the Content-Length header from the response
Receiver:
Receiver Name | Data Type | Description |
---|---|---|
res | Response | The response message |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
int | int: length of the message |
public function <Response res> getHeader(string headerName) (string, boolean)
Gets a transport header from the response
Receiver:
Receiver Name | Data Type | Description |
---|---|---|
res | Response | The response message |
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
headerName | string | The header name |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
string | string: The header value | |
boolean | string: The header value |
public function <Response res> getHeaders() (string[])
Gets transport headers from the response
Receiver:
Receiver Name | Data Type | Description |
---|---|---|
res | Response | The response message |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
string[] | string[]: The header values |
public function <Response res> getJsonPayload() (json)
Gets the response payload in JSON format
Receiver:
Receiver Name | Data Type | Description |
---|---|---|
res | Response | The response message |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
json | json: The JSON reresentation of the message payload |
public function <Response res> getProperty(string propertyName) (string)
Retrieve a response property
Receiver:
Receiver Name | Data Type | Description |
---|---|---|
res | Response | The response message |
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
propertyName | string | The name of the property |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
string | string: The property value |
public function <Response res> getStatusCode() (int)
Gets the HTTP status code from the response
Receiver:
Receiver Name | Data Type | Description |
---|---|---|
res | Response | The response message |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
int | int: http status code |
public function <Response res> getStringPayload() (string)
Gets the response payload in string format
Receiver:
Receiver Name | Data Type | Description |
---|---|---|
res | Response | The response message |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
string | string: The string representation of the message payload |
public function <Response res> getXmlPayload() (xml)
Gets the response payload in XML format
Receiver:
Receiver Name | Data Type | Description |
---|---|---|
res | Response | The response message |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
xml | xml: The XML representation of the message payload |
public function <Response res> removeAllHeaders()
Removes all transport headers from the response
Receiver:
Receiver Name | Data Type | Description |
---|---|---|
res | Response | The response message |
public function <Response res> removeHeader(string key)
Removes a transport header from the response
Receiver:
Receiver Name | Data Type | Description |
---|---|---|
res | Response | The response message |
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
key | string | The header name |
public function <Response res> send()
Sends outbound response to the caller.
Receiver:
Receiver Name | Data Type | Description |
---|---|---|
res | Response | The response message |
public function <Response res> setContentLength(int contentLength)
Sets the Content-Length header on the response
Receiver:
Receiver Name | Data Type | Description |
---|---|---|
res | Response | The response message |
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
contentLength | int | Length of the message |
public function <Response res> setHeader(string key, string value)
Sets the value of a transport header
Receiver:
Receiver Name | Data Type | Description |
---|---|---|
res | Response | The response message |
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
key | string | The header name |
value | string | The header value |
public function <Response res> setJsonPayload(json payload)
Sets the response payload using a JSON object
Receiver:
Receiver Name | Data Type | Description |
---|---|---|
res | Response | req: The response message |
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
payload | json | The JSON payload object |
public function <Response res> setProperty(string propertyName, string propertyValue)
Sets a response property
Receiver:
Receiver Name | Data Type | Description |
---|---|---|
res | Response | The response message |
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
propertyName | string | The name of the property |
propertyValue | string | The value of the property |
public function <Response res> setReasonPhrase(string reasonPhrase)
Sets a custom HTTP Reason phrase
Receiver:
Receiver Name | Data Type | Description |
---|---|---|
res | Response | The response message |
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
reasonPhrase | string | Reason phrase value |
public function <Response res> setStatusCode(int statusCode)
Sets the HTTP StatusCode on the response
Receiver:
Receiver Name | Data Type | Description |
---|---|---|
res | Response | The response message |
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
statusCode | int | HTTP status code |
public function <Response res> setStringPayload(string payload)
Sets the response payload using a string object
Receiver:
Receiver Name | Data Type | Description |
---|---|---|
res | Response | The response message |
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
payload | string | The string payload object |
public function <Response res> setXmlPayload(xml payload)
Sets the response payload using an XML object
Receiver:
Receiver Name | Data Type | Description |
---|---|---|
res | Response | The response message |
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
payload | xml | The XML payload object |
public function <Session session> getAttribute(string attributeKey) (any)
Gets the session attribute
Receiver:
Receiver Name | Data Type | Description |
---|---|---|
session | Session | A session struct |
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
attributeKey | string | HTTPSession attribute key |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
any | any: HTTPSession attribute value |
public function <Session session> getAttributeNames() (string[])
Gets the session attribute names
Receiver:
Receiver Name | Data Type | Description |
---|---|---|
session | Session | A session struct |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
string[] | string[]: HTTPSession attribute name array |
public function <Session session> getCreationTime() (int)
Gets the session creation time
Receiver:
Receiver Name | Data Type | Description |
---|---|---|
session | Session | A session struct |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
int | int: HTTPSession creation time |
public function <Session session> getId() (string)
Gets the session id
Receiver:
Receiver Name | Data Type | Description |
---|---|---|
session | Session | A session struct |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
string | string: HTTPSession id |
public function <Session session> getLastAccessedTime() (int)
Gets the session last accessed time
Receiver:
Receiver Name | Data Type | Description |
---|---|---|
session | Session | A session struct |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
int | int: HTTPSession last accessed time |
public function <Session session> getMaxInactiveInterval() (int)
Gets the session max inactive interval
Receiver:
Receiver Name | Data Type | Description |
---|---|---|
session | Session | A session struct |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
int | int: HTTPSession max inactive interval |
public function <Session session> invalidate()
Gets the session attribute
Receiver:
Receiver Name | Data Type | Description |
---|---|---|
session | Session | A session struct |
public function <Session session> isNew() (boolean)
Gets the session status
Receiver:
Receiver Name | Data Type | Description |
---|---|---|
session | Session | A session struct |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
boolean | boolean: HTTPSession status |
public function <Session session> removeAttribute(string attributeKey)
Remove the session attribute
Receiver:
Receiver Name | Data Type | Description |
---|---|---|
session | Session | A session struct |
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
attributeKey | string | HTTPSession attribute key |
public function <Session session> setAttribute(string attributeKey, any attributeValue)
Sets session attributes to the message
Receiver:
Receiver Name | Data Type | Description |
---|---|---|
session | Session | A session struct |
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
attributeKey | string | HTTPSession attribute key |
attributeValue | any | HTTPSession attribute Value |
public function <Session session> setMaxInactiveInterval(int timeInterval)
Sets session max inactive interval
Receiver:
Receiver Name | Data Type | Description |
---|---|---|
session | Session | A session struct |
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
timeInterval | int | HTTPSession max inactive interval |
Connectors of ballerina.net.http package
public connector HttpClient (string serviceUri, Options connectorOptions)
Http client connector for outbound http requests
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
serviceUri | string | Url of the service |
connectorOptions | Options | connector options |
action delete(string path, Request req)
The DELETE action implementation of the HTTP connector
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
path | string | Resource path |
req | Request | A request message |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
Response | response: The response message | |
HttpConnectorError | response: The response message |
action execute(string httpVerb, string path, Request req)
Invokes an HTTP call with the specified HTTP verb.
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
httpVerb | string | HTTP verb value |
path | string | Resource path |
req | Request | A request message |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
Response | response: The response message | |
HttpConnectorError | response: The response message |
action forward(string path, Request req)
forward action can be used to invoke an http call with incoming request httpVerb
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
path | string | Request path |
req | Request | A request message |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
Response | response: The response message | |
HttpConnectorError | response: The response message |
action get(string path, Request req)
GET action implementation of the HTTP Connector
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
path | string | Request path |
req | Request | A request message |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
Response | response: The response message | |
HttpConnectorError | response: The response message |
action head(string path, Request req)
The HEAD action implementation of the HTTP Connector.
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
path | string | Resource path |
req | Request | A request message |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
Response | response: The response message | |
HttpConnectorError | response: The response message |
action patch(string path, Request req)
The PATCH action implementation of the HTTP Connector.
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
path | string | Resource path |
req | Request | A request message |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
Response | response: The response message | |
HttpConnectorError | response: The response message |
action post(string path, Request req)
The POST action implementation of the HTTP Connector.
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
path | string | Resource path |
req | Request | A request message |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
Response | response: The response message | |
HttpConnectorError | response: The response message |
action put(string path, Request req)
The PUT action implementation of the HTTP Connector.
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
path | string | Resource path |
req | Request | A request message |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
Response | response: The response message | |
HttpConnectorError | response: The response message |
Structs of ballerina.net.http package
public struct HttpConnectorError
HttpConnectorError struct represents an error occured during the HTTP client invocation
Fields:
Field Name | Data Type | Description |
---|---|---|
msg | string | An error message explaining about the error |
cause | error | The error that caused HttpConnectorError to get thrown |
stackTrace | StackFrame[] | Represents the invocation stack when HttpConnectorError is thrown |
statusCode | int | HTTP status code |
public struct Options
Options struct represents options to be used for HTTP client invocation
Fields:
Field Name | Data Type | Description |
---|---|---|
port | int | Port number of the remote service |
endpointTimeout | int | Endpoint timeout value in millisecond |
chunkDisabled | boolean | Disable chunking |
followRedirects | FollowRedirects | Redirect related options |
ssl | SSL | ssl/tls related options |
retryConfig | Retry | Retry related options |
public struct Request
Represents a http request message
public struct Response
Represents a http response message
public struct Session
Represents a http Session
Annotations of ballerina.net.http package
annotation configuration
Configuration for HTTP service
Attributes:
Attribute Name | Data Type | Description |
---|---|---|
host | string | |
port | int | |
httpsPort | int | |
basePath | string | |
keyStoreFile | string | |
keyStorePassword | string | |
trustStoreFile | string | |
trustStorePassword | string | |
sslVerifyClient | string | |
certPassword | string | |
sslEnabledProtocols | string | |
ciphers | string | |
sslProtocol | string | |
allowOrigins | string[] | |
allowCredentials | boolean | |
allowMethods | string[] | |
allowHeaders | string[] | |
maxAge | int | |
exposeHeaders | string[] | |
webSocket | webSocket |
annotation resourceConfig
Configuration for HTTP resource
Attributes:
Attribute Name | Data Type | Description |
---|---|---|
methods | string[] | |
path | string | |
consumes | string[] | |
produces | string[] | |
allowOrigins | string[] | |
allowCredentials | boolean | |
allowMethods | string[] | |
allowHeaders | string[] | |
maxAge | int | |
exposeHeaders | string[] |
annotation webSocket
Annotation to upgrade connection from http to ws in the same base path.
Attributes:
Attribute Name | Data Type | Description |
---|---|---|
upgradePath | string | |
serviceName | string |