Class HttpListener

Hierarchy

HttpListener

Index

Constructors

Properties

logger resultFormatter router stopwatch?

Methods

onAccessDenied onAuth onController onControllerError onParametersFailed onRequest onResolveParameters onResponse onResultSerialization onRoute onRouteForward routeNotFound

Constructors

constructor

new HttpListener(router: HttpRouter, logger: LoggerInterface, resultFormatter: HttpResultFormatter, stopwatch?: Stopwatch): HttpListener
Parameters
- router: HttpRouter
- logger: LoggerInterface
- resultFormatter: HttpResultFormatter
- Optional stopwatch: Stopwatch
Returns HttpListener
- Defined in packages/http/src/http.ts:502

Properties

`Protected` logger

logger: LoggerInterface

`Protected` resultFormatter

resultFormatter: HttpResultFormatter

`Protected` router

router: HttpRouter

`Protected` `Optional` stopwatch

stopwatch?: Stopwatch

Methods

onAccessDenied

onAccessDenied(event: BaseEvent & Omit<HttpAccessDeniedEvent, "next" | "nextState"> & WorkflowNextEvent<{
    accessDenied: typeof HttpAccessDeniedEvent;
    auth: typeof HttpAuthEvent;
    controller: typeof HttpControllerEvent;
    controllerError: typeof HttpControllerErrorEvent;
    parametersFailed: typeof HttpControllerErrorEvent;
    request: typeof HttpWorkflowEvent;
    resolveParameters: typeof HttpResolveParametersEvent;
    response: typeof HttpResponseEvent;
    route: typeof HttpRouteEvent;
    routeNotFound: typeof HttpWorkflowEvent;
    start: typeof WorkflowEvent;
}>): void
Parameters
- event: BaseEvent & Omit<HttpAccessDeniedEvent, "next" | "nextState"> & WorkflowNextEvent<{
      accessDenied: typeof HttpAccessDeniedEvent;
      auth: typeof HttpAuthEvent;
      controller: typeof HttpControllerEvent;
      controllerError: typeof HttpControllerErrorEvent;
      parametersFailed: typeof HttpControllerErrorEvent;
      request: typeof HttpWorkflowEvent;
      resolveParameters: typeof HttpResolveParametersEvent;
      response: typeof HttpResponseEvent;
      route: typeof HttpRouteEvent;
      routeNotFound: typeof HttpWorkflowEvent;
      start: typeof WorkflowEvent;
  }>
Returns void
- Defined in packages/http/src/http.ts:626

onAuth

onAuth(event: BaseEvent & Omit<HttpAuthEvent, "next" | "nextState"> & WorkflowNextEvent<{
    accessDenied: typeof HttpAccessDeniedEvent;
    auth: typeof HttpAuthEvent;
    controller: typeof HttpControllerEvent;
    controllerError: typeof HttpControllerErrorEvent;
    parametersFailed: typeof HttpControllerErrorEvent;
    request: typeof HttpWorkflowEvent;
    resolveParameters: typeof HttpResolveParametersEvent;
    response: typeof HttpResponseEvent;
    route: typeof HttpRouteEvent;
    routeNotFound: typeof HttpWorkflowEvent;
    start: typeof WorkflowEvent;
}>): void
Parameters
- event: BaseEvent & Omit<HttpAuthEvent, "next" | "nextState"> & WorkflowNextEvent<{
      accessDenied: typeof HttpAccessDeniedEvent;
      auth: typeof HttpAuthEvent;
      controller: typeof HttpControllerEvent;
      controllerError: typeof HttpControllerErrorEvent;
      parametersFailed: typeof HttpControllerErrorEvent;
      request: typeof HttpWorkflowEvent;
      resolveParameters: typeof HttpResolveParametersEvent;
      response: typeof HttpResponseEvent;
      route: typeof HttpRouteEvent;
      routeNotFound: typeof HttpWorkflowEvent;
      start: typeof WorkflowEvent;
  }>
Returns void
- Defined in packages/http/src/http.ts:605

onController

