Class: Comet::ExternalLDAPAuthenticationSourceSettings

Inherits:
Object
  • Object
show all
Defined in:
lib/comet/models/external_ldapauthentication_source_settings.rb

Overview

ExternalLDAPAuthenticationSourceSettings is a typed class wrapper around the underlying Comet Server API data structure.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ ExternalLDAPAuthenticationSourceSettings

Returns a new instance of ExternalLDAPAuthenticationSourceSettings.



32
33
34
 
# File 'lib/comet/models/external_ldapauthentication_source_settings.rb', line 32

def initialize
  clear
end

Instance Attribute Details

#bind_user ⇒ Object

Returns the value of attribute bind_user.



27
28
29
 
# File 'lib/comet/models/external_ldapauthentication_source_settings.rb', line 27

def bind_user
  @bind_user
end

#hostname ⇒ Object

Returns the value of attribute hostname.



18
19
20
 
# File 'lib/comet/models/external_ldapauthentication_source_settings.rb', line 18

def hostname
  @hostname
end

#port ⇒ Object

Returns the value of attribute port.



21
22
23
 
# File 'lib/comet/models/external_ldapauthentication_source_settings.rb', line 21

def port
  @port
end

#security_method ⇒ Object

Returns the value of attribute security_method.



24
25
26
 
# File 'lib/comet/models/external_ldapauthentication_source_settings.rb', line 24

def security_method
  @security_method
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



30
31
32
 
# File 'lib/comet/models/external_ldapauthentication_source_settings.rb', line 30

def unknown_json_fields
  @unknown_json_fields
end

Instance Method Details

#clear ⇒ Object 



36
37
38
39
40
41
42
 
# File 'lib/comet/models/external_ldapauthentication_source_settings.rb', line 36

def clear
  @hostname = ''
  @port = 0
  @security_method = ''
  @bind_user = ''
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash

Raises:

  • (TypeError) 


52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/comet/models/external_ldapauthentication_source_settings.rb', line 52

def from_hash(obj)
  raise TypeError, "'obj' expected Hash, got #{obj.class}" unless obj.is_a? Hash

  obj.each do |k, v|
    case k
    when 'Hostname'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @hostname = v
    when 'Port'
      raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric

      @port = v
    when 'SecurityMethod'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @security_method = v
    when 'BindUser'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @bind_user = v
    else
      @unknown_json_fields[k] = v
    end
  end
end

#from_json(json_string) ⇒ Object

Parameters:

  • json_string (String) —

    The complete object in JSON format

Raises:

  • (TypeError) 


45
46
47
48
49
 
# File 'lib/comet/models/external_ldapauthentication_source_settings.rb', line 45

def from_json(json_string)
  raise TypeError, "'json_string' expected String, got #{json_string.class}" unless json_string.is_a? String

  from_hash(JSON.parse(json_string))
end

#to_h ⇒ Hash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash) —

    The complete object as a Ruby hash



93
94
95
 
# File 'lib/comet/models/external_ldapauthentication_source_settings.rb', line 93

def to_h
  to_hash
end

#to_hash ⇒ Hash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash) —

    The complete object as a Ruby hash



80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/comet/models/external_ldapauthentication_source_settings.rb', line 80

def to_hash
  ret = {}
  ret['Hostname'] = @hostname
  ret['Port'] = @port
  ret['SecurityMethod'] = @security_method
  ret['BindUser'] = @bind_user
  @unknown_json_fields.each do |k, v|
    ret[k] = v
  end
  ret
end

#to_json(options = {}) ⇒ String

Returns The complete object as a JSON string.

Returns:

  • (String) —

    The complete object as a JSON string



98
99
100
 
# File 'lib/comet/models/external_ldapauthentication_source_settings.rb', line 98

def to_json(options = {})
  to_hash.to_json(options)
end