Ballerina API Documentation

Functions of ballerina.net.http package

function convertToResponse(message m)

Converts the message into an HTTP response

Parameters:

Parameter NameData TypeDescription
mmessageA message object

function createSessionIfAbsent(message m) (Session )

Gets the session struct for valid id, otherwise create new

Parameters:

Parameter NameData TypeDescription
mmessageA message object

Return Parameters:

Return VariableData TypeDescription
SessionHTTP session struct

function getAttribute(Session session, string attributeKey) (any )

Gets the session attribute

Parameters:

Parameter NameData TypeDescription
sessionSessionA session struct
attributeKeystringHTTPSession attribute key

Return Parameters:

Return VariableData TypeDescription
anyHTTPSession attribute value

function getAttributeNames(Session session) (string[] )

Gets the session attribute names

Parameters:

Parameter NameData TypeDescription
sessionSessionA session struct

Return Parameters:

Return VariableData TypeDescription
string[]string[]: HTTPSession attribute name array

function getContentLength(message m) (int )

Gets the Content-Length header from the message

Parameters:

Parameter NameData TypeDescription
mmessageA message object

Return Parameters:

Return VariableData TypeDescription
intlength of the message

function getCreationTime(Session session) (int )

Gets the session creation time

Parameters:

Parameter NameData TypeDescription
sessionSessionA session struct

Return Parameters:

Return VariableData TypeDescription
intHTTPSession creation time

function getFormParams(message m) (map )

Gets formParam map from HTTP message

Parameters:

Parameter NameData TypeDescription
mmessageThe message object

Return Parameters:

Return VariableData TypeDescription
mapThe map of form params

function getId(Session session) (string )

Gets the session id

Parameters:

Parameter NameData TypeDescription
sessionSessionA session struct

Return Parameters:

Return VariableData TypeDescription
stringHTTPSession id

function getLastAccessedTime(Session session) (int )

Gets the session last accessed time

Parameters:

Parameter NameData TypeDescription
sessionSessionA session struct

Return Parameters:

Return VariableData TypeDescription
intHTTPSession last accessed time

function getMaxInactiveInterval(Session session) (int )

Gets the session max inactive interval

Parameters:

Parameter NameData TypeDescription
sessionSessionA session struct

Return Parameters:

Return VariableData TypeDescription
intHTTPSession max inactive interval

function getMethod(message m) (string )

Gets the HTTP method from the message

Parameters:

Parameter NameData TypeDescription
mmessageA message object

Return Parameters:

Return VariableData TypeDescription
stringhttp method value

function getRequestURL(message m) (string )

Gets the request URL from the message

Parameters:

Parameter NameData TypeDescription
mmessageThe message object

Return Parameters:

Return VariableData TypeDescription
stringThe request URL value

function getSession(message m) (Session )

Gets the session struct for valid id

Parameters:

Parameter NameData TypeDescription
mmessageA message object

Return Parameters:

Return VariableData TypeDescription
SessionHTTP session struct

function getStatusCode(message m) (int )

Gets the HTTP status code from the message

Parameters:

Parameter NameData TypeDescription
mmessageA message object

Return Parameters:

Return VariableData TypeDescription
inthttp status code

function invalidate(Session session)

Gets the session attribute

Parameters:

Parameter NameData TypeDescription
sessionSessionA session struct

function isNew(Session session) (boolean )

Gets the session status

Parameters:

Parameter NameData TypeDescription
sessionSessionA session struct

Return Parameters:

Return VariableData TypeDescription
booleanHTTPSession status

function removeAttribute(Session session, string attributeKey)

Remove the session attribute

Parameters:

Parameter NameData TypeDescription
sessionSessionA session struct
attributeKeystringHTTPSession attribute key

function setAttribute(Session session, string attributeKey, any attributeValue)

Sets session attributes to the message

Parameters:

Parameter NameData TypeDescription
sessionSessionA session struct
attributeKeystringHTTPSession attribute key
attributeValueanyHTTPSession attribute Value

function setContentLength(message m, int contentLength)

Sets the Content-Length header on the message

Parameters:

Parameter NameData TypeDescription
mmessageA message object
contentLengthintLength of the message

function setMaxInactiveInterval(Session session, int timeInterval)

Sets session max inactive interval

Parameters:

Parameter NameData TypeDescription
sessionSessionA session struct
timeIntervalintHTTPSession max inactive interval