onController(event: BaseEvent & Omit<HttpControllerEvent, "next" | "nextState"> & WorkflowNextEvent<{
    accessDenied: typeof HttpAccessDeniedEvent;
    auth: typeof HttpAuthEvent;
    controller: typeof HttpControllerEvent;
    controllerError: typeof HttpControllerErrorEvent;
    parametersFailed: typeof HttpControllerErrorEvent;
    request: typeof HttpWorkflowEvent;
    resolveParameters: typeof HttpResolveParametersEvent;
    response: typeof HttpResponseEvent;
    route: typeof HttpRouteEvent;
    routeNotFound: typeof HttpWorkflowEvent;
    start: typeof WorkflowEvent;
}>): Promise<void>
Parameters
- event: BaseEvent & Omit<HttpControllerEvent, "next" | "nextState"> & WorkflowNextEvent<{
      accessDenied: typeof HttpAccessDeniedEvent;
      auth: typeof HttpAuthEvent;
      controller: typeof HttpControllerEvent;
      controllerError: typeof HttpControllerErrorEvent;
      parametersFailed: typeof HttpControllerErrorEvent;
      request: typeof HttpWorkflowEvent;
      resolveParameters: typeof HttpResolveParametersEvent;
      response: typeof HttpResponseEvent;
      route: typeof HttpRouteEvent;
      routeNotFound: typeof HttpWorkflowEvent;
      start: typeof WorkflowEvent;
  }>
Returns Promise<void>
- Defined in packages/http/src/http.ts:634

onControllerError

onControllerError(event: BaseEvent & Omit<HttpControllerErrorEvent, "next" | "nextState"> & WorkflowNextEvent<{
    accessDenied: typeof HttpAccessDeniedEvent;
    auth: typeof HttpAuthEvent;
    controller: typeof HttpControllerEvent;
    controllerError: typeof HttpControllerErrorEvent;
    parametersFailed: typeof HttpControllerErrorEvent;
    request: typeof HttpWorkflowEvent;
    resolveParameters: typeof HttpResolveParametersEvent;
    response: typeof HttpResponseEvent;
    route: typeof HttpRouteEvent;
    routeNotFound: typeof HttpWorkflowEvent;
    start: typeof WorkflowEvent;
}>): void
Parameters
- event: BaseEvent & Omit<HttpControllerErrorEvent, "next" | "nextState"> & WorkflowNextEvent<{
      accessDenied: typeof HttpAccessDeniedEvent;
      auth: typeof HttpAuthEvent;
      controller: typeof HttpControllerEvent;
      controllerError: typeof HttpControllerErrorEvent;
      parametersFailed: typeof HttpControllerErrorEvent;
      request: typeof HttpWorkflowEvent;
      resolveParameters: typeof HttpResolveParametersEvent;
      response: typeof HttpResponseEvent;
      route: typeof HttpRouteEvent;
      routeNotFound: typeof HttpWorkflowEvent;
      start: typeof WorkflowEvent;
  }>
Returns void
- Defined in packages/http/src/http.ts:710

onParametersFailed

onParametersFailed(event: BaseEvent & Omit<HttpControllerErrorEvent, "next" | "nextState"> & WorkflowNextEvent<{
    accessDenied: typeof HttpAccessDeniedEvent;
    auth: typeof HttpAuthEvent;
    controller: typeof HttpControllerEvent;
    controllerError: typeof HttpControllerErrorEvent;
    parametersFailed: typeof HttpControllerErrorEvent;
    request: typeof HttpWorkflowEvent;
    resolveParameters: typeof HttpResolveParametersEvent;
    response: typeof HttpResponseEvent;
    route: typeof HttpRouteEvent;
    routeNotFound: typeof HttpWorkflowEvent;
    start: typeof WorkflowEvent;
}>): void
Parameters
- event: BaseEvent & Omit<HttpControllerErrorEvent, "next" | "nextState"> & WorkflowNextEvent<{
      accessDenied: typeof HttpAccessDeniedEvent;
      auth: typeof HttpAuthEvent;
      controller: typeof HttpControllerEvent;
      controllerError: typeof HttpControllerErrorEvent;
      parametersFailed: typeof HttpControllerErrorEvent;
      request: typeof HttpWorkflowEvent;
      resolveParameters: typeof HttpResolveParametersEvent;
      response: typeof HttpResponseEvent;
      route: typeof HttpRouteEvent;
      routeNotFound: typeof HttpWorkflowEvent;
      start: typeof WorkflowEvent;
  }>
