classafBedSheet::BedSheetBuilder

sys::Obj
  afBedSheet::BedSheetBuilder

Use to programmatically create and launch BedSheet server instances.

watchdog := true
BedSheetBuilder(AppModule#).startWisp(8069, watchdog, "dev")

Note that BedSheet requires specific IoC config to run. Hence when running BedSheet apps this class should be used in preference to afIoc::RegistryBuilder.

The toRegistryBuilder() method can be used to build a web app, but not start the web app or listen to a port.

Note the following options:

Name	Type	Value
wisp.sessionStore	Type	The `WispSessionStore` implementation to use - note this is built outside of IoC.
wisp.sessionStoreProxy	Type	The `WispSessionStore` implementation to use - this version may be an IoC service, or an IoC autobuilt class. Note because the SessionStore needs to be created before the IoC Registry, a session store proxy is created.

addModule

Source

This addModule(Type moduleType)

Adds an IoC module to the registry.

addModules

Source

This addModules(Type[] modules)

Adds many IoC modules to the registry.

addModulesFromPod

Source

This addModulesFromPod(Str podName, Bool addDependencies := true)

Inspects the pod's meta-data for the key afIoc.module. This is then treated as a CSV list of (qualified) module type names to load.

If addDependencies is true then the pod's dependencies are also inspected for IoC modules.

Convenience for registryBuilder.addModulesFromPod()

appName

Source

Str appName()

The application name. Returns pod.dis (or proj.nameif not found) from the application's pod meta, or the pod name if neither are defined. Read only.

build

Source

Registry build()

Builds the IoC Registry.

Essentially a convenience method for toRegistryBuilder.build().

enableRequestLogs

Source

This enableRequestLogs()

Enables request logs being setting BedSheet's logging level to debug.

makeFromAppModule

Source

new makeFromAppModule(Type appModule)

Creates a BedSheetBuilder from the given AppModule.

makeFromName

Source

new makeFromName(Str modOrPodName, Bool addPodDependencies := true)

Creates a BedSheetBuilder. modOrPodName may be a pod name or a qualified AppModule type name. addPodDependencies is only used if a pod name is passed in.

options

Source

Str:Obj? options := ... { private set }

Options for IoC RegistryBuilder. Map is mutable, but this field read only.

port

Source

Int port

The HTTP port to run the app on. Defaults to 8069

removeModule

Source

This removeModule(Type moduleType)

Removes modules of the given type. If a module of the given type is subsequently added, it is silently ignored.

setIpAddress

Source

This setIpAddress(IpAddr? ipAddr)

Sets the local IP address that Wisp should bind to, or set to null for the default.

This is useful when deploying your application to Open Shift or similar where the local IP address is mandated. See the Fantom Forum topic: IP address for afBedSheet.

setOption

Source

This setOption(Str name, Obj? value)

Sets a value in the options map. Returns this so it may be used as a builder method.

silence

Source

This silence()

Suppresses surplus logging by this and IoC's RegistryBuilder.

startWisp

Source

Int startWisp(Int port := 8069, Bool watchdog := false, Str? env := null)

Convenience method to start a Wisp server running BedSheetWebMod.

toRegistryBuilder

Source

RegistryBuilder toRegistryBuilder()

Copies the content of this builder, including all the BedSheet specific config, into an IoC RegistryBuilder instance.