Skip navigation links

oracle.bi.management.adminservices.mbeans
Interface SchedulerDatabaseMBean

@MBeanRequiredGlobalSecurityRole(value=Admin)
@Description(resourceKey="oracle.bi.management.adminservices.mbeans.SchedulerDatabaseMBean.description",
             resourceBundleBasename="oracle_bi_management_adminservices_rsc_BIMBeanMsg")
public interface SchedulerDatabaseMBean

Defines an MBean interface for managing scheduler database connection settings. To ensure that exceptions are correctly reported in clients such as JConsole, which typically do not have BIEE jars, only standard exceptions are surfaced here.

Method Summary

java.lang.String	getCallInterface() Returns the current database's call interface.
java.lang.String[]	getCallInterfaceForDatabaseType(java.lang.String databaseTypeName) Gets the call interface names which match the database type passed in.
java.lang.String	getDatabase() Returns the current database type.
java.lang.String[]	getDatabaseTypes() Returns the names of database types which are supported by the scheduler.
java.lang.String	getDataSource() Returns the data source of the database connection.
java.lang.String	getUsername() Retuns the user name.
void	setCallInterface(java.lang.String callInterface) Sets the current database's call interface.
void	setCredentials(java.lang.String username, char[] password) Sets the credentials for the scheduler database.
void	setCredentials(java.lang.String username, java.lang.String password) Deprecated. use setCredentials(String username, char[] password)
void	setDatabase(java.lang.String database) Sets the database type.
void	setDataSource(java.lang.String source) Sets the data source for the database connection
void	setUsername(java.lang.String username) Sets the user name NOTE: Use this api only when username alone needs updation.

Method Detail

getDatabaseTypes

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.SchedulerDatabaseMBean.DatabaseTypes",
             resourceBundleBasename="oracle_bi_management_adminservices_rsc_BIMBeanMsg")
java.lang.String[] getDatabaseTypes()

Returns the names of database types which are supported by the scheduler.

Returns:

array of DB types.

getCallInterfaceForDatabaseType

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.SchedulerDatabaseMBean.getCallInterfaceForDatabaseType",
             resourceBundleBasename="oracle_bi_management_adminservices_rsc_BIMBeanMsg")
java.lang.String[] getCallInterfaceForDatabaseType(@Name(value="databaseTypeName")
                                                               java.lang.String databaseTypeName)

Gets the call interface names which match the database type passed in.

Parameters:

databaseTypeName - the database type name.

Returns:

the name of the call interface or null if no match is found.

getCallInterface

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.SchedulerDatabaseMBean.CallInterface",
             resourceBundleBasename="oracle_bi_management_adminservices_rsc_BIMBeanMsg")
java.lang.String getCallInterface()

Returns the current database's call interface.

Returns:

call interface name

setCallInterface

void setCallInterface(java.lang.String callInterface)

Sets the current database's call interface.

Parameters:

callInterface - the name of the call interface.

getDatabase

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.SchedulerDatabaseMBean.Database",
             resourceBundleBasename="oracle_bi_management_adminservices_rsc_BIMBeanMsg")
java.lang.String getDatabase()

Returns the current database type.

setDatabase

void setDatabase(java.lang.String database)

Sets the database type.

getDataSource

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.SchedulerDatabaseMBean.DataSource",
             resourceBundleBasename="oracle_bi_management_adminservices_rsc_BIMBeanMsg")
java.lang.String getDataSource()

Returns the data source of the database connection.

setDataSource

void setDataSource(java.lang.String source)

Sets the data source for the database connection

Parameters:

source -

setCredentials

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.deprecated",
             resourceBundleBasename="oracle_bi_management_adminservices_rsc_BIMBeanMsg")
void setCredentials(@Name(value="username")
                                java.lang.String username,
                                @Name(value="password")
                                java.lang.String password)

Deprecated. use setCredentials(String username, char[] password)

Sets the credentials for the scheduler database.

Parameters:

username - The username. Must not be null.

password - The password. Must not be null.

setCredentials

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.SchedulerDatabaseMBean.setCredentials",
             resourceBundleBasename="oracle_bi_management_adminservices_rsc_BIMBeanMsg")
void setCredentials(@Name(value="username")
                                java.lang.String username,
                                @Name(value="password")
                                char[] password)

Sets the credentials for the scheduler database.

Parameters:

username - The username. Must not be null.

password - The password. Must not be null.

getUsername

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.SchedulerDatabaseMBean.Username",
             resourceBundleBasename="oracle_bi_management_adminservices_rsc_BIMBeanMsg")
java.lang.String getUsername()

Retuns the user name.

setUsername

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.SchedulerDatabaseMBean.Username",
             resourceBundleBasename="oracle_bi_management_adminservices_rsc_BIMBeanMsg")
void setUsername(java.lang.String username)

Sets the user name NOTE: Use this api only when username alone needs updation. Use setCredential(String,String) apis when both username and passwords are to be updated.

Since:

11.1.1.3.51

Skip navigation links