Class: Comet::ExternalAuthenticationSource

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ ExternalAuthenticationSource

Returns a new instance of ExternalAuthenticationSource.



61
62
63
 
# File 'lib/comet/models/external_authentication_source.rb', line 61

def initialize
  clear
end

Instance Attribute Details

#aws ⇒ Object

Amazon AWS - Virtual Storage Role



50
51
52
 
# File 'lib/comet/models/external_authentication_source.rb', line 50

def aws
  @aws
end

#b2 ⇒ Object

Returns the value of attribute b2.



37
38
39
 
# File 'lib/comet/models/external_authentication_source.rb', line 37

def b2
  @b2
end

#custom ⇒ Object

Returns the value of attribute custom.



43
44
45
 
# File 'lib/comet/models/external_authentication_source.rb', line 43

def custom
  @custom
end

#description ⇒ Object

Returns the value of attribute description.



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

def description
  @description
end

#ldap ⇒ Object

Returns the value of attribute ldap.



31
32
33
 
# File 'lib/comet/models/external_authentication_source.rb', line 31

def ldap
  @ldap
end

#new_user_permissions ⇒ Object

Returns the value of attribute new_user_permissions.



56
57
58
 
# File 'lib/comet/models/external_authentication_source.rb', line 56

def new_user_permissions
  @new_user_permissions
end

#oidc ⇒ Object

Returns the value of attribute oidc.



34
35
36
 
# File 'lib/comet/models/external_authentication_source.rb', line 34

def oidc
  @oidc
end

#password ⇒ Object

Returns the value of attribute password.



28
29
30
 
# File 'lib/comet/models/external_authentication_source.rb', line 28

def password
  @password
end

#remote_address ⇒ Object

Returns the value of attribute remote_address.



22
23
24
 
# File 'lib/comet/models/external_authentication_source.rb', line 22

def remote_address
  @remote_address
end

#s3 ⇒ Object

Returns the value of attribute s3.



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

def s3
  @s3
end

#storj ⇒ Object

Returns the value of attribute storj.



53
54
55
 
# File 'lib/comet/models/external_authentication_source.rb', line 53

def storj
  @storj
end

#type ⇒ Object

Returns the value of attribute type.



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

def type
  @type
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



59
60
61
 
# File 'lib/comet/models/external_authentication_source.rb', line 59

def unknown_json_fields
  @unknown_json_fields
end

#username ⇒ Object

Returns the value of attribute username.



25
26
27
 
# File 'lib/comet/models/external_authentication_source.rb', line 25

def username
  @username
end

#wasabi ⇒ Object

Returns the value of attribute wasabi.



40
41
42
 
# File 'lib/comet/models/external_authentication_source.rb', line 40

def wasabi
  @wasabi
end

Instance Method Details

#clear ⇒ Object 



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/comet/models/external_authentication_source.rb', line 65

def clear
  @type = ''
  @description = ''
  @remote_address = ''
  @username = ''
  @password = ''
  @ldap = Comet::ExternalLDAPAuthenticationSourceSettings.new
  @oidc = Comet::OidcConfig.new
  @b2 = Comet::B2VirtualStorageRoleSettings.new
  @wasabi = Comet::WasabiVirtualStorageRoleSettings.new
  @custom = Comet::CustomRemoteBucketSettings.new
  @s3 = Comet::S3GenericVirtualStorageRole.new
  @aws = Comet::AmazonAWSVirtualStorageRoleSettings.new
  @storj = Comet::StorjVirtualStorageRoleSetting.new
  @new_user_permissions = Comet::AdminUserPermissions.new
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash

Raises:

  • (TypeError) 


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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/comet/models/external_authentication_source.rb', line 91

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 'Type'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

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

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

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

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

      @password = v
    when 'LDAP'
      @ldap = Comet::ExternalLDAPAuthenticationSourceSettings.new
      @ldap.from_hash(v)
    when 'OIDC'
      @oidc = Comet::OidcConfig.new
      @oidc.from_hash(v)
    when 'B2'
      @b2 = Comet::B2VirtualStorageRoleSettings.new
      @b2.from_hash(v)
    when 'Wasabi'
      @wasabi = Comet::WasabiVirtualStorageRoleSettings.new
      @wasabi.from_hash(v)
    when 'Custom'
      @custom = Comet::CustomRemoteBucketSettings.new
      @custom.from_hash(v)
    when 'S3'
      @s3 = Comet::S3GenericVirtualStorageRole.new
      @s3.from_hash(v)
    when 'AWS'
      @aws = Comet::AmazonAWSVirtualStorageRoleSettings.new
      @aws.from_hash(v)
    when 'Storj'
      @storj = Comet::StorjVirtualStorageRoleSetting.new
      @storj.from_hash(v)
    when 'NewUserPermissions'
      @new_user_permissions = Comet::AdminUserPermissions.new
      @new_user_permissions.from_hash(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) 


84
85
86
87
88
 
# File 'lib/comet/models/external_authentication_source.rb', line 84

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



195
196
197
 
# File 'lib/comet/models/external_authentication_source.rb', line 195

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



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/comet/models/external_authentication_source.rb', line 150

def to_hash
  ret = {}
  ret['Type'] = @type
  ret['Description'] = @description
  unless @remote_address.nil?
    ret['RemoteAddress'] = @remote_address
  end
  unless @username.nil?
    ret['Username'] = @username
  end
  unless @password.nil?
    ret['Password'] = @password
  end
  unless @ldap.nil?
    ret['LDAP'] = @ldap
  end
  unless @oidc.nil?
    ret['OIDC'] = @oidc
  end
  unless @b2.nil?
    ret['B2'] = @b2
  end
  unless @wasabi.nil?
    ret['Wasabi'] = @wasabi
  end
  unless @custom.nil?
    ret['Custom'] = @custom
  end
  unless @s3.nil?
    ret['S3'] = @s3
  end
  unless @aws.nil?
    ret['AWS'] = @aws
  end
  unless @storj.nil?
    ret['Storj'] = @storj
  end
  ret['NewUserPermissions'] = @new_user_permissions
  @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



200
201
202
 
# File 'lib/comet/models/external_authentication_source.rb', line 200

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