Skip to main content

Class: SecurityPlugin

Registers security configuration and lifecycle integration with AxiSpark.

The global authentication and authorization middleware and guards provide the execution pipeline; this plugin binds its options and logger into the application's dependency injection container. Applications customize authentication and authorization by providing their own injectable Authenticator and AuthorizationPolicy implementations.

Extends​

Constructors​

Constructor​

new SecurityPlugin(logger): SecurityPlugin

Parameters​

logger​

Logger

Application logger used to create the plugin's scoped logger.

Returns​

SecurityPlugin

Overrides​

Plugin.constructor

Properties​

options​

protected options: SecurityPluginOptions

Overrides​

Plugin.options

state​

protected state: PluginLifecycle

Inherited from​

Plugin.state

stateError?​

protected optional stateError?: Error

Inherited from​

Plugin.stateError

dependencies?​

readonly static optional dependencies?: (PluginType<Plugin> | { optional: boolean; plugin: PluginType; })[]

Inherited from​

Plugin.dependencies

Methods​

getState()​

getState(): PluginLifecycle

Retrieves the current lifecycle state of the plugin.

Returns​

PluginLifecycle

The current lifecycle state of the plugin.

Inherited from​

Plugin.getState

getStateError()​

getStateError(): Error | undefined

Retrieves the error state of the plugin, if any.

Returns​

Error | undefined

The error that caused the plugin to enter the error state, or undefined if no error occurred.

Inherited from​

Plugin.getStateError

onRegister()​

onRegister(context, options?): Promise<void>

Binds the security options and scoped logger into the application container.

Parameters​

context​

AxiSparkContext

Running application context.

options?​

SecurityPluginOptions

Required security plugin configuration.

Returns​

Promise<void>

Throws​

PluginNotConfiguredError when options are omitted.

Overrides​

Plugin.onRegister

onStart()​

onStart(): Promise<void>

Logs that the security plugin has started.

Returns​

Promise<void>

Overrides​

Plugin.onStart

onStop()​

onStop(): Promise<void>

Logs that the security plugin has stopped.

Returns​

Promise<void>

Overrides​

Plugin.onStop

setState()​

setState(state): void

Sets the lifecycle state of the plugin.

Parameters​

state​

PluginLifecycle

The new lifecycle state of the plugin.

Returns​

void

Inherited from​

Plugin.setState

setStateError()​

setStateError(error): void

Sets the error state of the plugin.

Parameters​

error​

Error

The error that caused the plugin to enter the error state.

Returns​

void

Inherited from​

Plugin.setStateError