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.



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

def initialize
  clear
end

Instance Attribute Details

#accept_invalid_ssl ⇒ Object

Returns the value of attribute accept_invalid_ssl.



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

def accept_invalid_ssl
  @accept_invalid_ssl
end

#bind_password ⇒ Object

Returns the value of attribute bind_password.



35
36
37
 
# File 'lib/comet/models/external_ldapauthentication_source_settings.rb', line 35

def bind_password
  @bind_password
end

#bind_user ⇒ Object

Returns the value of attribute bind_user.



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

def bind_user
  @bind_user
end

#fallback_servers ⇒ Object

Returns the value of attribute fallback_servers.



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

def fallback_servers
  @fallback_servers
end

#hostname ⇒ Object

Returns the value of attribute hostname.



16
17
18
 
# File 'lib/comet/models/external_ldapauthentication_source_settings.rb', line 16

def hostname
  @hostname
end

#port ⇒ Object

Returns the value of attribute port.



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

def port
  @port
end

#search_dn ⇒ Object

Returns the value of attribute search_dn.



38
39
40
 
# File 'lib/comet/models/external_ldapauthentication_source_settings.rb', line 38

def search_dn
  @search_dn
end

#search_filter ⇒ Object

Returns the value of attribute search_filter.



41
42
43
 
# File 'lib/comet/models/external_ldapauthentication_source_settings.rb', line 41

def search_filter
  @search_filter
end

#security_method ⇒ Object

One of the LDAPSECURITYMETHOD_ constants (e.g. “plain” / “ldaps” / “starttls”)



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

def security_method
  @security_method
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



44
45
46
 
# File 'lib/comet/models/external_ldapauthentication_source_settings.rb', line 44

def unknown_json_fields
  @unknown_json_fields
end

Instance Method Details

#clear ⇒ Object 



50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/comet/models/external_ldapauthentication_source_settings.rb', line 50

def clear
  @hostname = ''
  @port = 0
  @security_method = ''
  @fallback_servers = []
  @bind_user = ''
  @bind_password = ''
  @search_dn = ''
  @search_filter = ''
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash

Raises:

  • (TypeError) 


70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/comet/models/external_ldapauthentication_source_settings.rb', line 70

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 'AcceptInvalidSSL'
      @accept_invalid_ssl = v
    when 'FallbackServers'
      if v.nil?
        @fallback_servers = []
      else
        @fallback_servers = Array.new(v.length)
        v.each_with_index do |v1, i1|
          @fallback_servers[i1] = Comet::ExternalLDAPAuthenticationSourceServer.new
          @fallback_servers[i1].from_hash(v1)
        end
      end
    when 'BindUser'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

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

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

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

      @search_filter = 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) 


63
64
65
66
67
 
# File 'lib/comet/models/external_ldapauthentication_source_settings.rb', line 63

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



140
141
142
 
# File 'lib/comet/models/external_ldapauthentication_source_settings.rb', line 140

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



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/comet/models/external_ldapauthentication_source_settings.rb', line 122

def to_hash
  ret = {}
  ret['Hostname'] = @hostname
  ret['Port'] = @port
  ret['SecurityMethod'] = @security_method
  ret['AcceptInvalidSSL'] = @accept_invalid_ssl
  ret['FallbackServers'] = @fallback_servers
  ret['BindUser'] = @bind_user
  ret['BindPassword'] = @bind_password
  ret['SearchDN'] = @search_dn
  ret['SearchFilter'] = @search_filter
  @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



145
146
147
 
# File 'lib/comet/models/external_ldapauthentication_source_settings.rb', line 145

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