function setReasonPhrase(message m, string reasonPhrase)

Sets a custom HTTP Reason phrase

Parameters:

Parameter NameData TypeDescription
mmessageA message object
reasonPhrasestringReason phrase value

function setStatusCode(message m, int statusCode)

Sets the HTTP StatusCode on the message

Parameters:

Parameter NameData TypeDescription
mmessageA message object
statusCodeintHTTP status code


Connectors of ballerina.net.http package

connector ClientConnector (string serviceUri)

Parameters:

Parameter NameData TypeDescription
serviceUristring

Actions:

action delete()

The DELETE action implementation of the HTTP connector

Parameters:

Parameter NameData TypeDescription
mmessageA message object

Return Parameters:

Return VariableData TypeDescription
messageThe response message object

action execute()

Invokes an HTTP call with the specified HTTP verb.

Parameters:

Parameter NameData TypeDescription
pathstringResource path
mmessageA message object

Return Parameters:

Return VariableData TypeDescription
messageThe response message object

action get()

GET action implementation of the HTTP Connector

Parameters:

Parameter NameData TypeDescription
mmessagemessage

Return Parameters:

Return VariableData TypeDescription
message

action head()

The HEAD action implementation of the HTTP Connector.

Parameters:

Parameter NameData TypeDescription
mmessageA message object

Return Parameters:

Return VariableData TypeDescription
messageThe response message object

action patch()

The PATCH action implementation of the HTTP Connector.

Parameters:

Parameter NameData TypeDescription
mmessageA message object

Return Parameters:

Return VariableData TypeDescription
messageThe response message object

action post()

The POST action implementation of the HTTP Connector.

Parameters:

Parameter NameData TypeDescription
mmessageA message object

Return Parameters:

Return VariableData TypeDescription
messageThe response message object

action put()

The PUT action implementation of the HTTP Connector.

Parameters:

Parameter NameData TypeDescription
mmessageA message object

Return Parameters:

Return VariableData TypeDescription
messageThe response message object


Structs of ballerina.net.http package

struct Session

Fields:

Field NameData TypeDescription
idstring


Annotations of ballerina.net.http package

annotation PathParam

Attributes:

Attribute NameData TypeDescription
valuestring

annotation QueryParam

Attributes:

Attribute NameData TypeDescription
valuestring

annotation configuration

Attributes:

Attribute NameData TypeDescription
hoststring
portint
httpsPortint
basePathstring
keyStoreFilestring
keyStorePassstring
certPassstring
allowOriginsstring[]
allowCredentialsboolean
allowMethodsstring[]
allowHeadersstring[]
maxAgeint
exposeHeadersstring[]

annotation resourceConfig

Attributes:

Attribute NameData TypeDescription
methodsstring[]
pathstring
consumesstring[]
producesstring[]
allowOriginsstring[]
allowCredentialsboolean
allowMethodsstring[]
allowHeadersstring[]
maxAgeint
exposeHeadersstring[]


Menu

  • Functions
    • convertToResponse(message m)
    • createSessionIfAbsent(message m) (Session )
    • getAttribute(Session session, string attributeKey) (any )
    • getAttributeNames(Session session) (string[] )
    • getContentLength(message m) (int )
    • getCreationTime(Session session) (int )
    • getFormParams(message m) (map )
    • getId(Session session) (string )
    • getLastAccessedTime(Session session) (int )
    • getMaxInactiveInterval(Session session) (int )
    • getMethod(message m) (string )
    • getRequestURL(message m) (string )
    • getSession(message m) (Session )
    • getStatusCode(message m) (int )
    • invalidate(Session session)
    • isNew(Session session) (boolean )
    • removeAttribute(Session session, string attributeKey)
    • setAttribute(Session session, string attributeKey, any attributeValue)
    • setContentLength(message m, int contentLength)
    • setMaxInactiveInterval(Session session, int timeInterval)
    • setReasonPhrase(message m, string reasonPhrase)
    • setStatusCode(message m, int statusCode)
  • Connectors
    • ClientConnector (string serviceUri)
      • delete(message m)
      • execute(string path, message m)
      • get(message m)
      • head(message m)
      • patch(message m)
      • post(message m)
      • put(message m)
  • Structs
    • Session
  • Annotations
    • PathParam
    • QueryParam
    • configuration
    • resourceConfig

Copyright 2017 Ballerina API Documentation