Class: Comet::PrivateBrandingProperties

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ PrivateBrandingProperties

Returns a new instance of PrivateBrandingProperties.



114
115
116
 
# File 'lib/comet/models/private_branding_properties.rb', line 114

def initialize
  clear
end

Instance Attribute Details

#build_mode ⇒ Object

One of the CLIENTBRANDINGBUILD_ constants



17
18
19
 
# File 'lib/comet/models/private_branding_properties.rb', line 17

def build_mode
  @build_mode
end

#mac_oscode_sign ⇒ Object

Returns the value of attribute mac_oscode_sign.



109
110
111
 
# File 'lib/comet/models/private_branding_properties.rb', line 109

def mac_oscode_sign
  @mac_oscode_sign
end

#package_identifier ⇒ Object

Returns the value of attribute package_identifier.



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

def package_identifier
  @package_identifier
end

#path_app_icon_image ⇒ Object

Returns the value of attribute path_app_icon_image.



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

def path_app_icon_image
  @path_app_icon_image
end

#path_eula_rtf ⇒ Object

Returns the value of attribute path_eula_rtf.



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

def path_eula_rtf
  @path_eula_rtf
end

#path_header_image ⇒ Object

Returns the value of attribute path_header_image.



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

def path_header_image
  @path_header_image
end

#path_icns_file ⇒ Object

Returns the value of attribute path_icns_file.



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

def path_icns_file
  @path_icns_file
end

#path_ico_file ⇒ Object

Returns the value of attribute path_ico_file.



20
21
22
 
# File 'lib/comet/models/private_branding_properties.rb', line 20

def path_ico_file
  @path_ico_file
end

#path_menu_bar_icns_file ⇒ Object

Returns the value of attribute path_menu_bar_icns_file.



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

def path_menu_bar_icns_file
  @path_menu_bar_icns_file
end

#path_tile_png ⇒ Object

Returns the value of attribute path_tile_png.



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

def path_tile_png
  @path_tile_png
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



112
113
114
 
# File 'lib/comet/models/private_branding_properties.rb', line 112

def unknown_json_fields
  @unknown_json_fields
end

#windows_code_sign_azure_app_id ⇒ Object

Returns the value of attribute windows_code_sign_azure_app_id.



84
85
86
 
# File 'lib/comet/models/private_branding_properties.rb', line 84

def windows_code_sign_azure_app_id
  @windows_code_sign_azure_app_id
end

#windows_code_sign_azure_app_secret ⇒ Object

Returns the value of attribute windows_code_sign_azure_app_secret.



91
92
93
 
# File 'lib/comet/models/private_branding_properties.rb', line 91

def windows_code_sign_azure_app_secret
  @windows_code_sign_azure_app_secret
end

#windows_code_sign_azure_app_secret_format ⇒ Object

One of the ENCRYPTIONMETHOD_ constants



88
89
90
 
# File 'lib/comet/models/private_branding_properties.rb', line 88

def windows_code_sign_azure_app_secret_format
  @windows_code_sign_azure_app_secret_format
end

#windows_code_sign_azure_cert_name ⇒ Object

Returns the value of attribute windows_code_sign_azure_cert_name.



81
82
83
 
# File 'lib/comet/models/private_branding_properties.rb', line 81

def windows_code_sign_azure_cert_name
  @windows_code_sign_azure_cert_name
end

#windows_code_sign_azure_tenant_id ⇒ Object

Returns the value of attribute windows_code_sign_azure_tenant_id.



94
95
96
 
# File 'lib/comet/models/private_branding_properties.rb', line 94

def windows_code_sign_azure_tenant_id
  @windows_code_sign_azure_tenant_id
end

#windows_code_sign_azure_vault_name ⇒ Object

Returns the value of attribute windows_code_sign_azure_vault_name.



78
79
80
 
# File 'lib/comet/models/private_branding_properties.rb', line 78

def windows_code_sign_azure_vault_name
  @windows_code_sign_azure_vault_name
end

#windows_code_sign_method ⇒ Object

One of the WINDOWSCODESIGN_METHOD_ constants



45
46
47
 
# File 'lib/comet/models/private_branding_properties.rb', line 45

