Exception: Wsaa::AuthenticationError

Inherits:
Error
  • Object
show all
Defined in:
lib/wsaa/errors.rb

Overview

Raised when WSAA authentication fails.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(message, fault_code: nil, fault_string: nil) ⇒ AuthenticationError

Creates a new AuthenticationError.

Parameters:

  • message (String) —

    The error message.

  • fault_code (String, nil) (defaults to: nil) —

    The SOAP fault code.

  • fault_string (String, nil) (defaults to: nil) —

    The SOAP fault message.



28
29
30
31
32
 
# File 'lib/wsaa/errors.rb', line 28

def initialize(message, fault_code: nil, fault_string: nil)
  @fault_code = fault_code
  @fault_string = fault_string
  super(message)
end

Instance Attribute Details

#fault_code ⇒ String? (readonly)

The SOAP fault code from WSAA.

Returns:

  • (String, nil) —

    the current value of fault_code



19
20
21
 
# File 'lib/wsaa/errors.rb', line 19

def fault_code
  @fault_code
end

#fault_string ⇒ String? (readonly)

The SOAP fault message from WSAA.

Returns:

  • (String, nil) —

    the current value of fault_string



19
20
21
 
# File 'lib/wsaa/errors.rb', line 19

def fault_string
  @fault_string
end