All Classes and Interfaces

Class
Description
Registry for defining Access Control Lists (ACLs) programmatically.
Helper class that allows to interpolate variables (@user, @request, @now) in permissions
See https://restheart.org/docs/plugins/security-plugins/#authenticators
See https://restheart.org/docs/plugins/security-plugins/#authentication-mechanisms
See https://restheart.org/docs/plugins/security-plugins/#authorizers
A secured request is allowed when no VETOER denies it and at least one ALLOWER allows it
 
Base concrete Account implementation
ACL Permission that specifies the conditions that are necessary to perform the request The request is authorized if BaseAclPermission.allow() returns true
Allows to modify the predicate of a BaseAclPermission
Base concrete Principal implmentation
ServiceRequest implementation backed by BsonValue and initialized from csv data.
Specialized Interceptor interface for services implementing BsonService
ServiceRequest implementation backed by BsonValue
ServiceResponse implementation backed by BsonValue
Specialized Service interface that uses BsonRequest and BsonResponse
 
Builder to help creating BsonArray
Builder to help creating BsonDocument
A buffered exchage stores content in a PooledByteBuffer This makes possibile using it in proxied requests.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Class that holds the configuration.
 
 
 
 
 
 
The root class in the exchange hierarchy.
 
 
 
 
 
 
 
 
Interface to get the response and request implementation classes at runtime
An helper class that simplifies getting the Plugin args from a configuration file.
Account implementation used by FileRealmAuthenticator
Specialized Interceptor interface for the GraphQL service
 
 
 
Builder to help creating JsonArray
Builder to help creating JsonObject
Parent interface of handling plugins: Service and Proxy
 
Constants enumerating the HTTP status codes.
 
 
Initializer allow to execute initialization logic at system startup time Seehttps://restheart.org/docs/plugins/core-plugins/#initializers
Defines the execution time point of an Initializer
 
Interceptors allow to snoop and modify requests and responses at different stages of the request lifecycle as defined by the interceptPoint parameter of the annotation RegisterPlugin.
 
Defines the intercept point of an Interceptor
 
 
 
 
 
 
Specialized Service interface that uses JsonRequest and JsonResponse
JsonUnflattener provides a static unflatten(String) method to unflatten any flattened JSON string back to nested one.
Deprecated.
Jwt Account
 
 
 
 
 
 
record for metric labels that can be serialized/deserialized to/from string
record for metric name and labels that can be serialized/deserialized to/from string
Utility class for metrics
 
 
 
Exception to be thrown when an unterminated comment appears in the input.
Exception to be thrown when an unterminated regular expression literal appears in the input.
Exception to be thrown when an unterminated string literal appears in the input.
Specialized Interceptor interface for MongoService
Encapsulates the permissions specific to the MongoService, definined by `mongo` property of the permission
Account implementation used by MongoRealmAuthenticator
Request implementation used by MongoService and backed by BsonValue that provides simplified methods to deal with headers and query parameters specific to mongo requests
Injects the request content to MongoRequest also check the Content-Type header in case the content is not empty
Response implementation used by MongoService and backed by BsonValue that provides simplify methods to deal mongo response
Util class for exchange attachments related to the MongoService
this duplicates si-lka Utils class
 
 
 
 
base class to implement a PipelinedHandler
wraps a HttpHandler into a PipelinedHttpHandler
Stores information about the pipeline that handles the request.
 
 
 
 
 
Base interface for dependency providers
 
 
Base class for Request implementation that can be used in proxied requests.
Base class for Response implementation that can be used in proxied requests.
Account implementation that holds PasswordCredential
 
rebuild the query string from the exchange.getQueryParameters() that might have been updated by request interceptors. it also encodes values
 
Annotation to register a Plugin
 
 
The root class for implementing a Request providing the implementation for common methods
 
The root class for implementing a Response providing the implementation for common methods
ReplicaSet Connection Options
Services allow to extend the API adding web services
Base class for Request implementations that can be used in service requests.
Base class for Response implementations that can be used in service requests.
Utility class for interpolating aggregation stages with a specified format, e.g., { [operator]: "name"}, and replacing placeholders with provided values.
 
 
 
 
 
 
 
 
Interface for token managers See https://restheart.org/docs/plugins/security-plugins/#token-managers
UninitializedRequest wraps the exchage and provides access to request attributes (such as getPath()) and allows setting a customRequestInitializer The request content can be only accessed in raw format with getRawContent() and setRawContent() Interceptors at intercePoint REQUEST_BEFORE_EXCHANGE_INIT receive UninitializedRequest as request argument
UninitializedResponse wraps the exchage and allows setting a customResponseInitializer Interceptors at intercePoint REQUEST_BEFORE_EXCHANGE_INIT receive UninitializedResponse as response argument
 
 
 
 
Utility class for interpolating variables within a BsonDocument or BsonArray by using a specific format, such as { [operator]: "name"}, and replacing placeholders with provided values.
 
 
A special interceptor that intercepts requests handled by any Service
Utility interface to handle additional account propereties