Exception: OAI::Exception

Inherits:

RuntimeError

• Object
• RuntimeError
• OAI::Exception

Defined in:

lib/oai/exception.rb

Overview

Standard error responses for problems serving OAI content. These messages will be wrapped in an XML response to the client.

Direct Known Subclasses

ArgumentException, FormatException, IdException, MetadataFormatException, NoMatchException, ResumptionTokenException, SetException, VerbException

Constant Summary

CODE =

nil

MESSAGE =

nil

@@codes =

{}

Instance Attribute Summary

• #code ⇒ Object readonly

  Returns the value of attribute code.

Class Method Summary

• .for(message: nil, code: nil) ⇒ Object
• .register_exception_code(code, exception_class) ⇒ Object

Instance Method Summary

• #initialize(message = nil, code = nil) ⇒ Exception constructor

  A new instance of Exception.

Constructor Details

#initialize(message = nil, code = nil) ⇒ Exception

Returns a new instance of Exception.

# File 'lib/oai/exception.rb', line 22

def initialize(message = nil, code = nil)
  super(message || self.class::MESSAGE)
  @code = code || self.class::CODE
end

Instance Attribute Details

#code ⇒ Object (readonly)

Returns the value of attribute code.

# File 'lib/oai/exception.rb', line 10

def code
  @code
end

Class Method Details

.for(message: nil, code: nil) ⇒ Object

# File 'lib/oai/exception.rb', line 18

def self.for(message: nil, code: nil)
  @@codes.fetch(code, Exception).new(message)
end

.register_exception_code(code, exception_class) ⇒ Object

# File 'lib/oai/exception.rb', line 14

def self.register_exception_code(code, exception_class)
  @@codes[code] = exception_class if exception_class.superclass == OAI::Exception
end