Skip navigation links

oracle.bi.management.adminservices.mbeans
Interface ScaleOutSupportMBean

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

Provides operations to support scaling out a domain. 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	createPackFile() Creates a new pack file and returns a name that can be used to fetch or delete it.
void	deletePackFile(java.lang.String packFileName) Deletes the pack file with the specified name.
long	getCheckSum(java.lang.String packFileName) Gets the CRC32 checksum for the pack file with the specified name.
byte[]	getNextPackFileChunk(java.lang.String packFileName) Fetches the next chunk of data for the pack file with the specified name.

Method Detail

createPackFile

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.ScaleOutSupportMBean.createPackFile",
             resourceBundleBasename="oracle_bi_management_adminservices_rsc_BIMBeanMsg")
java.lang.String createPackFile()

Creates a new pack file and returns a name that can be used to fetch or delete it. The client can then fetch the pack file content using getNextPackFileChunk(String). The client must call deletePackFile(String) once the content has been fetched to ensure resources are freed.
The pack file contains the definition of the domain ready to be applied via unpack() - typically to provision a new managed server.

getCheckSum

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.ScaleOutSupportMBean.getCheckSum",
             resourceBundleBasename="oracle_bi_management_adminservices_rsc_BIMBeanMsg")
long getCheckSum(@Name(value="packFileName")
                             java.lang.String packFileName)
                 throws java.lang.IllegalArgumentException

Gets the CRC32 checksum for the pack file with the specified name.

Parameters:

packFileName - The name of the pack file for which to return a checksum as provided by createPackFile().

Returns:

The CRC32 based checksum for the pack file.

Throws:

java.lang.IllegalArgumentException - If the packFileName argument is not a recognized name.

getNextPackFileChunk

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.ScaleOutSupportMBean.getNextPackFileChunk",
             resourceBundleBasename="oracle_bi_management_adminservices_rsc_BIMBeanMsg")
byte[] getNextPackFileChunk(@Name(value="packFileName")
                                        java.lang.String packFileName)
                            throws java.lang.IllegalArgumentException

Fetches the next chunk of data for the pack file with the specified name.

Parameters:

packFileName - The name of the pack file for which to fetch a chunk of data as provided by createPackFile().

Returns:

The next chunk of data for the pack file or a null reference if there is no more data to be fetched.

Throws:

java.lang.IllegalArgumentException - If the packFileName argument is not a recognized name.

deletePackFile

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.ScaleOutSupportMBean.deletePackFile",
             resourceBundleBasename="oracle_bi_management_adminservices_rsc_BIMBeanMsg")
void deletePackFile(@Name(value="packFileName")
                                java.lang.String packFileName)
                    throws java.lang.IllegalArgumentException

Deletes the pack file with the specified name. The resources associated with the pack file will be deleted, which means that any subsequent use of the packFileName on any methods of this class will result in an exception.

Parameters:

packFileName - The name of the pack file for which to be deleted as provided by createPackFile().

Throws:

java.lang.IllegalArgumentException - If the packFileName argument is not a recognized name.

Skip navigation links