Class GuardedMessageHandler<TContent>Abstract

Guard a message handler by getting and verifying the JWT token. It changes the MessageInfo parameter to AuthenticatedManagementSubjectMessageInfo which contains the JWT token subject. In addition it checks that the subjects permission match the required ones.

Type Parameters

  • TContent

Hierarchy

Constructors

constructor

Properties

messageType middleware overrides?

Methods

getEnvironmentInfo getSubject mapError? onMessage onMessageFailure?

Constructors

constructor

Properties

Readonly messageType

messageType: string

Readonly middleware

middleware: OnMessageMiddleware<unknown>[]

Optional Readonly overrides

overrides?: SubscriptionConfig

Methods

Protected getEnvironmentInfo

  • Get the environment info that was extracted through the authenticationMiddleware

    Parameters

    • message: MessageInfo<unknown>

      the RabbitMQ message that contains a JWT token

    Returns EnvironmentInfo

Protected getSubject

Optional mapError

  • Function to map thrown error of unspecified type to a more human-readable error. Defining this mapping function eliminates the need to wrap onMessage contents into an explicit try-catch block.

    Parameters

    • error: unknown

    Returns Error

Abstract onMessage

  • Main message handling function.

    Parameters

    • payload: TContent

      non-binary message payload (usually a json)

    • message: MessageInfo<TContent>

      message with all related message metadata, including message envelope

    • ackOrNack: AckOrNack

      acknowledgment or rejection callback that can be called to forcefully complete the message processing.

    Returns Promise<void>

Optional onMessageFailure

  • Function that will be called after the last retry attempt has failed. Useful for handling errors in an explicit way.

    Parameters

    • payload: TContent

      non-binary message payload (usually a json)

    • message: MessageInfo<TContent>

      message with all related message metadata, including message envelope

    • error: Error

      error object that caused message processing to repeatedly fail

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc