Class: SoarAuditingProvider::AuditingProvider

Inherits:
SoarAuditingProviderAPI::AuditingProviderAPI
  • Object
show all
Defined in:
lib/soar_auditing_provider/auditing_provider.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(configuration) ⇒ AuditingProvider

Returns a new instance of AuditingProvider.



24
25
26
27
28
29
30
31
32
# File 'lib/soar_auditing_provider/auditing_provider.rb', line 24

def initialize(configuration)
  validate_provider_configuration(configuration)
  @configuration = configuration
  super(create_auditors(configuration))
  select_auditor(configuration['default_nfrs'])
  create_auditing_worker
  @buffer_overflow_count = 0
  install_at_exit_handler
end

Instance Attribute Details

#configurationObject (readonly)

Returns the value of attribute configuration.



22
23
24
# File 'lib/soar_auditing_provider/auditing_provider.rb', line 22

def configuration
  @configuration
end

#service_identifierObject

Returns the value of attribute service_identifier.



21
22
23
# File 'lib/soar_auditing_provider/auditing_provider.rb', line 21

def service_identifier
  @service_identifier
end

#startup_flow_idObject

Returns the value of attribute startup_flow_id.



20
21
22
# File 'lib/soar_auditing_provider/auditing_provider.rb', line 20

def startup_flow_id
  @startup_flow_id
end

Instance Method Details

#<<(data, flow_identifier = nil) ⇒ Object



66
67
68
# File 'lib/soar_auditing_provider/auditing_provider.rb', line 66

def <<(data, flow_identifier = nil)
  enqueue(:info, format(:info, prepend_caller_information(data), flow_identifier))
end

#debug(data, flow_identifier = nil) ⇒ Object



46
47
48
# File 'lib/soar_auditing_provider/auditing_provider.rb', line 46

def debug(data, flow_identifier = nil)
  enqueue(:debug, format(:debug, prepend_caller_information(data), flow_identifier))
end

#detailed_statusObject



70
71
72
73
74
75
76
77
78
# File 'lib/soar_auditing_provider/auditing_provider.rb', line 70

def detailed_status
  { 'audit_buffer_overflows' => @buffer_overflow_count,
    'startup_flow_id'        => @startup_flow_id,
    'failed_audit_attempts'  => @worker.failed_audit_attempts,
    'successful_audits'      => @worker.successful_audits,
    'total_audits'           => @worker.total_audits,
    'latest_audit_timespan'  => @worker.latest_audit_timespan,
    'latest_audit_timestamp' => @worker.latest_audit_timestamp }
end

#error(data, flow_identifier = nil) ⇒ Object



58
59
60
# File 'lib/soar_auditing_provider/auditing_provider.rb', line 58

def error(data, flow_identifier = nil)
  enqueue(:error, format(:error, prepend_caller_information(data), flow_identifier))
end

#fatal(data, flow_identifier = nil) ⇒ Object



62
63
64
# File 'lib/soar_auditing_provider/auditing_provider.rb', line 62

def fatal(data, flow_identifier = nil)
  enqueue(:fatal, format(:fatal, prepend_caller_information(data), flow_identifier))
end

#flushObject



80
81
82
# File 'lib/soar_auditing_provider/auditing_provider.rb', line 80

def flush
  @worker.flush
end

#info(data, flow_identifier = nil) ⇒ Object



50
51
52
# File 'lib/soar_auditing_provider/auditing_provider.rb', line 50

def info(data, flow_identifier = nil)
  enqueue(:info, format(:info, prepend_caller_information(data), flow_identifier))
end

#select_auditor(nfrs) ⇒ Object



34
35
36
37
# File 'lib/soar_auditing_provider/auditing_provider.rb', line 34

def select_auditor(nfrs)
  select(nfrs)
  set_audit_level(@configuration['level'].to_sym)
end

#set_audit_level(level) ⇒ Object



39
40
41
42
43
44
# File 'lib/soar_auditing_provider/auditing_provider.rb', line 39

def set_audit_level(level)
  @auditor.set_audit_level(level)
rescue ArgumentError
  $stderr.puts 'Invalid auditing level'
  raise
end

#warn(data, flow_identifier = nil) ⇒ Object



54
55
56
# File 'lib/soar_auditing_provider/auditing_provider.rb', line 54

def warn(data, flow_identifier = nil)
  enqueue(:warn, format(:warn, prepend_caller_information(data), flow_identifier))
end