def windows_code_sign_method
  @windows_code_sign_method
end

#windows_code_sign_pkcs11certfile ⇒ Object

This field was deprecated between 23.3.0 and 23.6.x, but is now used again.



65
66
67
 
# File 'lib/comet/models/private_branding_properties.rb', line 65

def windows_code_sign_pkcs11certfile
  @windows_code_sign_pkcs11certfile
end

#windows_code_sign_pkcs11engine ⇒ Object

Returns the value of attribute windows_code_sign_pkcs11engine.



58
59
60
 
# File 'lib/comet/models/private_branding_properties.rb', line 58

def windows_code_sign_pkcs11engine
  @windows_code_sign_pkcs11engine
end

#windows_code_sign_pkcs11key_id ⇒ Object

Returns the value of attribute windows_code_sign_pkcs11key_id.



68
69
70
 
# File 'lib/comet/models/private_branding_properties.rb', line 68

def windows_code_sign_pkcs11key_id
  @windows_code_sign_pkcs11key_id
end

#windows_code_sign_pkcs11module ⇒ Object

Returns the value of attribute windows_code_sign_pkcs11module.



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

def windows_code_sign_pkcs11module
  @windows_code_sign_pkcs11module
end

#windows_code_sign_pkcs11password ⇒ Object

Returns the value of attribute windows_code_sign_pkcs11password.



75
76
77
 
# File 'lib/comet/models/private_branding_properties.rb', line 75

def windows_code_sign_pkcs11password
  @windows_code_sign_pkcs11password
end

#windows_code_sign_pkcs11password_format ⇒ Object

One of the ENCRYPTIONMETHOD_ constants



72
73
74
 
# File 'lib/comet/models/private_branding_properties.rb', line 72

def windows_code_sign_pkcs11password_format
  @windows_code_sign_pkcs11password_format
end

#windows_code_sign_pkcs12file_path ⇒ Object

Returns the value of attribute windows_code_sign_pkcs12file_path.



48
49
50
 
# File 'lib/comet/models/private_branding_properties.rb', line 48

def windows_code_sign_pkcs12file_path
  @windows_code_sign_pkcs12file_path
end

#windows_code_sign_pkcs12password ⇒ Object

Returns the value of attribute windows_code_sign_pkcs12password.



55
56
57
 
# File 'lib/comet/models/private_branding_properties.rb', line 55

def windows_code_sign_pkcs12password
  @windows_code_sign_pkcs12password
end

#windows_code_sign_pkcs12password_format ⇒ Object

One of the ENCRYPTIONMETHOD_ constants



52
53
54
 
# File 'lib/comet/models/private_branding_properties.rb', line 52

def windows_code_sign_pkcs12password_format
  @windows_code_sign_pkcs12password_format
end

#windows_code_sign_relic_key_name ⇒ Object

The name of the key to select on the remote SAS Relic server



106
107
108
 
# File 'lib/comet/models/private_branding_properties.rb', line 106

def windows_code_sign_relic_key_name
  @windows_code_sign_relic_key_name
end

#windows_code_sign_relic_keypair_file ⇒ Object

The SAS Relic client keypair in PEM format



102
103
104
 
# File 'lib/comet/models/private_branding_properties.rb', line 102

def windows_code_sign_relic_keypair_file
  @windows_code_sign_relic_keypair_file
end

#windows_code_sign_relic_server_url ⇒ Object

