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 createSessionIfAbsent(message m) (Session )
Gets the session struct for valid id, otherwise create new
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
m | message | A message object |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
Session | HTTP session struct |
function getAttribute(Session session, string attributeKey) (any )
Gets the session attribute
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
session | Session | A session struct |
attributeKey | string | HTTPSession attribute key |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
any | HTTPSession attribute value |
function getAttributeNames(Session session) (string[] )
Gets the session attribute names
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
session | Session | A session struct |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
string[] | string[]: HTTPSession attribute name array |
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 getCreationTime(Session session) (int )
Gets the session creation time
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
session | Session | A session struct |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
int | HTTPSession creation time |
function getFormParams(message m) (map )
Gets formParam map from HTTP message
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
m | message | The message object |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
map | The map of form params |
function getId(Session session) (string )
Gets the session id
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
session | Session | A session struct |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
string | HTTPSession id |
function getLastAccessedTime(Session session) (int )
Gets the session last accessed time
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
session | Session | A session struct |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
int | HTTPSession last accessed time |
function getMaxInactiveInterval(Session session) (int )
Gets the session max inactive interval
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
session | Session | A session struct |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
int | HTTPSession max inactive interval |
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 getSession(message m) (Session )
Gets the session struct for valid id
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
m | message | A message object |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
Session | HTTP session struct |
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 invalidate(Session session)
Gets the session attribute
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
session | Session | A session struct |
function isNew(Session session) (boolean )
Gets the session status
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
session | Session | A session struct |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
boolean | HTTPSession status |
function removeAttribute(Session session, string attributeKey)
Remove the session attribute
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
session | Session | A session struct |
attributeKey | string | HTTPSession attribute key |
function setAttribute(Session session, string attributeKey, any attributeValue)
Sets session attributes to the message
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
session | Session | A session struct |
attributeKey | string | HTTPSession attribute key |
attributeValue | any | HTTPSession attribute Value |
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 setMaxInactiveInterval(Session session, int timeInterval)
Sets session max inactive interval
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
session | Session | A session struct |
timeInterval | int | HTTPSession max inactive interval |
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)
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
serviceUri | string |
action delete()
The DELETE action implementation of the HTTP connector
Parameters:
Parameter Name | Data Type | Description |
---|---|---|
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 |
---|---|---|
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 |
---|---|---|
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 |
---|---|---|
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 |
---|---|---|
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 |
---|---|---|
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 |
---|---|---|
m | message | A message object |
Return Parameters:
Return Variable | Data Type | Description |
---|---|---|
message | The response message object |
Structs of ballerina.net.http package
struct Session
Fields:
Field Name | Data Type | Description |
---|---|---|
id | string |
Annotations of ballerina.net.http package
annotation configuration
Attributes:
Attribute Name | Data Type | Description |
---|---|---|
host | string | |
port | int | |
httpsPort | int | |
basePath | string | |
keyStoreFile | string | |
keyStorePass | string | |
certPass | string | |
allowOrigins | string[] | |
allowCredentials | boolean | |
allowMethods | string[] | |
allowHeaders | string[] | |
maxAge | int | |
exposeHeaders | string[] |
annotation resourceConfig
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[] |