Class: OCI::GoldenGate::Models::CreateJavaMessageServiceConnectionDetails
- Inherits:
-
CreateConnectionDetails
- Object
- CreateConnectionDetails
- OCI::GoldenGate::Models::CreateJavaMessageServiceConnectionDetails
- Defined in:
- lib/oci/golden_gate/models/create_java_message_service_connection_details.rb
Overview
The information about a new Java Message Service Connection.
Constant Summary
Constants inherited from CreateConnectionDetails
OCI::GoldenGate::Models::CreateConnectionDetails::CONNECTION_TYPE_ENUM, OCI::GoldenGate::Models::CreateConnectionDetails::ROUTING_METHOD_ENUM
Instance Attribute Summary collapse
-
#authentication_type ⇒ String
Authentication type for Java Message Service.
-
#connection_factory ⇒ String
The of Java class implementing javax.jms.ConnectionFactory interface supplied by the Java Message Service provider.
-
#connection_url ⇒ String
Connectin URL of the Java Message Service, specifying the protocol, host, and port.
-
#jndi_connection_factory ⇒ String
The Connection Factory can be looked up using this name.
-
#jndi_initial_context_factory ⇒ String
The implementation of javax.naming.spi.InitialContextFactory interface that the client uses to obtain initial naming context.
-
#jndi_provider_url ⇒ String
The URL that Java Message Service will use to contact the JNDI provider.
-
#jndi_security_credentials ⇒ String
The password associated to the principal.
-
#jndi_security_principal ⇒ String
Specifies the identity of the principal (user) to be authenticated.
-
#key_store ⇒ String
The base64 encoded content of the KeyStore file.
-
#key_store_password ⇒ String
The KeyStore password.
-
#password ⇒ String
The password Oracle GoldenGate uses to connect the associated Java Message Service.
-
#private_ip ⇒ String
Deprecated: this field will be removed in future versions.
-
#security_protocol ⇒ String
Security protocol for Java Message Service.
-
#should_use_jndi ⇒ BOOLEAN
[Required] If set to true, Java Naming and Directory Interface (JNDI) properties should be provided.
-
#ssl_key_password ⇒ String
The password for the cert inside of the KeyStore.
-
#technology_type ⇒ String
[Required] The Java Message Service technology type.
-
#trust_store ⇒ String
The base64 encoded content of the TrustStore file.
-
#trust_store_password ⇒ String
The TrustStore password.
-
#username ⇒ String
The username Oracle GoldenGate uses to connect to the Java Message Service.
Attributes inherited from CreateConnectionDetails
#compartment_id, #connection_type, #defined_tags, #description, #display_name, #freeform_tags, #key_id, #nsg_ids, #routing_method, #subnet_id, #vault_id
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ CreateJavaMessageServiceConnectionDetails
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Methods inherited from CreateConnectionDetails
Constructor Details
#initialize(attributes = {}) ⇒ CreateJavaMessageServiceConnectionDetails
Initializes the object
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 284 285 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 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 |
# File 'lib/oci/golden_gate/models/create_java_message_service_connection_details.rb', line 238 def initialize(attributes = {}) return unless attributes.is_a?(Hash) attributes['connectionType'] = 'JAVA_MESSAGE_SERVICE' super(attributes) # convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v } self.technology_type = attributes[:'technologyType'] if attributes[:'technologyType'] raise 'You cannot provide both :technologyType and :technology_type' if attributes.key?(:'technologyType') && attributes.key?(:'technology_type') self.technology_type = attributes[:'technology_type'] if attributes[:'technology_type'] self.should_use_jndi = attributes[:'shouldUseJndi'] unless attributes[:'shouldUseJndi'].nil? raise 'You cannot provide both :shouldUseJndi and :should_use_jndi' if attributes.key?(:'shouldUseJndi') && attributes.key?(:'should_use_jndi') self.should_use_jndi = attributes[:'should_use_jndi'] unless attributes[:'should_use_jndi'].nil? self.jndi_connection_factory = attributes[:'jndiConnectionFactory'] if attributes[:'jndiConnectionFactory'] raise 'You cannot provide both :jndiConnectionFactory and :jndi_connection_factory' if attributes.key?(:'jndiConnectionFactory') && attributes.key?(:'jndi_connection_factory') self.jndi_connection_factory = attributes[:'jndi_connection_factory'] if attributes[:'jndi_connection_factory'] self.jndi_provider_url = attributes[:'jndiProviderUrl'] if attributes[:'jndiProviderUrl'] raise 'You cannot provide both :jndiProviderUrl and :jndi_provider_url' if attributes.key?(:'jndiProviderUrl') && attributes.key?(:'jndi_provider_url') self.jndi_provider_url = attributes[:'jndi_provider_url'] if attributes[:'jndi_provider_url'] self.jndi_initial_context_factory = attributes[:'jndiInitialContextFactory'] if attributes[:'jndiInitialContextFactory'] raise 'You cannot provide both :jndiInitialContextFactory and :jndi_initial_context_factory' if attributes.key?(:'jndiInitialContextFactory') && attributes.key?(:'jndi_initial_context_factory') self.jndi_initial_context_factory = attributes[:'jndi_initial_context_factory'] if attributes[:'jndi_initial_context_factory'] self.jndi_security_principal = attributes[:'jndiSecurityPrincipal'] if attributes[:'jndiSecurityPrincipal'] raise 'You cannot provide both :jndiSecurityPrincipal and :jndi_security_principal' if attributes.key?(:'jndiSecurityPrincipal') && attributes.key?(:'jndi_security_principal') self.jndi_security_principal = attributes[:'jndi_security_principal'] if attributes[:'jndi_security_principal'] self.jndi_security_credentials = attributes[:'jndiSecurityCredentials'] if attributes[:'jndiSecurityCredentials'] raise 'You cannot provide both :jndiSecurityCredentials and :jndi_security_credentials' if attributes.key?(:'jndiSecurityCredentials') && attributes.key?(:'jndi_security_credentials') self.jndi_security_credentials = attributes[:'jndi_security_credentials'] if attributes[:'jndi_security_credentials'] self.connection_url = attributes[:'connectionUrl'] if attributes[:'connectionUrl'] raise 'You cannot provide both :connectionUrl and :connection_url' if attributes.key?(:'connectionUrl') && attributes.key?(:'connection_url') self.connection_url = attributes[:'connection_url'] if attributes[:'connection_url'] self.connection_factory = attributes[:'connectionFactory'] if attributes[:'connectionFactory'] raise 'You cannot provide both :connectionFactory and :connection_factory' if attributes.key?(:'connectionFactory') && attributes.key?(:'connection_factory') self.connection_factory = attributes[:'connection_factory'] if attributes[:'connection_factory'] self.username = attributes[:'username'] if attributes[:'username'] self.password = attributes[:'password'] if attributes[:'password'] self.security_protocol = attributes[:'securityProtocol'] if attributes[:'securityProtocol'] raise 'You cannot provide both :securityProtocol and :security_protocol' if attributes.key?(:'securityProtocol') && attributes.key?(:'security_protocol') self.security_protocol = attributes[:'security_protocol'] if attributes[:'security_protocol'] self.authentication_type = attributes[:'authenticationType'] if attributes[:'authenticationType'] raise 'You cannot provide both :authenticationType and :authentication_type' if attributes.key?(:'authenticationType') && attributes.key?(:'authentication_type') self.authentication_type = attributes[:'authentication_type'] if attributes[:'authentication_type'] self.trust_store = attributes[:'trustStore'] if attributes[:'trustStore'] raise 'You cannot provide both :trustStore and :trust_store' if attributes.key?(:'trustStore') && attributes.key?(:'trust_store') self.trust_store = attributes[:'trust_store'] if attributes[:'trust_store'] self.trust_store_password = attributes[:'trustStorePassword'] if attributes[:'trustStorePassword'] raise 'You cannot provide both :trustStorePassword and :trust_store_password' if attributes.key?(:'trustStorePassword') && attributes.key?(:'trust_store_password') self.trust_store_password = attributes[:'trust_store_password'] if attributes[:'trust_store_password'] self.key_store = attributes[:'keyStore'] if attributes[:'keyStore'] raise 'You cannot provide both :keyStore and :key_store' if attributes.key?(:'keyStore') && attributes.key?(:'key_store') self.key_store = attributes[:'key_store'] if attributes[:'key_store'] self.key_store_password = attributes[:'keyStorePassword'] if attributes[:'keyStorePassword'] raise 'You cannot provide both :keyStorePassword and :key_store_password' if attributes.key?(:'keyStorePassword') && attributes.key?(:'key_store_password') self.key_store_password = attributes[:'key_store_password'] if attributes[:'key_store_password'] self.ssl_key_password = attributes[:'sslKeyPassword'] if attributes[:'sslKeyPassword'] raise 'You cannot provide both :sslKeyPassword and :ssl_key_password' if attributes.key?(:'sslKeyPassword') && attributes.key?(:'ssl_key_password') self.ssl_key_password = attributes[:'ssl_key_password'] if attributes[:'ssl_key_password'] self.private_ip = attributes[:'privateIp'] if attributes[:'privateIp'] raise 'You cannot provide both :privateIp and :private_ip' if attributes.key?(:'privateIp') && attributes.key?(:'private_ip') self.private_ip = attributes[:'private_ip'] if attributes[:'private_ip'] end |
Instance Attribute Details
#authentication_type ⇒ String
Authentication type for Java Message Service. If not provided, default is NONE. Optional until 2024-06-27, in the release after it will be made required.
87 88 89 |
# File 'lib/oci/golden_gate/models/create_java_message_service_connection_details.rb', line 87 def authentication_type @authentication_type end |
#connection_factory ⇒ String
The of Java class implementing javax.jms.ConnectionFactory interface supplied by the Java Message Service provider. e.g.: 'com.stc.jmsjca.core.JConnectionFactoryXA'
64 65 66 |
# File 'lib/oci/golden_gate/models/create_java_message_service_connection_details.rb', line 64 def connection_factory @connection_factory end |
#connection_url ⇒ String
Connectin URL of the Java Message Service, specifying the protocol, host, and port. e.g.: 'mq://myjms.host.domain:7676'
57 58 59 |
# File 'lib/oci/golden_gate/models/create_java_message_service_connection_details.rb', line 57 def connection_url @connection_url end |
#jndi_connection_factory ⇒ String
The Connection Factory can be looked up using this name. e.g.: 'ConnectionFactory'
27 28 29 |
# File 'lib/oci/golden_gate/models/create_java_message_service_connection_details.rb', line 27 def jndi_connection_factory @jndi_connection_factory end |
#jndi_initial_context_factory ⇒ String
The implementation of javax.naming.spi.InitialContextFactory interface that the client uses to obtain initial naming context. e.g.: 'org.apache.activemq.jndi.ActiveMQInitialContextFactory'
40 41 42 |
# File 'lib/oci/golden_gate/models/create_java_message_service_connection_details.rb', line 40 def jndi_initial_context_factory @jndi_initial_context_factory end |
#jndi_provider_url ⇒ String
The URL that Java Message Service will use to contact the JNDI provider. e.g.: 'tcp://myjms.host.domain:61616?jms.prefetchPolicy.all=1000'
33 34 35 |
# File 'lib/oci/golden_gate/models/create_java_message_service_connection_details.rb', line 33 def jndi_provider_url @jndi_provider_url end |
#jndi_security_credentials ⇒ String
The password associated to the principal.
51 52 53 |
# File 'lib/oci/golden_gate/models/create_java_message_service_connection_details.rb', line 51 def jndi_security_credentials @jndi_security_credentials end |
#jndi_security_principal ⇒ String
Specifies the identity of the principal (user) to be authenticated. e.g.: 'admin2'
46 47 48 |
# File 'lib/oci/golden_gate/models/create_java_message_service_connection_details.rb', line 46 def jndi_security_principal @jndi_security_principal end |
#key_store ⇒ String
The base64 encoded content of the KeyStore file.
102 103 104 |
# File 'lib/oci/golden_gate/models/create_java_message_service_connection_details.rb', line 102 def key_store @key_store end |
#key_store_password ⇒ String
The KeyStore password.
107 108 109 |
# File 'lib/oci/golden_gate/models/create_java_message_service_connection_details.rb', line 107 def key_store_password @key_store_password end |
#password ⇒ String
The password Oracle GoldenGate uses to connect the associated Java Message Service.
75 76 77 |
# File 'lib/oci/golden_gate/models/create_java_message_service_connection_details.rb', line 75 def password @password end |
#private_ip ⇒ String
Deprecated: this field will be removed in future versions. Either specify the private IP in the connectionString or host field, or make sure the host name is resolvable in the target VCN.
The private IP address of the connection's endpoint in the customer's VCN, typically a database endpoint or a big data endpoint (e.g. Kafka bootstrap server). In case the privateIp is provided, the subnetId must also be provided. In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible. In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.
125 126 127 |
# File 'lib/oci/golden_gate/models/create_java_message_service_connection_details.rb', line 125 def private_ip @private_ip end |
#security_protocol ⇒ String
Security protocol for Java Message Service. If not provided, default is PLAIN. Optional until 2024-06-27, in the release after it will be made required.
81 82 83 |
# File 'lib/oci/golden_gate/models/create_java_message_service_connection_details.rb', line 81 def security_protocol @security_protocol end |
#should_use_jndi ⇒ BOOLEAN
[Required] If set to true, Java Naming and Directory Interface (JNDI) properties should be provided.
21 22 23 |
# File 'lib/oci/golden_gate/models/create_java_message_service_connection_details.rb', line 21 def should_use_jndi @should_use_jndi end |
#ssl_key_password ⇒ String
The password for the cert inside of the KeyStore. In case it differs from the KeyStore password, it should be provided.
113 114 115 |
# File 'lib/oci/golden_gate/models/create_java_message_service_connection_details.rb', line 113 def ssl_key_password @ssl_key_password end |
#technology_type ⇒ String
[Required] The Java Message Service technology type.
16 17 18 |
# File 'lib/oci/golden_gate/models/create_java_message_service_connection_details.rb', line 16 def technology_type @technology_type end |
#trust_store ⇒ String
The base64 encoded content of the TrustStore file.
92 93 94 |
# File 'lib/oci/golden_gate/models/create_java_message_service_connection_details.rb', line 92 def trust_store @trust_store end |
#trust_store_password ⇒ String
The TrustStore password.
97 98 99 |
# File 'lib/oci/golden_gate/models/create_java_message_service_connection_details.rb', line 97 def trust_store_password @trust_store_password end |
#username ⇒ String
The username Oracle GoldenGate uses to connect to the Java Message Service. This username must already exist and be available by the Java Message Service to be connected to.
70 71 72 |
# File 'lib/oci/golden_gate/models/create_java_message_service_connection_details.rb', line 70 def username @username end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 |
# File 'lib/oci/golden_gate/models/create_java_message_service_connection_details.rb', line 128 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'connection_type': :'connectionType', 'display_name': :'displayName', 'description': :'description', 'compartment_id': :'compartmentId', 'freeform_tags': :'freeformTags', 'defined_tags': :'definedTags', 'vault_id': :'vaultId', 'key_id': :'keyId', 'nsg_ids': :'nsgIds', 'subnet_id': :'subnetId', 'routing_method': :'routingMethod', 'technology_type': :'technologyType', 'should_use_jndi': :'shouldUseJndi', 'jndi_connection_factory': :'jndiConnectionFactory', 'jndi_provider_url': :'jndiProviderUrl', 'jndi_initial_context_factory': :'jndiInitialContextFactory', 'jndi_security_principal': :'jndiSecurityPrincipal', 'jndi_security_credentials': :'jndiSecurityCredentials', 'connection_url': :'connectionUrl', 'connection_factory': :'connectionFactory', 'username': :'username', 'password': :'password', 'security_protocol': :'securityProtocol', 'authentication_type': :'authenticationType', 'trust_store': :'trustStore', 'trust_store_password': :'trustStorePassword', 'key_store': :'keyStore', 'key_store_password': :'keyStorePassword', 'ssl_key_password': :'sslKeyPassword', 'private_ip': :'privateIp' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
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 |
# File 'lib/oci/golden_gate/models/create_java_message_service_connection_details.rb', line 166 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'connection_type': :'String', 'display_name': :'String', 'description': :'String', 'compartment_id': :'String', 'freeform_tags': :'Hash<String, String>', 'defined_tags': :'Hash<String, Hash<String, Object>>', 'vault_id': :'String', 'key_id': :'String', 'nsg_ids': :'Array<String>', 'subnet_id': :'String', 'routing_method': :'String', 'technology_type': :'String', 'should_use_jndi': :'BOOLEAN', 'jndi_connection_factory': :'String', 'jndi_provider_url': :'String', 'jndi_initial_context_factory': :'String', 'jndi_security_principal': :'String', 'jndi_security_credentials': :'String', 'connection_url': :'String', 'connection_factory': :'String', 'username': :'String', 'password': :'String', 'security_protocol': :'String', 'authentication_type': :'String', 'trust_store': :'String', 'trust_store_password': :'String', 'key_store': :'String', 'key_store_password': :'String', 'ssl_key_password': :'String', 'private_ip': :'String' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 |
# File 'lib/oci/golden_gate/models/create_java_message_service_connection_details.rb', line 362 def ==(other) return true if equal?(other) self.class == other.class && connection_type == other.connection_type && display_name == other.display_name && description == other.description && compartment_id == other.compartment_id && == other. && == other. && vault_id == other.vault_id && key_id == other.key_id && nsg_ids == other.nsg_ids && subnet_id == other.subnet_id && routing_method == other.routing_method && technology_type == other.technology_type && should_use_jndi == other.should_use_jndi && jndi_connection_factory == other.jndi_connection_factory && jndi_provider_url == other.jndi_provider_url && jndi_initial_context_factory == other.jndi_initial_context_factory && jndi_security_principal == other.jndi_security_principal && jndi_security_credentials == other.jndi_security_credentials && connection_url == other.connection_url && connection_factory == other.connection_factory && username == other.username && password == other.password && security_protocol == other.security_protocol && authentication_type == other.authentication_type && trust_store == other.trust_store && trust_store_password == other.trust_store_password && key_store == other.key_store && key_store_password == other.key_store_password && ssl_key_password == other.ssl_key_password && private_ip == other.private_ip end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 |
# File 'lib/oci/golden_gate/models/create_java_message_service_connection_details.rb', line 421 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_types.each_pair do |key, type| if type =~ /^Array<(.*)>/i # check to ensure the input is an array given that the the attribute # is documented as an array but the input is not if attributes[self.class.attribute_map[key]].is_a?(Array) public_method("#{key}=").call( attributes[self.class.attribute_map[key]] .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) } ) end elsif !attributes[self.class.attribute_map[key]].nil? public_method("#{key}=").call( OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]]) ) end # or else data not found in attributes(hash), not an issue as the data can be optional end self end |
#eql?(other) ⇒ Boolean
401 402 403 |
# File 'lib/oci/golden_gate/models/create_java_message_service_connection_details.rb', line 401 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
410 411 412 |
# File 'lib/oci/golden_gate/models/create_java_message_service_connection_details.rb', line 410 def hash [connection_type, display_name, description, compartment_id, , , vault_id, key_id, nsg_ids, subnet_id, routing_method, technology_type, should_use_jndi, jndi_connection_factory, jndi_provider_url, jndi_initial_context_factory, jndi_security_principal, jndi_security_credentials, connection_url, connection_factory, username, password, security_protocol, authentication_type, trust_store, trust_store_password, key_store, key_store_password, ssl_key_password, private_ip].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
454 455 456 457 458 459 460 461 462 463 |
# File 'lib/oci/golden_gate/models/create_java_message_service_connection_details.rb', line 454 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = public_method(attr).call next if value.nil? && !instance_variable_defined?("@#{attr}") hash[param] = _to_hash(value) end hash end |
#to_s ⇒ String
Returns the string representation of the object
448 449 450 |
# File 'lib/oci/golden_gate/models/create_java_message_service_connection_details.rb', line 448 def to_s to_hash.to_s end |