Package com.oracle.bmc.goldengate.model

Class JavaMessageServiceConnection

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20200407")
public final class JavaMessageServiceConnection
extends Connection
    Represents the metadata of a Java Message Service Connection.
    Note: Objects should always be created or deserialized using the JavaMessageServiceConnection.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the JavaMessageServiceConnection.Builder, which maintain a set of all explicitly set fields called JavaMessageServiceConnection.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

    • Method Detail

      • getShouldUseJndi

        public Boolean getShouldUseJndi()
        If set to true, Java Naming and Directory Interface (JNDI) properties should be provided.
        Returns:
        the value

      • getJndiConnectionFactory

        public String getJndiConnectionFactory()
        The Connection Factory can be looked up using this name.

        e.g.: ‘ConnectionFactory’

        Returns:
        the value

      • getJndiProviderUrl

        public String getJndiProviderUrl()
        The URL that Java Message Service will use to contact the JNDI provider.

        e.g.: ‘tcp://myjms.host.domain:61616?jms.prefetchPolicy.all=1000’

        Returns:
        the value

      • getJndiInitialContextFactory

        public String getJndiInitialContextFactory()
        The implementation of javax.naming.spi.InitialContextFactory interface that the client uses to obtain initial naming context.

        e.g.: ‘org.apache.activemq.jndi.ActiveMQInitialContextFactory’

        Returns:
        the value

      • getJndiSecurityPrincipal

        public String getJndiSecurityPrincipal()
        Specifies the identity of the principal (user) to be authenticated.

        e.g.: ‘admin2’

        Returns:
        the value

      • getConnectionUrl

        public String getConnectionUrl()
        Connection URL of the Java Message Service, specifying the protocol, host, and port.

        e.g.: ‘mq://myjms.host.domain:7676’

        Returns:
        the value

      • getConnectionFactory

        public String getConnectionFactory()
        The of Java class implementing javax.jms.ConnectionFactory interface supplied by the Java Message Service provider.

        e.g.: ‘com.stc.jmsjca.core.JConnectionFactoryXA’

        Returns:
        the value

      • getSecurityProtocol

        public JavaMessageServiceConnection.SecurityProtocol getSecurityProtocol()
        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.

        Returns:
        the value

      • getAuthenticationType

        public JavaMessageServiceConnection.AuthenticationType getAuthenticationType()
        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.

        Returns:
        the value

      • getUsername

        public String getUsername()
        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.

        Returns:
        the value

      • getPrivateIp

        public String getPrivateIp()
        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.

        Returns:
        the value

      • getJndiSecurityCredentialsSecretId

        public String getJndiSecurityCredentialsSecretId()
        The OCID of the Secret where the security credentials are stored associated to the principal.

        Note: When provided, ‘jndiSecurityCredentials’ field must not be provided.

        Returns:
        the value

      • getPasswordSecretId

        public String getPasswordSecretId()
        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.

        Returns:
        the value

      • getTrustStoreSecretId

        public String getTrustStoreSecretId()
        The OCID of the Secret where the content of the TrustStore file is stored.

        Note: When provided, ‘trustStore’ field must not be provided.

        Returns:
        the value

      • getTrustStorePasswordSecretId

        public String getTrustStorePasswordSecretId()
        The OCID of the Secret where the TrustStore password is stored.

        Note: When provided, ‘trustStorePassword’ field must not be provided.

        Returns:
        the value

      • getKeyStoreSecretId

        public String getKeyStoreSecretId()
        The OCID of the Secret where the content of the KeyStore file is stored.

        Note: When provided, ‘keyStore’ field must not be provided.

        Returns:
        the value

      • getKeyStorePasswordSecretId

        public String getKeyStorePasswordSecretId()
        The OCID of the Secret where the KeyStore password is stored.

        Note: When provided, ‘keyStorePassword’ field must not be provided.

        Returns:
        the value

      • getSslKeyPasswordSecretId

        public String getSslKeyPasswordSecretId()
        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.

        Returns:
        the value

      • toString

        public String toString​(boolean includeByteArrayContents)
        Return a string representation of the object.
        Overrides:
        toString in class Connection
        Parameters:
        includeByteArrayContents - true to include the full contents of byte arrays
        Returns:
        string representation