Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace CreateJavaMessageServiceConnectionDetails

The information about a new Java Message Service Connection.

Properties

Optional authenticationType

authenticationType: undefined | 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.

Optional clusterPlacementGroupId

clusterPlacementGroupId: undefined | string

The OCID(/Content/General/Concepts/identifiers.htm) of the cluster placement group for the resource. Only applicable for multicloud subscriptions. The cluster placement group id must be provided when a multicloud subscription id is provided. Otherwise the cluster placement group must not be provided.

compartmentId

compartmentId: string

The OCID of the compartment being referenced.

Optional connectionFactory

connectionFactory: undefined | string

The of Java class implementing javax.jms.ConnectionFactory interface supplied by the Java Message Service provider. e.g.: 'com.stc.jmsjca.core.JConnectionFactoryXA'

Const connectionType

connectionType: string = "JAVA_MESSAGE_SERVICE"

Optional connectionUrl

connectionUrl: undefined | string

Connection URL of the Java Message Service, specifying the protocol, host, and port. e.g.: 'mq://myjms.host.domain:7676'

Optional definedTags

definedTags: undefined | object

Tags defined for this resource. Each key is predefined and scoped to a namespace.

Example: {@code {\"foo-namespace\": {\"bar-key\": \"value\"}}}

Optional description

description: undefined | string

Metadata about this specific object.

displayName

displayName: string

An object's Display Name.

Optional doesUseSecretIds

doesUseSecretIds: undefined | false | true

Indicates that sensitive attributes are provided via Secrets.

Optional freeformTags

freeformTags: undefined | object

A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only.

Example: {@code {\"bar-key\": \"value\"}}

Optional jndiConnectionFactory

jndiConnectionFactory: undefined | string

The Connection Factory can be looked up using this name. e.g.: 'ConnectionFactory'

Optional jndiInitialContextFactory

jndiInitialContextFactory: undefined | 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'

Optional jndiProviderUrl

jndiProviderUrl: undefined | 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'

Optional jndiSecurityCredentials

jndiSecurityCredentials: undefined | string

The password associated to the principal. Deprecated: This field is deprecated and replaced by "jndiSecurityCredentialsSecretId". This field will be removed after February 15 2026.

Optional jndiSecurityCredentialsSecretId

jndiSecurityCredentialsSecretId: undefined | string

The OCID of the Secret where the security credentials are stored associated to the principal. Note: When provided, 'jndiSecurityCredentials' field must not be provided.

Optional jndiSecurityPrincipal

jndiSecurityPrincipal: undefined | string

Specifies the identity of the principal (user) to be authenticated. e.g.: 'admin2'

Optional keyId

keyId: undefined | string

Refers to the customer's master key OCID. If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.

Optional keyStore

keyStore: undefined | string

The base64 encoded content of the KeyStore file. Deprecated: This field is deprecated and replaced by "keyStoreSecretId". This field will be removed after February 15 2026.

Optional keyStorePassword

keyStorePassword: undefined | string

The KeyStore password. Deprecated: This field is deprecated and replaced by "keyStorePasswordSecretId". This field will be removed after February 15 2026.

Optional keyStorePasswordSecretId

keyStorePasswordSecretId: undefined | string

The OCID of the Secret where the KeyStore password is stored. Note: When provided, 'keyStorePassword' field must not be provided.

Optional keyStoreSecretId

keyStoreSecretId: undefined | string

The OCID of the Secret where the content of the KeyStore file is stored. Note: When provided, 'keyStore' field must not be provided.

Optional locks

Locks associated with this resource.

Optional nsgIds

nsgIds: Array<string>

An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.

Optional password

password: undefined | string

The password Oracle GoldenGate uses to connect the associated Java Message Service. Deprecated: This field is deprecated and replaced by "passwordSecretId". This field will be removed after February 15 2026.

Optional passwordSecretId

passwordSecretId: undefined | string

The OCID of the Secret where the password is stored, that Oracle GoldenGate uses to connect the associated Java Message Service. Note: When provided, 'password' field must not be provided.

Optional privateIp

privateIp: undefined | 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.

Optional routingMethod

routingMethod: model.RoutingMethod

Controls the network traffic direction to the target: SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets. SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet. DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.

Optional securityAttributes

securityAttributes: undefined | object

Security attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {@code {\"Oracle-ZPR\": {\"MaxEgressCount\": {\"value\": \"42\", \"mode\": \"enforce\"}}}}

Optional securityProtocol

securityProtocol: undefined | 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.

shouldUseJndi

shouldUseJndi: boolean

If set to true, Java Naming and Directory Interface (JNDI) properties should be provided.

Optional sslKeyPassword

sslKeyPassword: undefined | string

The password for the cert inside of the KeyStore. In case it differs from the KeyStore password, it should be provided. Deprecated: This field is deprecated and replaced by "sslKeyPasswordSecretId". This field will be removed after February 15 2026.

Optional sslKeyPasswordSecretId

sslKeyPasswordSecretId: undefined | string

The OCID of the Secret where the password is stored for the cert inside of the Keystore. In case it differs from the KeyStore password, it should be provided. Note: When provided, 'sslKeyPassword' field must not be provided.

Optional subnetId

subnetId: undefined | string

The OCID of the target subnet of the dedicated connection.

Optional subscriptionId

subscriptionId: undefined | string

The OCID of the subscription with which resource needs to be associated with.

technologyType

technologyType: string

The Java Message Service technology type.

Optional trustStore

trustStore: undefined | string

The base64 encoded content of the TrustStore file. Deprecated: This field is deprecated and replaced by "trustStoreSecretId". This field will be removed after February 15 2026.

Optional trustStorePassword

trustStorePassword: undefined | string

The TrustStore password. Deprecated: This field is deprecated and replaced by "trustStorePasswordSecretId". This field will be removed after February 15 2026.

Optional trustStorePasswordSecretId

trustStorePasswordSecretId: undefined | string

The OCID of the Secret where the TrustStore password is stored. Note: When provided, 'trustStorePassword' field must not be provided.

Optional trustStoreSecretId

trustStoreSecretId: undefined | string

The OCID of the Secret where the content of the TrustStore file is stored. Note: When provided, 'trustStore' field must not be provided.

Optional username

username: undefined | 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.

Optional vaultId

vaultId: undefined | string

Refers to the customer's vault OCID. If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate to manage secrets contained within this vault.

Methods

getDeserializedJsonObj

getJsonObj