Returns void
- Defined in packages/http/src/http.ts:684

onRequest

onRequest(event: BaseEvent & Omit<HttpWorkflowEvent, "next" | "nextState"> & WorkflowNextEvent<{
    accessDenied: typeof HttpAccessDeniedEvent;
    auth: typeof HttpAuthEvent;
    controller: typeof HttpControllerEvent;
    controllerError: typeof HttpControllerErrorEvent;
    parametersFailed: typeof HttpControllerErrorEvent;
    request: typeof HttpWorkflowEvent;
    resolveParameters: typeof HttpResolveParametersEvent;
    response: typeof HttpResponseEvent;
    route: typeof HttpRouteEvent;
    routeNotFound: typeof HttpWorkflowEvent;
    start: typeof WorkflowEvent;
}>): void
Parameters
- event: BaseEvent & Omit<HttpWorkflowEvent, "next" | "nextState"> & WorkflowNextEvent<{
      accessDenied: typeof HttpAccessDeniedEvent;
      auth: typeof HttpAuthEvent;
      controller: typeof HttpControllerEvent;
      controllerError: typeof HttpControllerErrorEvent;
      parametersFailed: typeof HttpControllerErrorEvent;
      request: typeof HttpWorkflowEvent;
      resolveParameters: typeof HttpResolveParametersEvent;
      response: typeof HttpResponseEvent;
      route: typeof HttpRouteEvent;
      routeNotFound: typeof HttpWorkflowEvent;
      start: typeof WorkflowEvent;
  }>
Returns void
- Defined in packages/http/src/http.ts:510

onResolveParameters

onResolveParameters(event: BaseEvent & Omit<HttpResolveParametersEvent, "next" | "nextState"> & WorkflowNextEvent<{
    accessDenied: typeof HttpAccessDeniedEvent;
    auth: typeof HttpAuthEvent;
    controller: typeof HttpControllerEvent;
    controllerError: typeof HttpControllerErrorEvent;
    parametersFailed: typeof HttpControllerErrorEvent;
    request: typeof HttpWorkflowEvent;
    resolveParameters: typeof HttpResolveParametersEvent;
    response: typeof HttpResponseEvent;
    route: typeof HttpRouteEvent;
    routeNotFound: typeof HttpWorkflowEvent;
    start: typeof WorkflowEvent;
}>): Promise<void>
Parameters
- event: BaseEvent & Omit<HttpResolveParametersEvent, "next" | "nextState"> & WorkflowNextEvent<{
      accessDenied: typeof HttpAccessDeniedEvent;
      auth: typeof HttpAuthEvent;
      controller: typeof HttpControllerEvent;
      controllerError: typeof HttpControllerErrorEvent;
      parametersFailed: typeof HttpControllerErrorEvent;
      request: typeof HttpWorkflowEvent;
      resolveParameters: typeof HttpResolveParametersEvent;
      response: typeof HttpResponseEvent;
      route: typeof HttpRouteEvent;
      routeNotFound: typeof HttpWorkflowEvent;
      start: typeof WorkflowEvent;
  }>
Returns Promise<void>
- Defined in packages/http/src/http.ts:613

onResponse

