Exception: Mongo::Error::InvalidSignature

Inherits:
Mongo::Error
  • Object
show all
Defined in:
build/ruby-driver-v2.19/lib/mongo/error/invalid_signature.rb

Overview

This exception is raised when the server verifier does not match the expected signature on the client.

Since:

  • 2.0.0

Constant Summary

Constants inherited from Mongo::Error

BAD_VALUE, CODE, CURSOR_NOT_FOUND, ERR, ERRMSG, ERROR, TRANSIENT_TRANSACTION_ERROR_LABEL, UNKNOWN_ERROR, UNKNOWN_TRANSACTION_COMMIT_RESULT_LABEL, WRITE_CONCERN_ERROR, WRITE_CONCERN_ERRORS, WRITE_ERRORS

Instance Attribute Summary collapse

Attributes included from Notable

#connection_global_id, #generation, #service_id

Instance Method Summary collapse

Methods inherited from Mongo::Error

#change_stream_resumable?, #write_concern_error_label?, #write_concern_error_labels

Methods included from ChangeStreamResumable

#change_stream_resumable?

Methods included from WriteRetryable

#write_retryable?

Methods included from Labelable

#add_label, #label?, #labels

Methods included from Notable

#add_note, #add_notes, #notes, #to_s

Constructor Details

#initialize(verifier, server_signature) ⇒ InvalidSignature

Create the new exception.

Examples:

Create the new exception.

InvalidSignature.new(verifier, server_signature)

Parameters:

  • verifier (String) —

    The verifier returned from the server.

  • server_signature (String) —

    The expected value from the server.

Since:

  • 2.0.0



43
44
45
46
47
 
# File 'build/ruby-driver-v2.19/lib/mongo/error/invalid_signature.rb', line 43

def initialize(verifier, server_signature)
  @verifier = verifier
  @server_signature = server_signature
  super("Expected server verifier '#{verifier}' to match '#{server_signature}'.")
end

Instance Attribute Details

#server_signature ⇒ String (readonly)

Returns server_signature The expected server signature.

Returns:

  • (String) —

    server_signature The expected server signature.

Since:

  • 2.0.0



31
32
33
 
# File 'build/ruby-driver-v2.19/lib/mongo/error/invalid_signature.rb', line 31

def server_signature
  @server_signature
end

#verifier ⇒ String (readonly)

Returns verifier The server verifier string.

Returns:

  • (String) —

    verifier The server verifier string.

Since:

  • 2.0.0



28
29
30
 
# File 'build/ruby-driver-v2.19/lib/mongo/error/invalid_signature.rb', line 28

def verifier
  @verifier
end