Simba::JNIDSI Namespace Reference

Classes

class  JNIArguments
 A class that translates an array of Java strings and make them presentable to SimbaServer. More...

Functions

simba_string GetFullJavaDriverName ()
 Returns the full class name of the Java driver implementation.
JavaVM * JvmFactory ()
 Factory function to provide the JavaVM pointer.
void SetClassLoader (jobject in_classLoader)
 Set the Java classLoader Object from the invoking Java program.
void SetConfigurationBranding ()
 Sets the branding to use for the configuration source. On Windows, this is used for a key in the registry under Software. Default: "Simba" On Unix platforms, this is used for a configuration file name. Default "simba.ini"

  • Note: The file will be looked for in several directories in order: 1. <current_working_directory>/<branding> 2. $HOME/.<branding> 3. /etc/<branding>

void SetInvokerObject (jobject in_invokerObj)
 Set the object that invokes the first JNI call to start SimbaServer.
void SetMessageSourceComponentName (simba_int32 in_componentID, const simba_wstring &in_componentName)
 Override the name used for a component by the native message source (Used for diagnostics originating from the native code).
void SetMessageSourcePrefixesVendorName (bool in_vendorNamePrefixed)
 Controls whether the native message source (Used for diagnostics originating from the native code) prefixes messages with the vendor name.
void SetMessageSourceVendorName (const simba_wstring &in_vendorName)
 Overrides the vendor name used for the native message source (Used for diagnostics originating from the native code).
JavaVM * SimbaJvmFactory ()
 Default factory function to provide the JavaVM pointer.
JNIArgumentsTranslateJavaArgs (jobjectArray in_stringArray)
 Translates an array of Java string arguments.

Variables

const simba_int16 JDBC_BOOLEAN = 16
 The typecode for the JDBC BOOLEAN type.
const simba_int32 JNIDSI_ERROR = 50
 Defines the component ID of JNIDSI.

Function Documentation

simba_string Simba::JNIDSI::GetFullJavaDriverName (  ) 

Returns the full class name of the Java driver implementation.

Returns:
The full class name of the Java driver implementation as a string.
JavaVM* Simba::JNIDSI::JvmFactory (  ) 

Factory function to provide the JavaVM pointer.

The resulting object is made available through JvmWrapper::GetInstance().

Exceptions:
std::exception if an error occurs while creating the JVM.
Returns:
JavaVM pointer. (OWN)
void Simba::JNIDSI::SetClassLoader ( jobject  in_classLoader  ) 

Set the Java classLoader Object from the invoking Java program.

The class loader will be used by the customer JavaDSI.

NOTE: This is only meaningful when the JNIDSI is built as a DLL and is to be loaded and invoked from a Java program.

Parameters:
in_classLoader The class loader to be used by the JavaDSI.
void Simba::JNIDSI::SetConfigurationBranding (  ) 

Sets the branding to use for the configuration source. On Windows, this is used for a key in the registry under Software. Default: "Simba" On Unix platforms, this is used for a configuration file name. Default "simba.ini"

  • Note: The file will be looked for in several directories in order: 1. <current_working_directory>/<branding> 2. $HOME/.<branding> 3. /etc/<branding>

void Simba::JNIDSI::SetInvokerObject ( jobject  in_invokerObj  ) 

Set the object that invokes the first JNI call to start SimbaServer.

NOTE: This is only meaningful when the JNIDSI is built as a DLL and is to be loaded and invoked from a Java program.

Parameters:
in_invokerObj The java object that invokes the first JNI class to start SibmaServer.
void Simba::JNIDSI::SetMessageSourceComponentName ( simba_int32  in_componentID,
const simba_wstring in_componentName 
)

Override the name used for a component by the native message source (Used for diagnostics originating from the native code).

See Simba::DSI::DSIMessageSource::SetComponentName()

Parameters:
in_componentID The component ID for the component who's name to override.
in_componentName The new name for the component.
void Simba::JNIDSI::SetMessageSourcePrefixesVendorName ( bool  in_vendorNamePrefixed  ) 

Controls whether the native message source (Used for diagnostics originating from the native code) prefixes messages with the vendor name.

See Simba::DSI::DSIMessageSource::SetVendorStringPrefixed()

Parameters:
in_vendorNamePrefixed Whether the native message source prefixes messages with the vendor name.
void Simba::JNIDSI::SetMessageSourceVendorName ( const simba_wstring in_vendorName  ) 

Overrides the vendor name used for the native message source (Used for diagnostics originating from the native code).

See Simba::DSI::DSIMessageSource::SetVendorName()

Parameters:
in_vendorName The vendor name to use instead of 'SIMBA'.
JavaVM* Simba::JNIDSI::SimbaJvmFactory (  ) 

Default factory function to provide the JavaVM pointer.

This uses the JNIConfig registry entry to create a JVM, as used in the sample drivers.

Exceptions:
std::exception if an error occurs while creating the JVM.
Returns:
JavaVM pointer. (OWN)
JNIArguments* Simba::JNIDSI::TranslateJavaArgs ( jobjectArray  in_stringArray  ) 

Translates an array of Java string arguments.

This methods creates an argument container that encapsulates the translated Java string arguments. The arguments can be used to start SimbaServer by Simba::Server::StartServer();

Parameters:
in_stringArray An array of Java string arguments.
Returns:
An object that encapsulates the Java string arguments. (OWN).

Variable Documentation

const simba_int16 JDBC_BOOLEAN = 16

The typecode for the JDBC BOOLEAN type.

const simba_int32 JNIDSI_ERROR = 50

Defines the component ID of JNIDSI.


Generated on Wed May 17 14:21:16 2017 for SimbaEngine 10.1.3.1011 by simba