com.businessobjects.sdk.plugin.desktop.auditeventinfo2
Interface IAuditConnectionInfo

public interface IAuditConnectionInfo

This interface provides access to variables pertaining to the auditing database connection.

Since:

4.0

Nested Class Summary

static interface

IAuditConnectionInfo.CeAuditDatabaseDriver This interface defines valid audit database drivers.

Method Summary

java.lang.String	getDatabaseDriver() Returns the current auditing database connection driver.
java.lang.String	getDsnName() Returns the data source name for the auditing database connection.
java.lang.String	getUserName() Returns the username credential being used to connect to the auditing database.
boolean	getUseTrustedConnection() Returns the status of the single sign-on flag for the auditing database.
boolean	isAuditDBRestartOnConnectionLoss() Returns the status of the flag for the auditing database to restart when the connection is lost.
void	setAuditDBRestartOnConnectionLoss(boolean restart) Sets the status of the flag for the auditing database to restart when the connection is lost.
void	setDatabaseDriver(java.lang.String driver) Sets the auditing database connection driver for the system to use.
void	setDsnName(java.lang.String name) Sets the auditing database connection data source name
void	setPassword(java.lang.String password) Sets the password credential for the auditing database connection.
void	setUserName(java.lang.String userName) Sets the username credential for the auditing database connection
void	setUseTrustedConnection(boolean useTrustedConnection) Sets the status of the single sign-on flag for the auditing database

Method Detail

getDatabaseDriver

java.lang.String getDatabaseDriver()

Returns the current auditing database connection driver.

Returns:

The name of the in-use auditing connection connection driver

getDsnName

java.lang.String getDsnName()

Returns the data source name for the auditing database connection.

Returns:

The DSN for the auditing database connection

getUserName

java.lang.String getUserName()

Returns the username credential being used to connect to the auditing database.

Returns:

The user name of the auditing database connection

getUseTrustedConnection

boolean getUseTrustedConnection()

Returns the status of the single sign-on flag for the auditing database.

Returns:

The status of availability for single sign-on with the database connection

setDatabaseDriver

void setDatabaseDriver(java.lang.String driver)
                       throws SDKException

Sets the auditing database connection driver for the system to use.

Parameters:

driver - The database driver of the auditing database connection, expected to be a String constant from the CeAuditDatabaseDriver interface.

Throws:

SDKException - This is thrown if the driver parameter is not a valid entry from the CeAuditDatabaseDriver interface.

See Also:

CeAuditDatabaseDriver

setDsnName

void setDsnName(java.lang.String name)

Sets the auditing database connection data source name

Parameters:

name - The DSN used by the auditing database connection

setUserName

void setUserName(java.lang.String userName)

Sets the username credential for the auditing database connection

Parameters:

userName - The username to be used by the auditing database connection

setUseTrustedConnection

void setUseTrustedConnection(boolean useTrustedConnection)
                             throws SDKException

Sets the status of the single sign-on flag for the auditing database

Parameters:

useTrustedConnection - The use trusted connection flag of the auditing database connection, it can be set to true only if the database driver is set to SQL_SERVER_AUDIT_DB_DRIVER.

Throws:

SDKException - This is thrown if the active auditing database driver is not set to SQL_SERVER_AUDIT_DB_DRIVER.

setPassword

void setPassword(java.lang.String password)
                 throws SDKException

Sets the password credential for the auditing database connection. The password is not retrievable afterwards.

Parameters:

password - The password to be used by the auditing database connection

Throws:

SDKException - when password is null.

isAuditDBRestartOnConnectionLoss

boolean isAuditDBRestartOnConnectionLoss()

Returns the status of the flag for the auditing database to restart when the connection is lost.

Returns:

The status of the flag indicating whether or not the auditing database will restart when it loses its connection with the CMS

setAuditDBRestartOnConnectionLoss

void setAuditDBRestartOnConnectionLoss(boolean restart)

Sets the status of the flag for the auditing database to restart when the connection is lost.

Parameters:

restart - The status of the flag for the auditing database to restart when it loses its connection with the CMS