Skip navigation links

oracle.bi.management.adminservices.mbeans
Interface ServerConfigurationMBean

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

Defines an MBean interface for managing settings related to the BI Server. 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.util.Date	getFileUploadTime(java.lang.String fileName) Returns the date the file specified was uploaded.
java.lang.String	getRepositoryDataSourceName() get the data source name for the default repository
java.lang.String	getRepositoryName() gets the name for the default repository (without the .rpd file extension).
java.lang.String	getRepositorySharedLocation() get the shared location to be used when OBIS is clustered.
boolean	isRepositoryShared() get whether a shared directory is used to find repository files when OBIS is clustered
boolean	isRepositorySharedLocationAccessible() Gets whether the shared location for the repository is accessible from the Enterprise Manager server.
void	setRepositoryDataSourceName(java.lang.String repositoryDataSourceName) set the data source name for the default repository
void	setRepositoryName(java.lang.String repositoryName) sets the name for the default repository (without the .rpd file extension).
void	setRepositoryShared(boolean repositoryShared) set whether a shared location is used to find repository files when OBIS is clustered.
void	setRepositorySharedLocation(java.lang.String repositorySharedLocation) set the shared location to be used when OBIS is clustered.
void	uploadRepository(java.lang.String rpdFilePath, java.lang.String password) Uploads the repository file whose full path is represented by rpdFilePath.

Method Detail

getRepositoryName

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.ServerConfigurationMBean.RepositoryName",
             resourceBundleBasename="oracle_bi_management_adminservices_rsc_BIMBeanMsg")
java.lang.String getRepositoryName()

gets the name for the default repository (without the .rpd file extension).

setRepositoryName

void setRepositoryName(java.lang.String repositoryName)

sets the name for the default repository (without the .rpd file extension).

Parameters:

repositoryName -

getRepositoryDataSourceName

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.ServerConfigurationMBean.RepositoryDataSourceName",
             resourceBundleBasename="oracle_bi_management_adminservices_rsc_BIMBeanMsg")
java.lang.String getRepositoryDataSourceName()

get the data source name for the default repository

setRepositoryDataSourceName

void setRepositoryDataSourceName(java.lang.String repositoryDataSourceName)

set the data source name for the default repository

Parameters:

repositoryDataSourceName -

isRepositoryShared

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.ServerConfigurationMBean.RepositoryShared",
             resourceBundleBasename="oracle_bi_management_adminservices_rsc_BIMBeanMsg")
boolean isRepositoryShared()

get whether a shared directory is used to find repository files when OBIS is clustered

setRepositoryShared

void setRepositoryShared(boolean repositoryShared)

set whether a shared location is used to find repository files when OBIS is clustered.
if true, then a repository shared location should be set. if false, then the repository shared location is ignored (and OBIS instances will use the local directory).

Parameters:

repositoryShared -

getRepositorySharedLocation

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.ServerConfigurationMBean.RepositorySharedLocation",
             resourceBundleBasename="oracle_bi_management_adminservices_rsc_BIMBeanMsg")
java.lang.String getRepositorySharedLocation()

get the shared location to be used when OBIS is clustered.

Returns:

the shared location - not meaningful if isRepositoryShared is false

setRepositorySharedLocation

void setRepositorySharedLocation(java.lang.String repositorySharedLocation)

set the shared location to be used when OBIS is clustered.

Parameters:

repositorySharedLocation - - the location, required if isRepositoryShared is true but ignored if isRepositoryShared is false. Thus setRepositoryShared(true) must be called before this method will persist the required location.

isRepositorySharedLocationAccessible

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.ServerConfigurationMBean.RepositorySharedLocationAccessible",
             resourceBundleBasename="oracle_bi_management_adminservices_rsc_BIMBeanMsg")
boolean isRepositorySharedLocationAccessible()

Gets whether the shared location for the repository is accessible from the Enterprise Manager server. If the shared location is not accessible then any shared RPD file will not be written to that location. It will have to be copied there as part of a manual task. If there is not a shared location specified then this method will return false.

Returns:

True only if the shared location can be accessed. In all other cases false is returned.

uploadRepository

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.ServerConfigurationMBean.uploadRepository.ByName",
             resourceBundleBasename="oracle_bi_management_adminservices_rsc_BIMBeanMsg")
void uploadRepository(@Name(value="rpdFilePath")
                                  java.lang.String rpdFilePath,
                                  @Name(value="password")
                                  java.lang.String password)
                      throws java.io.IOException

Uploads the repository file whose full path is represented by rpdFilePath.

Parameters:

rpdFilePath - the full path of the repository file.

password - the password for the RPD file.

Throws:

java.io.IOException

getFileUploadTime

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.ServerConfigurationMBean.getFileUploadTime",
             resourceBundleBasename="oracle_bi_management_adminservices_rsc_BIMBeanMsg")
java.util.Date getFileUploadTime(@Name(value="rpdFilePath")
                                             java.lang.String fileName)
                                 throws java.io.IOException

Returns the date the file specified was uploaded. Note: Only a single file of each type can be uploaded. Asking for the upload time of a previous uploaded file will result in an null return.

Parameters:

fileName - The name of the target file.

Returns:

The date the file was uploaded, or null if the file is not in the current upload bundle. Must not be null.

Throws:

java.io.IOException

Skip navigation links