URL of the SAS Relic server, with protocol (https://) and trailing slash



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

def windows_code_sign_relic_server_url
  @windows_code_sign_relic_server_url
end

Instance Method Details

#clear ⇒ Object 



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
148
149
 
# File 'lib/comet/models/private_branding_properties.rb', line 118

def clear
  @build_mode = 0
  @path_ico_file = ''
  @path_icns_file = ''
  @path_menu_bar_icns_file = ''
  @path_eula_rtf = ''
  @path_tile_png = ''
  @path_header_image = ''
  @path_app_icon_image = ''
  @package_identifier = ''
  @windows_code_sign_method = 0
  @windows_code_sign_pkcs12file_path = ''
  @windows_code_sign_pkcs12password_format = 0
  @windows_code_sign_pkcs12password = ''
  @windows_code_sign_pkcs11engine = ''
  @windows_code_sign_pkcs11module = ''
  @windows_code_sign_pkcs11certfile = ''
  @windows_code_sign_pkcs11key_id = ''
  @windows_code_sign_pkcs11password_format = 0
  @windows_code_sign_pkcs11password = ''
  @windows_code_sign_azure_vault_name = ''
  @windows_code_sign_azure_cert_name = ''
  @windows_code_sign_azure_app_id = ''
  @windows_code_sign_azure_app_secret_format = 0
  @windows_code_sign_azure_app_secret = ''
  @windows_code_sign_azure_tenant_id = ''
  @windows_code_sign_relic_server_url = ''
  @windows_code_sign_relic_keypair_file = ''
  @windows_code_sign_relic_key_name = ''
  @mac_oscode_sign = Comet::MacOSCodeSignProperties.new
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash

Raises:

  • (TypeError) 


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
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/comet/models/private_branding_properties.rb', line 159

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

      @windows_code_sign_relic_key_name = v
    when 'MacOSCodeSign'
      @mac_oscode_sign = Comet::MacOSCodeSignProperties.new
      @mac_oscode_sign.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) 


152
153
154
155
156
 
# File 'lib/comet/models/private_branding_properties.rb', line 152

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



324
325
326
 
# File 'lib/comet/models/private_branding_properties.rb', line 324

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



286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/comet/models/private_branding_properties.rb', line 286

def to_hash
  ret = {}
  ret['BuildMode'] = @build_mode
  ret['PathIcoFile'] = @path_ico_file
  ret['PathIcnsFile'] = @path_icns_file
  ret['PathMenuBarIcnsFile'] = @path_menu_bar_icns_file
  ret['PathEulaRtf'] = @path_eula_rtf
  ret['PathTilePng'] = @path_tile_png
  ret['PathHeaderImage'] = @path_header_image
  ret['PathAppIconImage'] = @path_app_icon_image
  ret['PackageIdentifier'] = @package_identifier
  ret['WindowsCodeSignMethod'] = @windows_code_sign_method
  ret['WindowsCodeSignPKCS12FilePath'] = @windows_code_sign_pkcs12file_path
  ret['WindowsCodeSignPKCS12PasswordFormat'] = @windows_code_sign_pkcs12password_format
  ret['WindowsCodeSignPKCS12Password'] = @windows_code_sign_pkcs12password
  ret['WindowsCodeSignPKCS11Engine'] = @windows_code_sign_pkcs11engine
  ret['WindowsCodeSignPKCS11Module'] = @windows_code_sign_pkcs11module
  ret['WindowsCodeSignPKCS11Certfile'] = @windows_code_sign_pkcs11certfile
  ret['WindowsCodeSignPKCS11KeyID'] = @windows_code_sign_pkcs11key_id
  ret['WindowsCodeSignPKCS11PasswordFormat'] = @windows_code_sign_pkcs11password_format
  ret['WindowsCodeSignPKCS11Password'] = @windows_code_sign_pkcs11password
  ret['WindowsCodeSignAzureVaultName'] = @windows_code_sign_azure_vault_name
  ret['WindowsCodeSignAzureCertName'] = @windows_code_sign_azure_cert_name
  ret['WindowsCodeSignAzureAppID'] = @windows_code_sign_azure_app_id
  ret['WindowsCodeSignAzureAppSecretFormat'] = @windows_code_sign_azure_app_secret_format
  ret['WindowsCodeSignAzureAppSecret'] = @windows_code_sign_azure_app_secret
  ret['WindowsCodeSignAzureTenantID'] = @windows_code_sign_azure_tenant_id
  ret['WindowsCodeSignRelicServerURL'] = @windows_code_sign_relic_server_url
  ret['WindowsCodeSignRelicKeypairFile'] = @windows_code_sign_relic_keypair_file
  ret['WindowsCodeSignRelicKeyName'] = @windows_code_sign_relic_key_name
  ret['MacOSCodeSign'] = @mac_oscode_sign
  @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



329
330
331
 
# File 'lib/comet/models/private_branding_properties.rb', line 329

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