onResponse(event: BaseEvent & Omit<HttpResponseEvent, "next" | "nextState"> & WorkflowNextEvent<{
    accessDenied: typeof HttpAccessDeniedEvent;
    auth: typeof HttpAuthEvent;
    controller: typeof HttpControllerEvent;
    controllerError: typeof HttpControllerErrorEvent;
    parametersFailed: typeof HttpControllerErrorEvent;
    request: typeof HttpWorkflowEvent;
    resolveParameters: typeof HttpResolveParametersEvent;
    response: typeof HttpResponseEvent;
    route: typeof HttpRouteEvent;
    routeNotFound: typeof HttpWorkflowEvent;
    start: typeof WorkflowEvent;
}>): Promise<void>
Parameters
- event: BaseEvent & Omit<HttpResponseEvent, "next" | "nextState"> & WorkflowNextEvent<{
      accessDenied: typeof HttpAccessDeniedEvent;
      auth: typeof HttpAuthEvent;
      controller: typeof HttpControllerEvent;
      controllerError: typeof HttpControllerErrorEvent;
      parametersFailed: typeof HttpControllerErrorEvent;
      request: typeof HttpWorkflowEvent;
      resolveParameters: typeof HttpResolveParametersEvent;
      response: typeof HttpResponseEvent;
      route: typeof HttpRouteEvent;
      routeNotFound: typeof HttpWorkflowEvent;
      start: typeof WorkflowEvent;
  }>
Returns Promise<void>
- Defined in packages/http/src/http.ts:766

onResultSerialization

onResultSerialization(event: BaseEvent & Omit<HttpResponseEvent, "next" | "nextState"> & WorkflowNextEvent<{
    accessDenied: typeof HttpAccessDeniedEvent;
    auth: typeof HttpAuthEvent;
    controller: typeof HttpControllerEvent;
    controllerError: typeof HttpControllerErrorEvent;
    parametersFailed: typeof HttpControllerErrorEvent;
    request: typeof HttpWorkflowEvent;
    resolveParameters: typeof HttpResolveParametersEvent;
    response: typeof HttpResponseEvent;
    route: typeof HttpRouteEvent;
    routeNotFound: typeof HttpWorkflowEvent;
    start: typeof WorkflowEvent;
}>): Promise<void>
This happens before the result is sent.
Parameters
- event: BaseEvent & Omit<HttpResponseEvent, "next" | "nextState"> & WorkflowNextEvent<{
      accessDenied: typeof HttpAccessDeniedEvent;
      auth: typeof HttpAuthEvent;
      controller: typeof HttpControllerEvent;
      controllerError: typeof HttpControllerErrorEvent;
      parametersFailed: typeof HttpControllerErrorEvent;
      request: typeof HttpWorkflowEvent;
      resolveParameters: typeof HttpResolveParametersEvent;
      response: typeof HttpResponseEvent;
      route: typeof HttpRouteEvent;
      routeNotFound: typeof HttpWorkflowEvent;
      start: typeof WorkflowEvent;
  }>
Returns Promise<void>
- Defined in packages/http/src/http.ts:736

onRoute

onRoute(event: BaseEvent & Omit<HttpRouteEvent, "next" | "nextState"> & WorkflowNextEvent<{
    accessDenied: typeof HttpAccessDeniedEvent;
    auth: typeof HttpAuthEvent;
    controller: typeof HttpControllerEvent;
    controllerError: typeof HttpControllerErrorEvent;
    parametersFailed: typeof HttpControllerErrorEvent;
    request: typeof HttpWorkflowEvent;
    resolveParameters: typeof HttpResolveParametersEvent;
    response: typeof HttpResponseEvent;
    route: typeof HttpRouteEvent;
    routeNotFound: typeof HttpWorkflowEvent;
    start: typeof WorkflowEvent;
}>): Promise<void>
Parameters
- event: BaseEvent & Omit<HttpRouteEvent, "next" | "nextState"> & WorkflowNextEvent<{
      accessDenied: typeof HttpAccessDeniedEvent;
      auth: typeof HttpAuthEvent;
      controller: typeof HttpControllerEvent;
      controllerError: typeof HttpControllerErrorEvent;
      parametersFailed: typeof HttpControllerErrorEvent;
      request: typeof HttpWorkflowEvent;
      resolveParameters: typeof HttpResolveParametersEvent;
      response: typeof HttpResponseEvent;
      route: typeof HttpRouteEvent;
      routeNotFound: typeof HttpWorkflowEvent;
      start: typeof WorkflowEvent;
  }>
Returns Promise<void>
- Defined in packages/http/src/http.ts:518

onRouteForward

onRouteForward(event: BaseEvent & Omit<HttpRouteEvent, "next" | "nextState"> & WorkflowNextEvent<{
    accessDenied: typeof HttpAccessDeniedEvent;
    auth: typeof HttpAuthEvent;
    controller: typeof HttpControllerEvent;
    controllerError: typeof HttpControllerErrorEvent;
    parametersFailed: typeof HttpControllerErrorEvent;
    request: typeof HttpWorkflowEvent;
    resolveParameters: typeof HttpResolveParametersEvent;
    response: typeof HttpResponseEvent;
    route: typeof HttpRouteEvent;
    routeNotFound: typeof HttpWorkflowEvent;
    start: typeof WorkflowEvent;
}>): void
Parameters
- event: BaseEvent & Omit<HttpRouteEvent, "next" | "nextState"> & WorkflowNextEvent<{
      accessDenied: typeof HttpAccessDeniedEvent;
      auth: typeof HttpAuthEvent;
      controller: typeof HttpControllerEvent;
      controllerError: typeof HttpControllerErrorEvent;
      parametersFailed: typeof HttpControllerErrorEvent;
      request: typeof HttpWorkflowEvent;
      resolveParameters: typeof HttpResolveParametersEvent;
      response: typeof HttpResponseEvent;
      route: typeof HttpRouteEvent;
      routeNotFound: typeof HttpWorkflowEvent;
      start: typeof WorkflowEvent;
  }>
Returns void
- Defined in packages/http/src/http.ts:587

routeNotFound

routeNotFound(event: BaseEvent & Omit<HttpWorkflowEvent, "next" | "nextState"> & WorkflowNextEvent<{
    accessDenied: typeof HttpAccessDeniedEvent;
    auth: typeof HttpAuthEvent;
    controller: typeof HttpControllerEvent;
    controllerError: typeof HttpControllerErrorEvent;
    parametersFailed: typeof HttpControllerErrorEvent;
    request: typeof HttpWorkflowEvent;
    resolveParameters: typeof HttpResolveParametersEvent;
    response: typeof HttpResponseEvent;
    route: typeof HttpRouteEvent;
    routeNotFound: typeof HttpWorkflowEvent;
    start: typeof WorkflowEvent;
}>): Promise<void>
Parameters
- event: BaseEvent & Omit<HttpWorkflowEvent, "next" | "nextState"> & WorkflowNextEvent<{
      accessDenied: typeof HttpAccessDeniedEvent;
      auth: typeof HttpAuthEvent;
      controller: typeof HttpControllerEvent;
      controllerError: typeof HttpControllerErrorEvent;
      parametersFailed: typeof HttpControllerErrorEvent;
      request: typeof HttpWorkflowEvent;
      resolveParameters: typeof HttpResolveParametersEvent;
      response: typeof HttpResponseEvent;
      route: typeof HttpRouteEvent;
      routeNotFound: typeof HttpWorkflowEvent;
      start: typeof WorkflowEvent;
  }>
Returns Promise<void>
- Defined in packages/http/src/http.ts:597

Class HttpListener

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

router: HttpRouter

logger: LoggerInterface

resultFormatter: HttpResultFormatter

Optional stopwatch: Stopwatch

Returns HttpListener

Properties

Protected logger

Protected resultFormatter

Protected router

Protected Optional stopwatch

Methods

onAccessDenied

Parameters

Returns void

onAuth

Parameters

Returns void

onController

Parameters

Returns Promise<void>

onControllerError

Parameters

Returns void

onParametersFailed

Parameters

Returns void

onRequest

Parameters

Returns void

onResolveParameters

Parameters

Returns Promise<void>

onResponse

Parameters

Returns Promise<void>

onResultSerialization

Parameters

Returns Promise<void>

onRoute

Parameters

Returns Promise<void>

onRouteForward

Parameters

Returns void

routeNotFound

Parameters

Returns Promise<void>

Settings

Member Visibility

Theme

`Optional` stopwatch: Stopwatch

`Protected` logger

`Protected` resultFormatter

`Protected` router

`Protected` `Optional` stopwatch