The annotation to configure a GraphQL service.


ServiceConfig

GraphqlServiceConfig

The GraphQL context object used to pass the meta information between resolvers.


init

Sets a given value for a given key in the GraphQL context.



'key

string

value

Retrieves a value using the given key from the GraphQL context.



The value if the key is present in the context, a `graphql:Error` otherwise


Removes a value using the given key from the GraphQL context.



remove

Context

The prefix used to denote the Basic authentication scheme.


AUTH_SCHEME_BASIC

The prefix used to denote the Bearer authentication scheme.


AUTH_SCHEME_BEARER

Represents the authentication error type.


Error

AuthnError

Represents the authorization error type.


AuthzError

Represents any error related to the Ballerina GraphQL module.


Invoked during the initialization of a `graphql:Listener`. Either an `http:Listner` or a port number must be
provided to initialize the listener.



An `http:Listener` or a port number to listen to the GraphQL service endpoint


listenTo

The additional configurations for the GraphQL listener


configuration

ListenerConfiguration

A `graphql:Error` if the listener initialization is failed or else `()`


Attaches the provided service to the Listener.



attach

The `graphql:Service` object to attach to the listener


Service

name

A `graphql:Error` if an error occurred during the service-attaching process or the schema
generation process or else `()`


Detaches the provided service from the Listener.



detach

The service to be detached from the listener


A `graphql:Error` if an error occurred during the service detaching process or else `()`


'start

A `graphql:Error`, if an error occurred during the service starting process, otherwise nil


Gracefully stops the graphql listener. Already accepted requests will be served before the connection closure.



gracefulStop

A `graphql:Error`, if an error occurred during the service stopping process, otherwise nil


Stops the service listener immediately.



immediateStop

A `graphql:Error` if an error occurred during the service stopping process or else `()`


Listener

Represent CORS configurations for internal HTTP service


The array of allowed headers by the service

allowHeaders

The array of allowed methods by the service

allowMethods

The array of origins with which the response is shared by the service

allowOrigins

The allowlisted headers, which clients are allowed to access

exposeHeaders

Specifies whether credentials are required to access the service

allowCredentials

The maximum duration to cache the preflight from client side

maxAge

CorsConfig

Represents file user store configurations for Basic Auth authentication.


FileUserStoreConfig

Represents the auth annotation for file user store configurations with scopes.



File user store configurations for Basic Auth authentication


fileUserStoreConfig

scopes

FileUserStoreConfigWithScopes

Provides a set of configurations for the GraphQL service.



maxQueryDepth

auth

ListenerAuthConfig

Function to initialize the context. If not provided, an empty context will be created


contextInit

ContextInit

The cross origin resource sharing configurations for the service


cors

Represents JWT validator configurations for JWT authentication.



Represents JWT validator configurations.


Expected issuer, which is mapped to the `iss`

issuer

Expected username, which is mapped to the `sub`

username

Expected audience, which is mapped to the `aud`

audience

Expected JWT ID, which is mapped to the `jti`

jwtId

Expected JWT key ID, which is mapped the `kid`

keyId

customClaims

Clock skew (in seconds) that can be used to avoid token validation failures due to clock synchronization problems

clockSkew

signatureConfig

Configurations related to the cache, which are used to store parsed JWT information

cacheConfig

ValidatorConfig

scopeKey

JwtValidatorConfig

Represents the auth annotation for JWT validator configurations with scopes.



JWT validator configurations for JWT authentication


jwtValidatorConfig

JwtValidatorConfigWithScopes

Represents LDAP user store configurations for Basic Auth authentication.


Represents the LDAP user store configurations.


domainName

connectionUrl

The username used to connect to the LDAP server

connectionName

The password used to connect to the LDAP server

connectionPassword

DN of the context or object under which the user entries are stored in the LDAP server

userSearchBase

Object class used to construct user entries

userEntryObjectClass

The attribute used for uniquely identifying a user entry

userNameAttribute

Filtering criteria used to search for a particular user entry

userNameSearchFilter

Filtering criteria for searching user entries in the LDAP server

userNameListFilter

DN of the context or object under which the group entries are stored in the LDAP server

groupSearchBase

Object class used to construct group entries

groupEntryObjectClass

The attribute used for uniquely identifying a group entry

groupNameAttribute

Filtering criteria used to search for a particular group entry

groupNameSearchFilter

Filtering criteria for searching group entries in the LDAP server

groupNameListFilter

Define the attribute, which contains the distinguished names (DN) of user objects that are there in a group

membershipAttribute

To indicate whether to cache the role list of a user

userRolesCacheEnabled

Define whether LDAP connection pooling is enabled

connectionPoolingEnabled

Connection timeout (in seconds) when making the initial LDAP connection

connectionTimeout

Reading timeout (in seconds) for LDAP operations

readTimeout

The SSL configurations for the LDAP client socket. This needs to be configured in order to communicate through LDAPs

secureSocket

LdapUserStoreConfig

Represents the auth annotation for LDAP user store configurations with scopes.



LDAP user store configurations for Basic Auth authentication


ldapUserStoreConfig

LdapUserStoreConfigWithScopes

Provides a set of configurations for configure the underlying HTTP listener of the GraphQL listener.


Provides a set of configurations for HTTP service endpoints.


host

Configurations related to HTTP/1.x protocol

http1Settings

The SSL configurations for the service endpoint. This needs to be configured in order to
communicate through HTTPS.

Highest HTTP version supported by the endpoint

httpVersion

Period of time in seconds that a connection waits for a read/write operation. Use value 0 to
disable timeout

timeout

The server name which should appear as a response header

server

Configurations associated with inbound request size limits

requestLimits

interceptors

Provides settings related to HTTP/1.x protocol, when using HTTP 1.x as the underlying protocol for the GraphQL
service.


Provides settings related to HTTP/1.x protocol.


Can be set to either `KEEPALIVE_AUTO`, which respects the `connection` header, or `KEEPALIVE_ALWAYS`,
which always keeps the connection alive, or `KEEPALIVE_NEVER`, which always closes the connection

keepAlive

Defines the maximum number of requests that can be processed at a given time on a single
connection. By default 10 requests can be pipelined on a single connection and user can
change this limit appropriately.

maxPipelinedRequests

ListenerHttp1Settings

Configures the SSL/TLS options to be used for the underlying HTTP service used in GraphQL service.


Configures the SSL/TLS options to be used for HTTP service.


Configurations associated with `crypto:KeyStore` or combination of certificate and (PKCS8) private key of the server

Configures associated with mutual SSL operations

mutualSsl

protocol

Certificate validation against OCSP_CRL, OCSP_STAPLING related options

certValidation

List of ciphers to be used
eg: TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA

ciphers

shareSession

handshakeTimeout

sessionTimeout

ListenerSecureSocket

Represents OAuth2 introspection server configurations for OAuth2 authentication.



Represents the introspection endpoint configurations.


A hint about the type of the token submitted for introspection

tokenTypeHint

Map of the optional parameters used for the introspection endpoint

optionalParams

Configurations for the cache used to store the OAuth2 access token and other related information

Expiration time (in seconds) of the tokens if the introspection response does not contain an `exp` field

defaultTokenExpTime

HTTP client configurations, which call the introspection endpoint

clientConfig

IntrospectionConfig

OAuth2IntrospectionConfig

Represents the auth annotation for OAuth2 introspection server configurations with scopes.



OAuth2 introspection server configurations for OAuth2 authentication


oauth2IntrospectionConfig

OAuth2IntrospectionConfigWithScopes

This module provides APIs for connecting and interacting with GraphQL endpoints.


Object type: Service