Struct GCHubRestServerBuilder

pub struct GCHubRestServerBuilder {
    bind_addr: String,
    port: u16,
    serve_path: Option<PathBuf>,
    log_reader_connection: Option<LogReaderConnection>,
    config_db: GCSharedConfigDatabase,
    rt_manager: GCSharedRuntimeManager,
    ldap_config: Option<LdapConfigBuilder>,
    default_user: Option<UserID>,
}

The main component that describes the REST API server. The server can be started in a different thread by calling the GCHubRestServerBuilder::run method. The open API specification can be generated by calling the generate_open_api_spec_json method.

Fields

bind_addr: String

port: u16

serve_path: Option<PathBuf>

log_reader_connection: Option<LogReaderConnection>

config_db: GCSharedConfigDatabase

rt_manager: GCSharedRuntimeManager

ldap_config: Option<LdapConfigBuilder>

default_user: Option<UserID>

Implementations

impl GCHubRestServerBuilder

pub fn new( rt_manager: GCSharedRuntimeManager, config_db: GCSharedConfigDatabase, ) -> Self

pub fn set_port(self, port: u16) -> Self

pub fn set_log_reader_connection( self, log_reader_connection: LogReaderConnection, ) -> Self

pub fn set_serve_directory(self, path: PathBuf) -> Self

pub fn set_bind_addr(self, bind_addr: &str) -> Self

pub fn set_disable_auth(self, user: UserID) -> Self

Provides a default user for all routes, this will disable authentication and authorization

pub fn set_ldap(self, ldap_auth: LdapConfigBuilder) -> Self

pub async fn run(self) -> Result<(), GCHubRestServerError>