Class: Verikloak::BFF::Error

Inherits:

Error

• Object
• Error
• Verikloak::BFF::Error

Defined in:

lib/verikloak/bff/errors.rb

Overview

Base error class with HTTP status and short code. Inherits from Error so that rescue Verikloak::Error catches all Verikloak gem errors uniformly.

Direct Known Subclasses

ClaimsMismatchError, HeaderMismatchError, MissingForwardedTokenError, UntrustedProxyError

Instance Attribute Summary

• #code ⇒ String readonly

  The current value of code.

• #http_status ⇒ Integer readonly

  The current value of http_status.

Instance Method Summary

• #initialize(message = nil, code: 'bff_error', http_status: 401) ⇒ void constructor

  Build a BFF error with a stable code and HTTP status.

Constructor Details

#initialize(message = nil, code: 'bff_error', http_status: 401) ⇒ void

Build a BFF error with a stable code and HTTP status.

Parameters:

• message (String, nil) (defaults to: nil)
• code (String) (defaults to: 'bff_error')
• http_status (Integer) (defaults to: 401)

# File 'lib/verikloak/bff/errors.rb', line 23

def initialize(message = nil, code: 'bff_error', http_status: 401)
  super(message || code, code: code, http_status: http_status)
end

Instance Attribute Details

#code ⇒ String (readonly)

Returns the current value of code.

Returns:

• (String) —

  the current value of code

# File 'lib/verikloak/bff/errors.rb', line 16

def code
  @code
end

#http_status ⇒ Integer (readonly)

Returns the current value of http_status.

Returns:

• (Integer) —

  the current value of http_status

# File 'lib/verikloak/bff/errors.rb', line 16

def http_status
  @http_status
end